@aws-sdk/client-bedrock-agent-runtime 3.1111.0 → 3.1112.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.
@@ -1,18 +1,35 @@
1
+ import { DocumentType as __DocumentType } from "@smithy/types";
1
2
  import {
2
3
  AgentCollaboration,
4
+ GuadrailAction,
3
5
  ImageFormat,
6
+ InputImageFormat,
7
+ KnowledgeBaseQueryType,
4
8
  OrchestrationType,
5
9
  RerankingModelType,
6
10
  RetrieveAndGenerateType,
7
11
  SearchType,
8
12
  SessionStatus,
9
13
  } from "./enums";
14
+ import {
15
+ AccessDeniedException,
16
+ BadGatewayException,
17
+ ConflictException,
18
+ DependencyFailedException,
19
+ InternalServerException,
20
+ ResourceNotFoundException,
21
+ ServiceQuotaExceededException,
22
+ ThrottlingException,
23
+ ValidationException,
24
+ } from "./errors";
10
25
  import {
11
26
  AgentActionGroup,
12
27
  AgenticRetrieveConfiguration,
28
+ AgenticRetrieveMemoryConfiguration,
13
29
  AgenticRetrieveMessage,
14
30
  AgenticRetrievePolicyConfiguration,
15
31
  BedrockModelConfigurations,
32
+ CitationEvent,
16
33
  CollaboratorConfiguration,
17
34
  ConversationHistory,
18
35
  CustomOrchestration,
@@ -21,22 +38,283 @@ import {
21
38
  GenerationConfiguration,
22
39
  GuardrailConfiguration,
23
40
  GuardrailConfigurationWithArn,
41
+ GuardrailEvent,
24
42
  ImplicitFilterConfiguration,
25
43
  InlineBedrockModelConfigurations,
26
44
  InlineSessionState,
27
45
  InputFile,
28
46
  InvocationResultMember,
29
- KnowledgeBaseQuery,
30
47
  ManagedSearchRerankingConfiguration,
31
48
  OrchestrationConfiguration,
32
49
  PromptCreationConfigurations,
33
50
  PromptOverrideConfiguration,
51
+ RetrievalResultContent,
52
+ RetrievalResultLocation,
34
53
  RetrieveAndGenerateInput,
35
54
  RetrieveAndGenerateSessionConfiguration,
36
55
  StreamingConfigurations,
37
56
  UserContext,
38
57
  VectorSearchRerankingConfiguration,
39
58
  } from "./models_0";
59
+ export interface RetrieveAndGenerateOutputEvent {
60
+ text: string | undefined;
61
+ }
62
+ export type RetrieveAndGenerateStreamResponseOutput =
63
+ | RetrieveAndGenerateStreamResponseOutput.AccessDeniedExceptionMember
64
+ | RetrieveAndGenerateStreamResponseOutput.BadGatewayExceptionMember
65
+ | RetrieveAndGenerateStreamResponseOutput.CitationMember
66
+ | RetrieveAndGenerateStreamResponseOutput.ConflictExceptionMember
67
+ | RetrieveAndGenerateStreamResponseOutput.DependencyFailedExceptionMember
68
+ | RetrieveAndGenerateStreamResponseOutput.GuardrailMember
69
+ | RetrieveAndGenerateStreamResponseOutput.InternalServerExceptionMember
70
+ | RetrieveAndGenerateStreamResponseOutput.OutputMember
71
+ | RetrieveAndGenerateStreamResponseOutput.ResourceNotFoundExceptionMember
72
+ | RetrieveAndGenerateStreamResponseOutput.ServiceQuotaExceededExceptionMember
73
+ | RetrieveAndGenerateStreamResponseOutput.ThrottlingExceptionMember
74
+ | RetrieveAndGenerateStreamResponseOutput.ValidationExceptionMember
75
+ | RetrieveAndGenerateStreamResponseOutput.$UnknownMember;
76
+ export declare namespace RetrieveAndGenerateStreamResponseOutput {
77
+ interface OutputMember {
78
+ output: RetrieveAndGenerateOutputEvent;
79
+ citation?: never;
80
+ guardrail?: never;
81
+ internalServerException?: never;
82
+ validationException?: never;
83
+ resourceNotFoundException?: never;
84
+ serviceQuotaExceededException?: never;
85
+ throttlingException?: never;
86
+ accessDeniedException?: never;
87
+ conflictException?: never;
88
+ dependencyFailedException?: never;
89
+ badGatewayException?: never;
90
+ $unknown?: never;
91
+ }
92
+ interface CitationMember {
93
+ output?: never;
94
+ citation: CitationEvent;
95
+ guardrail?: never;
96
+ internalServerException?: never;
97
+ validationException?: never;
98
+ resourceNotFoundException?: never;
99
+ serviceQuotaExceededException?: never;
100
+ throttlingException?: never;
101
+ accessDeniedException?: never;
102
+ conflictException?: never;
103
+ dependencyFailedException?: never;
104
+ badGatewayException?: never;
105
+ $unknown?: never;
106
+ }
107
+ interface GuardrailMember {
108
+ output?: never;
109
+ citation?: never;
110
+ guardrail: GuardrailEvent;
111
+ internalServerException?: never;
112
+ validationException?: never;
113
+ resourceNotFoundException?: never;
114
+ serviceQuotaExceededException?: never;
115
+ throttlingException?: never;
116
+ accessDeniedException?: never;
117
+ conflictException?: never;
118
+ dependencyFailedException?: never;
119
+ badGatewayException?: never;
120
+ $unknown?: never;
121
+ }
122
+ interface InternalServerExceptionMember {
123
+ output?: never;
124
+ citation?: never;
125
+ guardrail?: never;
126
+ internalServerException: InternalServerException;
127
+ validationException?: never;
128
+ resourceNotFoundException?: never;
129
+ serviceQuotaExceededException?: never;
130
+ throttlingException?: never;
131
+ accessDeniedException?: never;
132
+ conflictException?: never;
133
+ dependencyFailedException?: never;
134
+ badGatewayException?: never;
135
+ $unknown?: never;
136
+ }
137
+ interface ValidationExceptionMember {
138
+ output?: never;
139
+ citation?: never;
140
+ guardrail?: never;
141
+ internalServerException?: never;
142
+ validationException: ValidationException;
143
+ resourceNotFoundException?: never;
144
+ serviceQuotaExceededException?: never;
145
+ throttlingException?: never;
146
+ accessDeniedException?: never;
147
+ conflictException?: never;
148
+ dependencyFailedException?: never;
149
+ badGatewayException?: never;
150
+ $unknown?: never;
151
+ }
152
+ interface ResourceNotFoundExceptionMember {
153
+ output?: never;
154
+ citation?: never;
155
+ guardrail?: never;
156
+ internalServerException?: never;
157
+ validationException?: never;
158
+ resourceNotFoundException: ResourceNotFoundException;
159
+ serviceQuotaExceededException?: never;
160
+ throttlingException?: never;
161
+ accessDeniedException?: never;
162
+ conflictException?: never;
163
+ dependencyFailedException?: never;
164
+ badGatewayException?: never;
165
+ $unknown?: never;
166
+ }
167
+ interface ServiceQuotaExceededExceptionMember {
168
+ output?: never;
169
+ citation?: never;
170
+ guardrail?: never;
171
+ internalServerException?: never;
172
+ validationException?: never;
173
+ resourceNotFoundException?: never;
174
+ serviceQuotaExceededException: ServiceQuotaExceededException;
175
+ throttlingException?: never;
176
+ accessDeniedException?: never;
177
+ conflictException?: never;
178
+ dependencyFailedException?: never;
179
+ badGatewayException?: never;
180
+ $unknown?: never;
181
+ }
182
+ interface ThrottlingExceptionMember {
183
+ output?: never;
184
+ citation?: never;
185
+ guardrail?: never;
186
+ internalServerException?: never;
187
+ validationException?: never;
188
+ resourceNotFoundException?: never;
189
+ serviceQuotaExceededException?: never;
190
+ throttlingException: ThrottlingException;
191
+ accessDeniedException?: never;
192
+ conflictException?: never;
193
+ dependencyFailedException?: never;
194
+ badGatewayException?: never;
195
+ $unknown?: never;
196
+ }
197
+ interface AccessDeniedExceptionMember {
198
+ output?: never;
199
+ citation?: never;
200
+ guardrail?: never;
201
+ internalServerException?: never;
202
+ validationException?: never;
203
+ resourceNotFoundException?: never;
204
+ serviceQuotaExceededException?: never;
205
+ throttlingException?: never;
206
+ accessDeniedException: AccessDeniedException;
207
+ conflictException?: never;
208
+ dependencyFailedException?: never;
209
+ badGatewayException?: never;
210
+ $unknown?: never;
211
+ }
212
+ interface ConflictExceptionMember {
213
+ output?: never;
214
+ citation?: never;
215
+ guardrail?: never;
216
+ internalServerException?: never;
217
+ validationException?: never;
218
+ resourceNotFoundException?: never;
219
+ serviceQuotaExceededException?: never;
220
+ throttlingException?: never;
221
+ accessDeniedException?: never;
222
+ conflictException: ConflictException;
223
+ dependencyFailedException?: never;
224
+ badGatewayException?: never;
225
+ $unknown?: never;
226
+ }
227
+ interface DependencyFailedExceptionMember {
228
+ output?: never;
229
+ citation?: never;
230
+ guardrail?: never;
231
+ internalServerException?: never;
232
+ validationException?: never;
233
+ resourceNotFoundException?: never;
234
+ serviceQuotaExceededException?: never;
235
+ throttlingException?: never;
236
+ accessDeniedException?: never;
237
+ conflictException?: never;
238
+ dependencyFailedException: DependencyFailedException;
239
+ badGatewayException?: never;
240
+ $unknown?: never;
241
+ }
242
+ interface BadGatewayExceptionMember {
243
+ output?: never;
244
+ citation?: never;
245
+ guardrail?: never;
246
+ internalServerException?: never;
247
+ validationException?: never;
248
+ resourceNotFoundException?: never;
249
+ serviceQuotaExceededException?: never;
250
+ throttlingException?: never;
251
+ accessDeniedException?: never;
252
+ conflictException?: never;
253
+ dependencyFailedException?: never;
254
+ badGatewayException: BadGatewayException;
255
+ $unknown?: never;
256
+ }
257
+ interface $UnknownMember {
258
+ output?: never;
259
+ citation?: never;
260
+ guardrail?: never;
261
+ internalServerException?: never;
262
+ validationException?: never;
263
+ resourceNotFoundException?: never;
264
+ serviceQuotaExceededException?: never;
265
+ throttlingException?: never;
266
+ accessDeniedException?: never;
267
+ conflictException?: never;
268
+ dependencyFailedException?: never;
269
+ badGatewayException?: never;
270
+ $unknown: [string, any];
271
+ }
272
+ interface Visitor<T> {
273
+ output: (value: RetrieveAndGenerateOutputEvent) => T;
274
+ citation: (value: CitationEvent) => T;
275
+ guardrail: (value: GuardrailEvent) => T;
276
+ internalServerException: (value: InternalServerException) => T;
277
+ validationException: (value: ValidationException) => T;
278
+ resourceNotFoundException: (value: ResourceNotFoundException) => T;
279
+ serviceQuotaExceededException: (value: ServiceQuotaExceededException) => T;
280
+ throttlingException: (value: ThrottlingException) => T;
281
+ accessDeniedException: (value: AccessDeniedException) => T;
282
+ conflictException: (value: ConflictException) => T;
283
+ dependencyFailedException: (value: DependencyFailedException) => T;
284
+ badGatewayException: (value: BadGatewayException) => T;
285
+ _: (name: string, value: any) => T;
286
+ }
287
+ }
288
+ export interface RetrieveAndGenerateStreamResponse {
289
+ stream: AsyncIterable<RetrieveAndGenerateStreamResponseOutput> | undefined;
290
+ sessionId: string | undefined;
291
+ }
292
+ export interface InputImage {
293
+ format: InputImageFormat | undefined;
294
+ inlineContent: Uint8Array | undefined;
295
+ }
296
+ export interface KnowledgeBaseQuery {
297
+ type?: KnowledgeBaseQueryType | undefined;
298
+ text?: string | undefined;
299
+ image?: InputImage | undefined;
300
+ }
301
+ export interface KnowledgeBaseRetrievalResult {
302
+ content: RetrievalResultContent | undefined;
303
+ location?: RetrievalResultLocation | undefined;
304
+ score?: number | undefined;
305
+ metadata?: Record<string, __DocumentType> | undefined;
306
+ documentId?: string | undefined;
307
+ }
308
+ export interface RetrieveResponse {
309
+ retrievalResults: KnowledgeBaseRetrievalResult[] | undefined;
310
+ guardrailAction?: GuadrailAction | undefined;
311
+ nextToken?: string | undefined;
312
+ }
313
+ export interface CreateSessionRequest {
314
+ sessionMetadata?: Record<string, string> | undefined;
315
+ encryptionKeyArn?: string | undefined;
316
+ tags?: Record<string, string> | undefined;
317
+ }
40
318
  export interface CreateSessionResponse {
41
319
  sessionId: string | undefined;
42
320
  sessionArn: string | undefined;
@@ -556,6 +834,7 @@ export interface AgenticRetrieveStreamRequest {
556
834
  policyConfiguration?: AgenticRetrievePolicyConfiguration | undefined;
557
835
  nextToken?: string | undefined;
558
836
  userContext?: UserContext | undefined;
837
+ memoryConfiguration?: AgenticRetrieveMemoryConfiguration | undefined;
559
838
  generateResponse?: boolean | undefined;
560
839
  }
561
840
  export interface KnowledgeBaseRetrievalConfiguration {
@@ -36,6 +36,11 @@ export declare var AgenticRetrieveFailure$: StaticStructureSchema;
36
36
  export declare var AgenticRetrieveFullDocExpansionDetails$: StaticStructureSchema;
37
37
  export declare var AgenticRetrieveGeneratedResponse$: StaticStructureSchema;
38
38
  export declare var AgenticRetrieveGuardrailWarning$: StaticStructureSchema;
39
+ export declare var AgenticRetrieveMemoryConfiguration$: StaticStructureSchema;
40
+ export declare var AgenticRetrieveMemoryMetadataFilter$: StaticStructureSchema;
41
+ export declare var AgenticRetrieveMemoryRetrievalConfig$: StaticStructureSchema;
42
+ export declare var AgenticRetrieveMemoryRetrieveDetails$: StaticStructureSchema;
43
+ export declare var AgenticRetrieveMemorySessionBinding$: StaticStructureSchema;
39
44
  export declare var AgenticRetrieveMessage$: StaticStructureSchema;
40
45
  export declare var AgenticRetrieveMessageContent$: StaticStructureSchema;
41
46
  export declare var AgenticRetrievePolicyConfiguration$: StaticStructureSchema;
@@ -332,6 +337,9 @@ export declare var VectorSearchBedrockRerankingModelConfiguration$: StaticStruct
332
337
  export declare var VectorSearchRerankingConfiguration$: StaticStructureSchema;
333
338
  export declare var VideoSegment$: StaticStructureSchema;
334
339
  export declare var ActionGroupExecutor$: StaticUnionSchema;
340
+ export declare var AgenticRetrieveMemoryMetadataFilterLeft$: StaticUnionSchema;
341
+ export declare var AgenticRetrieveMemoryMetadataFilterRight$: StaticUnionSchema;
342
+ export declare var AgenticRetrieveMemoryMetadataValue$: StaticUnionSchema;
335
343
  export declare var AgenticRetrieveStreamResponseOutput$: StaticUnionSchema;
336
344
  export declare var AgenticRetrieveWarning$: StaticUnionSchema;
337
345
  export declare var APISchema$: StaticUnionSchema;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-bedrock-agent-runtime",
3
- "version": "3.1111.0",
3
+ "version": "3.1112.0",
4
4
  "description": "AWS SDK for JavaScript Bedrock Agent Runtime Client for Node.js, Browser and React Native",
5
5
  "homepage": "https://github.com/aws/aws-sdk-js-v3/tree/main/clients/client-bedrock-agent-runtime",
6
6
  "license": "Apache-2.0",