Skip to content

Commit 8de9119

Browse files
author
AWS SDK for Go v2 automation user
committed
Update API model
1 parent 05fcf66 commit 8de9119

File tree

6 files changed

+1024
-125
lines changed

6 files changed

+1024
-125
lines changed

codegen/sdk-codegen/aws-models/bedrock-agent-runtime.json

Lines changed: 24 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2722,72 +2722,84 @@
27222722
"equals": {
27232723
"target": "com.amazonaws.bedrockagentruntime#FilterAttribute",
27242724
"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>"
27262726
}
27272727
},
27282728
"notEquals": {
27292729
"target": "com.amazonaws.bedrockagentruntime#FilterAttribute",
27302730
"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>"
27322732
}
27332733
},
27342734
"greaterThan": {
27352735
"target": "com.amazonaws.bedrockagentruntime#FilterAttribute",
27362736
"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>"
27382738
}
27392739
},
27402740
"greaterThanOrEquals": {
27412741
"target": "com.amazonaws.bedrockagentruntime#FilterAttribute",
27422742
"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>"
27442744
}
27452745
},
27462746
"lessThan": {
27472747
"target": "com.amazonaws.bedrockagentruntime#FilterAttribute",
27482748
"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>"
27502750
}
27512751
},
27522752
"lessThanOrEquals": {
27532753
"target": "com.amazonaws.bedrockagentruntime#FilterAttribute",
27542754
"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>"
27562756
}
27572757
},
27582758
"in": {
27592759
"target": "com.amazonaws.bedrockagentruntime#FilterAttribute",
27602760
"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>"
27622762
}
27632763
},
27642764
"notIn": {
27652765
"target": "com.amazonaws.bedrockagentruntime#FilterAttribute",
27662766
"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>"
27682768
}
27692769
},
27702770
"startsWith": {
27712771
"target": "com.amazonaws.bedrockagentruntime#FilterAttribute",
27722772
"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>"
27742786
}
27752787
},
27762788
"andAll": {
27772789
"target": "com.amazonaws.bedrockagentruntime#RetrievalFilterList",
27782790
"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>"
27802792
}
27812793
},
27822794
"orAll": {
27832795
"target": "com.amazonaws.bedrockagentruntime#RetrievalFilterList",
27842796
"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>"
27862798
}
27872799
}
27882800
},
27892801
"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>",
27912803
"smithy.api#sensitive": {}
27922804
}
27932805
},

0 commit comments

Comments
 (0)