@aws-sdk/client-bedrock-agent-runtime 3.934.0 → 3.936.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 (59) hide show
  1. package/dist-cjs/index.js +345 -345
  2. package/dist-es/index.js +2 -1
  3. package/dist-es/models/enums.js +330 -0
  4. package/dist-es/models/errors.js +127 -0
  5. package/dist-es/models/models_0.js +1 -431
  6. package/dist-es/schemas/schemas_0.js +1 -1
  7. package/dist-types/commands/CreateInvocationCommand.d.ts +1 -1
  8. package/dist-types/commands/CreateSessionCommand.d.ts +1 -1
  9. package/dist-types/commands/DeleteSessionCommand.d.ts +1 -1
  10. package/dist-types/commands/EndSessionCommand.d.ts +1 -1
  11. package/dist-types/commands/GetInvocationStepCommand.d.ts +1 -1
  12. package/dist-types/commands/GetSessionCommand.d.ts +1 -1
  13. package/dist-types/commands/InvokeAgentCommand.d.ts +1 -2
  14. package/dist-types/commands/InvokeInlineAgentCommand.d.ts +1 -2
  15. package/dist-types/commands/ListInvocationStepsCommand.d.ts +1 -1
  16. package/dist-types/commands/ListInvocationsCommand.d.ts +1 -1
  17. package/dist-types/commands/ListSessionsCommand.d.ts +1 -1
  18. package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
  19. package/dist-types/commands/PutInvocationStepCommand.d.ts +1 -1
  20. package/dist-types/commands/RetrieveAndGenerateCommand.d.ts +1 -1
  21. package/dist-types/commands/RetrieveAndGenerateStreamCommand.d.ts +1 -1
  22. package/dist-types/commands/RetrieveCommand.d.ts +1 -1
  23. package/dist-types/commands/TagResourceCommand.d.ts +1 -1
  24. package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
  25. package/dist-types/commands/UpdateSessionCommand.d.ts +1 -1
  26. package/dist-types/index.d.ts +3 -1
  27. package/dist-types/models/enums.d.ts +850 -0
  28. package/dist-types/models/errors.d.ts +137 -0
  29. package/dist-types/models/models_0.d.ts +2078 -914
  30. package/dist-types/ts3.4/commands/CreateInvocationCommand.d.ts +1 -1
  31. package/dist-types/ts3.4/commands/CreateSessionCommand.d.ts +1 -1
  32. package/dist-types/ts3.4/commands/DeleteSessionCommand.d.ts +1 -1
  33. package/dist-types/ts3.4/commands/EndSessionCommand.d.ts +1 -1
  34. package/dist-types/ts3.4/commands/GetInvocationStepCommand.d.ts +1 -1
  35. package/dist-types/ts3.4/commands/GetSessionCommand.d.ts +1 -1
  36. package/dist-types/ts3.4/commands/InvokeAgentCommand.d.ts +1 -2
  37. package/dist-types/ts3.4/commands/InvokeInlineAgentCommand.d.ts +4 -2
  38. package/dist-types/ts3.4/commands/ListInvocationStepsCommand.d.ts +1 -1
  39. package/dist-types/ts3.4/commands/ListInvocationsCommand.d.ts +1 -1
  40. package/dist-types/ts3.4/commands/ListSessionsCommand.d.ts +1 -1
  41. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +1 -1
  42. package/dist-types/ts3.4/commands/PutInvocationStepCommand.d.ts +1 -1
  43. package/dist-types/ts3.4/commands/RetrieveAndGenerateCommand.d.ts +1 -1
  44. package/dist-types/ts3.4/commands/RetrieveAndGenerateStreamCommand.d.ts +1 -1
  45. package/dist-types/ts3.4/commands/RetrieveCommand.d.ts +1 -1
  46. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
  47. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +1 -1
  48. package/dist-types/ts3.4/commands/UpdateSessionCommand.d.ts +1 -1
  49. package/dist-types/ts3.4/index.d.ts +3 -1
  50. package/dist-types/ts3.4/models/enums.d.ts +442 -0
  51. package/dist-types/ts3.4/models/errors.d.ts +73 -0
  52. package/dist-types/ts3.4/models/models_0.d.ts +968 -479
  53. package/package.json +19 -19
  54. package/dist-es/models/index.js +0 -2
  55. package/dist-es/models/models_1.js +0 -26
  56. package/dist-types/models/index.d.ts +0 -2
  57. package/dist-types/models/models_1.d.ts +0 -2151
  58. package/dist-types/ts3.4/models/index.d.ts +0 -2
  59. package/dist-types/ts3.4/models/models_1.d.ts +0 -969
@@ -1,2151 +0,0 @@
1
- import { DocumentType as __DocumentType } from "@smithy/types";
2
- import { AccessDeniedException, AgentActionGroup, AgentCollaboration, BadGatewayException, BedrockModelConfigurations, ByteContentDoc, Citation, CollaboratorConfiguration, ConflictException, ConversationHistory, CustomOrchestration, DependencyFailedException, ExternalSourcesGenerationConfiguration, FilterAttribute, GeneratedResponsePart, GuardrailConfiguration, GuardrailConfigurationWithArn, ImplicitFilterConfiguration, InferenceConfig, InlineBedrockModelConfigurations, InlineSessionState, InputFile, InternalServerException, InvocationResultMember, OrchestrationType, PerformanceConfiguration, PromptCreationConfigurations, PromptOverrideConfiguration, PromptTemplate, ResourceNotFoundException, RetrievalResultContent, RetrievalResultLocation, RetrieveAndGenerateInput, RetrievedReference, S3ObjectDoc, SearchType, ServiceQuotaExceededException, StreamingConfigurations, ThrottlingException, ValidationException, VectorSearchRerankingConfiguration } from "./models_0";
3
- /**
4
- * @public
5
- * @enum
6
- */
7
- export declare const ExternalSourceType: {
8
- readonly BYTE_CONTENT: "BYTE_CONTENT";
9
- readonly S3: "S3";
10
- };
11
- /**
12
- * @public
13
- */
14
- export type ExternalSourceType = (typeof ExternalSourceType)[keyof typeof ExternalSourceType];
15
- /**
16
- * <p>The unique external source of the content contained in the wrapper object.</p>
17
- * @public
18
- */
19
- export interface ExternalSource {
20
- /**
21
- * <p>The source type of the external source wrapper object.</p>
22
- * @public
23
- */
24
- sourceType: ExternalSourceType | undefined;
25
- /**
26
- * <p>The S3 location of the external source wrapper object.</p>
27
- * @public
28
- */
29
- s3Location?: S3ObjectDoc | undefined;
30
- /**
31
- * <p>The identifier, contentType, and data of the external source wrapper object.</p>
32
- * @public
33
- */
34
- byteContent?: ByteContentDoc | undefined;
35
- }
36
- /**
37
- * <p>The configurations of the external source wrapper object in the <code>retrieveAndGenerate</code> function.</p>
38
- * @public
39
- */
40
- export interface ExternalSourcesRetrieveAndGenerateConfiguration {
41
- /**
42
- * <p>The model Amazon Resource Name (ARN) for the external source wrapper object in the <code>retrieveAndGenerate</code> function.</p>
43
- * @public
44
- */
45
- modelArn: string | undefined;
46
- /**
47
- * <p>The document for the external source wrapper object in the <code>retrieveAndGenerate</code> function.</p>
48
- * @public
49
- */
50
- sources: ExternalSource[] | undefined;
51
- /**
52
- * <p>The prompt used with the external source wrapper object with the <code>retrieveAndGenerate</code> function.</p>
53
- * @public
54
- */
55
- generationConfiguration?: ExternalSourcesGenerationConfiguration | undefined;
56
- }
57
- /**
58
- * <p>Contains configurations for response generation based on the knowledge base query results.</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_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax">RetrieveAndGenerate request</a> </p> </li> </ul>
59
- * @public
60
- */
61
- export interface GenerationConfiguration {
62
- /**
63
- * <p>Contains the template for the prompt that's sent to the model for response generation. Generation prompts must include the <code>$search_results$</code> variable. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html">Use placeholder variables</a> in the user guide.</p>
64
- * @public
65
- */
66
- promptTemplate?: PromptTemplate | undefined;
67
- /**
68
- * <p>The configuration details for the guardrail.</p>
69
- * @public
70
- */
71
- guardrailConfiguration?: GuardrailConfiguration | undefined;
72
- /**
73
- * <p> Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source. </p>
74
- * @public
75
- */
76
- inferenceConfig?: InferenceConfig | undefined;
77
- /**
78
- * <p> Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows users to provide custom model parameters specific to the language model being used. </p>
79
- * @public
80
- */
81
- additionalModelRequestFields?: Record<string, __DocumentType> | undefined;
82
- /**
83
- * <p>The latency configuration for the model.</p>
84
- * @public
85
- */
86
- performanceConfig?: PerformanceConfiguration | undefined;
87
- }
88
- /**
89
- * @public
90
- * @enum
91
- */
92
- export declare const QueryTransformationType: {
93
- readonly QUERY_DECOMPOSITION: "QUERY_DECOMPOSITION";
94
- };
95
- /**
96
- * @public
97
- */
98
- export type QueryTransformationType = (typeof QueryTransformationType)[keyof typeof QueryTransformationType];
99
- /**
100
- * <p>To split up the prompt and retrieve multiple sources, set the transformation type to <code>QUERY_DECOMPOSITION</code>.</p>
101
- * @public
102
- */
103
- export interface QueryTransformationConfiguration {
104
- /**
105
- * <p>The type of transformation to apply to the prompt.</p>
106
- * @public
107
- */
108
- type: QueryTransformationType | undefined;
109
- }
110
- /**
111
- * <p>Settings for how the model processes the prompt prior to retrieval and generation.</p>
112
- * @public
113
- */
114
- export interface OrchestrationConfiguration {
115
- /**
116
- * <p>Contains the template for the prompt that's sent to the model. Orchestration prompts must include the <code>$conversation_history$</code> and <code>$output_format_instructions$</code> variables. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html">Use placeholder variables</a> in the user guide.</p>
117
- * @public
118
- */
119
- promptTemplate?: PromptTemplate | undefined;
120
- /**
121
- * <p> Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source. </p>
122
- * @public
123
- */
124
- inferenceConfig?: InferenceConfig | undefined;
125
- /**
126
- * <p> Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows users to provide custom model parameters specific to the language model being used. </p>
127
- * @public
128
- */
129
- additionalModelRequestFields?: Record<string, __DocumentType> | undefined;
130
- /**
131
- * <p>To split up the prompt and retrieve multiple sources, set the transformation type to <code>QUERY_DECOMPOSITION</code>.</p>
132
- * @public
133
- */
134
- queryTransformationConfiguration?: QueryTransformationConfiguration | undefined;
135
- /**
136
- * <p>The latency configuration for the model.</p>
137
- * @public
138
- */
139
- performanceConfig?: PerformanceConfiguration | undefined;
140
- }
141
- /**
142
- * @public
143
- * @enum
144
- */
145
- export declare const RetrieveAndGenerateType: {
146
- readonly EXTERNAL_SOURCES: "EXTERNAL_SOURCES";
147
- readonly KNOWLEDGE_BASE: "KNOWLEDGE_BASE";
148
- };
149
- /**
150
- * @public
151
- */
152
- export type RetrieveAndGenerateType = (typeof RetrieveAndGenerateType)[keyof typeof RetrieveAndGenerateType];
153
- /**
154
- * <p>Contains configuration about the session with 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_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax">RetrieveAndGenerate request</a> – in the <code>sessionConfiguration</code> field</p> </li> </ul>
155
- * @public
156
- */
157
- export interface RetrieveAndGenerateSessionConfiguration {
158
- /**
159
- * <p>The ARN of the KMS key encrypting the session.</p>
160
- * @public
161
- */
162
- kmsKeyArn: string | undefined;
163
- }
164
- /**
165
- * @public
166
- * @enum
167
- */
168
- export declare const GuadrailAction: {
169
- readonly INTERVENED: "INTERVENED";
170
- readonly NONE: "NONE";
171
- };
172
- /**
173
- * @public
174
- */
175
- export type GuadrailAction = (typeof GuadrailAction)[keyof typeof GuadrailAction];
176
- /**
177
- * <p>Contains the response generated 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_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax">RetrieveAndGenerate response</a> – in the <code>output</code> field</p> </li> </ul>
178
- * @public
179
- */
180
- export interface RetrieveAndGenerateOutput {
181
- /**
182
- * <p>The response generated from querying the knowledge base.</p>
183
- * @public
184
- */
185
- text: string | undefined;
186
- }
187
- /**
188
- * @public
189
- */
190
- export interface RetrieveAndGenerateResponse {
191
- /**
192
- * <p>The unique identifier of the session. When you first make a <code>RetrieveAndGenerate</code> request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the <code>sessionId</code> yourself.</p>
193
- * @public
194
- */
195
- sessionId: string | undefined;
196
- /**
197
- * <p>Contains the response generated from querying the knowledge base.</p>
198
- * @public
199
- */
200
- output: RetrieveAndGenerateOutput | undefined;
201
- /**
202
- * <p>A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.</p>
203
- * @public
204
- */
205
- citations?: Citation[] | undefined;
206
- /**
207
- * <p>Specifies if there is a guardrail intervention in the response.</p>
208
- * @public
209
- */
210
- guardrailAction?: GuadrailAction | undefined;
211
- }
212
- /**
213
- * <p>A citation event.</p>
214
- * @public
215
- */
216
- export interface CitationEvent {
217
- /**
218
- * <p>The citation.</p>
219
- *
220
- * @deprecated Citation is deprecated. Please use GeneratedResponsePart and RetrievedReferences for citation event.
221
- * @public
222
- */
223
- citation?: Citation | undefined;
224
- /**
225
- * <p>The generated response to the citation event.</p>
226
- * @public
227
- */
228
- generatedResponsePart?: GeneratedResponsePart | undefined;
229
- /**
230
- * <p>The retrieved references of the citation event.</p>
231
- * @public
232
- */
233
- retrievedReferences?: RetrievedReference[] | undefined;
234
- }
235
- /**
236
- * <p>A guardrail event.</p>
237
- * @public
238
- */
239
- export interface GuardrailEvent {
240
- /**
241
- * <p>The guardrail action.</p>
242
- * @public
243
- */
244
- action?: GuadrailAction | undefined;
245
- }
246
- /**
247
- * <p>A retrieve and generate output event.</p>
248
- * @public
249
- */
250
- export interface RetrieveAndGenerateOutputEvent {
251
- /**
252
- * <p>A text response.</p>
253
- * @public
254
- */
255
- text: string | undefined;
256
- }
257
- /**
258
- * <p>A retrieve and generate stream response output.</p>
259
- * @public
260
- */
261
- 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;
262
- /**
263
- * @public
264
- */
265
- export declare namespace RetrieveAndGenerateStreamResponseOutput {
266
- /**
267
- * <p>An output event.</p>
268
- * @public
269
- */
270
- interface OutputMember {
271
- output: RetrieveAndGenerateOutputEvent;
272
- citation?: never;
273
- guardrail?: never;
274
- internalServerException?: never;
275
- validationException?: never;
276
- resourceNotFoundException?: never;
277
- serviceQuotaExceededException?: never;
278
- throttlingException?: never;
279
- accessDeniedException?: never;
280
- conflictException?: never;
281
- dependencyFailedException?: never;
282
- badGatewayException?: never;
283
- $unknown?: never;
284
- }
285
- /**
286
- * <p>A citation event.</p>
287
- * @public
288
- */
289
- interface CitationMember {
290
- output?: never;
291
- citation: CitationEvent;
292
- guardrail?: never;
293
- internalServerException?: never;
294
- validationException?: never;
295
- resourceNotFoundException?: never;
296
- serviceQuotaExceededException?: never;
297
- throttlingException?: never;
298
- accessDeniedException?: never;
299
- conflictException?: never;
300
- dependencyFailedException?: never;
301
- badGatewayException?: never;
302
- $unknown?: never;
303
- }
304
- /**
305
- * <p>A guardrail event.</p>
306
- * @public
307
- */
308
- interface GuardrailMember {
309
- output?: never;
310
- citation?: never;
311
- guardrail: GuardrailEvent;
312
- internalServerException?: never;
313
- validationException?: never;
314
- resourceNotFoundException?: never;
315
- serviceQuotaExceededException?: never;
316
- throttlingException?: never;
317
- accessDeniedException?: never;
318
- conflictException?: never;
319
- dependencyFailedException?: never;
320
- badGatewayException?: never;
321
- $unknown?: never;
322
- }
323
- /**
324
- * <p>An internal server error occurred. Retry your request.</p>
325
- * @public
326
- */
327
- interface InternalServerExceptionMember {
328
- output?: never;
329
- citation?: never;
330
- guardrail?: never;
331
- internalServerException: InternalServerException;
332
- validationException?: never;
333
- resourceNotFoundException?: never;
334
- serviceQuotaExceededException?: never;
335
- throttlingException?: never;
336
- accessDeniedException?: never;
337
- conflictException?: never;
338
- dependencyFailedException?: never;
339
- badGatewayException?: never;
340
- $unknown?: never;
341
- }
342
- /**
343
- * <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>
344
- * @public
345
- */
346
- interface ValidationExceptionMember {
347
- output?: never;
348
- citation?: never;
349
- guardrail?: never;
350
- internalServerException?: never;
351
- validationException: ValidationException;
352
- resourceNotFoundException?: never;
353
- serviceQuotaExceededException?: never;
354
- throttlingException?: never;
355
- accessDeniedException?: never;
356
- conflictException?: never;
357
- dependencyFailedException?: never;
358
- badGatewayException?: never;
359
- $unknown?: never;
360
- }
361
- /**
362
- * <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>
363
- * @public
364
- */
365
- interface ResourceNotFoundExceptionMember {
366
- output?: never;
367
- citation?: never;
368
- guardrail?: never;
369
- internalServerException?: never;
370
- validationException?: never;
371
- resourceNotFoundException: ResourceNotFoundException;
372
- serviceQuotaExceededException?: never;
373
- throttlingException?: never;
374
- accessDeniedException?: never;
375
- conflictException?: never;
376
- dependencyFailedException?: never;
377
- badGatewayException?: never;
378
- $unknown?: never;
379
- }
380
- /**
381
- * <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>
382
- * @public
383
- */
384
- interface ServiceQuotaExceededExceptionMember {
385
- output?: never;
386
- citation?: never;
387
- guardrail?: never;
388
- internalServerException?: never;
389
- validationException?: never;
390
- resourceNotFoundException?: never;
391
- serviceQuotaExceededException: ServiceQuotaExceededException;
392
- throttlingException?: never;
393
- accessDeniedException?: never;
394
- conflictException?: never;
395
- dependencyFailedException?: never;
396
- badGatewayException?: never;
397
- $unknown?: never;
398
- }
399
- /**
400
- * <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>
401
- * @public
402
- */
403
- interface ThrottlingExceptionMember {
404
- output?: never;
405
- citation?: never;
406
- guardrail?: never;
407
- internalServerException?: never;
408
- validationException?: never;
409
- resourceNotFoundException?: never;
410
- serviceQuotaExceededException?: never;
411
- throttlingException: ThrottlingException;
412
- accessDeniedException?: never;
413
- conflictException?: never;
414
- dependencyFailedException?: never;
415
- badGatewayException?: never;
416
- $unknown?: never;
417
- }
418
- /**
419
- * <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>
420
- * @public
421
- */
422
- interface AccessDeniedExceptionMember {
423
- output?: never;
424
- citation?: never;
425
- guardrail?: never;
426
- internalServerException?: never;
427
- validationException?: never;
428
- resourceNotFoundException?: never;
429
- serviceQuotaExceededException?: never;
430
- throttlingException?: never;
431
- accessDeniedException: AccessDeniedException;
432
- conflictException?: never;
433
- dependencyFailedException?: never;
434
- badGatewayException?: never;
435
- $unknown?: never;
436
- }
437
- /**
438
- * <p>Error occurred because of a conflict while performing an operation.</p>
439
- * @public
440
- */
441
- interface ConflictExceptionMember {
442
- output?: never;
443
- citation?: never;
444
- guardrail?: never;
445
- internalServerException?: never;
446
- validationException?: never;
447
- resourceNotFoundException?: never;
448
- serviceQuotaExceededException?: never;
449
- throttlingException?: never;
450
- accessDeniedException?: never;
451
- conflictException: ConflictException;
452
- dependencyFailedException?: never;
453
- badGatewayException?: never;
454
- $unknown?: never;
455
- }
456
- /**
457
- * <p>The request failed due to a dependency error.</p>
458
- * @public
459
- */
460
- interface DependencyFailedExceptionMember {
461
- output?: never;
462
- citation?: never;
463
- guardrail?: never;
464
- internalServerException?: never;
465
- validationException?: never;
466
- resourceNotFoundException?: never;
467
- serviceQuotaExceededException?: never;
468
- throttlingException?: never;
469
- accessDeniedException?: never;
470
- conflictException?: never;
471
- dependencyFailedException: DependencyFailedException;
472
- badGatewayException?: never;
473
- $unknown?: never;
474
- }
475
- /**
476
- * <p>The request failed due to a bad gateway error.</p>
477
- * @public
478
- */
479
- interface BadGatewayExceptionMember {
480
- output?: never;
481
- citation?: never;
482
- guardrail?: never;
483
- internalServerException?: never;
484
- validationException?: never;
485
- resourceNotFoundException?: never;
486
- serviceQuotaExceededException?: never;
487
- throttlingException?: never;
488
- accessDeniedException?: never;
489
- conflictException?: never;
490
- dependencyFailedException?: never;
491
- badGatewayException: BadGatewayException;
492
- $unknown?: never;
493
- }
494
- /**
495
- * @public
496
- */
497
- interface $UnknownMember {
498
- output?: never;
499
- citation?: never;
500
- guardrail?: never;
501
- internalServerException?: never;
502
- validationException?: never;
503
- resourceNotFoundException?: never;
504
- serviceQuotaExceededException?: never;
505
- throttlingException?: never;
506
- accessDeniedException?: never;
507
- conflictException?: never;
508
- dependencyFailedException?: never;
509
- badGatewayException?: never;
510
- $unknown: [string, any];
511
- }
512
- /**
513
- * @deprecated unused in schema-serde mode.
514
- *
515
- */
516
- interface Visitor<T> {
517
- output: (value: RetrieveAndGenerateOutputEvent) => T;
518
- citation: (value: CitationEvent) => T;
519
- guardrail: (value: GuardrailEvent) => T;
520
- internalServerException: (value: InternalServerException) => T;
521
- validationException: (value: ValidationException) => T;
522
- resourceNotFoundException: (value: ResourceNotFoundException) => T;
523
- serviceQuotaExceededException: (value: ServiceQuotaExceededException) => T;
524
- throttlingException: (value: ThrottlingException) => T;
525
- accessDeniedException: (value: AccessDeniedException) => T;
526
- conflictException: (value: ConflictException) => T;
527
- dependencyFailedException: (value: DependencyFailedException) => T;
528
- badGatewayException: (value: BadGatewayException) => T;
529
- _: (name: string, value: any) => T;
530
- }
531
- }
532
- /**
533
- * @public
534
- */
535
- export interface RetrieveAndGenerateStreamResponse {
536
- /**
537
- * <p>A stream of events from the model.</p>
538
- * @public
539
- */
540
- stream: AsyncIterable<RetrieveAndGenerateStreamResponseOutput> | undefined;
541
- /**
542
- * <p>The session ID.</p>
543
- * @public
544
- */
545
- sessionId: string | undefined;
546
- }
547
- /**
548
- * <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>
549
- * @public
550
- */
551
- export interface KnowledgeBaseQuery {
552
- /**
553
- * <p>The text of the query made to the knowledge base.</p>
554
- * @public
555
- */
556
- text: string | undefined;
557
- }
558
- /**
559
- * <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>
560
- * @public
561
- */
562
- export interface KnowledgeBaseRetrievalResult {
563
- /**
564
- * <p>Contains information about the content of the chunk.</p>
565
- * @public
566
- */
567
- content: RetrievalResultContent | undefined;
568
- /**
569
- * <p>Contains information about the location of the data source.</p>
570
- * @public
571
- */
572
- location?: RetrievalResultLocation | undefined;
573
- /**
574
- * <p>The level of relevance of the result to the query.</p>
575
- * @public
576
- */
577
- score?: number | undefined;
578
- /**
579
- * <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>
580
- * @public
581
- */
582
- metadata?: Record<string, __DocumentType> | undefined;
583
- }
584
- /**
585
- * @public
586
- */
587
- export interface RetrieveResponse {
588
- /**
589
- * <p>A list of results from querying the knowledge base.</p>
590
- * @public
591
- */
592
- retrievalResults: KnowledgeBaseRetrievalResult[] | undefined;
593
- /**
594
- * <p>Specifies if there is a guardrail intervention in the response.</p>
595
- * @public
596
- */
597
- guardrailAction?: GuadrailAction | undefined;
598
- /**
599
- * <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>
600
- * @public
601
- */
602
- nextToken?: string | undefined;
603
- }
604
- /**
605
- * @public
606
- */
607
- export interface CreateSessionRequest {
608
- /**
609
- * <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>
610
- * @public
611
- */
612
- sessionMetadata?: Record<string, string> | undefined;
613
- /**
614
- * <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>
615
- * @public
616
- */
617
- encryptionKeyArn?: string | undefined;
618
- /**
619
- * <p>Specify the key-value pairs for the tags that you want to attach to the session.</p>
620
- * @public
621
- */
622
- tags?: Record<string, string> | undefined;
623
- }
624
- /**
625
- * @public
626
- * @enum
627
- */
628
- export declare const SessionStatus: {
629
- readonly ACTIVE: "ACTIVE";
630
- readonly ENDED: "ENDED";
631
- readonly EXPIRED: "EXPIRED";
632
- };
633
- /**
634
- * @public
635
- */
636
- export type SessionStatus = (typeof SessionStatus)[keyof typeof SessionStatus];
637
- /**
638
- * @public
639
- */
640
- export interface CreateSessionResponse {
641
- /**
642
- * <p>The unique identifier for the session.</p>
643
- * @public
644
- */
645
- sessionId: string | undefined;
646
- /**
647
- * <p>The Amazon Resource Name (ARN) of the created session.</p>
648
- * @public
649
- */
650
- sessionArn: string | undefined;
651
- /**
652
- * <p>The current status of the session.</p>
653
- * @public
654
- */
655
- sessionStatus: SessionStatus | undefined;
656
- /**
657
- * <p>The timestamp for when the session was created.</p>
658
- * @public
659
- */
660
- createdAt: Date | undefined;
661
- }
662
- /**
663
- * @public
664
- */
665
- export interface DeleteSessionRequest {
666
- /**
667
- * <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>
668
- * @public
669
- */
670
- sessionIdentifier: string | undefined;
671
- }
672
- /**
673
- * @public
674
- */
675
- export interface DeleteSessionResponse {
676
- }
677
- /**
678
- * @public
679
- */
680
- export interface EndSessionRequest {
681
- /**
682
- * <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>
683
- * @public
684
- */
685
- sessionIdentifier: string | undefined;
686
- }
687
- /**
688
- * @public
689
- */
690
- export interface EndSessionResponse {
691
- /**
692
- * <p>The unique identifier of the session you ended.</p>
693
- * @public
694
- */
695
- sessionId: string | undefined;
696
- /**
697
- * <p>The Amazon Resource Name (ARN) of the session you ended.</p>
698
- * @public
699
- */
700
- sessionArn: string | undefined;
701
- /**
702
- * <p>The current status of the session you ended.</p>
703
- * @public
704
- */
705
- sessionStatus: SessionStatus | undefined;
706
- }
707
- /**
708
- * @public
709
- */
710
- export interface GetSessionRequest {
711
- /**
712
- * <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>
713
- * @public
714
- */
715
- sessionIdentifier: string | undefined;
716
- }
717
- /**
718
- * @public
719
- */
720
- export interface GetSessionResponse {
721
- /**
722
- * <p>The unique identifier for the session in UUID format.</p>
723
- * @public
724
- */
725
- sessionId: string | undefined;
726
- /**
727
- * <p>The Amazon Resource Name (ARN) of the session.</p>
728
- * @public
729
- */
730
- sessionArn: string | undefined;
731
- /**
732
- * <p>The current status of the session.</p>
733
- * @public
734
- */
735
- sessionStatus: SessionStatus | undefined;
736
- /**
737
- * <p>The timestamp for when the session was created.</p>
738
- * @public
739
- */
740
- createdAt: Date | undefined;
741
- /**
742
- * <p>The timestamp for when the session was last modified.</p>
743
- * @public
744
- */
745
- lastUpdatedAt: Date | undefined;
746
- /**
747
- * <p>A map of key-value pairs containing attributes persisted across the session.</p>
748
- * @public
749
- */
750
- sessionMetadata?: Record<string, string> | undefined;
751
- /**
752
- * <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>
753
- * @public
754
- */
755
- encryptionKeyArn?: string | undefined;
756
- }
757
- /**
758
- * @public
759
- */
760
- export interface CreateInvocationRequest {
761
- /**
762
- * <p>A unique identifier for the invocation in UUID format.</p>
763
- * @public
764
- */
765
- invocationId?: string | undefined;
766
- /**
767
- * <p>A description for the interactions in the invocation. For example, "User asking about weather in Seattle".</p>
768
- * @public
769
- */
770
- description?: string | undefined;
771
- /**
772
- * <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>
773
- * @public
774
- */
775
- sessionIdentifier: string | undefined;
776
- }
777
- /**
778
- * @public
779
- */
780
- export interface CreateInvocationResponse {
781
- /**
782
- * <p>The unique identifier for the session associated with the invocation.</p>
783
- * @public
784
- */
785
- sessionId: string | undefined;
786
- /**
787
- * <p>The unique identifier for the invocation.</p>
788
- * @public
789
- */
790
- invocationId: string | undefined;
791
- /**
792
- * <p>The timestamp for when the invocation was created.</p>
793
- * @public
794
- */
795
- createdAt: Date | undefined;
796
- }
797
- /**
798
- * @public
799
- */
800
- export interface ListInvocationsRequest {
801
- /**
802
- * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results. </p>
803
- * @public
804
- */
805
- nextToken?: string | undefined;
806
- /**
807
- * <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
808
- * @public
809
- */
810
- maxResults?: number | undefined;
811
- /**
812
- * <p>The unique identifier for the session to list invocations for. You can specify either the session's <code>sessionId</code> or its Amazon Resource Name (ARN).</p>
813
- * @public
814
- */
815
- sessionIdentifier: string | undefined;
816
- }
817
- /**
818
- * <p>Contains details about an invocation in a session. For more information about sessions, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/sessions.html">Store and retrieve conversation history and context with Amazon Bedrock sessions</a>.</p>
819
- * @public
820
- */
821
- export interface InvocationSummary {
822
- /**
823
- * <p>The unique identifier for the session associated with the invocation.</p>
824
- * @public
825
- */
826
- sessionId: string | undefined;
827
- /**
828
- * <p>A unique identifier for the invocation in UUID format.</p>
829
- * @public
830
- */
831
- invocationId: string | undefined;
832
- /**
833
- * <p>The timestamp for when the invocation was created.</p>
834
- * @public
835
- */
836
- createdAt: Date | undefined;
837
- }
838
- /**
839
- * @public
840
- */
841
- export interface ListInvocationsResponse {
842
- /**
843
- * <p>A list of invocation summaries associated with the session.</p>
844
- * @public
845
- */
846
- invocationSummaries: InvocationSummary[] | undefined;
847
- /**
848
- * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
849
- * @public
850
- */
851
- nextToken?: string | undefined;
852
- }
853
- /**
854
- * @public
855
- */
856
- export interface GetInvocationStepRequest {
857
- /**
858
- * <p>The unique identifier for the invocation in UUID format.</p>
859
- * @public
860
- */
861
- invocationIdentifier: string | undefined;
862
- /**
863
- * <p>The unique identifier (in UUID format) for the specific invocation step to retrieve.</p>
864
- * @public
865
- */
866
- invocationStepId: string | undefined;
867
- /**
868
- * <p>The unique identifier for the invocation step's associated session. You can specify either the session's <code>sessionId</code> or its Amazon Resource Name (ARN).</p>
869
- * @public
870
- */
871
- sessionIdentifier: string | undefined;
872
- }
873
- /**
874
- * @public
875
- * @enum
876
- */
877
- export declare const ImageFormat: {
878
- readonly GIF: "gif";
879
- readonly JPEG: "jpeg";
880
- readonly PNG: "png";
881
- readonly WEBP: "webp";
882
- };
883
- /**
884
- * @public
885
- */
886
- export type ImageFormat = (typeof ImageFormat)[keyof typeof ImageFormat];
887
- /**
888
- * <p>Information about the Amazon S3 bucket where the image is stored.</p>
889
- * @public
890
- */
891
- export interface S3Location {
892
- /**
893
- * <p>The path to the Amazon S3 bucket where the image is stored.</p>
894
- * @public
895
- */
896
- uri: string | undefined;
897
- }
898
- /**
899
- * <p>The source for an image.</p>
900
- * @public
901
- */
902
- export type ImageSource = ImageSource.BytesMember | ImageSource.S3LocationMember | ImageSource.$UnknownMember;
903
- /**
904
- * @public
905
- */
906
- export declare namespace ImageSource {
907
- /**
908
- * <p> The raw image bytes for the image. If you use an Amazon Web Services SDK, you don't need to encode the image bytes in base64.</p>
909
- * @public
910
- */
911
- interface BytesMember {
912
- bytes: Uint8Array;
913
- s3Location?: never;
914
- $unknown?: never;
915
- }
916
- /**
917
- * <p>The path to the Amazon S3 bucket where the image is stored.</p>
918
- * @public
919
- */
920
- interface S3LocationMember {
921
- bytes?: never;
922
- s3Location: S3Location;
923
- $unknown?: never;
924
- }
925
- /**
926
- * @public
927
- */
928
- interface $UnknownMember {
929
- bytes?: never;
930
- s3Location?: never;
931
- $unknown: [string, any];
932
- }
933
- /**
934
- * @deprecated unused in schema-serde mode.
935
- *
936
- */
937
- interface Visitor<T> {
938
- bytes: (value: Uint8Array) => T;
939
- s3Location: (value: S3Location) => T;
940
- _: (name: string, value: any) => T;
941
- }
942
- }
943
- /**
944
- * <p>Image content for an invocation step.</p>
945
- * @public
946
- */
947
- export interface ImageBlock {
948
- /**
949
- * <p>The format of the image.</p>
950
- * @public
951
- */
952
- format: ImageFormat | undefined;
953
- /**
954
- * <p>The source for the image.</p>
955
- * @public
956
- */
957
- source: ImageSource | undefined;
958
- }
959
- /**
960
- * <p>A block of content that you pass to, or receive from, a Amazon Bedrock session in an invocation step. You pass the content to a session in the <code>payLoad</code> of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_PutInvocationStep.html">PutInvocationStep</a> API operation. You retrieve the content with the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_GetInvocationStep.html">GetInvocationStep</a> API operation.</p> <p>For more information about sessions, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/sessions.html">Store and retrieve conversation history and context with Amazon Bedrock sessions</a>.</p>
961
- * @public
962
- */
963
- export type BedrockSessionContentBlock = BedrockSessionContentBlock.ImageMember | BedrockSessionContentBlock.TextMember | BedrockSessionContentBlock.$UnknownMember;
964
- /**
965
- * @public
966
- */
967
- export declare namespace BedrockSessionContentBlock {
968
- /**
969
- * <p>The text in the invocation step.</p>
970
- * @public
971
- */
972
- interface TextMember {
973
- text: string;
974
- image?: never;
975
- $unknown?: never;
976
- }
977
- /**
978
- * <p>The image in the invocation step.</p>
979
- * @public
980
- */
981
- interface ImageMember {
982
- text?: never;
983
- image: ImageBlock;
984
- $unknown?: never;
985
- }
986
- /**
987
- * @public
988
- */
989
- interface $UnknownMember {
990
- text?: never;
991
- image?: never;
992
- $unknown: [string, any];
993
- }
994
- /**
995
- * @deprecated unused in schema-serde mode.
996
- *
997
- */
998
- interface Visitor<T> {
999
- text: (value: string) => T;
1000
- image: (value: ImageBlock) => T;
1001
- _: (name: string, value: any) => T;
1002
- }
1003
- }
1004
- /**
1005
- * <p>Payload content, such as text and images, for the invocation step.</p>
1006
- * @public
1007
- */
1008
- export type InvocationStepPayload = InvocationStepPayload.ContentBlocksMember | InvocationStepPayload.$UnknownMember;
1009
- /**
1010
- * @public
1011
- */
1012
- export declare namespace InvocationStepPayload {
1013
- /**
1014
- * <p>The content for the invocation step.</p>
1015
- * @public
1016
- */
1017
- interface ContentBlocksMember {
1018
- contentBlocks: BedrockSessionContentBlock[];
1019
- $unknown?: never;
1020
- }
1021
- /**
1022
- * @public
1023
- */
1024
- interface $UnknownMember {
1025
- contentBlocks?: never;
1026
- $unknown: [string, any];
1027
- }
1028
- /**
1029
- * @deprecated unused in schema-serde mode.
1030
- *
1031
- */
1032
- interface Visitor<T> {
1033
- contentBlocks: (value: BedrockSessionContentBlock[]) => T;
1034
- _: (name: string, value: any) => T;
1035
- }
1036
- }
1037
- /**
1038
- * <p>Stores fine-grained state checkpoints, including text and images, for each interaction in an invocation in a session. For more information about sessions, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/sessions.html">Store and retrieve conversation history and context with Amazon Bedrock sessions</a>. </p>
1039
- * @public
1040
- */
1041
- export interface InvocationStep {
1042
- /**
1043
- * <p>The unique identifier of the session containing the invocation step.</p>
1044
- * @public
1045
- */
1046
- sessionId: string | undefined;
1047
- /**
1048
- * <p>The unique identifier (in UUID format) for the invocation that includes the invocation step.</p>
1049
- * @public
1050
- */
1051
- invocationId: string | undefined;
1052
- /**
1053
- * <p>The unique identifier (in UUID format) for the invocation step.</p>
1054
- * @public
1055
- */
1056
- invocationStepId: string | undefined;
1057
- /**
1058
- * <p>The timestamp for when the invocation step was created.</p>
1059
- * @public
1060
- */
1061
- invocationStepTime: Date | undefined;
1062
- /**
1063
- * <p>Payload content, such as text and images, for the invocation step.</p>
1064
- * @public
1065
- */
1066
- payload: InvocationStepPayload | undefined;
1067
- }
1068
- /**
1069
- * @public
1070
- */
1071
- export interface GetInvocationStepResponse {
1072
- /**
1073
- * <p>The complete details of the requested invocation step.</p>
1074
- * @public
1075
- */
1076
- invocationStep: InvocationStep | undefined;
1077
- }
1078
- /**
1079
- * @public
1080
- */
1081
- export interface ListInvocationStepsRequest {
1082
- /**
1083
- * <p>The unique identifier (in UUID format) for the invocation to list invocation steps for.</p>
1084
- * @public
1085
- */
1086
- invocationIdentifier?: string | undefined;
1087
- /**
1088
- * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results. </p>
1089
- * @public
1090
- */
1091
- nextToken?: string | undefined;
1092
- /**
1093
- * <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
1094
- * @public
1095
- */
1096
- maxResults?: number | undefined;
1097
- /**
1098
- * <p>The unique identifier for the session associated with the invocation steps. You can specify either the session's <code>sessionId</code> or its Amazon Resource Name (ARN).</p>
1099
- * @public
1100
- */
1101
- sessionIdentifier: string | undefined;
1102
- }
1103
- /**
1104
- * <p>Contains details about an invocation step within an invocation in a session. For more information about sessions, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/sessions.html">Store and retrieve conversation history and context with Amazon Bedrock sessions</a>.</p>
1105
- * @public
1106
- */
1107
- export interface InvocationStepSummary {
1108
- /**
1109
- * <p>The unique identifier for the session associated with the invocation step.</p>
1110
- * @public
1111
- */
1112
- sessionId: string | undefined;
1113
- /**
1114
- * <p>A unique identifier for the invocation in UUID format.</p>
1115
- * @public
1116
- */
1117
- invocationId: string | undefined;
1118
- /**
1119
- * <p>The unique identifier (in UUID format) for the invocation step.</p>
1120
- * @public
1121
- */
1122
- invocationStepId: string | undefined;
1123
- /**
1124
- * <p>The timestamp for when the invocation step was created.</p>
1125
- * @public
1126
- */
1127
- invocationStepTime: Date | undefined;
1128
- }
1129
- /**
1130
- * @public
1131
- */
1132
- export interface ListInvocationStepsResponse {
1133
- /**
1134
- * <p>A list of summaries for each invocation step associated with a session and if you specified it, an invocation within the session.</p>
1135
- * @public
1136
- */
1137
- invocationStepSummaries: InvocationStepSummary[] | undefined;
1138
- /**
1139
- * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
1140
- * @public
1141
- */
1142
- nextToken?: string | undefined;
1143
- }
1144
- /**
1145
- * @public
1146
- */
1147
- export interface PutInvocationStepRequest {
1148
- /**
1149
- * <p>The unique identifier for the session to add the invocation step to. You can specify either the session's <code>sessionId</code> or its Amazon Resource Name (ARN).</p>
1150
- * @public
1151
- */
1152
- sessionIdentifier: string | undefined;
1153
- /**
1154
- * <p>The unique identifier (in UUID format) of the invocation to add the invocation step to.</p>
1155
- * @public
1156
- */
1157
- invocationIdentifier: string | undefined;
1158
- /**
1159
- * <p>The timestamp for when the invocation step occurred.</p>
1160
- * @public
1161
- */
1162
- invocationStepTime: Date | undefined;
1163
- /**
1164
- * <p>The payload for the invocation step, including text and images for the interaction.</p>
1165
- * @public
1166
- */
1167
- payload: InvocationStepPayload | undefined;
1168
- /**
1169
- * <p>The unique identifier of the invocation step in UUID format.</p>
1170
- * @public
1171
- */
1172
- invocationStepId?: string | undefined;
1173
- }
1174
- /**
1175
- * @public
1176
- */
1177
- export interface PutInvocationStepResponse {
1178
- /**
1179
- * <p>The unique identifier of the invocation step in UUID format.</p>
1180
- * @public
1181
- */
1182
- invocationStepId: string | undefined;
1183
- }
1184
- /**
1185
- * @public
1186
- */
1187
- export interface ListSessionsRequest {
1188
- /**
1189
- * <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
1190
- * @public
1191
- */
1192
- maxResults?: number | undefined;
1193
- /**
1194
- * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results. </p>
1195
- * @public
1196
- */
1197
- nextToken?: string | undefined;
1198
- }
1199
- /**
1200
- * <p>Contains details about a session. For more information about sessions, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/sessions.html">Store and retrieve conversation history and context with Amazon Bedrock sessions</a>.</p>
1201
- * @public
1202
- */
1203
- export interface SessionSummary {
1204
- /**
1205
- * <p>The unique identifier for the session.</p>
1206
- * @public
1207
- */
1208
- sessionId: string | undefined;
1209
- /**
1210
- * <p>The Amazon Resource Name (ARN) of the session.</p>
1211
- * @public
1212
- */
1213
- sessionArn: string | undefined;
1214
- /**
1215
- * <p>The current status of the session.</p>
1216
- * @public
1217
- */
1218
- sessionStatus: SessionStatus | undefined;
1219
- /**
1220
- * <p>The timestamp for when the session was created.</p>
1221
- * @public
1222
- */
1223
- createdAt: Date | undefined;
1224
- /**
1225
- * <p>The timestamp for when the session was last modified.</p>
1226
- * @public
1227
- */
1228
- lastUpdatedAt: Date | undefined;
1229
- }
1230
- /**
1231
- * @public
1232
- */
1233
- export interface ListSessionsResponse {
1234
- /**
1235
- * <p>A list of summaries for each session in your Amazon Web Services account.</p>
1236
- * @public
1237
- */
1238
- sessionSummaries: SessionSummary[] | undefined;
1239
- /**
1240
- * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
1241
- * @public
1242
- */
1243
- nextToken?: string | undefined;
1244
- }
1245
- /**
1246
- * @public
1247
- */
1248
- export interface UpdateSessionRequest {
1249
- /**
1250
- * <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>
1251
- * @public
1252
- */
1253
- sessionMetadata?: Record<string, string> | undefined;
1254
- /**
1255
- * <p>The unique identifier of the session to modify. You can specify either the session's <code>sessionId</code> or its Amazon Resource Name (ARN).</p>
1256
- * @public
1257
- */
1258
- sessionIdentifier: string | undefined;
1259
- }
1260
- /**
1261
- * @public
1262
- */
1263
- export interface UpdateSessionResponse {
1264
- /**
1265
- * <p>The unique identifier of the session you updated.</p>
1266
- * @public
1267
- */
1268
- sessionId: string | undefined;
1269
- /**
1270
- * <p>The Amazon Resource Name (ARN) of the session that was updated.</p>
1271
- * @public
1272
- */
1273
- sessionArn: string | undefined;
1274
- /**
1275
- * <p>The status of the session you updated.</p>
1276
- * @public
1277
- */
1278
- sessionStatus: SessionStatus | undefined;
1279
- /**
1280
- * <p>The timestamp for when the session was created.</p>
1281
- * @public
1282
- */
1283
- createdAt: Date | undefined;
1284
- /**
1285
- * <p>The timestamp for when the session was last modified.</p>
1286
- * @public
1287
- */
1288
- lastUpdatedAt: Date | undefined;
1289
- }
1290
- /**
1291
- * @public
1292
- */
1293
- export interface ListTagsForResourceRequest {
1294
- /**
1295
- * <p>The Amazon Resource Name (ARN) of the resource for which to list tags.</p>
1296
- * @public
1297
- */
1298
- resourceArn: string | undefined;
1299
- }
1300
- /**
1301
- * @public
1302
- */
1303
- export interface ListTagsForResourceResponse {
1304
- /**
1305
- * <p>The key-value pairs for the tags associated with the resource.</p>
1306
- * @public
1307
- */
1308
- tags?: Record<string, string> | undefined;
1309
- }
1310
- /**
1311
- * @public
1312
- */
1313
- export interface TagResourceRequest {
1314
- /**
1315
- * <p>The Amazon Resource Name (ARN) of the resource to tag.</p>
1316
- * @public
1317
- */
1318
- resourceArn: string | undefined;
1319
- /**
1320
- * <p>An object containing key-value pairs that define the tags to attach to the resource.</p>
1321
- * @public
1322
- */
1323
- tags: Record<string, string> | undefined;
1324
- }
1325
- /**
1326
- * @public
1327
- */
1328
- export interface TagResourceResponse {
1329
- }
1330
- /**
1331
- * @public
1332
- */
1333
- export interface UntagResourceRequest {
1334
- /**
1335
- * <p>The Amazon Resource Name (ARN) of the resource from which to remove tags.</p>
1336
- * @public
1337
- */
1338
- resourceArn: string | undefined;
1339
- /**
1340
- * <p>A list of keys of the tags to remove from the resource.</p>
1341
- * @public
1342
- */
1343
- tagKeys: string[] | undefined;
1344
- }
1345
- /**
1346
- * @public
1347
- */
1348
- export interface UntagResourceResponse {
1349
- }
1350
- /**
1351
- * <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>
1352
- * @public
1353
- */
1354
- export type RetrievalFilter = RetrievalFilter.AndAllMember | RetrievalFilter.EqualsMember | RetrievalFilter.GreaterThanMember | RetrievalFilter.GreaterThanOrEqualsMember | RetrievalFilter.InMember | RetrievalFilter.LessThanMember | RetrievalFilter.LessThanOrEqualsMember | RetrievalFilter.ListContainsMember | RetrievalFilter.NotEqualsMember | RetrievalFilter.NotInMember | RetrievalFilter.OrAllMember | RetrievalFilter.StartsWithMember | RetrievalFilter.StringContainsMember | RetrievalFilter.$UnknownMember;
1355
- /**
1356
- * @public
1357
- */
1358
- export declare namespace RetrievalFilter {
1359
- /**
1360
- * <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> <p>The following example would return data sources with an <code>animal</code> attribute whose value is <code>cat</code>:</p> <p> <code>"equals": \{ "key": "animal", "value": "cat" \}</code> </p>
1361
- * @public
1362
- */
1363
- interface EqualsMember {
1364
- equals: FilterAttribute;
1365
- notEquals?: never;
1366
- greaterThan?: never;
1367
- greaterThanOrEquals?: never;
1368
- lessThan?: never;
1369
- lessThanOrEquals?: never;
1370
- in?: never;
1371
- notIn?: never;
1372
- startsWith?: never;
1373
- listContains?: never;
1374
- stringContains?: never;
1375
- andAll?: never;
1376
- orAll?: never;
1377
- $unknown?: never;
1378
- }
1379
- /**
1380
- * <p>Knowledge base data sources are returned when:</p> <ul> <li> <p>It contains a metadata attribute whose name matches the <code>key</code> and whose value doesn't match the <code>value</code> in this object.</p> </li> <li> <p>The key is not present in the document.</p> </li> </ul> <p>The following example would return data sources that don't contain an <code>animal</code> attribute whose value is <code>cat</code>.</p> <p> <code>"notEquals": \{ "key": "animal", "value": "cat" \}</code> </p>
1381
- * @public
1382
- */
1383
- interface NotEqualsMember {
1384
- equals?: never;
1385
- notEquals: FilterAttribute;
1386
- greaterThan?: never;
1387
- greaterThanOrEquals?: never;
1388
- lessThan?: never;
1389
- lessThanOrEquals?: never;
1390
- in?: never;
1391
- notIn?: never;
1392
- startsWith?: never;
1393
- listContains?: never;
1394
- stringContains?: never;
1395
- andAll?: never;
1396
- orAll?: never;
1397
- $unknown?: never;
1398
- }
1399
- /**
1400
- * <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> <p>The following example would return data sources with an <code>year</code> attribute whose value is greater than <code>1989</code>:</p> <p> <code>"greaterThan": \{ "key": "year", "value": 1989 \}</code> </p>
1401
- * @public
1402
- */
1403
- interface GreaterThanMember {
1404
- equals?: never;
1405
- notEquals?: never;
1406
- greaterThan: FilterAttribute;
1407
- greaterThanOrEquals?: never;
1408
- lessThan?: never;
1409
- lessThanOrEquals?: never;
1410
- in?: never;
1411
- notIn?: never;
1412
- startsWith?: never;
1413
- listContains?: never;
1414
- stringContains?: never;
1415
- andAll?: never;
1416
- orAll?: never;
1417
- $unknown?: never;
1418
- }
1419
- /**
1420
- * <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> <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> <p> <code>"greaterThanOrEquals": \{ "key": "year", "value": 1989 \}</code> </p>
1421
- * @public
1422
- */
1423
- interface GreaterThanOrEqualsMember {
1424
- equals?: never;
1425
- notEquals?: never;
1426
- greaterThan?: never;
1427
- greaterThanOrEquals: FilterAttribute;
1428
- lessThan?: never;
1429
- lessThanOrEquals?: never;
1430
- in?: never;
1431
- notIn?: never;
1432
- startsWith?: never;
1433
- listContains?: never;
1434
- stringContains?: never;
1435
- andAll?: never;
1436
- orAll?: never;
1437
- $unknown?: never;
1438
- }
1439
- /**
1440
- * <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> <p>The following example would return data sources with an <code>year</code> attribute whose value is less than to <code>1989</code>.</p> <p> <code>"lessThan": \{ "key": "year", "value": 1989 \}</code> </p>
1441
- * @public
1442
- */
1443
- interface LessThanMember {
1444
- equals?: never;
1445
- notEquals?: never;
1446
- greaterThan?: never;
1447
- greaterThanOrEquals?: never;
1448
- lessThan: FilterAttribute;
1449
- lessThanOrEquals?: never;
1450
- in?: never;
1451
- notIn?: never;
1452
- startsWith?: never;
1453
- listContains?: never;
1454
- stringContains?: never;
1455
- andAll?: never;
1456
- orAll?: never;
1457
- $unknown?: never;
1458
- }
1459
- /**
1460
- * <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> <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> <p> <code>"lessThanOrEquals": \{ "key": "year", "value": 1989 \}</code> </p>
1461
- * @public
1462
- */
1463
- interface LessThanOrEqualsMember {
1464
- equals?: never;
1465
- notEquals?: never;
1466
- greaterThan?: never;
1467
- greaterThanOrEquals?: never;
1468
- lessThan?: never;
1469
- lessThanOrEquals: FilterAttribute;
1470
- in?: never;
1471
- notIn?: never;
1472
- startsWith?: never;
1473
- listContains?: never;
1474
- stringContains?: never;
1475
- andAll?: never;
1476
- orAll?: never;
1477
- $unknown?: never;
1478
- }
1479
- /**
1480
- * <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> <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> <p> <code>"in": \{ "key": "animal", "value": ["cat", "dog"] \}</code> </p>
1481
- * @public
1482
- */
1483
- interface InMember {
1484
- equals?: never;
1485
- notEquals?: never;
1486
- greaterThan?: never;
1487
- greaterThanOrEquals?: never;
1488
- lessThan?: never;
1489
- lessThanOrEquals?: never;
1490
- in: FilterAttribute;
1491
- notIn?: never;
1492
- startsWith?: never;
1493
- listContains?: never;
1494
- stringContains?: never;
1495
- andAll?: never;
1496
- orAll?: never;
1497
- $unknown?: never;
1498
- }
1499
- /**
1500
- * <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> <p>The following example would return data sources whose <code>animal</code> attribute is neither <code>cat</code> nor <code>dog</code>.</p> <p> <code>"notIn": \{ "key": "animal", "value": ["cat", "dog"] \}</code> </p>
1501
- * @public
1502
- */
1503
- interface NotInMember {
1504
- equals?: never;
1505
- notEquals?: never;
1506
- greaterThan?: never;
1507
- greaterThanOrEquals?: never;
1508
- lessThan?: never;
1509
- lessThanOrEquals?: never;
1510
- in?: never;
1511
- notIn: FilterAttribute;
1512
- startsWith?: never;
1513
- listContains?: never;
1514
- stringContains?: never;
1515
- andAll?: never;
1516
- orAll?: never;
1517
- $unknown?: never;
1518
- }
1519
- /**
1520
- * <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> <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> <p> <code>"startsWith": \{ "key": "animal", "value": "ca" \}</code> </p>
1521
- * @public
1522
- */
1523
- interface StartsWithMember {
1524
- equals?: never;
1525
- notEquals?: never;
1526
- greaterThan?: never;
1527
- greaterThanOrEquals?: never;
1528
- lessThan?: never;
1529
- lessThanOrEquals?: never;
1530
- in?: never;
1531
- notIn?: never;
1532
- startsWith: FilterAttribute;
1533
- listContains?: never;
1534
- stringContains?: never;
1535
- andAll?: never;
1536
- orAll?: never;
1537
- $unknown?: never;
1538
- }
1539
- /**
1540
- * <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> <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> <p> <code>"listContains": \{ "key": "animals", "value": "cat" \}</code> </p>
1541
- * @public
1542
- */
1543
- interface ListContainsMember {
1544
- equals?: never;
1545
- notEquals?: never;
1546
- greaterThan?: never;
1547
- greaterThanOrEquals?: never;
1548
- lessThan?: never;
1549
- lessThanOrEquals?: never;
1550
- in?: never;
1551
- notIn?: never;
1552
- startsWith?: never;
1553
- listContains: FilterAttribute;
1554
- stringContains?: never;
1555
- andAll?: never;
1556
- orAll?: never;
1557
- $unknown?: never;
1558
- }
1559
- /**
1560
- * <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> <ul> <li> <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> <p> <code>"stringContains": \{ "key": "animal", "value": "at" \}</code> </p> </li> <li> <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> <p> <code>"stringContains": \{ "key": "animals", "value": "at" \}</code> </p> </li> </ul>
1561
- * @public
1562
- */
1563
- interface StringContainsMember {
1564
- equals?: never;
1565
- notEquals?: never;
1566
- greaterThan?: never;
1567
- greaterThanOrEquals?: never;
1568
- lessThan?: never;
1569
- lessThanOrEquals?: never;
1570
- in?: never;
1571
- notIn?: never;
1572
- startsWith?: never;
1573
- listContains?: never;
1574
- stringContains: FilterAttribute;
1575
- andAll?: never;
1576
- orAll?: never;
1577
- $unknown?: never;
1578
- }
1579
- /**
1580
- * <p>Knowledge base data sources are returned if their metadata attributes fulfill all the filter conditions inside this list.</p>
1581
- * @public
1582
- */
1583
- interface AndAllMember {
1584
- equals?: never;
1585
- notEquals?: never;
1586
- greaterThan?: never;
1587
- greaterThanOrEquals?: never;
1588
- lessThan?: never;
1589
- lessThanOrEquals?: never;
1590
- in?: never;
1591
- notIn?: never;
1592
- startsWith?: never;
1593
- listContains?: never;
1594
- stringContains?: never;
1595
- andAll: RetrievalFilter[];
1596
- orAll?: never;
1597
- $unknown?: never;
1598
- }
1599
- /**
1600
- * <p>Knowledge base data sources are returned if their metadata attributes fulfill at least one of the filter conditions inside this list.</p>
1601
- * @public
1602
- */
1603
- interface OrAllMember {
1604
- equals?: never;
1605
- notEquals?: never;
1606
- greaterThan?: never;
1607
- greaterThanOrEquals?: never;
1608
- lessThan?: never;
1609
- lessThanOrEquals?: never;
1610
- in?: never;
1611
- notIn?: never;
1612
- startsWith?: never;
1613
- listContains?: never;
1614
- stringContains?: never;
1615
- andAll?: never;
1616
- orAll: RetrievalFilter[];
1617
- $unknown?: never;
1618
- }
1619
- /**
1620
- * @public
1621
- */
1622
- interface $UnknownMember {
1623
- equals?: never;
1624
- notEquals?: never;
1625
- greaterThan?: never;
1626
- greaterThanOrEquals?: never;
1627
- lessThan?: never;
1628
- lessThanOrEquals?: never;
1629
- in?: never;
1630
- notIn?: never;
1631
- startsWith?: never;
1632
- listContains?: never;
1633
- stringContains?: never;
1634
- andAll?: never;
1635
- orAll?: never;
1636
- $unknown: [string, any];
1637
- }
1638
- /**
1639
- * @deprecated unused in schema-serde mode.
1640
- *
1641
- */
1642
- interface Visitor<T> {
1643
- equals: (value: FilterAttribute) => T;
1644
- notEquals: (value: FilterAttribute) => T;
1645
- greaterThan: (value: FilterAttribute) => T;
1646
- greaterThanOrEquals: (value: FilterAttribute) => T;
1647
- lessThan: (value: FilterAttribute) => T;
1648
- lessThanOrEquals: (value: FilterAttribute) => T;
1649
- in: (value: FilterAttribute) => T;
1650
- notIn: (value: FilterAttribute) => T;
1651
- startsWith: (value: FilterAttribute) => T;
1652
- listContains: (value: FilterAttribute) => T;
1653
- stringContains: (value: FilterAttribute) => T;
1654
- andAll: (value: RetrievalFilter[]) => T;
1655
- orAll: (value: RetrievalFilter[]) => T;
1656
- _: (name: string, value: any) => T;
1657
- }
1658
- }
1659
- /**
1660
- * <p>Configurations for how to perform the search query and return results. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</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>vectorSearchConfiguration</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>vectorSearchConfiguration</code> field</p> </li> </ul>
1661
- * @public
1662
- */
1663
- export interface KnowledgeBaseVectorSearchConfiguration {
1664
- /**
1665
- * <p>The number of source chunks to retrieve.</p>
1666
- * @public
1667
- */
1668
- numberOfResults?: number | undefined;
1669
- /**
1670
- * <p>By default, Amazon Bedrock decides a search strategy for you. If you're using an Amazon OpenSearch Serverless vector store that contains a filterable text field, you can specify whether to query the knowledge base with a <code>HYBRID</code> search using both vector embeddings and raw text, or <code>SEMANTIC</code> search using only vector embeddings. For other vector store configurations, only <code>SEMANTIC</code> search is available. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-test.html">Test a knowledge base</a>.</p>
1671
- * @public
1672
- */
1673
- overrideSearchType?: SearchType | undefined;
1674
- /**
1675
- * <p>Specifies the filters to use on the metadata 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>
1676
- * @public
1677
- */
1678
- filter?: RetrievalFilter | undefined;
1679
- /**
1680
- * <p>Contains configurations for reranking the retrieved results. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/rerank.html">Improve the relevance of query responses with a reranker model</a>.</p>
1681
- * @public
1682
- */
1683
- rerankingConfiguration?: VectorSearchRerankingConfiguration | undefined;
1684
- /**
1685
- * <p>Settings for implicit filtering.</p>
1686
- * @public
1687
- */
1688
- implicitFilterConfiguration?: ImplicitFilterConfiguration | undefined;
1689
- }
1690
- /**
1691
- * <p>Contains configurations for knowledge base query. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</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>retrievalConfiguration</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>retrievalConfiguration</code> field</p> </li> </ul>
1692
- * @public
1693
- */
1694
- export interface KnowledgeBaseRetrievalConfiguration {
1695
- /**
1696
- * <p>Contains details about how the results from the vector search should be returned. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</p>
1697
- * @public
1698
- */
1699
- vectorSearchConfiguration: KnowledgeBaseVectorSearchConfiguration | undefined;
1700
- }
1701
- /**
1702
- * <p> Details of the knowledge base associated withe inline agent. </p>
1703
- * @public
1704
- */
1705
- export interface KnowledgeBase {
1706
- /**
1707
- * <p> The unique identifier for a knowledge base associated with the inline agent. </p>
1708
- * @public
1709
- */
1710
- knowledgeBaseId: string | undefined;
1711
- /**
1712
- * <p> The description of the knowledge base associated with the inline agent. </p>
1713
- * @public
1714
- */
1715
- description: string | undefined;
1716
- /**
1717
- * <p> The configurations to apply to the knowledge base during query. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>. </p>
1718
- * @public
1719
- */
1720
- retrievalConfiguration?: KnowledgeBaseRetrievalConfiguration | undefined;
1721
- }
1722
- /**
1723
- * <p>Configurations to apply to a knowledge base attached to the agent during query. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html#session-state-kb">Knowledge base retrieval configurations</a>.</p>
1724
- * @public
1725
- */
1726
- export interface KnowledgeBaseConfiguration {
1727
- /**
1728
- * <p>The unique identifier for a knowledge base attached to the agent.</p>
1729
- * @public
1730
- */
1731
- knowledgeBaseId: string | undefined;
1732
- /**
1733
- * <p>The configurations to apply to the knowledge base during query. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</p>
1734
- * @public
1735
- */
1736
- retrievalConfiguration: KnowledgeBaseRetrievalConfiguration | undefined;
1737
- }
1738
- /**
1739
- * <p>Contains details about the resource being queried.</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>knowledgeBaseConfiguration</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>knowledgeBaseConfiguration</code> field</p> </li> </ul>
1740
- * @public
1741
- */
1742
- export interface KnowledgeBaseRetrieveAndGenerateConfiguration {
1743
- /**
1744
- * <p>The unique identifier of the knowledge base that is queried.</p>
1745
- * @public
1746
- */
1747
- knowledgeBaseId: string | undefined;
1748
- /**
1749
- * <p>The ARN of the foundation model or <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html">inference profile</a> used to generate a response.</p>
1750
- * @public
1751
- */
1752
- modelArn: string | undefined;
1753
- /**
1754
- * <p>Contains configurations for how to retrieve and return the knowledge base query.</p>
1755
- * @public
1756
- */
1757
- retrievalConfiguration?: KnowledgeBaseRetrievalConfiguration | undefined;
1758
- /**
1759
- * <p>Contains configurations for response generation based on the knowledge base query results.</p>
1760
- * @public
1761
- */
1762
- generationConfiguration?: GenerationConfiguration | undefined;
1763
- /**
1764
- * <p>Settings for how the model processes the prompt prior to retrieval and generation.</p>
1765
- * @public
1766
- */
1767
- orchestrationConfiguration?: OrchestrationConfiguration | undefined;
1768
- }
1769
- /**
1770
- * @public
1771
- */
1772
- export interface RetrieveRequest {
1773
- /**
1774
- * <p>The unique identifier of the knowledge base to query.</p>
1775
- * @public
1776
- */
1777
- knowledgeBaseId: string | undefined;
1778
- /**
1779
- * <p>Contains the query to send the knowledge base.</p>
1780
- * @public
1781
- */
1782
- retrievalQuery: KnowledgeBaseQuery | undefined;
1783
- /**
1784
- * <p>Contains configurations for the knowledge base query and retrieval process. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</p>
1785
- * @public
1786
- */
1787
- retrievalConfiguration?: KnowledgeBaseRetrievalConfiguration | undefined;
1788
- /**
1789
- * <p>Guardrail settings.</p>
1790
- * @public
1791
- */
1792
- guardrailConfiguration?: GuardrailConfiguration | undefined;
1793
- /**
1794
- * <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>
1795
- * @public
1796
- */
1797
- nextToken?: string | undefined;
1798
- }
1799
- /**
1800
- * <p>Contains details about the resource being queried.</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_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax">RetrieveAndGenerate request</a> – in the <code>retrieveAndGenerateConfiguration</code> field</p> </li> </ul>
1801
- * @public
1802
- */
1803
- export interface RetrieveAndGenerateConfiguration {
1804
- /**
1805
- * <p>The type of resource that contains your data for retrieving information and generating responses.</p> <note> <p>If you choose to use <code>EXTERNAL_SOURCES</code>, then currently only Anthropic Claude 3 Sonnet models for knowledge bases are supported.</p> </note>
1806
- * @public
1807
- */
1808
- type: RetrieveAndGenerateType | undefined;
1809
- /**
1810
- * <p>Contains details about the knowledge base for retrieving information and generating responses.</p>
1811
- * @public
1812
- */
1813
- knowledgeBaseConfiguration?: KnowledgeBaseRetrieveAndGenerateConfiguration | undefined;
1814
- /**
1815
- * <p>The configuration for the external source wrapper object in the <code>retrieveAndGenerate</code> function.</p>
1816
- * @public
1817
- */
1818
- externalSourcesConfiguration?: ExternalSourcesRetrieveAndGenerateConfiguration | undefined;
1819
- }
1820
- /**
1821
- * <p> List of inline collaborators. </p>
1822
- * @public
1823
- */
1824
- export interface Collaborator {
1825
- /**
1826
- * <p> The Amazon Resource Name (ARN) of the AWS KMS key that encrypts the inline collaborator. </p>
1827
- * @public
1828
- */
1829
- customerEncryptionKeyArn?: string | undefined;
1830
- /**
1831
- * <p> The foundation model used by the inline collaborator agent. </p>
1832
- * @public
1833
- */
1834
- foundationModel: string | undefined;
1835
- /**
1836
- * <p> Instruction that tell the inline collaborator agent what it should do and how it should interact with users. </p>
1837
- * @public
1838
- */
1839
- instruction: string | undefined;
1840
- /**
1841
- * <p> The number of seconds for which the Amazon Bedrock keeps information about the user's conversation with the inline collaborator agent.</p> <p>A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout. </p>
1842
- * @public
1843
- */
1844
- idleSessionTTLInSeconds?: number | undefined;
1845
- /**
1846
- * <p> List of action groups with each action group defining tasks the inline collaborator agent needs to carry out. </p>
1847
- * @public
1848
- */
1849
- actionGroups?: AgentActionGroup[] | undefined;
1850
- /**
1851
- * <p> Knowledge base associated with the inline collaborator agent. </p>
1852
- * @public
1853
- */
1854
- knowledgeBases?: KnowledgeBase[] | undefined;
1855
- /**
1856
- * <p> Details of the guardwrail associated with the inline collaborator. </p>
1857
- * @public
1858
- */
1859
- guardrailConfiguration?: GuardrailConfigurationWithArn | undefined;
1860
- /**
1861
- * <p> Contains configurations to override prompt templates in different parts of an inline collaborator sequence. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html">Advanced prompts</a>. </p>
1862
- * @public
1863
- */
1864
- promptOverrideConfiguration?: PromptOverrideConfiguration | undefined;
1865
- /**
1866
- * <p> Defines how the inline supervisor agent handles information across multiple collaborator agents to coordinate a final response. </p>
1867
- * @public
1868
- */
1869
- agentCollaboration?: AgentCollaboration | undefined;
1870
- /**
1871
- * <p> Settings of the collaborator agent. </p>
1872
- * @public
1873
- */
1874
- collaboratorConfigurations?: CollaboratorConfiguration[] | undefined;
1875
- /**
1876
- * <p> Name of the inline collaborator agent which must be the same name as specified for <code>collaboratorName</code>. </p>
1877
- * @public
1878
- */
1879
- agentName?: string | undefined;
1880
- }
1881
- /**
1882
- * @public
1883
- */
1884
- export interface RetrieveAndGenerateRequest {
1885
- /**
1886
- * <p>The unique identifier of the session. When you first make a <code>RetrieveAndGenerate</code> request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the <code>sessionId</code> yourself.</p>
1887
- * @public
1888
- */
1889
- sessionId?: string | undefined;
1890
- /**
1891
- * <p>Contains the query to be made to the knowledge base.</p>
1892
- * @public
1893
- */
1894
- input: RetrieveAndGenerateInput | undefined;
1895
- /**
1896
- * <p>Contains configurations for the knowledge base query and retrieval process. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</p>
1897
- * @public
1898
- */
1899
- retrieveAndGenerateConfiguration?: RetrieveAndGenerateConfiguration | undefined;
1900
- /**
1901
- * <p>Contains details about the session with the knowledge base.</p>
1902
- * @public
1903
- */
1904
- sessionConfiguration?: RetrieveAndGenerateSessionConfiguration | undefined;
1905
- }
1906
- /**
1907
- * @public
1908
- */
1909
- export interface RetrieveAndGenerateStreamRequest {
1910
- /**
1911
- * <p>The unique identifier of the session. When you first make a <code>RetrieveAndGenerate</code> request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the <code>sessionId</code> yourself.</p>
1912
- * @public
1913
- */
1914
- sessionId?: string | undefined;
1915
- /**
1916
- * <p>Contains the query to be made to the knowledge base.</p>
1917
- * @public
1918
- */
1919
- input: RetrieveAndGenerateInput | undefined;
1920
- /**
1921
- * <p>Contains configurations for the knowledge base query and retrieval process. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</p>
1922
- * @public
1923
- */
1924
- retrieveAndGenerateConfiguration?: RetrieveAndGenerateConfiguration | undefined;
1925
- /**
1926
- * <p>Contains details about the session with the knowledge base.</p>
1927
- * @public
1928
- */
1929
- sessionConfiguration?: RetrieveAndGenerateSessionConfiguration | undefined;
1930
- }
1931
- /**
1932
- * <p>Contains parameters that specify various attributes that persist across a session or prompt. You can define session state attributes as key-value pairs when writing a <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-lambda.html">Lambda function</a> for an action group or pass them when making an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html">InvokeAgent</a> request. Use session state attributes to control and provide conversational context for your agent and to help customize your agent's behavior. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html">Control session context</a>.</p>
1933
- * @public
1934
- */
1935
- export interface SessionState {
1936
- /**
1937
- * <p>Contains attributes that persist across a session and the values of those attributes. If <code>sessionAttributes</code> are passed to a supervisor agent in <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-multi-agent-collaboration.html">multi-agent collaboration</a>, it will be forwarded to all agent collaborators.</p>
1938
- * @public
1939
- */
1940
- sessionAttributes?: Record<string, string> | undefined;
1941
- /**
1942
- * <p>Contains attributes that persist across a prompt and the values of those attributes. </p> <ul> <li> <p>In orchestration prompt template, these attributes replace the $prompt_session_attributes$ placeholder variable. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html">Prompt template placeholder variables</a>.</p> </li> <li> <p>In <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-multi-agent-collaboration.html">multi-agent collaboration</a>, the <code>promptSessionAttributes</code> will only be used by supervisor agent when $prompt_session_attributes$ is present in prompt template. </p> </li> </ul>
1943
- * @public
1944
- */
1945
- promptSessionAttributes?: Record<string, string> | undefined;
1946
- /**
1947
- * <p>Contains information about the results from the action group invocation. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-returncontrol.html">Return control to the agent developer</a> and <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html">Control session context</a>.</p> <note> <p>If you include this field, the <code>inputText</code> field will be ignored.</p> </note>
1948
- * @public
1949
- */
1950
- returnControlInvocationResults?: InvocationResultMember[] | undefined;
1951
- /**
1952
- * <p>The identifier of the invocation of an action. This value must match the <code>invocationId</code> returned in the <code>InvokeAgent</code> response for the action whose results are provided in the <code>returnControlInvocationResults</code> field. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-returncontrol.html">Return control to the agent developer</a> and <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html">Control session context</a>.</p>
1953
- * @public
1954
- */
1955
- invocationId?: string | undefined;
1956
- /**
1957
- * <p>Contains information about the files used by code interpreter.</p>
1958
- * @public
1959
- */
1960
- files?: InputFile[] | undefined;
1961
- /**
1962
- * <p>An array of configurations, each of which applies to a knowledge base attached to the agent.</p>
1963
- * @public
1964
- */
1965
- knowledgeBaseConfigurations?: KnowledgeBaseConfiguration[] | undefined;
1966
- /**
1967
- * <p>The state's conversation history.</p>
1968
- * @public
1969
- */
1970
- conversationHistory?: ConversationHistory | undefined;
1971
- }
1972
- /**
1973
- * @public
1974
- */
1975
- export interface InvokeAgentRequest {
1976
- /**
1977
- * <p>Contains parameters that specify various attributes of the session. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html">Control session context</a>.</p> <note> <p>If you include <code>returnControlInvocationResults</code> in the <code>sessionState</code> field, the <code>inputText</code> field will be ignored.</p> </note>
1978
- * @public
1979
- */
1980
- sessionState?: SessionState | undefined;
1981
- /**
1982
- * <p>The unique identifier of the agent to use.</p>
1983
- * @public
1984
- */
1985
- agentId: string | undefined;
1986
- /**
1987
- * <p>The alias of the agent to use.</p>
1988
- * @public
1989
- */
1990
- agentAliasId: string | undefined;
1991
- /**
1992
- * <p>The unique identifier of the session. Use the same value across requests to continue the same conversation.</p>
1993
- * @public
1994
- */
1995
- sessionId: string | undefined;
1996
- /**
1997
- * <p>Specifies whether to end the session with the agent or not.</p>
1998
- * @public
1999
- */
2000
- endSession?: boolean | undefined;
2001
- /**
2002
- * <p>Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-events">Trace enablement</a>.</p>
2003
- * @public
2004
- */
2005
- enableTrace?: boolean | undefined;
2006
- /**
2007
- * <p>The prompt text to send the agent.</p> <note> <p>If you include <code>returnControlInvocationResults</code> in the <code>sessionState</code> field, the <code>inputText</code> field will be ignored.</p> </note>
2008
- * @public
2009
- */
2010
- inputText?: string | undefined;
2011
- /**
2012
- * <p>The unique identifier of the agent memory.</p>
2013
- * @public
2014
- */
2015
- memoryId?: string | undefined;
2016
- /**
2017
- * <p>Model performance settings for the request.</p>
2018
- * @public
2019
- */
2020
- bedrockModelConfigurations?: BedrockModelConfigurations | undefined;
2021
- /**
2022
- * <p> Specifies the configurations for streaming. </p> <note> <p>To use agent streaming, you need permissions to perform the <code>bedrock:InvokeModelWithResponseStream</code> action.</p> </note>
2023
- * @public
2024
- */
2025
- streamingConfigurations?: StreamingConfigurations | undefined;
2026
- /**
2027
- * <p>Specifies parameters that control how the service populates the agent prompt for an <code>InvokeAgent</code> request. You can control which aspects of previous invocations in the same agent session the service uses to populate the agent prompt. This gives you more granular control over the contextual history that is used to process the current request.</p>
2028
- * @public
2029
- */
2030
- promptCreationConfigurations?: PromptCreationConfigurations | undefined;
2031
- /**
2032
- * <p>The ARN of the resource making the request.</p>
2033
- * @public
2034
- */
2035
- sourceArn?: string | undefined;
2036
- }
2037
- /**
2038
- * @public
2039
- */
2040
- export interface InvokeInlineAgentRequest {
2041
- /**
2042
- * <p> The Amazon Resource Name (ARN) of the Amazon Web Services KMS key to use to encrypt your inline agent. </p>
2043
- * @public
2044
- */
2045
- customerEncryptionKeyArn?: string | undefined;
2046
- /**
2047
- * <p> The <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns">model identifier (ID)</a> of the model to use for orchestration by the inline agent. For example, <code>meta.llama3-1-70b-instruct-v1:0</code>. </p>
2048
- * @public
2049
- */
2050
- foundationModel: string | undefined;
2051
- /**
2052
- * <p> The instructions that tell the inline agent what it should do and how it should interact with users. </p>
2053
- * @public
2054
- */
2055
- instruction: string | undefined;
2056
- /**
2057
- * <p> The number of seconds for which the inline agent should maintain session information. After this time expires, the subsequent <code>InvokeInlineAgent</code> request begins a new session. </p> <p>A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and the data provided before the timeout is deleted.</p>
2058
- * @public
2059
- */
2060
- idleSessionTTLInSeconds?: number | undefined;
2061
- /**
2062
- * <p> A list of action groups with each action group defining the action the inline agent needs to carry out. </p>
2063
- * @public
2064
- */
2065
- actionGroups?: AgentActionGroup[] | undefined;
2066
- /**
2067
- * <p> Contains information of the knowledge bases to associate with. </p>
2068
- * @public
2069
- */
2070
- knowledgeBases?: KnowledgeBase[] | undefined;
2071
- /**
2072
- * <p> The <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails.html">guardrails</a> to assign to the inline agent. </p>
2073
- * @public
2074
- */
2075
- guardrailConfiguration?: GuardrailConfigurationWithArn | undefined;
2076
- /**
2077
- * <p> Configurations for advanced prompts used to override the default prompts to enhance the accuracy of the inline agent. </p>
2078
- * @public
2079
- */
2080
- promptOverrideConfiguration?: PromptOverrideConfiguration | undefined;
2081
- /**
2082
- * <p> Defines how the inline collaborator agent handles information across multiple collaborator agents to coordinate a final response. The inline collaborator agent can also be the supervisor. </p>
2083
- * @public
2084
- */
2085
- agentCollaboration?: AgentCollaboration | undefined;
2086
- /**
2087
- * <p> Settings for an inline agent collaborator called with <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeInlineAgent.html">InvokeInlineAgent</a>. </p>
2088
- * @public
2089
- */
2090
- collaboratorConfigurations?: CollaboratorConfiguration[] | undefined;
2091
- /**
2092
- * <p>The name for the agent.</p>
2093
- * @public
2094
- */
2095
- agentName?: string | undefined;
2096
- /**
2097
- * <p> The unique identifier of the session. Use the same value across requests to continue the same conversation. </p>
2098
- * @public
2099
- */
2100
- sessionId: string | undefined;
2101
- /**
2102
- * <p> Specifies whether to end the session with the inline agent or not. </p>
2103
- * @public
2104
- */
2105
- endSession?: boolean | undefined;
2106
- /**
2107
- * <p> Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/trace-events.html">Using trace</a>. </p>
2108
- * @public
2109
- */
2110
- enableTrace?: boolean | undefined;
2111
- /**
2112
- * <p> The prompt text to send to the agent. </p> <note> <p>If you include <code>returnControlInvocationResults</code> in the <code>sessionState</code> field, the <code>inputText</code> field will be ignored.</p> </note>
2113
- * @public
2114
- */
2115
- inputText?: string | undefined;
2116
- /**
2117
- * <p> Specifies the configurations for streaming. </p> <note> <p>To use agent streaming, you need permissions to perform the <code>bedrock:InvokeModelWithResponseStream</code> action.</p> </note>
2118
- * @public
2119
- */
2120
- streamingConfigurations?: StreamingConfigurations | undefined;
2121
- /**
2122
- * <p>Specifies parameters that control how the service populates the agent prompt for an <code>InvokeInlineAgent</code> request. You can control which aspects of previous invocations in the same agent session the service uses to populate the agent prompt. This gives you more granular control over the contextual history that is used to process the current request.</p>
2123
- * @public
2124
- */
2125
- promptCreationConfigurations?: PromptCreationConfigurations | undefined;
2126
- /**
2127
- * <p> Parameters that specify the various attributes of a sessions. You can include attributes for the session or prompt or, if you configured an action group to return control, results from invocation of the action group. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html">Control session context</a>. </p> <note> <p>If you include <code>returnControlInvocationResults</code> in the <code>sessionState</code> field, the <code>inputText</code> field will be ignored.</p> </note>
2128
- * @public
2129
- */
2130
- inlineSessionState?: InlineSessionState | undefined;
2131
- /**
2132
- * <p> List of collaborator inline agents. </p>
2133
- * @public
2134
- */
2135
- collaborators?: Collaborator[] | undefined;
2136
- /**
2137
- * <p>Model settings for the request.</p>
2138
- * @public
2139
- */
2140
- bedrockModelConfigurations?: InlineBedrockModelConfigurations | undefined;
2141
- /**
2142
- * <p>Specifies the type of orchestration strategy for the agent. This is set to DEFAULT orchestration type, by default. </p>
2143
- * @public
2144
- */
2145
- orchestrationType?: OrchestrationType | undefined;
2146
- /**
2147
- * <p>Contains details of the custom orchestration configured for the agent. </p>
2148
- * @public
2149
- */
2150
- customOrchestration?: CustomOrchestration | undefined;
2151
- }