@aws-sdk/client-bedrock-agent-runtime 3.1110.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.
Files changed (52) hide show
  1. package/README.md +15 -1
  2. package/dist-cjs/index.js +302 -85
  3. package/dist-es/BedrockAgentRuntime.js +4 -0
  4. package/dist-es/commands/CheckIngestedDocumentAclCommand.js +4 -0
  5. package/dist-es/commands/GetIngestedDocumentAclCommand.js +4 -0
  6. package/dist-es/commands/index.js +2 -0
  7. package/dist-es/models/enums.js +26 -0
  8. package/dist-es/schemas/schemas_0.js +243 -84
  9. package/dist-types/BedrockAgentRuntime.d.ts +15 -1
  10. package/dist-types/BedrockAgentRuntimeClient.d.ts +5 -3
  11. package/dist-types/commands/AgenticRetrieveStreamCommand.d.ts +44 -2
  12. package/dist-types/commands/CheckIngestedDocumentAclCommand.d.ts +91 -0
  13. package/dist-types/commands/CreateInvocationCommand.d.ts +1 -1
  14. package/dist-types/commands/CreateSessionCommand.d.ts +1 -1
  15. package/dist-types/commands/DeleteSessionCommand.d.ts +1 -1
  16. package/dist-types/commands/EndSessionCommand.d.ts +1 -1
  17. package/dist-types/commands/GetIngestedDocumentAclCommand.d.ts +129 -0
  18. package/dist-types/commands/GetSessionCommand.d.ts +1 -1
  19. package/dist-types/commands/InvokeAgentCommand.d.ts +1 -1
  20. package/dist-types/commands/RetrieveAndGenerateStreamCommand.d.ts +1 -2
  21. package/dist-types/commands/RetrieveCommand.d.ts +1 -2
  22. package/dist-types/commands/index.d.ts +2 -0
  23. package/dist-types/index.d.ts +1 -1
  24. package/dist-types/models/enums.d.ts +100 -0
  25. package/dist-types/models/models_0.d.ts +454 -607
  26. package/dist-types/models/models_1.d.ts +582 -6
  27. package/dist-types/runtimeConfig.browser.d.ts +39 -39
  28. package/dist-types/runtimeConfig.d.ts +36 -36
  29. package/dist-types/runtimeConfig.native.d.ts +38 -38
  30. package/dist-types/runtimeConfig.shared.d.ts +2 -2
  31. package/dist-types/schemas/schemas_0.d.ts +19 -0
  32. package/dist-types/ts3.4/BedrockAgentRuntime.d.ts +34 -0
  33. package/dist-types/ts3.4/BedrockAgentRuntimeClient.d.ts +12 -0
  34. package/dist-types/ts3.4/commands/CheckIngestedDocumentAclCommand.d.ts +42 -0
  35. package/dist-types/ts3.4/commands/CreateInvocationCommand.d.ts +1 -1
  36. package/dist-types/ts3.4/commands/CreateSessionCommand.d.ts +1 -1
  37. package/dist-types/ts3.4/commands/DeleteSessionCommand.d.ts +1 -1
  38. package/dist-types/ts3.4/commands/EndSessionCommand.d.ts +1 -1
  39. package/dist-types/ts3.4/commands/GetIngestedDocumentAclCommand.d.ts +39 -0
  40. package/dist-types/ts3.4/commands/GetSessionCommand.d.ts +1 -1
  41. package/dist-types/ts3.4/commands/RetrieveAndGenerateStreamCommand.d.ts +4 -2
  42. package/dist-types/ts3.4/commands/RetrieveCommand.d.ts +1 -2
  43. package/dist-types/ts3.4/commands/index.d.ts +2 -0
  44. package/dist-types/ts3.4/models/enums.d.ts +34 -0
  45. package/dist-types/ts3.4/models/models_0.d.ts +155 -302
  46. package/dist-types/ts3.4/models/models_1.d.ts +320 -1
  47. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +55 -57
  48. package/dist-types/ts3.4/runtimeConfig.d.ts +58 -58
  49. package/dist-types/ts3.4/runtimeConfig.native.d.ts +59 -61
  50. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +3 -3
  51. package/dist-types/ts3.4/schemas/schemas_0.d.ts +19 -0
  52. package/package.json +5 -5
@@ -1,5 +1,576 @@
1
- import type { AgentCollaboration, ImageFormat, OrchestrationType, RerankingModelType, RetrieveAndGenerateType, SearchType, SessionStatus } from "./enums";
2
- import type { AgentActionGroup, AgenticRetrieveConfiguration, AgenticRetrieveMessage, AgenticRetrievePolicyConfiguration, BedrockModelConfigurations, CollaboratorConfiguration, ConversationHistory, CustomOrchestration, ExternalSourcesRetrieveAndGenerateConfiguration, FilterAttribute, GenerationConfiguration, GuardrailConfiguration, GuardrailConfigurationWithArn, ImplicitFilterConfiguration, InlineBedrockModelConfigurations, InlineSessionState, InputFile, InvocationResultMember, KnowledgeBaseQuery, ManagedSearchRerankingConfiguration, OrchestrationConfiguration, PromptCreationConfigurations, PromptOverrideConfiguration, RetrieveAndGenerateInput, RetrieveAndGenerateSessionConfiguration, StreamingConfigurations, UserContext, VectorSearchRerankingConfiguration } from "./models_0";
1
+ import type { DocumentType as __DocumentType } from "@smithy/types";
2
+ import type { AgentCollaboration, GuadrailAction, ImageFormat, InputImageFormat, KnowledgeBaseQueryType, OrchestrationType, RerankingModelType, RetrieveAndGenerateType, SearchType, SessionStatus } from "./enums";
3
+ import type { AccessDeniedException, BadGatewayException, ConflictException, DependencyFailedException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, ThrottlingException, ValidationException } from "./errors";
4
+ import type { AgentActionGroup, AgenticRetrieveConfiguration, AgenticRetrieveMemoryConfiguration, AgenticRetrieveMessage, AgenticRetrievePolicyConfiguration, BedrockModelConfigurations, CitationEvent, CollaboratorConfiguration, ConversationHistory, CustomOrchestration, ExternalSourcesRetrieveAndGenerateConfiguration, FilterAttribute, GenerationConfiguration, GuardrailConfiguration, GuardrailConfigurationWithArn, GuardrailEvent, ImplicitFilterConfiguration, InlineBedrockModelConfigurations, InlineSessionState, InputFile, InvocationResultMember, ManagedSearchRerankingConfiguration, OrchestrationConfiguration, PromptCreationConfigurations, PromptOverrideConfiguration, RetrievalResultContent, RetrievalResultLocation, RetrieveAndGenerateInput, RetrieveAndGenerateSessionConfiguration, StreamingConfigurations, UserContext, VectorSearchRerankingConfiguration } from "./models_0";
5
+ /**
6
+ * <p>A retrieve and generate output event.</p>
7
+ * @public
8
+ */
9
+ export interface RetrieveAndGenerateOutputEvent {
10
+ /**
11
+ * <p>A text response.</p>
12
+ * @public
13
+ */
14
+ text: string | undefined;
15
+ }
16
+ /**
17
+ * <p>A retrieve and generate stream response output.</p>
18
+ * @public
19
+ */
20
+ export type RetrieveAndGenerateStreamResponseOutput = RetrieveAndGenerateStreamResponseOutput.AccessDeniedExceptionMember | RetrieveAndGenerateStreamResponseOutput.BadGatewayExceptionMember | RetrieveAndGenerateStreamResponseOutput.CitationMember | RetrieveAndGenerateStreamResponseOutput.ConflictExceptionMember | RetrieveAndGenerateStreamResponseOutput.DependencyFailedExceptionMember | RetrieveAndGenerateStreamResponseOutput.GuardrailMember | RetrieveAndGenerateStreamResponseOutput.InternalServerExceptionMember | RetrieveAndGenerateStreamResponseOutput.OutputMember | RetrieveAndGenerateStreamResponseOutput.ResourceNotFoundExceptionMember | RetrieveAndGenerateStreamResponseOutput.ServiceQuotaExceededExceptionMember | RetrieveAndGenerateStreamResponseOutput.ThrottlingExceptionMember | RetrieveAndGenerateStreamResponseOutput.ValidationExceptionMember | RetrieveAndGenerateStreamResponseOutput.$UnknownMember;
21
+ /**
22
+ * @public
23
+ */
24
+ export declare namespace RetrieveAndGenerateStreamResponseOutput {
25
+ /**
26
+ * <p>An output event.</p>
27
+ * @public
28
+ */
29
+ interface OutputMember {
30
+ output: RetrieveAndGenerateOutputEvent;
31
+ citation?: never;
32
+ guardrail?: never;
33
+ internalServerException?: never;
34
+ validationException?: never;
35
+ resourceNotFoundException?: never;
36
+ serviceQuotaExceededException?: never;
37
+ throttlingException?: never;
38
+ accessDeniedException?: never;
39
+ conflictException?: never;
40
+ dependencyFailedException?: never;
41
+ badGatewayException?: never;
42
+ $unknown?: never;
43
+ }
44
+ /**
45
+ * <p>A citation event.</p>
46
+ * @public
47
+ */
48
+ interface CitationMember {
49
+ output?: never;
50
+ citation: CitationEvent;
51
+ guardrail?: never;
52
+ internalServerException?: never;
53
+ validationException?: never;
54
+ resourceNotFoundException?: never;
55
+ serviceQuotaExceededException?: never;
56
+ throttlingException?: never;
57
+ accessDeniedException?: never;
58
+ conflictException?: never;
59
+ dependencyFailedException?: never;
60
+ badGatewayException?: never;
61
+ $unknown?: never;
62
+ }
63
+ /**
64
+ * <p>A guardrail event.</p>
65
+ * @public
66
+ */
67
+ interface GuardrailMember {
68
+ output?: never;
69
+ citation?: never;
70
+ guardrail: GuardrailEvent;
71
+ internalServerException?: never;
72
+ validationException?: never;
73
+ resourceNotFoundException?: never;
74
+ serviceQuotaExceededException?: never;
75
+ throttlingException?: never;
76
+ accessDeniedException?: never;
77
+ conflictException?: never;
78
+ dependencyFailedException?: never;
79
+ badGatewayException?: never;
80
+ $unknown?: never;
81
+ }
82
+ /**
83
+ * <p>An internal server error occurred. Retry your request.</p>
84
+ * @public
85
+ */
86
+ interface InternalServerExceptionMember {
87
+ output?: never;
88
+ citation?: never;
89
+ guardrail?: never;
90
+ internalServerException: InternalServerException;
91
+ validationException?: never;
92
+ resourceNotFoundException?: never;
93
+ serviceQuotaExceededException?: never;
94
+ throttlingException?: never;
95
+ accessDeniedException?: never;
96
+ conflictException?: never;
97
+ dependencyFailedException?: never;
98
+ badGatewayException?: never;
99
+ $unknown?: never;
100
+ }
101
+ /**
102
+ * <p>The input fails to satisfy the constraints specified by <i>Amazon Bedrock</i>. For troubleshooting this error, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-validation-error">ValidationError</a> in the Amazon Bedrock User Guide.</p>
103
+ * @public
104
+ */
105
+ interface ValidationExceptionMember {
106
+ output?: never;
107
+ citation?: never;
108
+ guardrail?: never;
109
+ internalServerException?: never;
110
+ validationException: ValidationException;
111
+ resourceNotFoundException?: never;
112
+ serviceQuotaExceededException?: never;
113
+ throttlingException?: never;
114
+ accessDeniedException?: never;
115
+ conflictException?: never;
116
+ dependencyFailedException?: never;
117
+ badGatewayException?: never;
118
+ $unknown?: never;
119
+ }
120
+ /**
121
+ * <p>The specified resource ARN was not found. For troubleshooting this error, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-resource-not-found">ResourceNotFound</a> in the Amazon Bedrock User Guide.</p>
122
+ * @public
123
+ */
124
+ interface ResourceNotFoundExceptionMember {
125
+ output?: never;
126
+ citation?: never;
127
+ guardrail?: never;
128
+ internalServerException?: never;
129
+ validationException?: never;
130
+ resourceNotFoundException: ResourceNotFoundException;
131
+ serviceQuotaExceededException?: never;
132
+ throttlingException?: never;
133
+ accessDeniedException?: never;
134
+ conflictException?: never;
135
+ dependencyFailedException?: never;
136
+ badGatewayException?: never;
137
+ $unknown?: never;
138
+ }
139
+ /**
140
+ * <p>Your request exceeds the service quota for your account. You can view your quotas at <a href="https://docs.aws.amazon.com/servicequotas/latest/userguide/gs-request-quota.html">Viewing service quotas</a>. You can resubmit your request later.</p>
141
+ * @public
142
+ */
143
+ interface ServiceQuotaExceededExceptionMember {
144
+ output?: never;
145
+ citation?: never;
146
+ guardrail?: never;
147
+ internalServerException?: never;
148
+ validationException?: never;
149
+ resourceNotFoundException?: never;
150
+ serviceQuotaExceededException: ServiceQuotaExceededException;
151
+ throttlingException?: never;
152
+ accessDeniedException?: never;
153
+ conflictException?: never;
154
+ dependencyFailedException?: never;
155
+ badGatewayException?: never;
156
+ $unknown?: never;
157
+ }
158
+ /**
159
+ * <p>Your request was denied due to exceeding the account quotas for <i>Amazon Bedrock</i>. For troubleshooting this error, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-throttling-exception">ThrottlingException</a> in the Amazon Bedrock User Guide.</p>
160
+ * @public
161
+ */
162
+ interface ThrottlingExceptionMember {
163
+ output?: never;
164
+ citation?: never;
165
+ guardrail?: never;
166
+ internalServerException?: never;
167
+ validationException?: never;
168
+ resourceNotFoundException?: never;
169
+ serviceQuotaExceededException?: never;
170
+ throttlingException: ThrottlingException;
171
+ accessDeniedException?: never;
172
+ conflictException?: never;
173
+ dependencyFailedException?: never;
174
+ badGatewayException?: never;
175
+ $unknown?: never;
176
+ }
177
+ /**
178
+ * <p>The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-access-denied">AccessDeniedException</a> in the Amazon Bedrock User Guide.</p>
179
+ * @public
180
+ */
181
+ interface AccessDeniedExceptionMember {
182
+ output?: never;
183
+ citation?: never;
184
+ guardrail?: never;
185
+ internalServerException?: never;
186
+ validationException?: never;
187
+ resourceNotFoundException?: never;
188
+ serviceQuotaExceededException?: never;
189
+ throttlingException?: never;
190
+ accessDeniedException: AccessDeniedException;
191
+ conflictException?: never;
192
+ dependencyFailedException?: never;
193
+ badGatewayException?: never;
194
+ $unknown?: never;
195
+ }
196
+ /**
197
+ * <p>Error occurred because of a conflict while performing an operation.</p>
198
+ * @public
199
+ */
200
+ interface ConflictExceptionMember {
201
+ output?: never;
202
+ citation?: never;
203
+ guardrail?: never;
204
+ internalServerException?: never;
205
+ validationException?: never;
206
+ resourceNotFoundException?: never;
207
+ serviceQuotaExceededException?: never;
208
+ throttlingException?: never;
209
+ accessDeniedException?: never;
210
+ conflictException: ConflictException;
211
+ dependencyFailedException?: never;
212
+ badGatewayException?: never;
213
+ $unknown?: never;
214
+ }
215
+ /**
216
+ * <p>The request failed due to a dependency error.</p>
217
+ * @public
218
+ */
219
+ interface DependencyFailedExceptionMember {
220
+ output?: never;
221
+ citation?: never;
222
+ guardrail?: never;
223
+ internalServerException?: never;
224
+ validationException?: never;
225
+ resourceNotFoundException?: never;
226
+ serviceQuotaExceededException?: never;
227
+ throttlingException?: never;
228
+ accessDeniedException?: never;
229
+ conflictException?: never;
230
+ dependencyFailedException: DependencyFailedException;
231
+ badGatewayException?: never;
232
+ $unknown?: never;
233
+ }
234
+ /**
235
+ * <p>The request failed due to a bad gateway error.</p>
236
+ * @public
237
+ */
238
+ interface BadGatewayExceptionMember {
239
+ output?: never;
240
+ citation?: never;
241
+ guardrail?: never;
242
+ internalServerException?: never;
243
+ validationException?: never;
244
+ resourceNotFoundException?: never;
245
+ serviceQuotaExceededException?: never;
246
+ throttlingException?: never;
247
+ accessDeniedException?: never;
248
+ conflictException?: never;
249
+ dependencyFailedException?: never;
250
+ badGatewayException: BadGatewayException;
251
+ $unknown?: never;
252
+ }
253
+ /**
254
+ * @public
255
+ */
256
+ interface $UnknownMember {
257
+ output?: never;
258
+ citation?: never;
259
+ guardrail?: never;
260
+ internalServerException?: never;
261
+ validationException?: never;
262
+ resourceNotFoundException?: never;
263
+ serviceQuotaExceededException?: never;
264
+ throttlingException?: never;
265
+ accessDeniedException?: never;
266
+ conflictException?: never;
267
+ dependencyFailedException?: never;
268
+ badGatewayException?: never;
269
+ $unknown: [string, any];
270
+ }
271
+ /**
272
+ * @deprecated unused in schema-serde mode.
273
+ *
274
+ */
275
+ interface Visitor<T> {
276
+ output: (value: RetrieveAndGenerateOutputEvent) => T;
277
+ citation: (value: CitationEvent) => T;
278
+ guardrail: (value: GuardrailEvent) => T;
279
+ internalServerException: (value: InternalServerException) => T;
280
+ validationException: (value: ValidationException) => T;
281
+ resourceNotFoundException: (value: ResourceNotFoundException) => T;
282
+ serviceQuotaExceededException: (value: ServiceQuotaExceededException) => T;
283
+ throttlingException: (value: ThrottlingException) => T;
284
+ accessDeniedException: (value: AccessDeniedException) => T;
285
+ conflictException: (value: ConflictException) => T;
286
+ dependencyFailedException: (value: DependencyFailedException) => T;
287
+ badGatewayException: (value: BadGatewayException) => T;
288
+ _: (name: string, value: any) => T;
289
+ }
290
+ }
291
+ /**
292
+ * @public
293
+ */
294
+ export interface RetrieveAndGenerateStreamResponse {
295
+ /**
296
+ * <p>A stream of events from the model.</p>
297
+ * @public
298
+ */
299
+ stream: AsyncIterable<RetrieveAndGenerateStreamResponseOutput> | undefined;
300
+ /**
301
+ * <p>The session ID.</p>
302
+ * @public
303
+ */
304
+ sessionId: string | undefined;
305
+ }
306
+ /**
307
+ * <p>Contains the image data for multimodal knowledge base queries, including format and content.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <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>image</code> field</p> </li> </ul>
308
+ * @public
309
+ */
310
+ export interface InputImage {
311
+ /**
312
+ * <p>The format of the input image. Supported formats include png, gif, jpeg, and webp.</p>
313
+ * @public
314
+ */
315
+ format: InputImageFormat | undefined;
316
+ /**
317
+ * <p>The base64-encoded image data for inline image content. Maximum size is 5MB.</p>
318
+ * @public
319
+ */
320
+ inlineContent: Uint8Array | undefined;
321
+ }
322
+ /**
323
+ * <p>Contains the query made to the knowledge base.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <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>retrievalQuery</code> field</p> </li> </ul>
324
+ * @public
325
+ */
326
+ export interface KnowledgeBaseQuery {
327
+ /**
328
+ * <p>The type of query being performed.</p>
329
+ * @public
330
+ */
331
+ type?: KnowledgeBaseQueryType | undefined;
332
+ /**
333
+ * <p>The text of the query made to the knowledge base.</p>
334
+ * @public
335
+ */
336
+ text?: string | undefined;
337
+ /**
338
+ * <p>An image to include in the knowledge base query for multimodal retrieval.</p>
339
+ * @public
340
+ */
341
+ image?: InputImage | undefined;
342
+ }
343
+ /**
344
+ * <p>Details about a result from querying the knowledge base.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax">Retrieve response</a> – in the <code>retrievalResults</code> field</p> </li> </ul>
345
+ * @public
346
+ */
347
+ export interface KnowledgeBaseRetrievalResult {
348
+ /**
349
+ * <p>Contains information about the content of the chunk.</p>
350
+ * @public
351
+ */
352
+ content: RetrievalResultContent | undefined;
353
+ /**
354
+ * <p>Contains information about the location of the data source.</p>
355
+ * @public
356
+ */
357
+ location?: RetrievalResultLocation | undefined;
358
+ /**
359
+ * <p>The level of relevance of the result to the query.</p>
360
+ * @public
361
+ */
362
+ score?: number | undefined;
363
+ /**
364
+ * <p>Contains metadata attributes and their values for the file in the data source. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-ds.html#kb-ds-metadata">Metadata and filtering</a>.</p>
365
+ * @public
366
+ */
367
+ metadata?: Record<string, __DocumentType> | undefined;
368
+ /**
369
+ * <p>The unique identifier of the document. Use with <code>GetDocumentContent</code> to retrieve the full document.</p>
370
+ * @public
371
+ */
372
+ documentId?: string | undefined;
373
+ }
374
+ /**
375
+ * @public
376
+ */
377
+ export interface RetrieveResponse {
378
+ /**
379
+ * <p>A list of results from querying the knowledge base.</p>
380
+ * @public
381
+ */
382
+ retrievalResults: KnowledgeBaseRetrievalResult[] | undefined;
383
+ /**
384
+ * <p>Specifies if there is a guardrail intervention in the response.</p>
385
+ * @public
386
+ */
387
+ guardrailAction?: GuadrailAction | undefined;
388
+ /**
389
+ * <p>If there are more results than can fit in the response, the response returns a <code>nextToken</code>. Use this token in the <code>nextToken</code> field of another request to retrieve the next batch of results.</p>
390
+ * @public
391
+ */
392
+ nextToken?: string | undefined;
393
+ }
394
+ /**
395
+ * @public
396
+ */
397
+ export interface CreateSessionRequest {
398
+ /**
399
+ * <p>A map of key-value pairs containing attributes to be persisted across the session. For example, the user's ID, their language preference, and the type of device they are using.</p>
400
+ * @public
401
+ */
402
+ sessionMetadata?: Record<string, string> | undefined;
403
+ /**
404
+ * <p>The Amazon Resource Name (ARN) of the KMS key to use to encrypt the session data. The user or role creating the session must have permission to use the key. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/session-encryption.html">Amazon Bedrock session encryption</a>. </p>
405
+ * @public
406
+ */
407
+ encryptionKeyArn?: string | undefined;
408
+ /**
409
+ * <p>Specify the key-value pairs for the tags that you want to attach to the session.</p>
410
+ * @public
411
+ */
412
+ tags?: Record<string, string> | undefined;
413
+ }
414
+ /**
415
+ * @public
416
+ */
417
+ export interface CreateSessionResponse {
418
+ /**
419
+ * <p>The unique identifier for the session.</p>
420
+ * @public
421
+ */
422
+ sessionId: string | undefined;
423
+ /**
424
+ * <p>The Amazon Resource Name (ARN) of the created session.</p>
425
+ * @public
426
+ */
427
+ sessionArn: string | undefined;
428
+ /**
429
+ * <p>The current status of the session.</p>
430
+ * @public
431
+ */
432
+ sessionStatus: SessionStatus | undefined;
433
+ /**
434
+ * <p>The timestamp for when the session was created.</p>
435
+ * @public
436
+ */
437
+ createdAt: Date | undefined;
438
+ }
439
+ /**
440
+ * @public
441
+ */
442
+ export interface DeleteSessionRequest {
443
+ /**
444
+ * <p>The unique identifier for the session to be deleted. You can specify either the session's <code>sessionId</code> or its Amazon Resource Name (ARN).</p>
445
+ * @public
446
+ */
447
+ sessionIdentifier: string | undefined;
448
+ }
449
+ /**
450
+ * @public
451
+ */
452
+ export interface DeleteSessionResponse {
453
+ }
454
+ /**
455
+ * @public
456
+ */
457
+ export interface EndSessionRequest {
458
+ /**
459
+ * <p>The unique identifier for the session to end. You can specify either the session's <code>sessionId</code> or its Amazon Resource Name (ARN).</p>
460
+ * @public
461
+ */
462
+ sessionIdentifier: string | undefined;
463
+ }
464
+ /**
465
+ * @public
466
+ */
467
+ export interface EndSessionResponse {
468
+ /**
469
+ * <p>The unique identifier of the session you ended.</p>
470
+ * @public
471
+ */
472
+ sessionId: string | undefined;
473
+ /**
474
+ * <p>The Amazon Resource Name (ARN) of the session you ended.</p>
475
+ * @public
476
+ */
477
+ sessionArn: string | undefined;
478
+ /**
479
+ * <p>The current status of the session you ended.</p>
480
+ * @public
481
+ */
482
+ sessionStatus: SessionStatus | undefined;
483
+ }
484
+ /**
485
+ * @public
486
+ */
487
+ export interface GetSessionRequest {
488
+ /**
489
+ * <p>A unique identifier for the session to retrieve. You can specify either the session's <code>sessionId</code> or its Amazon Resource Name (ARN).</p>
490
+ * @public
491
+ */
492
+ sessionIdentifier: string | undefined;
493
+ }
494
+ /**
495
+ * @public
496
+ */
497
+ export interface GetSessionResponse {
498
+ /**
499
+ * <p>The unique identifier for the session in UUID format.</p>
500
+ * @public
501
+ */
502
+ sessionId: string | undefined;
503
+ /**
504
+ * <p>The Amazon Resource Name (ARN) of the session.</p>
505
+ * @public
506
+ */
507
+ sessionArn: string | undefined;
508
+ /**
509
+ * <p>The current status of the session.</p>
510
+ * @public
511
+ */
512
+ sessionStatus: SessionStatus | undefined;
513
+ /**
514
+ * <p>The timestamp for when the session was created.</p>
515
+ * @public
516
+ */
517
+ createdAt: Date | undefined;
518
+ /**
519
+ * <p>The timestamp for when the session was last modified.</p>
520
+ * @public
521
+ */
522
+ lastUpdatedAt: Date | undefined;
523
+ /**
524
+ * <p>A map of key-value pairs containing attributes persisted across the session.</p>
525
+ * @public
526
+ */
527
+ sessionMetadata?: Record<string, string> | undefined;
528
+ /**
529
+ * <p>The Amazon Resource Name (ARN) of the Key Management Service key used to encrypt the session data. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/session-encryption.html">Amazon Bedrock session encryption</a>.</p>
530
+ * @public
531
+ */
532
+ encryptionKeyArn?: string | undefined;
533
+ }
534
+ /**
535
+ * @public
536
+ */
537
+ export interface CreateInvocationRequest {
538
+ /**
539
+ * <p>A unique identifier for the invocation in UUID format.</p>
540
+ * @public
541
+ */
542
+ invocationId?: string | undefined;
543
+ /**
544
+ * <p>A description for the interactions in the invocation. For example, "User asking about weather in Seattle".</p>
545
+ * @public
546
+ */
547
+ description?: string | undefined;
548
+ /**
549
+ * <p>The unique identifier for the associated session for the invocation. You can specify either the session's <code>sessionId</code> or its Amazon Resource Name (ARN). </p>
550
+ * @public
551
+ */
552
+ sessionIdentifier: string | undefined;
553
+ }
554
+ /**
555
+ * @public
556
+ */
557
+ export interface CreateInvocationResponse {
558
+ /**
559
+ * <p>The unique identifier for the session associated with the invocation.</p>
560
+ * @public
561
+ */
562
+ sessionId: string | undefined;
563
+ /**
564
+ * <p>The unique identifier for the invocation.</p>
565
+ * @public
566
+ */
567
+ invocationId: string | undefined;
568
+ /**
569
+ * <p>The timestamp for when the invocation was created.</p>
570
+ * @public
571
+ */
572
+ createdAt: Date | undefined;
573
+ }
3
574
  /**
4
575
  * @public
5
576
  */
@@ -890,7 +1461,7 @@ export interface ManagedSearchConfiguration {
890
1461
  */
891
1462
  numberOfResults?: number | undefined;
892
1463
  /**
893
- * <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> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <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> </li> <li> <p> <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> </li> </ul>
1464
+ * <p>Filters the metadata of the retrieved results so that Amazon Bedrock returns only results that match the filter.</p>
894
1465
  * @public
895
1466
  */
896
1467
  filter?: RetrievalFilter | undefined;
@@ -1021,6 +1592,11 @@ export interface AgenticRetrieveStreamRequest {
1021
1592
  * @public
1022
1593
  */
1023
1594
  userContext?: UserContext | undefined;
1595
+ /**
1596
+ * <p>The configuration for using an Amazon Bedrock AgentCore Memory resource with this retrieval.</p>
1597
+ * @public
1598
+ */
1599
+ memoryConfiguration?: AgenticRetrieveMemoryConfiguration | undefined;
1024
1600
  /**
1025
1601
  * <p>Whether to generate a response based on the retrieved results.</p>
1026
1602
  * @public
@@ -1141,7 +1717,7 @@ export interface RetrieveRequest {
1141
1717
  */
1142
1718
  nextToken?: string | undefined;
1143
1719
  /**
1144
- * <p>Contains information about the user making the request. Use this to pass user identity information for access control filtering, so that retrieval results only include documents the user is authorized to access.</p>
1720
+ * <p>Contains information about the user making the request. This is used for access control filtering to ensure that retrieval results only include documents the user is authorized to access.</p>
1145
1721
  * @public
1146
1722
  */
1147
1723
  userContext?: UserContext | undefined;
@@ -1253,7 +1829,7 @@ export interface RetrieveAndGenerateRequest {
1253
1829
  */
1254
1830
  sessionConfiguration?: RetrieveAndGenerateSessionConfiguration | undefined;
1255
1831
  /**
1256
- * <p>Contains information about the user making the request. Use this to pass user identity information for access control filtering, so that retrieval results only include documents the user is authorized to access.</p>
1832
+ * <p>Contains information about the user making the request. This is used for access control filtering to ensure that retrieval results only include documents the user is authorized to access.</p>
1257
1833
  * @public
1258
1834
  */
1259
1835
  userContext?: UserContext | undefined;
@@ -1283,7 +1859,7 @@ export interface RetrieveAndGenerateStreamRequest {
1283
1859
  */
1284
1860
  sessionConfiguration?: RetrieveAndGenerateSessionConfiguration | undefined;
1285
1861
  /**
1286
- * <p>Contains information about the user making the request. Use this to pass user identity information for access control filtering, so that retrieval results only include documents the user is authorized to access.</p>
1862
+ * <p>Contains information about the user making the request. This is used for access control filtering to ensure that retrieval results only include documents the user is authorized to access.</p>
1287
1863
  * @public
1288
1864
  */
1289
1865
  userContext?: UserContext | undefined;