@aws-sdk/client-bedrock-agent-runtime 3.1070.0 → 3.1072.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (65) hide show
  1. package/README.md +14 -0
  2. package/dist-cjs/index.js +93 -8
  3. package/dist-cjs/models/errors.js +42 -42
  4. package/dist-cjs/runtimeConfig.js +5 -2
  5. package/dist-cjs/schemas/schemas_0.js +567 -139
  6. package/dist-es/BedrockAgentRuntime.js +4 -0
  7. package/dist-es/commands/AgenticRetrieveStreamCommand.js +20 -0
  8. package/dist-es/commands/GetDocumentContentCommand.js +16 -0
  9. package/dist-es/commands/index.js +2 -0
  10. package/dist-es/models/enums.js +50 -7
  11. package/dist-es/models/errors.js +42 -42
  12. package/dist-es/runtimeConfig.js +5 -2
  13. package/dist-es/schemas/schemas_0.js +521 -139
  14. package/dist-types/BedrockAgentRuntime.d.ts +14 -0
  15. package/dist-types/BedrockAgentRuntimeClient.d.ts +4 -2
  16. package/dist-types/commands/AgenticRetrieveStreamCommand.d.ts +338 -0
  17. package/dist-types/commands/GetDocumentContentCommand.d.ts +99 -0
  18. package/dist-types/commands/GetInvocationStepCommand.d.ts +1 -1
  19. package/dist-types/commands/InvokeAgentCommand.d.ts +55 -4
  20. package/dist-types/commands/InvokeFlowCommand.d.ts +14 -2
  21. package/dist-types/commands/InvokeInlineAgentCommand.d.ts +78 -8
  22. package/dist-types/commands/ListFlowExecutionEventsCommand.d.ts +14 -2
  23. package/dist-types/commands/ListInvocationStepsCommand.d.ts +1 -1
  24. package/dist-types/commands/ListInvocationsCommand.d.ts +1 -1
  25. package/dist-types/commands/ListSessionsCommand.d.ts +1 -1
  26. package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
  27. package/dist-types/commands/PutInvocationStepCommand.d.ts +1 -1
  28. package/dist-types/commands/RetrieveAndGenerateCommand.d.ts +45 -3
  29. package/dist-types/commands/RetrieveAndGenerateStreamCommand.d.ts +52 -4
  30. package/dist-types/commands/RetrieveCommand.d.ts +45 -2
  31. package/dist-types/commands/TagResourceCommand.d.ts +1 -1
  32. package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
  33. package/dist-types/commands/UpdateSessionCommand.d.ts +1 -1
  34. package/dist-types/commands/index.d.ts +2 -0
  35. package/dist-types/models/enums.d.ts +163 -16
  36. package/dist-types/models/errors.d.ts +45 -45
  37. package/dist-types/models/models_0.d.ts +4105 -4355
  38. package/dist-types/models/models_1.d.ts +1396 -2
  39. package/dist-types/runtimeConfig.d.ts +1 -1
  40. package/dist-types/schemas/schemas_0.d.ts +48 -0
  41. package/dist-types/ts3.4/BedrockAgentRuntime.d.ts +34 -0
  42. package/dist-types/ts3.4/BedrockAgentRuntimeClient.d.ts +12 -0
  43. package/dist-types/ts3.4/commands/AgenticRetrieveStreamCommand.d.ts +51 -0
  44. package/dist-types/ts3.4/commands/GetDocumentContentCommand.d.ts +53 -0
  45. package/dist-types/ts3.4/commands/GetInvocationStepCommand.d.ts +1 -1
  46. package/dist-types/ts3.4/commands/InvokeAgentCommand.d.ts +2 -1
  47. package/dist-types/ts3.4/commands/ListInvocationStepsCommand.d.ts +1 -1
  48. package/dist-types/ts3.4/commands/ListInvocationsCommand.d.ts +1 -1
  49. package/dist-types/ts3.4/commands/ListSessionsCommand.d.ts +1 -1
  50. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +1 -1
  51. package/dist-types/ts3.4/commands/PutInvocationStepCommand.d.ts +1 -1
  52. package/dist-types/ts3.4/commands/RetrieveAndGenerateCommand.d.ts +2 -4
  53. package/dist-types/ts3.4/commands/RetrieveAndGenerateStreamCommand.d.ts +2 -4
  54. package/dist-types/ts3.4/commands/RetrieveCommand.d.ts +2 -1
  55. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
  56. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +1 -1
  57. package/dist-types/ts3.4/commands/UpdateSessionCommand.d.ts +1 -1
  58. package/dist-types/ts3.4/commands/index.d.ts +2 -0
  59. package/dist-types/ts3.4/models/enums.d.ts +74 -11
  60. package/dist-types/ts3.4/models/errors.d.ts +28 -28
  61. package/dist-types/ts3.4/models/models_0.d.ts +448 -541
  62. package/dist-types/ts3.4/models/models_1.d.ts +602 -3
  63. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -1
  64. package/dist-types/ts3.4/schemas/schemas_0.d.ts +48 -0
  65. package/package.json +3 -3
@@ -1,5 +1,6 @@
1
1
  import type { HttpHandlerOptions as __HttpHandlerOptions, PaginationConfiguration, Paginator } from "@smithy/types";
2
2
  import { BedrockAgentRuntimeClient } from "./BedrockAgentRuntimeClient";
3
+ import { type AgenticRetrieveStreamCommandInput, type AgenticRetrieveStreamCommandOutput } from "./commands/AgenticRetrieveStreamCommand";
3
4
  import { type CreateInvocationCommandInput, type CreateInvocationCommandOutput } from "./commands/CreateInvocationCommand";
4
5
  import { type CreateSessionCommandInput, type CreateSessionCommandOutput } from "./commands/CreateSessionCommand";
5
6
  import { type DeleteAgentMemoryCommandInput, type DeleteAgentMemoryCommandOutput } from "./commands/DeleteAgentMemoryCommand";
@@ -7,6 +8,7 @@ import { type DeleteSessionCommandInput, type DeleteSessionCommandOutput } from
7
8
  import { type EndSessionCommandInput, type EndSessionCommandOutput } from "./commands/EndSessionCommand";
8
9
  import { type GenerateQueryCommandInput, type GenerateQueryCommandOutput } from "./commands/GenerateQueryCommand";
9
10
  import { type GetAgentMemoryCommandInput, type GetAgentMemoryCommandOutput } from "./commands/GetAgentMemoryCommand";
11
+ import { type GetDocumentContentCommandInput, type GetDocumentContentCommandOutput } from "./commands/GetDocumentContentCommand";
10
12
  import { type GetExecutionFlowSnapshotCommandInput, type GetExecutionFlowSnapshotCommandOutput } from "./commands/GetExecutionFlowSnapshotCommand";
11
13
  import { type GetFlowExecutionCommandInput, type GetFlowExecutionCommandOutput } from "./commands/GetFlowExecutionCommand";
12
14
  import { type GetInvocationStepCommandInput, type GetInvocationStepCommandOutput } from "./commands/GetInvocationStepCommand";
@@ -32,6 +34,12 @@ import { type TagResourceCommandInput, type TagResourceCommandOutput } from "./c
32
34
  import { type UntagResourceCommandInput, type UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
33
35
  import { type UpdateSessionCommandInput, type UpdateSessionCommandOutput } from "./commands/UpdateSessionCommand";
34
36
  export interface BedrockAgentRuntime {
37
+ /**
38
+ * @see {@link AgenticRetrieveStreamCommand}
39
+ */
40
+ agenticRetrieveStream(args: AgenticRetrieveStreamCommandInput, options?: __HttpHandlerOptions): Promise<AgenticRetrieveStreamCommandOutput>;
41
+ agenticRetrieveStream(args: AgenticRetrieveStreamCommandInput, cb: (err: any, data?: AgenticRetrieveStreamCommandOutput) => void): void;
42
+ agenticRetrieveStream(args: AgenticRetrieveStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AgenticRetrieveStreamCommandOutput) => void): void;
35
43
  /**
36
44
  * @see {@link CreateInvocationCommand}
37
45
  */
@@ -75,6 +83,12 @@ export interface BedrockAgentRuntime {
75
83
  getAgentMemory(args: GetAgentMemoryCommandInput, options?: __HttpHandlerOptions): Promise<GetAgentMemoryCommandOutput>;
76
84
  getAgentMemory(args: GetAgentMemoryCommandInput, cb: (err: any, data?: GetAgentMemoryCommandOutput) => void): void;
77
85
  getAgentMemory(args: GetAgentMemoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAgentMemoryCommandOutput) => void): void;
86
+ /**
87
+ * @see {@link GetDocumentContentCommand}
88
+ */
89
+ getDocumentContent(args: GetDocumentContentCommandInput, options?: __HttpHandlerOptions): Promise<GetDocumentContentCommandOutput>;
90
+ getDocumentContent(args: GetDocumentContentCommandInput, cb: (err: any, data?: GetDocumentContentCommandOutput) => void): void;
91
+ getDocumentContent(args: GetDocumentContentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDocumentContentCommandOutput) => void): void;
78
92
  /**
79
93
  * @see {@link GetExecutionFlowSnapshotCommand}
80
94
  */
@@ -7,6 +7,7 @@ import { type HttpHandlerUserInput as __HttpHandlerUserInput } from "@smithy/cor
7
7
  import { type RetryInputConfig, type RetryResolvedConfig } from "@smithy/core/retry";
8
8
  import type { AwsCredentialIdentityProvider, BodyLengthCalculator as __BodyLengthCalculator, CheckOptionalClientConfig as __CheckOptionalClientConfig, ChecksumConstructor as __ChecksumConstructor, Decoder as __Decoder, Encoder as __Encoder, EventStreamSerdeProvider as __EventStreamSerdeProvider, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@smithy/types";
9
9
  import { type HttpAuthSchemeInputConfig, type HttpAuthSchemeResolvedConfig } from "./auth/httpAuthSchemeProvider";
10
+ import type { AgenticRetrieveStreamCommandInput, AgenticRetrieveStreamCommandOutput } from "./commands/AgenticRetrieveStreamCommand";
10
11
  import type { CreateInvocationCommandInput, CreateInvocationCommandOutput } from "./commands/CreateInvocationCommand";
11
12
  import type { CreateSessionCommandInput, CreateSessionCommandOutput } from "./commands/CreateSessionCommand";
12
13
  import type { DeleteAgentMemoryCommandInput, DeleteAgentMemoryCommandOutput } from "./commands/DeleteAgentMemoryCommand";
@@ -14,6 +15,7 @@ import type { DeleteSessionCommandInput, DeleteSessionCommandOutput } from "./co
14
15
  import type { EndSessionCommandInput, EndSessionCommandOutput } from "./commands/EndSessionCommand";
15
16
  import type { GenerateQueryCommandInput, GenerateQueryCommandOutput } from "./commands/GenerateQueryCommand";
16
17
  import type { GetAgentMemoryCommandInput, GetAgentMemoryCommandOutput } from "./commands/GetAgentMemoryCommand";
18
+ import type { GetDocumentContentCommandInput, GetDocumentContentCommandOutput } from "./commands/GetDocumentContentCommand";
17
19
  import type { GetExecutionFlowSnapshotCommandInput, GetExecutionFlowSnapshotCommandOutput } from "./commands/GetExecutionFlowSnapshotCommand";
18
20
  import type { GetFlowExecutionCommandInput, GetFlowExecutionCommandOutput } from "./commands/GetFlowExecutionCommand";
19
21
  import type { GetInvocationStepCommandInput, GetInvocationStepCommandOutput } from "./commands/GetInvocationStepCommand";
@@ -44,11 +46,11 @@ export { __Client };
44
46
  /**
45
47
  * @public
46
48
  */
47
- export type ServiceInputTypes = CreateInvocationCommandInput | CreateSessionCommandInput | DeleteAgentMemoryCommandInput | DeleteSessionCommandInput | EndSessionCommandInput | GenerateQueryCommandInput | GetAgentMemoryCommandInput | GetExecutionFlowSnapshotCommandInput | GetFlowExecutionCommandInput | GetInvocationStepCommandInput | GetSessionCommandInput | InvokeAgentCommandInput | InvokeFlowCommandInput | InvokeInlineAgentCommandInput | ListFlowExecutionEventsCommandInput | ListFlowExecutionsCommandInput | ListInvocationStepsCommandInput | ListInvocationsCommandInput | ListSessionsCommandInput | ListTagsForResourceCommandInput | OptimizePromptCommandInput | PutInvocationStepCommandInput | RerankCommandInput | RetrieveAndGenerateCommandInput | RetrieveAndGenerateStreamCommandInput | RetrieveCommandInput | StartFlowExecutionCommandInput | StopFlowExecutionCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateSessionCommandInput;
49
+ export type ServiceInputTypes = AgenticRetrieveStreamCommandInput | CreateInvocationCommandInput | CreateSessionCommandInput | DeleteAgentMemoryCommandInput | DeleteSessionCommandInput | EndSessionCommandInput | GenerateQueryCommandInput | GetAgentMemoryCommandInput | GetDocumentContentCommandInput | GetExecutionFlowSnapshotCommandInput | GetFlowExecutionCommandInput | GetInvocationStepCommandInput | GetSessionCommandInput | InvokeAgentCommandInput | InvokeFlowCommandInput | InvokeInlineAgentCommandInput | ListFlowExecutionEventsCommandInput | ListFlowExecutionsCommandInput | ListInvocationStepsCommandInput | ListInvocationsCommandInput | ListSessionsCommandInput | ListTagsForResourceCommandInput | OptimizePromptCommandInput | PutInvocationStepCommandInput | RerankCommandInput | RetrieveAndGenerateCommandInput | RetrieveAndGenerateStreamCommandInput | RetrieveCommandInput | StartFlowExecutionCommandInput | StopFlowExecutionCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateSessionCommandInput;
48
50
  /**
49
51
  * @public
50
52
  */
51
- export type ServiceOutputTypes = CreateInvocationCommandOutput | CreateSessionCommandOutput | DeleteAgentMemoryCommandOutput | DeleteSessionCommandOutput | EndSessionCommandOutput | GenerateQueryCommandOutput | GetAgentMemoryCommandOutput | GetExecutionFlowSnapshotCommandOutput | GetFlowExecutionCommandOutput | GetInvocationStepCommandOutput | GetSessionCommandOutput | InvokeAgentCommandOutput | InvokeFlowCommandOutput | InvokeInlineAgentCommandOutput | ListFlowExecutionEventsCommandOutput | ListFlowExecutionsCommandOutput | ListInvocationStepsCommandOutput | ListInvocationsCommandOutput | ListSessionsCommandOutput | ListTagsForResourceCommandOutput | OptimizePromptCommandOutput | PutInvocationStepCommandOutput | RerankCommandOutput | RetrieveAndGenerateCommandOutput | RetrieveAndGenerateStreamCommandOutput | RetrieveCommandOutput | StartFlowExecutionCommandOutput | StopFlowExecutionCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateSessionCommandOutput;
53
+ export type ServiceOutputTypes = AgenticRetrieveStreamCommandOutput | CreateInvocationCommandOutput | CreateSessionCommandOutput | DeleteAgentMemoryCommandOutput | DeleteSessionCommandOutput | EndSessionCommandOutput | GenerateQueryCommandOutput | GetAgentMemoryCommandOutput | GetDocumentContentCommandOutput | GetExecutionFlowSnapshotCommandOutput | GetFlowExecutionCommandOutput | GetInvocationStepCommandOutput | GetSessionCommandOutput | InvokeAgentCommandOutput | InvokeFlowCommandOutput | InvokeInlineAgentCommandOutput | ListFlowExecutionEventsCommandOutput | ListFlowExecutionsCommandOutput | ListInvocationStepsCommandOutput | ListInvocationsCommandOutput | ListSessionsCommandOutput | ListTagsForResourceCommandOutput | OptimizePromptCommandOutput | PutInvocationStepCommandOutput | RerankCommandOutput | RetrieveAndGenerateCommandOutput | RetrieveAndGenerateStreamCommandOutput | RetrieveCommandOutput | StartFlowExecutionCommandOutput | StopFlowExecutionCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateSessionCommandOutput;
52
54
  /**
53
55
  * @public
54
56
  */
@@ -0,0 +1,338 @@
1
+ import { Command as $Command } from "@smithy/core/client";
2
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import type { BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentRuntimeClient";
4
+ import type { AgenticRetrieveStreamResponse } from "../models/models_0";
5
+ import type { AgenticRetrieveStreamRequest } from "../models/models_1";
6
+ /**
7
+ * @public
8
+ */
9
+ export type { __MetadataBearer };
10
+ export { $Command };
11
+ /**
12
+ * @public
13
+ *
14
+ * The input for {@link AgenticRetrieveStreamCommand}.
15
+ */
16
+ export interface AgenticRetrieveStreamCommandInput extends AgenticRetrieveStreamRequest {
17
+ }
18
+ /**
19
+ * @public
20
+ *
21
+ * The output of {@link AgenticRetrieveStreamCommand}.
22
+ */
23
+ export interface AgenticRetrieveStreamCommandOutput extends AgenticRetrieveStreamResponse, __MetadataBearer {
24
+ }
25
+ declare const AgenticRetrieveStreamCommand_base: {
26
+ new (input: AgenticRetrieveStreamCommandInput): import("@smithy/core/client").CommandImpl<AgenticRetrieveStreamCommandInput, AgenticRetrieveStreamCommandOutput, BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ new (input: AgenticRetrieveStreamCommandInput): import("@smithy/core/client").CommandImpl<AgenticRetrieveStreamCommandInput, AgenticRetrieveStreamCommandOutput, BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
28
+ getEndpointParameterInstructions(): {
29
+ [x: string]: unknown;
30
+ };
31
+ };
32
+ /**
33
+ * <p>Retrieves information from one or more knowledge bases using an agentic approach. Agentic retrieval uses a foundation model to intelligently decompose complex queries into sub-queries and iteratively retrieve relevant information from your knowledge bases. This approach improves retrieval accuracy for complex, multi-step questions that a single retrieval pass might not fully address.</p> <p>The operation returns results through a stream that includes retrieval results, trace events for visibility into the process, and a generated response synthesized from the results by default, which can be turned off.</p>
34
+ * @example
35
+ * Use a bare-bones client and the command you need to make an API call.
36
+ * ```javascript
37
+ * import { BedrockAgentRuntimeClient, AgenticRetrieveStreamCommand } from "@aws-sdk/client-bedrock-agent-runtime"; // ES Modules import
38
+ * // const { BedrockAgentRuntimeClient, AgenticRetrieveStreamCommand } = require("@aws-sdk/client-bedrock-agent-runtime"); // CommonJS import
39
+ * // import type { BedrockAgentRuntimeClientConfig } from "@aws-sdk/client-bedrock-agent-runtime";
40
+ * const config = {}; // type is BedrockAgentRuntimeClientConfig
41
+ * const client = new BedrockAgentRuntimeClient(config);
42
+ * const input = { // AgenticRetrieveStreamRequest
43
+ * messages: [ // AgenticRetrieveMessages // required
44
+ * { // AgenticRetrieveMessage
45
+ * content: { // AgenticRetrieveMessageContent
46
+ * text: "STRING_VALUE",
47
+ * },
48
+ * role: "user" || "assistant", // required
49
+ * },
50
+ * ],
51
+ * retrievers: [ // AgenticRetrievers // required
52
+ * { // AgenticRetriever
53
+ * description: "STRING_VALUE",
54
+ * configuration: { // RetrieverConfiguration Union: only one key present
55
+ * knowledgeBase: { // KnowledgeBaseRetrieverConfiguration
56
+ * knowledgeBaseId: "STRING_VALUE", // required
57
+ * retrievalOverrides: { // RetrievalOverrides
58
+ * filter: { // RetrievalFilter Union: only one key present
59
+ * equals: { // FilterAttribute
60
+ * key: "STRING_VALUE", // required
61
+ * value: "DOCUMENT_VALUE", // required
62
+ * },
63
+ * notEquals: {
64
+ * key: "STRING_VALUE", // required
65
+ * value: "DOCUMENT_VALUE", // required
66
+ * },
67
+ * greaterThan: {
68
+ * key: "STRING_VALUE", // required
69
+ * value: "DOCUMENT_VALUE", // required
70
+ * },
71
+ * greaterThanOrEquals: {
72
+ * key: "STRING_VALUE", // required
73
+ * value: "DOCUMENT_VALUE", // required
74
+ * },
75
+ * lessThan: {
76
+ * key: "STRING_VALUE", // required
77
+ * value: "DOCUMENT_VALUE", // required
78
+ * },
79
+ * lessThanOrEquals: "<FilterAttribute>",
80
+ * in: "<FilterAttribute>",
81
+ * notIn: "<FilterAttribute>",
82
+ * startsWith: "<FilterAttribute>",
83
+ * listContains: "<FilterAttribute>",
84
+ * stringContains: "<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
+ * listContains: "<FilterAttribute>",
97
+ * stringContains: "<FilterAttribute>",
98
+ * andAll: [
99
+ * "<RetrievalFilter>",
100
+ * ],
101
+ * orAll: [
102
+ * "<RetrievalFilter>",
103
+ * ],
104
+ * },
105
+ * ],
106
+ * orAll: [
107
+ * "<RetrievalFilter>",
108
+ * ],
109
+ * },
110
+ * maxNumberOfResults: Number("int"),
111
+ * },
112
+ * },
113
+ * },
114
+ * },
115
+ * ],
116
+ * agenticRetrieveConfiguration: { // AgenticRetrieveConfiguration
117
+ * foundationModelType: "CUSTOM" || "MANAGED",
118
+ * foundationModelConfiguration: { // FoundationModelConfiguration
119
+ * type: "BEDROCK_FOUNDATION_MODEL", // required
120
+ * bedrockFoundationModelConfiguration: { // BedrockFoundationModelConfiguration
121
+ * modelConfiguration: { // BedrockFoundationModelModelConfiguration
122
+ * modelArn: "STRING_VALUE", // required
123
+ * },
124
+ * },
125
+ * },
126
+ * rerankingModelType: "CUSTOM" || "MANAGED" || "NONE",
127
+ * rerankingConfiguration: { // AgenticRetrieveRerankingConfiguration
128
+ * type: "BEDROCK_RERANKING_MODEL", // required
129
+ * bedrockRerankingConfiguration: { // AgenticRetrieveBedrockRerankingConfiguration
130
+ * modelConfiguration: { // AgenticRetrieveBedrockRerankingModelConfiguration
131
+ * modelArn: "STRING_VALUE", // required
132
+ * },
133
+ * },
134
+ * },
135
+ * maxAgentIteration: Number("int"),
136
+ * },
137
+ * policyConfiguration: { // AgenticRetrievePolicyConfiguration
138
+ * bedrockGuardrailConfiguration: { // AgenticRetrieveBedrockGuardrailConfiguration
139
+ * guardrailId: "STRING_VALUE", // required
140
+ * guardrailVersion: "STRING_VALUE", // required
141
+ * },
142
+ * },
143
+ * nextToken: "STRING_VALUE",
144
+ * userContext: { // UserContext
145
+ * userId: "STRING_VALUE", // required
146
+ * },
147
+ * generateResponse: true || false,
148
+ * };
149
+ * const command = new AgenticRetrieveStreamCommand(input);
150
+ * const response = await client.send(command);
151
+ * // { // AgenticRetrieveStreamResponse
152
+ * // stream: { // AgenticRetrieveStreamResponseOutput Union: only one key present
153
+ * // result: { // AgenticRetrieveResultEvent
154
+ * // results: [ // AgenticRetrieveResults // required
155
+ * // { // AgenticRetrieveResultItem
156
+ * // content: { // RetrievalContent
157
+ * // byteContent: new Uint8Array(),
158
+ * // text: "STRING_VALUE",
159
+ * // mimeType: "STRING_VALUE", // required
160
+ * // },
161
+ * // metadata: { // AgenticRetrieveMetadata
162
+ * // "<keys>": "DOCUMENT_VALUE",
163
+ * // },
164
+ * // sourceRetriever: { // AgenticRetrieveSourceRetriever
165
+ * // identifier: "STRING_VALUE", // required
166
+ * // },
167
+ * // },
168
+ * // ],
169
+ * // generatedResponse: { // AgenticRetrieveGeneratedResponse
170
+ * // answer: "STRING_VALUE", // required
171
+ * // citations: [ // AgenticRetrieveCitationList
172
+ * // { // AgenticRetrieveCitation
173
+ * // startIndex: Number("int"), // required
174
+ * // endIndex: Number("int"), // required
175
+ * // references: [ // AgenticRetrieveCitationReferenceList // required
176
+ * // { // AgenticRetrieveCitationReference
177
+ * // resultIndex: Number("int"), // required
178
+ * // },
179
+ * // ],
180
+ * // },
181
+ * // ],
182
+ * // },
183
+ * // nextToken: "STRING_VALUE",
184
+ * // },
185
+ * // traceEvent: { // AgenticRetrieveTraceEvent
186
+ * // id: "STRING_VALUE", // required
187
+ * // timestamp: Number("long"), // required
188
+ * // attributes: { // AgenticRetrieveTraceEventAttributes
189
+ * // step: "Planning" || "Retrieval" || "SpeculativeRetrieval" || "FullDocumentExpansion", // required
190
+ * // status: "IN_PROGRESS" || "SUCCEEDED" || "FAILED", // required
191
+ * // message: "STRING_VALUE", // required
192
+ * // actions: [ // AgenticRetrieveActions
193
+ * // { // AgenticRetrieveAction
194
+ * // retrieve: { // AgenticRetrieveActionDetails
195
+ * // inputQuery: { // AgenticRetrieveMessageContent
196
+ * // text: "STRING_VALUE",
197
+ * // },
198
+ * // sourceRetrievers: [ // AgenticRetrieveSourceRetrieverList // required
199
+ * // {
200
+ * // identifier: "STRING_VALUE", // required
201
+ * // },
202
+ * // ],
203
+ * // },
204
+ * // fullDocumentExpansion: { // AgenticRetrieveFullDocExpansionDetails
205
+ * // documentId: "STRING_VALUE",
206
+ * // sourceRetriever: "<AgenticRetrieveSourceRetriever>",
207
+ * // },
208
+ * // },
209
+ * // ],
210
+ * // warnings: [ // AgenticRetrieveWarnings
211
+ * // { // AgenticRetrieveWarning Union: only one key present
212
+ * // message: { // AgenticRetrieveWarningMessage
213
+ * // message: "STRING_VALUE", // required
214
+ * // },
215
+ * // guardrail: { // AgenticRetrieveGuardrailWarning
216
+ * // id: "STRING_VALUE", // required
217
+ * // version: "STRING_VALUE", // required
218
+ * // action: "INTERVENED" || "NONE", // required
219
+ * // message: "STRING_VALUE",
220
+ * // },
221
+ * // },
222
+ * // ],
223
+ * // failures: [ // AgenticRetrieveFailures
224
+ * // { // AgenticRetrieveFailure
225
+ * // message: "STRING_VALUE", // required
226
+ * // },
227
+ * // ],
228
+ * // retrievalMetadata: [ // AgenticRetrieveSourceMetadataList
229
+ * // { // AgenticRetrieveSourceMetadata
230
+ * // identifier: "STRING_VALUE",
231
+ * // retrievalType: "BedrockKnowledgeBase",
232
+ * // },
233
+ * // ],
234
+ * // retrievalResponse: [ // AgenticRetrieveTraceResults
235
+ * // { // AgenticRetrieveTraceResultItem
236
+ * // content: {
237
+ * // byteContent: new Uint8Array(),
238
+ * // text: "STRING_VALUE",
239
+ * // mimeType: "STRING_VALUE", // required
240
+ * // },
241
+ * // metadata: {
242
+ * // "<keys>": "DOCUMENT_VALUE",
243
+ * // },
244
+ * // sourceRetriever: "<AgenticRetrieveSourceRetriever>",
245
+ * // },
246
+ * // ],
247
+ * // },
248
+ * // },
249
+ * // responseEvent: { // AgenticRetrieveResponseEvent
250
+ * // text: "STRING_VALUE", // required
251
+ * // },
252
+ * // internalServerException: { // InternalServerException
253
+ * // message: "STRING_VALUE",
254
+ * // reason: "STRING_VALUE",
255
+ * // },
256
+ * // validationException: { // ValidationException
257
+ * // message: "STRING_VALUE",
258
+ * // },
259
+ * // resourceNotFoundException: { // ResourceNotFoundException
260
+ * // message: "STRING_VALUE",
261
+ * // },
262
+ * // serviceQuotaExceededException: { // ServiceQuotaExceededException
263
+ * // message: "STRING_VALUE",
264
+ * // },
265
+ * // throttlingException: { // ThrottlingException
266
+ * // message: "STRING_VALUE",
267
+ * // },
268
+ * // accessDeniedException: { // AccessDeniedException
269
+ * // message: "STRING_VALUE",
270
+ * // },
271
+ * // conflictException: { // ConflictException
272
+ * // message: "STRING_VALUE",
273
+ * // },
274
+ * // dependencyFailedException: { // DependencyFailedException
275
+ * // message: "STRING_VALUE",
276
+ * // resourceName: "STRING_VALUE",
277
+ * // },
278
+ * // badGatewayException: { // BadGatewayException
279
+ * // message: "STRING_VALUE",
280
+ * // resourceName: "STRING_VALUE",
281
+ * // },
282
+ * // },
283
+ * // };
284
+ *
285
+ * ```
286
+ *
287
+ * @param AgenticRetrieveStreamCommandInput - {@link AgenticRetrieveStreamCommandInput}
288
+ * @returns {@link AgenticRetrieveStreamCommandOutput}
289
+ * @see {@link AgenticRetrieveStreamCommandInput} for command's `input` shape.
290
+ * @see {@link AgenticRetrieveStreamCommandOutput} for command's `response` shape.
291
+ * @see {@link BedrockAgentRuntimeClientResolvedConfig | config} for BedrockAgentRuntimeClient's `config` shape.
292
+ *
293
+ * @throws {@link AccessDeniedException} (client fault)
294
+ * <p>The request is denied because of missing access permissions. Check your permissions and retry your request.</p>
295
+ *
296
+ * @throws {@link BadGatewayException} (server fault)
297
+ * <p>There was an issue with a dependency due to a server issue. Retry your request.</p>
298
+ *
299
+ * @throws {@link ConflictException} (client fault)
300
+ * <p>There was a conflict performing an operation. Resolve the conflict and retry your request.</p>
301
+ *
302
+ * @throws {@link DependencyFailedException} (client fault)
303
+ * <p>There was an issue with a dependency. Check the resource configurations and retry the request.</p>
304
+ *
305
+ * @throws {@link InternalServerException} (server fault)
306
+ * <p>An internal server error occurred. Retry your request.</p>
307
+ *
308
+ * @throws {@link ResourceNotFoundException} (client fault)
309
+ * <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
310
+ *
311
+ * @throws {@link ServiceQuotaExceededException} (client fault)
312
+ * <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
313
+ *
314
+ * @throws {@link ThrottlingException} (client fault)
315
+ * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
316
+ *
317
+ * @throws {@link ValidationException} (client fault)
318
+ * <p>Input validation failed. Check your request parameters and retry the request.</p>
319
+ *
320
+ * @throws {@link BedrockAgentRuntimeServiceException}
321
+ * <p>Base exception class for all service exceptions from BedrockAgentRuntime service.</p>
322
+ *
323
+ *
324
+ * @public
325
+ */
326
+ export declare class AgenticRetrieveStreamCommand extends AgenticRetrieveStreamCommand_base {
327
+ /** @internal type navigation helper, not in runtime. */
328
+ protected static __types: {
329
+ api: {
330
+ input: AgenticRetrieveStreamRequest;
331
+ output: AgenticRetrieveStreamResponse;
332
+ };
333
+ sdk: {
334
+ input: AgenticRetrieveStreamCommandInput;
335
+ output: AgenticRetrieveStreamCommandOutput;
336
+ };
337
+ };
338
+ }
@@ -0,0 +1,99 @@
1
+ import { Command as $Command } from "@smithy/core/client";
2
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import type { BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentRuntimeClient";
4
+ import type { GetDocumentContentRequest, GetDocumentContentResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetDocumentContentCommand}.
14
+ */
15
+ export interface GetDocumentContentCommandInput extends GetDocumentContentRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetDocumentContentCommand}.
21
+ */
22
+ export interface GetDocumentContentCommandOutput extends GetDocumentContentResponse, __MetadataBearer {
23
+ }
24
+ declare const GetDocumentContentCommand_base: {
25
+ new (input: GetDocumentContentCommandInput): import("@smithy/core/client").CommandImpl<GetDocumentContentCommandInput, GetDocumentContentCommandOutput, BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: GetDocumentContentCommandInput): import("@smithy/core/client").CommandImpl<GetDocumentContentCommandInput, GetDocumentContentCommandOutput, BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): {
28
+ [x: string]: unknown;
29
+ };
30
+ };
31
+ /**
32
+ * <p>Retrieves the content of an ingested document from a knowledge base. Returns a pre-signed URL for secure document access.</p>
33
+ * @example
34
+ * Use a bare-bones client and the command you need to make an API call.
35
+ * ```javascript
36
+ * import { BedrockAgentRuntimeClient, GetDocumentContentCommand } from "@aws-sdk/client-bedrock-agent-runtime"; // ES Modules import
37
+ * // const { BedrockAgentRuntimeClient, GetDocumentContentCommand } = require("@aws-sdk/client-bedrock-agent-runtime"); // CommonJS import
38
+ * // import type { BedrockAgentRuntimeClientConfig } from "@aws-sdk/client-bedrock-agent-runtime";
39
+ * const config = {}; // type is BedrockAgentRuntimeClientConfig
40
+ * const client = new BedrockAgentRuntimeClient(config);
41
+ * const input = { // GetDocumentContentRequest
42
+ * knowledgeBaseId: "STRING_VALUE", // required
43
+ * dataSourceId: "STRING_VALUE", // required
44
+ * documentId: "STRING_VALUE", // required
45
+ * outputFormat: "RAW" || "EXTRACTED",
46
+ * userContext: { // UserContext
47
+ * userId: "STRING_VALUE", // required
48
+ * },
49
+ * };
50
+ * const command = new GetDocumentContentCommand(input);
51
+ * const response = await client.send(command);
52
+ * // { // GetDocumentContentResponse
53
+ * // mimeType: "STRING_VALUE", // required
54
+ * // presignedUrl: "STRING_VALUE", // required
55
+ * // documentContentLength: Number("long"),
56
+ * // };
57
+ *
58
+ * ```
59
+ *
60
+ * @param GetDocumentContentCommandInput - {@link GetDocumentContentCommandInput}
61
+ * @returns {@link GetDocumentContentCommandOutput}
62
+ * @see {@link GetDocumentContentCommandInput} for command's `input` shape.
63
+ * @see {@link GetDocumentContentCommandOutput} for command's `response` shape.
64
+ * @see {@link BedrockAgentRuntimeClientResolvedConfig | config} for BedrockAgentRuntimeClient's `config` shape.
65
+ *
66
+ * @throws {@link AccessDeniedException} (client fault)
67
+ * <p>The request is denied because of missing access permissions. Check your permissions and retry your request.</p>
68
+ *
69
+ * @throws {@link InternalServerException} (server fault)
70
+ * <p>An internal server error occurred. Retry your request.</p>
71
+ *
72
+ * @throws {@link ResourceNotFoundException} (client fault)
73
+ * <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
74
+ *
75
+ * @throws {@link ThrottlingException} (client fault)
76
+ * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
77
+ *
78
+ * @throws {@link ValidationException} (client fault)
79
+ * <p>Input validation failed. Check your request parameters and retry the request.</p>
80
+ *
81
+ * @throws {@link BedrockAgentRuntimeServiceException}
82
+ * <p>Base exception class for all service exceptions from BedrockAgentRuntime service.</p>
83
+ *
84
+ *
85
+ * @public
86
+ */
87
+ export declare class GetDocumentContentCommand extends GetDocumentContentCommand_base {
88
+ /** @internal type navigation helper, not in runtime. */
89
+ protected static __types: {
90
+ api: {
91
+ input: GetDocumentContentRequest;
92
+ output: GetDocumentContentResponse;
93
+ };
94
+ sdk: {
95
+ input: GetDocumentContentCommandInput;
96
+ output: GetDocumentContentCommandOutput;
97
+ };
98
+ };
99
+ }
@@ -1,7 +1,7 @@
1
1
  import { Command as $Command } from "@smithy/core/client";
2
2
  import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
3
  import type { BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentRuntimeClient";
4
- import type { GetInvocationStepRequest, GetInvocationStepResponse } from "../models/models_0";
4
+ import type { GetInvocationStepRequest, GetInvocationStepResponse } from "../models/models_1";
5
5
  /**
6
6
  * @public
7
7
  */
@@ -1,7 +1,8 @@
1
1
  import { Command as $Command } from "@smithy/core/client";
2
2
  import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
3
  import type { BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentRuntimeClient";
4
- import type { InvokeAgentRequest, InvokeAgentResponse } from "../models/models_0";
4
+ import type { InvokeAgentResponse } from "../models/models_0";
5
+ import type { InvokeAgentRequest } from "../models/models_1";
5
6
  /**
6
7
  * @public
7
8
  */
@@ -206,6 +207,38 @@ declare const InvokeAgentCommand_base: {
206
207
  * modelArn: "STRING_VALUE", // required
207
208
  * },
208
209
  * },
210
+ * managedSearchConfiguration: { // ManagedSearchConfiguration
211
+ * numberOfResults: Number("int"),
212
+ * filter: "<RetrievalFilter>",
213
+ * rerankingModelType: "CUSTOM" || "MANAGED" || "NONE",
214
+ * rerankingConfiguration: { // ManagedSearchRerankingConfiguration
215
+ * type: "BEDROCK_RERANKING_MODEL", // required
216
+ * bedrockRerankingConfiguration: { // ManagedSearchBedrockRerankingConfiguration
217
+ * modelConfiguration: { // ManagedSearchBedrockRerankingModelConfiguration
218
+ * modelArn: "STRING_VALUE", // required
219
+ * additionalModelRequestFields: {
220
+ * "<keys>": "DOCUMENT_VALUE",
221
+ * },
222
+ * },
223
+ * numberOfRerankedResults: Number("int"),
224
+ * metadataConfiguration: {
225
+ * selectionMode: "SELECTIVE" || "ALL", // required
226
+ * selectiveModeConfiguration: {// Union: only one key present
227
+ * fieldsToInclude: [
228
+ * {
229
+ * fieldName: "STRING_VALUE", // required
230
+ * },
231
+ * ],
232
+ * fieldsToExclude: [
233
+ * {
234
+ * fieldName: "STRING_VALUE", // required
235
+ * },
236
+ * ],
237
+ * },
238
+ * },
239
+ * },
240
+ * },
241
+ * },
209
242
  * },
210
243
  * },
211
244
  * ],
@@ -285,7 +318,7 @@ declare const InvokeAgentCommand_base: {
285
318
  * // ],
286
319
  * // },
287
320
  * // location: { // RetrievalResultLocation
288
- * // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM" || "KENDRA" || "SQL", // required
321
+ * // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM" || "KENDRA" || "SQL" || "ONEDRIVE" || "GOOGLEDRIVE", // required
289
322
  * // s3Location: { // RetrievalResultS3Location
290
323
  * // uri: "STRING_VALUE",
291
324
  * // },
@@ -310,6 +343,12 @@ declare const InvokeAgentCommand_base: {
310
343
  * // sqlLocation: { // RetrievalResultSqlLocation
311
344
  * // query: "STRING_VALUE",
312
345
  * // },
346
+ * // oneDriveLocation: { // RetrievalResultOneDriveLocation
347
+ * // url: "STRING_VALUE",
348
+ * // },
349
+ * // googleDriveLocation: { // RetrievalResultGoogleDriveLocation
350
+ * // url: "STRING_VALUE",
351
+ * // },
313
352
  * // },
314
353
  * // metadata: { // RetrievalResultMetadata
315
354
  * // "<keys>": "DOCUMENT_VALUE",
@@ -681,7 +720,7 @@ declare const InvokeAgentCommand_base: {
681
720
  * // ],
682
721
  * // },
683
722
  * // location: {
684
- * // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM" || "KENDRA" || "SQL", // required
723
+ * // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM" || "KENDRA" || "SQL" || "ONEDRIVE" || "GOOGLEDRIVE", // required
685
724
  * // s3Location: {
686
725
  * // uri: "STRING_VALUE",
687
726
  * // },
@@ -706,6 +745,12 @@ declare const InvokeAgentCommand_base: {
706
745
  * // sqlLocation: {
707
746
  * // query: "STRING_VALUE",
708
747
  * // },
748
+ * // oneDriveLocation: {
749
+ * // url: "STRING_VALUE",
750
+ * // },
751
+ * // googleDriveLocation: {
752
+ * // url: "STRING_VALUE",
753
+ * // },
709
754
  * // },
710
755
  * // metadata: {
711
756
  * // "<keys>": "DOCUMENT_VALUE",
@@ -977,7 +1022,7 @@ declare const InvokeAgentCommand_base: {
977
1022
  * // ],
978
1023
  * // },
979
1024
  * // location: {
980
- * // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM" || "KENDRA" || "SQL", // required
1025
+ * // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM" || "KENDRA" || "SQL" || "ONEDRIVE" || "GOOGLEDRIVE", // required
981
1026
  * // s3Location: {
982
1027
  * // uri: "STRING_VALUE",
983
1028
  * // },
@@ -1002,6 +1047,12 @@ declare const InvokeAgentCommand_base: {
1002
1047
  * // sqlLocation: {
1003
1048
  * // query: "STRING_VALUE",
1004
1049
  * // },
1050
+ * // oneDriveLocation: {
1051
+ * // url: "STRING_VALUE",
1052
+ * // },
1053
+ * // googleDriveLocation: {
1054
+ * // url: "STRING_VALUE",
1055
+ * // },
1005
1056
  * // },
1006
1057
  * // metadata: {
1007
1058
  * // "<keys>": "DOCUMENT_VALUE",