Skip to content

Commit 9996a39

Browse files
author
awstools
committed
feat(client-bedrock-agent-runtime): This release introduces filtering support on Retrieve and RetrieveAndGenerate APIs.
1 parent 4473efc commit 9996a39

File tree

6 files changed

+1005
-164
lines changed

6 files changed

+1005
-164
lines changed

‎clients/client-bedrock-agent-runtime/src/commands/InvokeAgentCommand.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,9 @@ export interface InvokeAgentCommandOutput extends InvokeAgentResponse, __Metadat
117117
* // uri: "STRING_VALUE",
118118
* // },
119119
* // },
120+
* // metadata: { // RetrievalResultMetadata
121+
* // "<keys>": "DOCUMENT_VALUE",
122+
* // },
120123
* // },
121124
* // ],
122125
* // },
@@ -208,6 +211,9 @@ export interface InvokeAgentCommandOutput extends InvokeAgentResponse, __Metadat
208211
* // uri: "STRING_VALUE",
209212
* // },
210213
* // },
214+
* // metadata: {
215+
* // "<keys>": "DOCUMENT_VALUE",
216+
* // },
211217
* // },
212218
* // ],
213219
* // },

‎clients/client-bedrock-agent-runtime/src/commands/RetrieveAndGenerateCommand.ts

Lines changed: 52 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ export interface RetrieveAndGenerateCommandInput extends RetrieveAndGenerateRequ
3636
export interface RetrieveAndGenerateCommandOutput extends RetrieveAndGenerateResponse, __MetadataBearer {}
3737

3838
/**
39-
* <p>Queries a knowledge base and generates responses based on the retrieved results. The response cites up to five sources but only selects the ones that are relevant to the query.</p>
39+
* <p>Queries a knowledge base and generates responses based on the retrieved results. The response only cites sources that are relevant to the query.</p>
4040
* @example
4141
* Use a bare-bones client and the command you need to make an API call.
4242
* ```javascript
@@ -57,6 +57,54 @@ export interface RetrieveAndGenerateCommandOutput extends RetrieveAndGenerateRes
5757
* vectorSearchConfiguration: { // KnowledgeBaseVectorSearchConfiguration
5858
* numberOfResults: Number("int"),
5959
* overrideSearchType: "HYBRID" || "SEMANTIC",
60+
* filter: { // RetrievalFilter Union: only one key present
61+
* equals: { // FilterAttribute
62+
* key: "STRING_VALUE", // required
63+
* value: "DOCUMENT_VALUE", // required
64+
* },
65+
* notEquals: {
66+
* key: "STRING_VALUE", // required
67+
* value: "DOCUMENT_VALUE", // required
68+
* },
69+
* greaterThan: {
70+
* key: "STRING_VALUE", // required
71+
* value: "DOCUMENT_VALUE", // required
72+
* },
73+
* greaterThanOrEquals: {
74+
* key: "STRING_VALUE", // required
75+
* value: "DOCUMENT_VALUE", // required
76+
* },
77+
* lessThan: {
78+
* key: "STRING_VALUE", // required
79+
* value: "DOCUMENT_VALUE", // required
80+
* },
81+
* lessThanOrEquals: "<FilterAttribute>",
82+
* in: "<FilterAttribute>",
83+
* notIn: "<FilterAttribute>",
84+
* startsWith: "<FilterAttribute>",
85+
* andAll: [ // RetrievalFilterList
86+
* {// Union: only one key present
87+
* equals: "<FilterAttribute>",
88+
* notEquals: "<FilterAttribute>",
89+
* greaterThan: "<FilterAttribute>",
90+
* greaterThanOrEquals: "<FilterAttribute>",
91+
* lessThan: "<FilterAttribute>",
92+
* lessThanOrEquals: "<FilterAttribute>",
93+
* in: "<FilterAttribute>",
94+
* notIn: "<FilterAttribute>",
95+
* startsWith: "<FilterAttribute>",
96+
* andAll: [
97+
* "<RetrievalFilter>",
98+
* ],
99+
* orAll: [
100+
* "<RetrievalFilter>",
101+
* ],
102+
* },
103+
* ],
104+
* orAll: [
105+
* "<RetrievalFilter>",
106+
* ],
107+
* },
60108
* },
61109
* },
62110
* generationConfiguration: { // GenerationConfiguration
@@ -99,6 +147,9 @@ export interface RetrieveAndGenerateCommandOutput extends RetrieveAndGenerateRes
99147
* // uri: "STRING_VALUE",
100148
* // },
101149
* // },
150+
* // metadata: { // RetrievalResultMetadata
151+
* // "<keys>": "DOCUMENT_VALUE",
152+
* // },
102153
* // },
103154
* // ],
104155
* // },

‎clients/client-bedrock-agent-runtime/src/commands/RetrieveCommand.ts

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,54 @@ export interface RetrieveCommandOutput extends RetrieveResponse, __MetadataBeare
5252
* vectorSearchConfiguration: { // KnowledgeBaseVectorSearchConfiguration
5353
* numberOfResults: Number("int"),
5454
* overrideSearchType: "HYBRID" || "SEMANTIC",
55+
* filter: { // RetrievalFilter Union: only one key present
56+
* equals: { // FilterAttribute
57+
* key: "STRING_VALUE", // required
58+
* value: "DOCUMENT_VALUE", // required
59+
* },
60+
* notEquals: {
61+
* key: "STRING_VALUE", // required
62+
* value: "DOCUMENT_VALUE", // required
63+
* },
64+
* greaterThan: {
65+
* key: "STRING_VALUE", // required
66+
* value: "DOCUMENT_VALUE", // required
67+
* },
68+
* greaterThanOrEquals: {
69+
* key: "STRING_VALUE", // required
70+
* value: "DOCUMENT_VALUE", // required
71+
* },
72+
* lessThan: {
73+
* key: "STRING_VALUE", // required
74+
* value: "DOCUMENT_VALUE", // required
75+
* },
76+
* lessThanOrEquals: "<FilterAttribute>",
77+
* in: "<FilterAttribute>",
78+
* notIn: "<FilterAttribute>",
79+
* startsWith: "<FilterAttribute>",
80+
* andAll: [ // RetrievalFilterList
81+
* {// Union: only one key present
82+
* equals: "<FilterAttribute>",
83+
* notEquals: "<FilterAttribute>",
84+
* greaterThan: "<FilterAttribute>",
85+
* greaterThanOrEquals: "<FilterAttribute>",
86+
* lessThan: "<FilterAttribute>",
87+
* lessThanOrEquals: "<FilterAttribute>",
88+
* in: "<FilterAttribute>",
89+
* notIn: "<FilterAttribute>",
90+
* startsWith: "<FilterAttribute>",
91+
* andAll: [
92+
* "<RetrievalFilter>",
93+
* ],
94+
* orAll: [
95+
* "<RetrievalFilter>",
96+
* ],
97+
* },
98+
* ],
99+
* orAll: [
100+
* "<RetrievalFilter>",
101+
* ],
102+
* },
55103
* },
56104
* },
57105
* nextToken: "STRING_VALUE",
@@ -71,6 +119,9 @@ export interface RetrieveCommandOutput extends RetrieveResponse, __MetadataBeare
71119
* // },
72120
* // },
73121
* // score: Number("double"),
122+
* // metadata: { // RetrievalResultMetadata
123+
* // "<keys>": "DOCUMENT_VALUE",
124+
* // },
74125
* // },
75126
* // ],
76127
* // nextToken: "STRING_VALUE",

0 commit comments

Comments
 (0)