|
2722 | 2722 | "equals": {
|
2723 | 2723 | "target": "com.amazonaws.bedrockagentruntime#FilterAttribute",
|
2724 | 2724 | "traits": {
|
2725 |
| - "smithy.api#documentation": "<p>Knowledge base data sources that contain a metadata attribute whose name matches the <code>key</code> and whose value matches the <code>value</code> in this object are returned.</p>" |
| 2725 | + "smithy.api#documentation": "<p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the <code>key</code> and whose value matches the <code>value</code> in this object.</p>\n <p>The following example would return data sources with an <code>animal</code> attribute whose value is <code>cat</code>:</p>\n <p>\n <code>\"equals\": { \"key\": \"animal\", \"value\": \"cat\" }</code>\n </p>" |
2726 | 2726 | }
|
2727 | 2727 | },
|
2728 | 2728 | "notEquals": {
|
2729 | 2729 | "target": "com.amazonaws.bedrockagentruntime#FilterAttribute",
|
2730 | 2730 | "traits": {
|
2731 |
| - "smithy.api#documentation": "<p>Knowledge base data sources that contain a metadata attribute whose name matches the <code>key</code> and whose value doesn't match the <code>value</code> in this object are returned.</p>" |
| 2731 | + "smithy.api#documentation": "<p>Knowledge base data sources that contain a metadata attribute whose name matches the <code>key</code> and whose value doesn't match the <code>value</code> in this object are returned.</p>\n <p>The following example would return data sources that don't contain an <code>animal</code> attribute whose value is <code>cat</code>.</p>\n <p>\n <code>\"notEquals\": { \"key\": \"animal\", \"value\": \"cat\" }</code>\n </p>" |
2732 | 2732 | }
|
2733 | 2733 | },
|
2734 | 2734 | "greaterThan": {
|
2735 | 2735 | "target": "com.amazonaws.bedrockagentruntime#FilterAttribute",
|
2736 | 2736 | "traits": {
|
2737 |
| - "smithy.api#documentation": "<p>Knowledge base data sources that contain a metadata attribute whose name matches the <code>key</code> and whose value is greater than the <code>value</code> in this object are returned.</p>" |
| 2737 | + "smithy.api#documentation": "<p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the <code>key</code> and whose value is greater than the <code>value</code> in this object.</p>\n <p>The following example would return data sources with an <code>year</code> attribute whose value is greater than <code>1989</code>:</p>\n <p>\n <code>\"greaterThan\": { \"key\": \"year\", \"value\": 1989 }</code>\n </p>" |
2738 | 2738 | }
|
2739 | 2739 | },
|
2740 | 2740 | "greaterThanOrEquals": {
|
2741 | 2741 | "target": "com.amazonaws.bedrockagentruntime#FilterAttribute",
|
2742 | 2742 | "traits": {
|
2743 |
| - "smithy.api#documentation": "<p>Knowledge base data sources that contain a metadata attribute whose name matches the <code>key</code> and whose value is greater than or equal to the <code>value</code> in this object are returned.</p>" |
| 2743 | + "smithy.api#documentation": "<p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the <code>key</code> and whose value is greater than or equal to the <code>value</code> in this object.</p>\n <p>The following example would return data sources with an <code>year</code> attribute whose value is greater than or equal to <code>1989</code>:</p>\n <p>\n <code>\"greaterThanOrEquals\": { \"key\": \"year\", \"value\": 1989 }</code>\n </p>" |
2744 | 2744 | }
|
2745 | 2745 | },
|
2746 | 2746 | "lessThan": {
|
2747 | 2747 | "target": "com.amazonaws.bedrockagentruntime#FilterAttribute",
|
2748 | 2748 | "traits": {
|
2749 |
| - "smithy.api#documentation": "<p>Knowledge base data sources that contain a metadata attribute whose name matches the <code>key</code> and whose value is less than the <code>value</code> in this object are returned.</p>" |
| 2749 | + "smithy.api#documentation": "<p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the <code>key</code> and whose value is less than the <code>value</code> in this object.</p>\n <p>The following example would return data sources with an <code>year</code> attribute whose value is less than to <code>1989</code>.</p>\n <p>\n <code>\"lessThan\": { \"key\": \"year\", \"value\": 1989 }</code>\n </p>" |
2750 | 2750 | }
|
2751 | 2751 | },
|
2752 | 2752 | "lessThanOrEquals": {
|
2753 | 2753 | "target": "com.amazonaws.bedrockagentruntime#FilterAttribute",
|
2754 | 2754 | "traits": {
|
2755 |
| - "smithy.api#documentation": "<p>Knowledge base data sources that contain a metadata attribute whose name matches the <code>key</code> and whose value is less than or equal to the <code>value</code> in this object are returned.</p>" |
| 2755 | + "smithy.api#documentation": "<p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the <code>key</code> and whose value is less than or equal to the <code>value</code> in this object.</p>\n <p>The following example would return data sources with an <code>year</code> attribute whose value is less than or equal to <code>1989</code>.</p>\n <p>\n <code>\"lessThanOrEquals\": { \"key\": \"year\", \"value\": 1989 }</code>\n </p>" |
2756 | 2756 | }
|
2757 | 2757 | },
|
2758 | 2758 | "in": {
|
2759 | 2759 | "target": "com.amazonaws.bedrockagentruntime#FilterAttribute",
|
2760 | 2760 | "traits": {
|
2761 |
| - "smithy.api#documentation": "<p>Knowledge base data sources that contain a metadata attribute whose name matches the <code>key</code> and whose value is in the list specified in the <code>value</code> in this object are returned.</p>" |
| 2761 | + "smithy.api#documentation": "<p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the <code>key</code> and whose value is in the list specified in the <code>value</code> in this object.</p>\n <p>The following example would return data sources with an <code>animal</code> attribute that is either <code>cat</code> or <code>dog</code>:</p>\n <p>\n <code>\"in\": { \"key\": \"animal\", \"value\": [\"cat\", \"dog\"] }</code>\n </p>" |
2762 | 2762 | }
|
2763 | 2763 | },
|
2764 | 2764 | "notIn": {
|
2765 | 2765 | "target": "com.amazonaws.bedrockagentruntime#FilterAttribute",
|
2766 | 2766 | "traits": {
|
2767 |
| - "smithy.api#documentation": "<p>Knowledge base data sources that contain a metadata attribute whose name matches the <code>key</code> and whose value isn't in the list specified in the <code>value</code> in this object are returned.</p>" |
| 2767 | + "smithy.api#documentation": "<p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the <code>key</code> and whose value isn't in the list specified in the <code>value</code> in this object.</p>\n <p>The following example would return data sources whose <code>animal</code> attribute is neither <code>cat</code> nor <code>dog</code>.</p>\n <p>\n <code>\"notIn\": { \"key\": \"animal\", \"value\": [\"cat\", \"dog\"] }</code>\n </p>" |
2768 | 2768 | }
|
2769 | 2769 | },
|
2770 | 2770 | "startsWith": {
|
2771 | 2771 | "target": "com.amazonaws.bedrockagentruntime#FilterAttribute",
|
2772 | 2772 | "traits": {
|
2773 |
| - "smithy.api#documentation": "<p>Knowledge base data sources that contain a metadata attribute whose name matches the <code>key</code> and whose value starts with the <code>value</code> in this object are returned. This filter is currently only supported for Amazon OpenSearch Serverless vector stores.</p>" |
| 2773 | + "smithy.api#documentation": "<p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the <code>key</code> and whose value starts with the <code>value</code> in this object. This filter is currently only supported for Amazon OpenSearch Serverless vector stores.</p>\n <p>The following example would return data sources with an <code>animal</code> attribute starts with <code>ca</code> (for example, <code>cat</code> or <code>camel</code>).</p>\n <p>\n <code>\"startsWith\": { \"key\": \"animal\", \"value\": \"ca\" }</code>\n </p>" |
| 2774 | + } |
| 2775 | + }, |
| 2776 | + "listContains": { |
| 2777 | + "target": "com.amazonaws.bedrockagentruntime#FilterAttribute", |
| 2778 | + "traits": { |
| 2779 | + "smithy.api#documentation": "<p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the <code>key</code> and whose value is a list that contains the <code>value</code> as one of its members.</p>\n <p>The following example would return data sources with an <code>animals</code> attribute that is a list containing a <code>cat</code> member (for example <code>[\"dog\", \"cat\"]</code>).</p>\n <p>\n <code>\"listContains\": { \"key\": \"animals\", \"value\": \"cat\" }</code>\n </p>" |
| 2780 | + } |
| 2781 | + }, |
| 2782 | + "stringContains": { |
| 2783 | + "target": "com.amazonaws.bedrockagentruntime#FilterAttribute", |
| 2784 | + "traits": { |
| 2785 | + "smithy.api#documentation": "<p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the <code>key</code> and whose value is one of the following:</p>\n <ul>\n <li>\n <p>A string that contains the <code>value</code> as a substring. The following example would return data sources with an <code>animal</code> attribute that contains the substring <code>at</code> (for example <code>cat</code>).</p>\n <p>\n <code>\"stringContains\": { \"key\": \"animal\", \"value\": \"at\" }</code>\n </p>\n </li>\n <li>\n <p>A list with a member that contains the <code>value</code> as a substring. The following example would return data sources with an <code>animals</code> attribute that is a list containing a member that contains the substring <code>at</code> (for example <code>[\"dog\", \"cat\"]</code>).</p>\n <p>\n <code>\"stringContains\": { \"key\": \"animals\", \"value\": \"at\" }</code>\n </p>\n </li>\n </ul>" |
2774 | 2786 | }
|
2775 | 2787 | },
|
2776 | 2788 | "andAll": {
|
2777 | 2789 | "target": "com.amazonaws.bedrockagentruntime#RetrievalFilterList",
|
2778 | 2790 | "traits": {
|
2779 |
| - "smithy.api#documentation": "<p>Knowledge base data sources whose metadata attributes fulfill all the filter conditions inside this list are returned.</p>" |
| 2791 | + "smithy.api#documentation": "<p>Knowledge base data sources are returned if their metadata attributes fulfill all the filter conditions inside this list.</p>" |
2780 | 2792 | }
|
2781 | 2793 | },
|
2782 | 2794 | "orAll": {
|
2783 | 2795 | "target": "com.amazonaws.bedrockagentruntime#RetrievalFilterList",
|
2784 | 2796 | "traits": {
|
2785 |
| - "smithy.api#documentation": "<p>Knowledge base data sources whose metadata attributes fulfill at least one of the filter conditions inside this list are returned.</p>" |
| 2797 | + "smithy.api#documentation": "<p>Knowledge base data sources are returned if their metadata attributes fulfill at least one of the filter conditions inside this list.</p>" |
2786 | 2798 | }
|
2787 | 2799 | }
|
2788 | 2800 | },
|
2789 | 2801 | "traits": {
|
2790 |
| - "smithy.api#documentation": "<p>Specifies the filters to use on the metadata attributes in the knowledge base data sources before returning results. For more information, see <a href=\"https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html\">Query configurations</a>.</p>\n <p>This data type is used in the following API operations:</p>\n <ul>\n <li>\n <p>\n <a href=\"https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax\">Retrieve request</a> – in the <code>filter</code> field</p>\n </li>\n <li>\n <p>\n <a href=\"https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax\">RetrieveAndGenerate request</a> – in the <code>filter</code> field</p>\n </li>\n </ul>", |
| 2802 | + "smithy.api#documentation": "<p>Specifies the filters to use on the metadata attributes in the knowledge base data sources before returning results. For more information, see <a href=\"https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html\">Query configurations</a>. See the examples below to see how to use these filters.</p>\n <p>This data type is used in the following API operations:</p>\n <ul>\n <li>\n <p>\n <a href=\"https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax\">Retrieve request</a> – in the <code>filter</code> field</p>\n </li>\n <li>\n <p>\n <a href=\"https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax\">RetrieveAndGenerate request</a> – in the <code>filter</code> field</p>\n </li>\n </ul>", |
2791 | 2803 | "smithy.api#sensitive": {}
|
2792 | 2804 | }
|
2793 | 2805 | },
|
|
0 commit comments