@aws-sdk/client-bedrock-agent-runtime 3.529.1 → 3.533.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.
@@ -2,7 +2,7 @@ import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-cli
2
2
  import { BedrockAgentRuntimeServiceException as __BaseException } from "./BedrockAgentRuntimeServiceException";
3
3
  /**
4
4
  * @public
5
- * This exception is thrown when a request is denied per access permissions
5
+ * <p>The request is denied because of missing access permissions. Check your permissions and retry your request.</p>
6
6
  */
7
7
  export declare class AccessDeniedException extends __BaseException {
8
8
  readonly name: "AccessDeniedException";
@@ -14,88 +14,88 @@ export declare class AccessDeniedException extends __BaseException {
14
14
  }
15
15
  /**
16
16
  * @public
17
- * parameters included in action group invocation
17
+ * <p>A parameter in the Lambda input event.</p>
18
18
  */
19
19
  export interface Parameter {
20
20
  /**
21
21
  * @public
22
- * Name of parameter
22
+ * <p>The name of the parameter.</p>
23
23
  */
24
24
  name?: string;
25
25
  /**
26
26
  * @public
27
- * Type of parameter
27
+ * <p>The type of the parameter.</p>
28
28
  */
29
29
  type?: string;
30
30
  /**
31
31
  * @public
32
- * Value of parameter
32
+ * <p>The value of the parameter.</p>
33
33
  */
34
34
  value?: string;
35
35
  }
36
36
  /**
37
37
  * @public
38
- * Request Body Content Map
38
+ * <p>The parameters in the request body for the Lambda input event.</p>
39
39
  */
40
40
  export interface RequestBody {
41
41
  /**
42
42
  * @public
43
- * Content type paramter map
43
+ * <p>The content in the request body.</p>
44
44
  */
45
45
  content?: Record<string, Parameter[]>;
46
46
  }
47
47
  /**
48
48
  * @public
49
- * input to lambda used in action group
49
+ * <p>Contains information about the action group being invoked.</p>
50
50
  */
51
51
  export interface ActionGroupInvocationInput {
52
52
  /**
53
53
  * @public
54
- * Agent Trace Action Group Name
54
+ * <p>The name of the action group.</p>
55
55
  */
56
56
  actionGroupName?: string;
57
57
  /**
58
58
  * @public
59
- * Agent Trace Action Group Action verb
59
+ * <p>The API method being used, based off the action group.</p>
60
60
  */
61
61
  verb?: string;
62
62
  /**
63
63
  * @public
64
- * Agent Trace Action Group API path
64
+ * <p>The path to the API to call, based off the action group.</p>
65
65
  */
66
66
  apiPath?: string;
67
67
  /**
68
68
  * @public
69
- * list of parameters included in action group invocation
69
+ * <p>The parameters in the Lambda input event.</p>
70
70
  */
71
71
  parameters?: Parameter[];
72
72
  /**
73
73
  * @public
74
- * Request Body Content Map
74
+ * <p>The parameters in the request body for the Lambda input event.</p>
75
75
  */
76
76
  requestBody?: RequestBody;
77
77
  }
78
78
  /**
79
79
  * @public
80
- * output from lambda used in action group
80
+ * <p>Contains the JSON-formatted string returned by the API invoked by the action group.</p>
81
81
  */
82
82
  export interface ActionGroupInvocationOutput {
83
83
  /**
84
84
  * @public
85
- * Agent Trace Action Group Lambda Invocation Output String
85
+ * <p>The JSON-formatted string returned by the API invoked by the action group.</p>
86
86
  */
87
87
  text?: string;
88
88
  }
89
89
  /**
90
90
  * @public
91
- * This exception is thrown when a request fails due to dependency like Lambda, Bedrock, STS resource
91
+ * <p>There was an issue with a dependency due to a server issue. Retry your request.</p>
92
92
  */
93
93
  export declare class BadGatewayException extends __BaseException {
94
94
  readonly name: "BadGatewayException";
95
95
  readonly $fault: "server";
96
96
  /**
97
97
  * @public
98
- * Non Blank String
98
+ * <p>The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or STS.</p>
99
99
  */
100
100
  resourceName?: string;
101
101
  /**
@@ -105,7 +105,7 @@ export declare class BadGatewayException extends __BaseException {
105
105
  }
106
106
  /**
107
107
  * @public
108
- * This exception is thrown when there is a conflict performing an operation
108
+ * <p>There was a conflict performing an operation. Resolve the conflict and retry your request.</p>
109
109
  */
110
110
  export declare class ConflictException extends __BaseException {
111
111
  readonly name: "ConflictException";
@@ -117,14 +117,14 @@ export declare class ConflictException extends __BaseException {
117
117
  }
118
118
  /**
119
119
  * @public
120
- * This exception is thrown when a request fails due to dependency like Lambda, Bedrock, STS resource due to a customer fault (i.e. bad configuration)
120
+ * <p>There was an issue with a dependency. Check the resource configurations and retry the request.</p>
121
121
  */
122
122
  export declare class DependencyFailedException extends __BaseException {
123
123
  readonly name: "DependencyFailedException";
124
124
  readonly $fault: "client";
125
125
  /**
126
126
  * @public
127
- * Non Blank String
127
+ * <p>The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or STS.</p>
128
128
  */
129
129
  resourceName?: string;
130
130
  /**
@@ -134,7 +134,7 @@ export declare class DependencyFailedException extends __BaseException {
134
134
  }
135
135
  /**
136
136
  * @public
137
- * This exception is thrown if there was an unexpected error during processing of request
137
+ * <p>An internal server error occurred. Retry your request.</p>
138
138
  */
139
139
  export declare class InternalServerException extends __BaseException {
140
140
  readonly name: "InternalServerException";
@@ -146,123 +146,122 @@ export declare class InternalServerException extends __BaseException {
146
146
  }
147
147
  /**
148
148
  * @public
149
- * Session state provided
149
+ * <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/sessionstate.html">Session context</a>.</p>
150
150
  */
151
151
  export interface SessionState {
152
152
  /**
153
153
  * @public
154
- * Session Attributes
154
+ * <p>Contains attributes that persist across a session and the values of those attributes.</p>
155
155
  */
156
156
  sessionAttributes?: Record<string, string>;
157
157
  /**
158
158
  * @public
159
- * Prompt Session Attributes
159
+ * <p>Contains attributes that persist across a prompt and the values of those attributes. These attributes replace the $prompt_session_attributes$ placeholder variable in the orchestration prompt template. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html">Prompt template placeholder variables</a>.</p>
160
160
  */
161
161
  promptSessionAttributes?: Record<string, string>;
162
162
  }
163
163
  /**
164
164
  * @public
165
- * InvokeAgent Request
166
165
  */
167
166
  export interface InvokeAgentRequest {
168
167
  /**
169
168
  * @public
170
- * Session state passed by customer. Base64 encoded json string representation of SessionState.
169
+ * <p>Contains parameters that specify various attributes of the session.</p>
171
170
  */
172
171
  sessionState?: SessionState;
173
172
  /**
174
173
  * @public
175
- * Identifier for Agent
174
+ * <p>The unique identifier of the agent to use.</p>
176
175
  */
177
176
  agentId: string | undefined;
178
177
  /**
179
178
  * @public
180
- * Identifier for Agent Alias
179
+ * <p>The alias of the agent to use.</p>
181
180
  */
182
181
  agentAliasId: string | undefined;
183
182
  /**
184
183
  * @public
185
- * Identifier used for the current session
184
+ * <p>The unique identifier of the session. Use the same value across requests to continue the same conversation.</p>
186
185
  */
187
186
  sessionId: string | undefined;
188
187
  /**
189
188
  * @public
190
- * End current session
189
+ * <p>Specifies whether to end the session with the agent or not.</p>
191
190
  */
192
191
  endSession?: boolean;
193
192
  /**
194
193
  * @public
195
- * Enable agent trace events for improved debugging
194
+ * <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>
196
195
  */
197
196
  enableTrace?: boolean;
198
197
  /**
199
198
  * @public
200
- * Input data in the format specified in the Content-Type request header.
199
+ * <p>The prompt text to send the agent.</p>
201
200
  */
202
201
  inputText: string | undefined;
203
202
  }
204
203
  /**
205
204
  * @public
206
- * Span of text
205
+ * <p>Contains information about where the text with a citation begins and ends in the generated output.</p>
207
206
  */
208
207
  export interface Span {
209
208
  /**
210
209
  * @public
211
- * Start of span
210
+ * <p>Where the text with a citation starts in the generated output.</p>
212
211
  */
213
212
  start?: number;
214
213
  /**
215
214
  * @public
216
- * End of span
215
+ * <p>Where the text with a citation ends in the generated output.</p>
217
216
  */
218
217
  end?: number;
219
218
  }
220
219
  /**
221
220
  * @public
222
- * Text response part
221
+ * <p>Contains the part of the generated text that contains a citation, alongside where it begins and ends.</p>
223
222
  */
224
223
  export interface TextResponsePart {
225
224
  /**
226
225
  * @public
227
- * Response part in text
226
+ * <p>The part of the generated text that contains a citation.</p>
228
227
  */
229
228
  text?: string;
230
229
  /**
231
230
  * @public
232
- * Span of text
231
+ * <p>Contains information about where the text with a citation begins and ends in the generated output.</p>
233
232
  */
234
233
  span?: Span;
235
234
  }
236
235
  /**
237
236
  * @public
238
- * Generate response part
237
+ * <p>Contains metadata about a part of the generated response that is accompanied by a citation.</p>
239
238
  */
240
239
  export interface GeneratedResponsePart {
241
240
  /**
242
241
  * @public
243
- * Text response part
242
+ * <p>Contains metadata about a textual part of the generated response that is accompanied by a citation.</p>
244
243
  */
245
244
  textResponsePart?: TextResponsePart;
246
245
  }
247
246
  /**
248
247
  * @public
249
- * Content of a retrieval result.
248
+ * <p>Contains the cited text from the data source.</p>
250
249
  */
251
250
  export interface RetrievalResultContent {
252
251
  /**
253
252
  * @public
254
- * Content of a retrieval result in text
253
+ * <p>The cited text from the data source.</p>
255
254
  */
256
255
  text: string | undefined;
257
256
  }
258
257
  /**
259
258
  * @public
260
- * The S3 location of a retrieval result.
259
+ * <p>Contains the S3 location of the data source.</p>
261
260
  */
262
261
  export interface RetrievalResultS3Location {
263
262
  /**
264
263
  * @public
265
- * URI of S3 location
264
+ * <p>The S3 URI of the data source.</p>
266
265
  */
267
266
  uri?: string;
268
267
  }
@@ -279,82 +278,82 @@ export declare const RetrievalResultLocationType: {
279
278
  export type RetrievalResultLocationType = (typeof RetrievalResultLocationType)[keyof typeof RetrievalResultLocationType];
280
279
  /**
281
280
  * @public
282
- * The source location of a retrieval result.
281
+ * <p>Contains information about the location of the data source.</p>
283
282
  */
284
283
  export interface RetrievalResultLocation {
285
284
  /**
286
285
  * @public
287
- * The location type of a retrieval result.
286
+ * <p>The type of the location of the data source.</p>
288
287
  */
289
288
  type: RetrievalResultLocationType | undefined;
290
289
  /**
291
290
  * @public
292
- * The S3 location of a retrieval result.
291
+ * <p>Contains the S3 location of the data source.</p>
293
292
  */
294
293
  s3Location?: RetrievalResultS3Location;
295
294
  }
296
295
  /**
297
296
  * @public
298
- * Retrieved reference
297
+ * <p>Contains metadata about a sources cited for the generated response.</p>
299
298
  */
300
299
  export interface RetrievedReference {
301
300
  /**
302
301
  * @public
303
- * Content of a retrieval result.
302
+ * <p>Contains the cited text from the data source.</p>
304
303
  */
305
304
  content?: RetrievalResultContent;
306
305
  /**
307
306
  * @public
308
- * The source location of a retrieval result.
307
+ * <p>Contains information about the location of the data source.</p>
309
308
  */
310
309
  location?: RetrievalResultLocation;
311
310
  }
312
311
  /**
313
312
  * @public
314
- * Citation associated with the agent response
313
+ * <p>An object containing a segment of the generated response that is based on a source in the knowledge base, alongside information about the source.</p>
315
314
  */
316
315
  export interface Citation {
317
316
  /**
318
317
  * @public
319
- * Generate response part
318
+ * <p>Contains the generated response and metadata </p>
320
319
  */
321
320
  generatedResponsePart?: GeneratedResponsePart;
322
321
  /**
323
322
  * @public
324
- * list of retrieved references
323
+ * <p>Contains metadata about the sources cited for the generated response.</p>
325
324
  */
326
325
  retrievedReferences?: RetrievedReference[];
327
326
  }
328
327
  /**
329
328
  * @public
330
- * Citations associated with final agent response
329
+ * <p>Contains citations for a part of an agent response.</p>
331
330
  */
332
331
  export interface Attribution {
333
332
  /**
334
333
  * @public
335
- * List of citations
334
+ * <p>A list of citations and related information for a part of an agent response.</p>
336
335
  */
337
336
  citations?: Citation[];
338
337
  }
339
338
  /**
340
339
  * @public
341
- * Base 64 endoded byte response
340
+ * <p>Contains a part of an agent response and citations for it.</p>
342
341
  */
343
342
  export interface PayloadPart {
344
343
  /**
345
344
  * @public
346
- * PartBody of the payload in bytes
345
+ * <p>A part of the agent response in bytes.</p>
347
346
  */
348
347
  bytes?: Uint8Array;
349
348
  /**
350
349
  * @public
351
- * Citations associated with final agent response
350
+ * <p>Contains citations for a part of an agent response.</p>
352
351
  */
353
352
  attribution?: Attribution;
354
353
  }
355
354
  /**
356
355
  * @public
357
- * This exception is thrown when a resource referenced by the operation does not exist
356
+ * <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
358
357
  */
359
358
  export declare class ResourceNotFoundException extends __BaseException {
360
359
  readonly name: "ResourceNotFoundException";
@@ -366,7 +365,7 @@ export declare class ResourceNotFoundException extends __BaseException {
366
365
  }
367
366
  /**
368
367
  * @public
369
- * This exception is thrown when a request is made beyond the service quota
368
+ * <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
370
369
  */
371
370
  export declare class ServiceQuotaExceededException extends __BaseException {
372
371
  readonly name: "ServiceQuotaExceededException";
@@ -378,7 +377,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
378
377
  }
379
378
  /**
380
379
  * @public
381
- * This exception is thrown when the number of requests exceeds the limit
380
+ * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
382
381
  */
383
382
  export declare class ThrottlingException extends __BaseException {
384
383
  readonly name: "ThrottlingException";
@@ -390,17 +389,17 @@ export declare class ThrottlingException extends __BaseException {
390
389
  }
391
390
  /**
392
391
  * @public
393
- * Trace Part which is emitted when agent trace could not be generated
392
+ * <p>Contains information about the failure of the interaction.</p>
394
393
  */
395
394
  export interface FailureTrace {
396
395
  /**
397
396
  * @public
398
- * Identifier for trace
397
+ * <p>The unique identifier of the trace.</p>
399
398
  */
400
399
  traceId?: string;
401
400
  /**
402
401
  * @public
403
- * Agent Trace Failed Reason String
402
+ * <p>The reason the interaction failed.</p>
404
403
  */
405
404
  failureReason?: string;
406
405
  }
@@ -419,74 +418,74 @@ export declare const InvocationType: {
419
418
  export type InvocationType = (typeof InvocationType)[keyof typeof InvocationType];
420
419
  /**
421
420
  * @public
422
- * Input to lambda used in action group
421
+ * <p>Contains details about the knowledge base to look up and the query to be made.</p>
423
422
  */
424
423
  export interface KnowledgeBaseLookupInput {
425
424
  /**
426
425
  * @public
427
- * Agent Trace Action Group Lambda Invocation Output String
426
+ * <p>The query made to the knowledge base.</p>
428
427
  */
429
428
  text?: string;
430
429
  /**
431
430
  * @public
432
- * Agent Trace Action Group Knowledge Base Id
431
+ * <p>The unique identifier of the knowledge base to look up.</p>
433
432
  */
434
433
  knowledgeBaseId?: string;
435
434
  }
436
435
  /**
437
436
  * @public
438
- * Trace Part which contains input details for action group or knowledge base
437
+ * <p>Contains information pertaining to the action group or knowledge base that is being invoked.</p>
439
438
  */
440
439
  export interface InvocationInput {
441
440
  /**
442
441
  * @public
443
- * Identifier for trace
442
+ * <p>The unique identifier of the trace.</p>
444
443
  */
445
444
  traceId?: string;
446
445
  /**
447
446
  * @public
448
- * types of invocations
447
+ * <p>Specifies whether the agent is invoking an action group or a knowledge base.</p>
449
448
  */
450
449
  invocationType?: InvocationType;
451
450
  /**
452
451
  * @public
453
- * input to lambda used in action group
452
+ * <p>Contains information about the action group to be invoked.</p>
454
453
  */
455
454
  actionGroupInvocationInput?: ActionGroupInvocationInput;
456
455
  /**
457
456
  * @public
458
- * Input to lambda used in action group
457
+ * <p>Contains details about the knowledge base to look up and the query to be made.</p>
459
458
  */
460
459
  knowledgeBaseLookupInput?: KnowledgeBaseLookupInput;
461
460
  }
462
461
  /**
463
462
  * @public
464
- * Configurations for controlling the inference response of an InvokeAgent API call
463
+ * <p>Specifications about the inference parameters that were provided alongside the prompt. These are specified in the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html">PromptOverrideConfiguration</a> object that was set when the agent was created or updated. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters for foundation models</a>.</p>
465
464
  */
466
465
  export interface InferenceConfiguration {
467
466
  /**
468
467
  * @public
469
- * Controls randomness, higher values increase diversity
468
+ * <p>The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.</p>
470
469
  */
471
470
  temperature?: number;
472
471
  /**
473
472
  * @public
474
- * Cumulative probability cutoff for token selection
473
+ * <p>While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for <code>Top P</code> determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set <code>topP</code> to 80, the model only selects the next token from the top 80% of the probability distribution of next tokens.</p>
475
474
  */
476
475
  topP?: number;
477
476
  /**
478
477
  * @public
479
- * Sample from the k most likely next tokens
478
+ * <p>While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for <code>topK</code> is the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set <code>topK</code> to 50, the model selects the next token from among the top 50 most likely choices.</p>
480
479
  */
481
480
  topK?: number;
482
481
  /**
483
482
  * @public
484
- * Maximum length of output
483
+ * <p>The maximum number of tokens allowed in the generated response.</p>
485
484
  */
486
485
  maximumLength?: number;
487
486
  /**
488
487
  * @public
489
- * List of stop sequences
488
+ * <p>A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.</p>
490
489
  */
491
490
  stopSequences?: string[];
492
491
  }
@@ -518,64 +517,75 @@ export declare const PromptType: {
518
517
  export type PromptType = (typeof PromptType)[keyof typeof PromptType];
519
518
  /**
520
519
  * @public
521
- * Trace Part which contains information used to call Invoke Model
520
+ * <p>The input for the pre-processing step.</p>
521
+ * <ul>
522
+ * <li>
523
+ * <p>The <code>type</code> matches the agent step.</p>
524
+ * </li>
525
+ * <li>
526
+ * <p>The <code>text</code> contains the prompt.</p>
527
+ * </li>
528
+ * <li>
529
+ * <p>The <code>inferenceConfiguration</code>, <code>parserMode</code>, and <code>overrideLambda</code> values are set in the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html">PromptOverrideConfiguration</a> object that was set when the agent was created or updated.</p>
530
+ * </li>
531
+ * </ul>
522
532
  */
523
533
  export interface ModelInvocationInput {
524
534
  /**
525
535
  * @public
526
- * Identifier for trace
536
+ * <p>The unique identifier of the trace.</p>
527
537
  */
528
538
  traceId?: string;
529
539
  /**
530
540
  * @public
531
- * Prompt Message
541
+ * <p>The text that prompted the agent at this step.</p>
532
542
  */
533
543
  text?: string;
534
544
  /**
535
545
  * @public
536
- * types of prompts
546
+ * <p>The step in the agent sequence.</p>
537
547
  */
538
548
  type?: PromptType;
539
549
  /**
540
550
  * @public
541
- * Configurations for controlling the inference response of an InvokeAgent API call
551
+ * <p>Specifications about the inference parameters that were provided alongside the prompt. These are specified in the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html">PromptOverrideConfiguration</a> object that was set when the agent was created or updated. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters for foundation models</a>.</p>
542
552
  */
543
553
  inferenceConfiguration?: InferenceConfiguration;
544
554
  /**
545
555
  * @public
546
- * ARN of a Lambda.
556
+ * <p>The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence.</p>
547
557
  */
548
558
  overrideLambda?: string;
549
559
  /**
550
560
  * @public
551
- * indicates if agent uses default prompt or overriden prompt
561
+ * <p>Specifies whether the default prompt template was <code>OVERRIDDEN</code>. If it was, the <code>basePromptTemplate</code> that was set in the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html">PromptOverrideConfiguration</a> object when the agent was created or updated is used instead.</p>
552
562
  */
553
563
  promptCreationMode?: CreationMode;
554
564
  /**
555
565
  * @public
556
- * indicates if agent uses default prompt or overriden prompt
566
+ * <p>Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the <code>promptType</code>.</p>
557
567
  */
558
568
  parserMode?: CreationMode;
559
569
  }
560
570
  /**
561
571
  * @public
562
- * Agent finish output
572
+ * <p>Contains details about the response to the user.</p>
563
573
  */
564
574
  export interface FinalResponse {
565
575
  /**
566
576
  * @public
567
- * Agent Trace Action Group Lambda Invocation Output String
577
+ * <p>The text in the response to the user.</p>
568
578
  */
569
579
  text?: string;
570
580
  }
571
581
  /**
572
582
  * @public
573
- * Input to lambda used in action group
583
+ * <p>Contains details about the results from looking up the knowledge base.</p>
574
584
  */
575
585
  export interface KnowledgeBaseLookupOutput {
576
586
  /**
577
587
  * @public
578
- * list of retrieved references
588
+ * <p>Contains metadata about the sources cited for the generated response.</p>
579
589
  */
580
590
  retrievedReferences?: RetrievedReference[];
581
591
  }
@@ -594,17 +604,17 @@ export declare const Source: {
594
604
  export type Source = (typeof Source)[keyof typeof Source];
595
605
  /**
596
606
  * @public
597
- * Observation information if there were reprompts
607
+ * <p>Contains details about the agent's response to reprompt the input.</p>
598
608
  */
599
609
  export interface RepromptResponse {
600
610
  /**
601
611
  * @public
602
- * Reprompt response text
612
+ * <p>The text reprompting the input.</p>
603
613
  */
604
614
  text?: string;
605
615
  /**
606
616
  * @public
607
- * Parsing error source
617
+ * <p>Specifies what output is prompting the agent to reprompt the input.</p>
608
618
  */
609
619
  source?: Source;
610
620
  }
@@ -625,59 +635,81 @@ export declare const Type: {
625
635
  export type Type = (typeof Type)[keyof typeof Type];
626
636
  /**
627
637
  * @public
628
- * Trace Part which contains output details for action group or knowledge base or final response
638
+ * <p>Contains the result or output of an action group or knowledge base, or the response to the user.</p>
629
639
  */
630
640
  export interface Observation {
631
641
  /**
632
642
  * @public
633
- * Identifier for trace
643
+ * <p>The unique identifier of the trace.</p>
634
644
  */
635
645
  traceId?: string;
636
646
  /**
637
647
  * @public
638
- * types of observations
648
+ * <p>Specifies what kind of information the agent returns in the observation. The following values are possible.</p>
649
+ * <ul>
650
+ * <li>
651
+ * <p>
652
+ * <code>ACTION_GROUP</code> – The agent returns the result of an action group.</p>
653
+ * </li>
654
+ * <li>
655
+ * <p>
656
+ * <code>KNOWLEDGE_BASE</code> – The agent returns information from a knowledge base.</p>
657
+ * </li>
658
+ * <li>
659
+ * <p>
660
+ * <code>FINISH</code> – The agent returns a final response to the user with no follow-up.</p>
661
+ * </li>
662
+ * <li>
663
+ * <p>
664
+ * <code>ASK_USER</code> – The agent asks the user a question.</p>
665
+ * </li>
666
+ * <li>
667
+ * <p>
668
+ * <code>REPROMPT</code> – The agent prompts the user again for the same information.</p>
669
+ * </li>
670
+ * </ul>
639
671
  */
640
672
  type?: Type;
641
673
  /**
642
674
  * @public
643
- * output from lambda used in action group
675
+ * <p>Contains the JSON-formatted string returned by the API invoked by the action group.</p>
644
676
  */
645
677
  actionGroupInvocationOutput?: ActionGroupInvocationOutput;
646
678
  /**
647
679
  * @public
648
- * Input to lambda used in action group
680
+ * <p>Contains details about the results from looking up the knowledge base.</p>
649
681
  */
650
682
  knowledgeBaseLookupOutput?: KnowledgeBaseLookupOutput;
651
683
  /**
652
684
  * @public
653
- * Agent finish output
685
+ * <p>Contains details about the response to the user.</p>
654
686
  */
655
687
  finalResponse?: FinalResponse;
656
688
  /**
657
689
  * @public
658
- * Observation information if there were reprompts
690
+ * <p>Contains details about the response to reprompt the input.</p>
659
691
  */
660
692
  repromptResponse?: RepromptResponse;
661
693
  }
662
694
  /**
663
695
  * @public
664
- * Trace Part which contains information related to reasoning
696
+ * <p>Contains the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.</p>
665
697
  */
666
698
  export interface Rationale {
667
699
  /**
668
700
  * @public
669
- * Identifier for trace
701
+ * <p>The unique identifier of the trace step.</p>
670
702
  */
671
703
  traceId?: string;
672
704
  /**
673
705
  * @public
674
- * Agent Trace Rationale String
706
+ * <p>The reasoning or thought process of the agent, based on the input.</p>
675
707
  */
676
708
  text?: string;
677
709
  }
678
710
  /**
679
711
  * @public
680
- * Trace contains intermidate response during orchestration
712
+ * <p>Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.</p>
681
713
  */
682
714
  export type OrchestrationTrace = OrchestrationTrace.InvocationInputMember | OrchestrationTrace.ModelInvocationInputMember | OrchestrationTrace.ObservationMember | OrchestrationTrace.RationaleMember | OrchestrationTrace.$UnknownMember;
683
715
  /**
@@ -686,7 +718,7 @@ export type OrchestrationTrace = OrchestrationTrace.InvocationInputMember | Orch
686
718
  export declare namespace OrchestrationTrace {
687
719
  /**
688
720
  * @public
689
- * Trace Part which contains information related to reasoning
721
+ * <p>Details about the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.</p>
690
722
  */
691
723
  interface RationaleMember {
692
724
  rationale: Rationale;
@@ -697,7 +729,7 @@ export declare namespace OrchestrationTrace {
697
729
  }
698
730
  /**
699
731
  * @public
700
- * Trace Part which contains input details for action group or knowledge base
732
+ * <p>Contains information pertaining to the action group or knowledge base that is being invoked.</p>
701
733
  */
702
734
  interface InvocationInputMember {
703
735
  rationale?: never;
@@ -708,7 +740,7 @@ export declare namespace OrchestrationTrace {
708
740
  }
709
741
  /**
710
742
  * @public
711
- * Trace Part which contains output details for action group or knowledge base or final response
743
+ * <p>Details about the observation (the output of the action group Lambda or knowledge base) made by the agent.</p>
712
744
  */
713
745
  interface ObservationMember {
714
746
  rationale?: never;
@@ -719,7 +751,18 @@ export declare namespace OrchestrationTrace {
719
751
  }
720
752
  /**
721
753
  * @public
722
- * Trace Part which contains information used to call Invoke Model
754
+ * <p>The input for the orchestration step.</p>
755
+ * <ul>
756
+ * <li>
757
+ * <p>The <code>type</code> is <code>ORCHESTRATION</code>.</p>
758
+ * </li>
759
+ * <li>
760
+ * <p>The <code>text</code> contains the prompt.</p>
761
+ * </li>
762
+ * <li>
763
+ * <p>The <code>inferenceConfiguration</code>, <code>parserMode</code>, and <code>overrideLambda</code> values are set in the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html">PromptOverrideConfiguration</a> object that was set when the agent was created or updated.</p>
764
+ * </li>
765
+ * </ul>
723
766
  */
724
767
  interface ModelInvocationInputMember {
725
768
  rationale?: never;
@@ -749,34 +792,34 @@ export declare namespace OrchestrationTrace {
749
792
  }
750
793
  /**
751
794
  * @public
752
- * Trace Part which contains information if preprocessing was successful
795
+ * <p>Details about the response from the Lambda parsing of the output from the post-processing step.</p>
753
796
  */
754
797
  export interface PostProcessingParsedResponse {
755
798
  /**
756
799
  * @public
757
- * Agent Trace Output String
800
+ * <p>The text returned by the parser.</p>
758
801
  */
759
802
  text?: string;
760
803
  }
761
804
  /**
762
805
  * @public
763
- * Trace Part which contains information related to postprocessing
806
+ * <p>The foundation model output from the post-processing step.</p>
764
807
  */
765
808
  export interface PostProcessingModelInvocationOutput {
766
809
  /**
767
810
  * @public
768
- * Identifier for trace
811
+ * <p>The unique identifier of the trace.</p>
769
812
  */
770
813
  traceId?: string;
771
814
  /**
772
815
  * @public
773
- * Trace Part which contains information if preprocessing was successful
816
+ * <p>Details about the response from the Lambda parsing of the output of the post-processing step.</p>
774
817
  */
775
818
  parsedResponse?: PostProcessingParsedResponse;
776
819
  }
777
820
  /**
778
821
  * @public
779
- * Trace Part which contains information related to post processing step
822
+ * <p>Details about the post-processing step, in which the agent shapes the response.</p>
780
823
  */
781
824
  export type PostProcessingTrace = PostProcessingTrace.ModelInvocationInputMember | PostProcessingTrace.ModelInvocationOutputMember | PostProcessingTrace.$UnknownMember;
782
825
  /**
@@ -785,7 +828,18 @@ export type PostProcessingTrace = PostProcessingTrace.ModelInvocationInputMember
785
828
  export declare namespace PostProcessingTrace {
786
829
  /**
787
830
  * @public
788
- * Trace Part which contains information used to call Invoke Model
831
+ * <p>The input for the post-processing step.</p>
832
+ * <ul>
833
+ * <li>
834
+ * <p>The <code>type</code> is <code>POST_PROCESSING</code>.</p>
835
+ * </li>
836
+ * <li>
837
+ * <p>The <code>text</code> contains the prompt.</p>
838
+ * </li>
839
+ * <li>
840
+ * <p>The <code>inferenceConfiguration</code>, <code>parserMode</code>, and <code>overrideLambda</code> values are set in the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html">PromptOverrideConfiguration</a> object that was set when the agent was created or updated.</p>
841
+ * </li>
842
+ * </ul>
789
843
  */
790
844
  interface ModelInvocationInputMember {
791
845
  modelInvocationInput: ModelInvocationInput;
@@ -794,7 +848,7 @@ export declare namespace PostProcessingTrace {
794
848
  }
795
849
  /**
796
850
  * @public
797
- * Trace Part which contains information related to postprocessing
851
+ * <p>The foundation model output from the post-processing step.</p>
798
852
  */
799
853
  interface ModelInvocationOutputMember {
800
854
  modelInvocationInput?: never;
@@ -818,39 +872,39 @@ export declare namespace PostProcessingTrace {
818
872
  }
819
873
  /**
820
874
  * @public
821
- * Trace Part which contains information if preprocessing was successful
875
+ * <p>Details about the response from the Lambda parsing of the output from the pre-processing step.</p>
822
876
  */
823
877
  export interface PreProcessingParsedResponse {
824
878
  /**
825
879
  * @public
826
- * Agent Trace Rationale String
880
+ * <p>The text returned by the parsing of the pre-processing step, explaining the steps that the agent plans to take in orchestration, if the user input is valid.</p>
827
881
  */
828
882
  rationale?: string;
829
883
  /**
830
884
  * @public
831
- * Boolean value
885
+ * <p>Whether the user input is valid or not. If <code>false</code>, the agent doesn't proceed to orchestration.</p>
832
886
  */
833
887
  isValid?: boolean;
834
888
  }
835
889
  /**
836
890
  * @public
837
- * Trace Part which contains information related to preprocessing
891
+ * <p>The foundation model output from the pre-processing step.</p>
838
892
  */
839
893
  export interface PreProcessingModelInvocationOutput {
840
894
  /**
841
895
  * @public
842
- * Identifier for trace
896
+ * <p>The unique identifier of the trace.</p>
843
897
  */
844
898
  traceId?: string;
845
899
  /**
846
900
  * @public
847
- * Trace Part which contains information if preprocessing was successful
901
+ * <p>Details about the response from the Lambda parsing of the output of the pre-processing step.</p>
848
902
  */
849
903
  parsedResponse?: PreProcessingParsedResponse;
850
904
  }
851
905
  /**
852
906
  * @public
853
- * Trace Part which contains information related to preprocessing step
907
+ * <p>Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.</p>
854
908
  */
855
909
  export type PreProcessingTrace = PreProcessingTrace.ModelInvocationInputMember | PreProcessingTrace.ModelInvocationOutputMember | PreProcessingTrace.$UnknownMember;
856
910
  /**
@@ -859,7 +913,18 @@ export type PreProcessingTrace = PreProcessingTrace.ModelInvocationInputMember |
859
913
  export declare namespace PreProcessingTrace {
860
914
  /**
861
915
  * @public
862
- * Trace Part which contains information used to call Invoke Model
916
+ * <p>The input for the pre-processing step.</p>
917
+ * <ul>
918
+ * <li>
919
+ * <p>The <code>type</code> is <code>PRE_PROCESSING</code>.</p>
920
+ * </li>
921
+ * <li>
922
+ * <p>The <code>text</code> contains the prompt.</p>
923
+ * </li>
924
+ * <li>
925
+ * <p>The <code>inferenceConfiguration</code>, <code>parserMode</code>, and <code>overrideLambda</code> values are set in the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html">PromptOverrideConfiguration</a> object that was set when the agent was created or updated.</p>
926
+ * </li>
927
+ * </ul>
863
928
  */
864
929
  interface ModelInvocationInputMember {
865
930
  modelInvocationInput: ModelInvocationInput;
@@ -868,7 +933,7 @@ export declare namespace PreProcessingTrace {
868
933
  }
869
934
  /**
870
935
  * @public
871
- * Trace Part which contains information related to preprocessing
936
+ * <p>The foundation model output from the pre-processing step.</p>
872
937
  */
873
938
  interface ModelInvocationOutputMember {
874
939
  modelInvocationInput?: never;
@@ -892,7 +957,7 @@ export declare namespace PreProcessingTrace {
892
957
  }
893
958
  /**
894
959
  * @public
895
- * Trace contains intermidate response for customer
960
+ * <p>Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-enablement">Trace enablement</a>.</p>
896
961
  */
897
962
  export type Trace = Trace.FailureTraceMember | Trace.OrchestrationTraceMember | Trace.PostProcessingTraceMember | Trace.PreProcessingTraceMember | Trace.$UnknownMember;
898
963
  /**
@@ -901,7 +966,7 @@ export type Trace = Trace.FailureTraceMember | Trace.OrchestrationTraceMember |
901
966
  export declare namespace Trace {
902
967
  /**
903
968
  * @public
904
- * Trace Part which contains information related to preprocessing step
969
+ * <p>Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.</p>
905
970
  */
906
971
  interface PreProcessingTraceMember {
907
972
  preProcessingTrace: PreProcessingTrace;
@@ -912,7 +977,7 @@ export declare namespace Trace {
912
977
  }
913
978
  /**
914
979
  * @public
915
- * Trace contains intermidate response during orchestration
980
+ * <p>Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.</p>
916
981
  */
917
982
  interface OrchestrationTraceMember {
918
983
  preProcessingTrace?: never;
@@ -923,7 +988,7 @@ export declare namespace Trace {
923
988
  }
924
989
  /**
925
990
  * @public
926
- * Trace Part which contains information related to post processing step
991
+ * <p>Details about the post-processing step, in which the agent shapes the response..</p>
927
992
  */
928
993
  interface PostProcessingTraceMember {
929
994
  preProcessingTrace?: never;
@@ -934,7 +999,7 @@ export declare namespace Trace {
934
999
  }
935
1000
  /**
936
1001
  * @public
937
- * Trace Part which is emitted when agent trace could not be generated
1002
+ * <p>Contains information about the failure of the interaction.</p>
938
1003
  */
939
1004
  interface FailureTraceMember {
940
1005
  preProcessingTrace?: never;
@@ -964,33 +1029,33 @@ export declare namespace Trace {
964
1029
  }
965
1030
  /**
966
1031
  * @public
967
- * Trace Part which contains intermidate response for customer
1032
+ * <p>Contains information about the agent and session, alongside the agent's reasoning process and results from calling API actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-enablement">Trace enablement</a>.</p>
968
1033
  */
969
1034
  export interface TracePart {
970
1035
  /**
971
1036
  * @public
972
- * Identifier of the agent.
1037
+ * <p>The unique identifier of the agent.</p>
973
1038
  */
974
1039
  agentId?: string;
975
1040
  /**
976
1041
  * @public
977
- * Identifier of the agent alias.
1042
+ * <p>The unique identifier of the alias of the agent.</p>
978
1043
  */
979
1044
  agentAliasId?: string;
980
1045
  /**
981
1046
  * @public
982
- * Identifier of the session.
1047
+ * <p>The unique identifier of the session with the agent.</p>
983
1048
  */
984
1049
  sessionId?: string;
985
1050
  /**
986
1051
  * @public
987
- * Trace contains intermidate response for customer
1052
+ * <p>Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-enablement">Trace enablement</a>.</p>
988
1053
  */
989
1054
  trace?: Trace;
990
1055
  }
991
1056
  /**
992
1057
  * @public
993
- * This exception is thrown when the request's input validation fails
1058
+ * <p>Input validation failed. Check your request parameters and retry the request.</p>
994
1059
  */
995
1060
  export declare class ValidationException extends __BaseException {
996
1061
  readonly name: "ValidationException";
@@ -1002,7 +1067,7 @@ export declare class ValidationException extends __BaseException {
1002
1067
  }
1003
1068
  /**
1004
1069
  * @public
1005
- * Response body of is a stream
1070
+ * <p>The response from invoking the agent and associated citations and trace information.</p>
1006
1071
  */
1007
1072
  export type ResponseStream = ResponseStream.AccessDeniedExceptionMember | ResponseStream.BadGatewayExceptionMember | ResponseStream.ChunkMember | ResponseStream.ConflictExceptionMember | ResponseStream.DependencyFailedExceptionMember | ResponseStream.InternalServerExceptionMember | ResponseStream.ResourceNotFoundExceptionMember | ResponseStream.ServiceQuotaExceededExceptionMember | ResponseStream.ThrottlingExceptionMember | ResponseStream.TraceMember | ResponseStream.ValidationExceptionMember | ResponseStream.$UnknownMember;
1008
1073
  /**
@@ -1011,7 +1076,7 @@ export type ResponseStream = ResponseStream.AccessDeniedExceptionMember | Respon
1011
1076
  export declare namespace ResponseStream {
1012
1077
  /**
1013
1078
  * @public
1014
- * Base 64 endoded byte response
1079
+ * <p>Contains a part of an agent response and citations for it.</p>
1015
1080
  */
1016
1081
  interface ChunkMember {
1017
1082
  chunk: PayloadPart;
@@ -1029,7 +1094,7 @@ export declare namespace ResponseStream {
1029
1094
  }
1030
1095
  /**
1031
1096
  * @public
1032
- * Trace Part which contains intermidate response for customer
1097
+ * <p>Contains information about the agent and session, alongside the agent's reasoning process and results from calling API actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/trace-events.html">Trace events</a>.</p>
1033
1098
  */
1034
1099
  interface TraceMember {
1035
1100
  chunk?: never;
@@ -1047,7 +1112,7 @@ export declare namespace ResponseStream {
1047
1112
  }
1048
1113
  /**
1049
1114
  * @public
1050
- * This exception is thrown if there was an unexpected error during processing of request
1115
+ * <p>An internal server error occurred. Retry your request.</p>
1051
1116
  */
1052
1117
  interface InternalServerExceptionMember {
1053
1118
  chunk?: never;
@@ -1065,7 +1130,7 @@ export declare namespace ResponseStream {
1065
1130
  }
1066
1131
  /**
1067
1132
  * @public
1068
- * This exception is thrown when the request's input validation fails
1133
+ * <p>Input validation failed. Check your request parameters and retry the request.</p>
1069
1134
  */
1070
1135
  interface ValidationExceptionMember {
1071
1136
  chunk?: never;
@@ -1083,7 +1148,7 @@ export declare namespace ResponseStream {
1083
1148
  }
1084
1149
  /**
1085
1150
  * @public
1086
- * This exception is thrown when a resource referenced by the operation does not exist
1151
+ * <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
1087
1152
  */
1088
1153
  interface ResourceNotFoundExceptionMember {
1089
1154
  chunk?: never;
@@ -1101,7 +1166,7 @@ export declare namespace ResponseStream {
1101
1166
  }
1102
1167
  /**
1103
1168
  * @public
1104
- * This exception is thrown when a request is made beyond the service quota
1169
+ * <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
1105
1170
  */
1106
1171
  interface ServiceQuotaExceededExceptionMember {
1107
1172
  chunk?: never;
@@ -1119,7 +1184,7 @@ export declare namespace ResponseStream {
1119
1184
  }
1120
1185
  /**
1121
1186
  * @public
1122
- * This exception is thrown when the number of requests exceeds the limit
1187
+ * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
1123
1188
  */
1124
1189
  interface ThrottlingExceptionMember {
1125
1190
  chunk?: never;
@@ -1137,7 +1202,7 @@ export declare namespace ResponseStream {
1137
1202
  }
1138
1203
  /**
1139
1204
  * @public
1140
- * This exception is thrown when a request is denied per access permissions
1205
+ * <p>The request is denied because of missing access permissions. Check your permissions and retry your request.</p>
1141
1206
  */
1142
1207
  interface AccessDeniedExceptionMember {
1143
1208
  chunk?: never;
@@ -1155,7 +1220,7 @@ export declare namespace ResponseStream {
1155
1220
  }
1156
1221
  /**
1157
1222
  * @public
1158
- * This exception is thrown when there is a conflict performing an operation
1223
+ * <p>There was a conflict performing an operation. Resolve the conflict and retry your request.</p>
1159
1224
  */
1160
1225
  interface ConflictExceptionMember {
1161
1226
  chunk?: never;
@@ -1173,7 +1238,7 @@ export declare namespace ResponseStream {
1173
1238
  }
1174
1239
  /**
1175
1240
  * @public
1176
- * This exception is thrown when a request fails due to dependency like Lambda, Bedrock, STS resource due to a customer fault (i.e. bad configuration)
1241
+ * <p>There was an issue with a dependency. Check the resource configurations and retry the request.</p>
1177
1242
  */
1178
1243
  interface DependencyFailedExceptionMember {
1179
1244
  chunk?: never;
@@ -1191,7 +1256,7 @@ export declare namespace ResponseStream {
1191
1256
  }
1192
1257
  /**
1193
1258
  * @public
1194
- * This exception is thrown when a request fails due to dependency like Lambda, Bedrock, STS resource
1259
+ * <p>There was an issue with a dependency due to a server issue. Retry your request.</p>
1195
1260
  */
1196
1261
  interface BadGatewayExceptionMember {
1197
1262
  chunk?: never;
@@ -1242,33 +1307,32 @@ export declare namespace ResponseStream {
1242
1307
  }
1243
1308
  /**
1244
1309
  * @public
1245
- * InvokeAgent Response
1246
1310
  */
1247
1311
  export interface InvokeAgentResponse {
1248
1312
  /**
1249
1313
  * @public
1250
- * Inference response from the model in the format specified in the Content-Type response header.
1314
+ * <p>The agent's response to the user prompt.</p>
1251
1315
  */
1252
1316
  completion: AsyncIterable<ResponseStream> | undefined;
1253
1317
  /**
1254
1318
  * @public
1255
- * streaming response mimetype of the model
1319
+ * <p>The MIME type of the input data in the request. The default value is <code>application/json</code>.</p>
1256
1320
  */
1257
1321
  contentType: string | undefined;
1258
1322
  /**
1259
1323
  * @public
1260
- * streaming response mimetype of the model
1324
+ * <p>The unique identifier of the session with the agent.</p>
1261
1325
  */
1262
1326
  sessionId: string | undefined;
1263
1327
  }
1264
1328
  /**
1265
1329
  * @public
1266
- * Customer input of the turn
1330
+ * <p>Contains the query made to the knowledge base.</p>
1267
1331
  */
1268
1332
  export interface RetrieveAndGenerateInput {
1269
1333
  /**
1270
1334
  * @public
1271
- * Customer input of the turn in text
1335
+ * <p>The query made to the knowledge base.</p>
1272
1336
  */
1273
1337
  text: string | undefined;
1274
1338
  }
@@ -1286,49 +1350,65 @@ export declare const SearchType: {
1286
1350
  export type SearchType = (typeof SearchType)[keyof typeof SearchType];
1287
1351
  /**
1288
1352
  * @public
1289
- * Knowledge base vector search configuration
1353
+ * <p>Configurations for how to carry out the search.</p>
1290
1354
  */
1291
1355
  export interface KnowledgeBaseVectorSearchConfiguration {
1292
1356
  /**
1293
1357
  * @public
1294
- * Top-K results to retrieve from knowledge base.
1358
+ * <p>The number of results to return.</p>
1359
+ * <note>
1360
+ * <p>The <code>numberOfResults</code> field is currently unsupported for <code>RetrieveAndGenerate</code>. Don't include it in this field if you are sending a <code>RetrieveAndGenerate</code> request.</p>
1361
+ * </note>
1295
1362
  */
1296
1363
  numberOfResults?: number;
1297
1364
  /**
1298
1365
  * @public
1299
- * Override the type of query to be performed on data store
1366
+ * <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>
1300
1367
  */
1301
1368
  overrideSearchType?: SearchType;
1302
1369
  }
1303
1370
  /**
1304
1371
  * @public
1305
- * Search parameters for retrieving from knowledge base.
1372
+ * <p>Contains details about how the results should be returned.</p>
1373
+ * <p>This data type is used in the following API operations:</p>
1374
+ * <ul>
1375
+ * <li>
1376
+ * <p>
1377
+ * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax">Retrieve request body</a>
1378
+ * </p>
1379
+ * </li>
1380
+ * <li>
1381
+ * <p>
1382
+ * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax">RetrieveAndGenerate request body</a>
1383
+ * </p>
1384
+ * </li>
1385
+ * </ul>
1306
1386
  */
1307
1387
  export interface KnowledgeBaseRetrievalConfiguration {
1308
1388
  /**
1309
1389
  * @public
1310
- * Knowledge base vector search configuration
1390
+ * <p>Contains details about how the results from the vector search should be returned.</p>
1311
1391
  */
1312
1392
  vectorSearchConfiguration: KnowledgeBaseVectorSearchConfiguration | undefined;
1313
1393
  }
1314
1394
  /**
1315
1395
  * @public
1316
- * Configurations for retrieval and generation for knowledge base.
1396
+ * <p>Contains details about the resource being queried.</p>
1317
1397
  */
1318
1398
  export interface KnowledgeBaseRetrieveAndGenerateConfiguration {
1319
1399
  /**
1320
1400
  * @public
1321
- * Identifier of the KnowledgeBase
1401
+ * <p>The unique identifier of the knowledge base that is queried and the foundation model used for generation.</p>
1322
1402
  */
1323
1403
  knowledgeBaseId: string | undefined;
1324
1404
  /**
1325
1405
  * @public
1326
- * Arn of a Bedrock model.
1406
+ * <p>The ARN of the foundation model used to generate a response.</p>
1327
1407
  */
1328
1408
  modelArn: string | undefined;
1329
1409
  /**
1330
1410
  * @public
1331
- * Search parameters for retrieving from knowledge base.
1411
+ * <p>Contains configurations for how to retrieve and return the knowledge base query.</p>
1332
1412
  */
1333
1413
  retrievalConfiguration?: KnowledgeBaseRetrievalConfiguration;
1334
1414
  }
@@ -1345,28 +1425,28 @@ export declare const RetrieveAndGenerateType: {
1345
1425
  export type RetrieveAndGenerateType = (typeof RetrieveAndGenerateType)[keyof typeof RetrieveAndGenerateType];
1346
1426
  /**
1347
1427
  * @public
1348
- * Configures the retrieval and generation for the session.
1428
+ * <p>Contains details about the resource being queried.</p>
1349
1429
  */
1350
1430
  export interface RetrieveAndGenerateConfiguration {
1351
1431
  /**
1352
1432
  * @public
1353
- * The type of RetrieveAndGenerate.
1433
+ * <p>The type of resource that is queried by the request.</p>
1354
1434
  */
1355
1435
  type: RetrieveAndGenerateType | undefined;
1356
1436
  /**
1357
1437
  * @public
1358
- * Configurations for retrieval and generation for knowledge base.
1438
+ * <p>Contains details about the resource being queried.</p>
1359
1439
  */
1360
1440
  knowledgeBaseConfiguration?: KnowledgeBaseRetrieveAndGenerateConfiguration;
1361
1441
  }
1362
1442
  /**
1363
1443
  * @public
1364
- * Configures common parameters of the session.
1444
+ * <p>Contains configuration about the session with the knowledge base.</p>
1365
1445
  */
1366
1446
  export interface RetrieveAndGenerateSessionConfiguration {
1367
1447
  /**
1368
1448
  * @public
1369
- * The KMS key arn to encrypt the customer data of the session.
1449
+ * <p>The ARN of the KMS key encrypting the session.</p>
1370
1450
  */
1371
1451
  kmsKeyArn: string | undefined;
1372
1452
  }
@@ -1376,33 +1456,33 @@ export interface RetrieveAndGenerateSessionConfiguration {
1376
1456
  export interface RetrieveAndGenerateRequest {
1377
1457
  /**
1378
1458
  * @public
1379
- * Identifier of the session.
1459
+ * <p>The unique identifier of the session. Reuse the same value to continue the same session with the knowledge base.</p>
1380
1460
  */
1381
1461
  sessionId?: string;
1382
1462
  /**
1383
1463
  * @public
1384
- * Customer input of the turn
1464
+ * <p>Contains the query made to the knowledge base.</p>
1385
1465
  */
1386
1466
  input: RetrieveAndGenerateInput | undefined;
1387
1467
  /**
1388
1468
  * @public
1389
- * Configures the retrieval and generation for the session.
1469
+ * <p>Contains details about the resource being queried and the foundation model used for generation.</p>
1390
1470
  */
1391
1471
  retrieveAndGenerateConfiguration?: RetrieveAndGenerateConfiguration;
1392
1472
  /**
1393
1473
  * @public
1394
- * Configures common parameters of the session.
1474
+ * <p>Contains details about the session with the knowledge base.</p>
1395
1475
  */
1396
1476
  sessionConfiguration?: RetrieveAndGenerateSessionConfiguration;
1397
1477
  }
1398
1478
  /**
1399
1479
  * @public
1400
- * Service response of the turn
1480
+ * <p>Contains the response generated from querying the knowledge base.</p>
1401
1481
  */
1402
1482
  export interface RetrieveAndGenerateOutput {
1403
1483
  /**
1404
1484
  * @public
1405
- * Service response of the turn in text
1485
+ * <p>The response generated from querying the knowledge base.</p>
1406
1486
  */
1407
1487
  text: string | undefined;
1408
1488
  }
@@ -1412,28 +1492,28 @@ export interface RetrieveAndGenerateOutput {
1412
1492
  export interface RetrieveAndGenerateResponse {
1413
1493
  /**
1414
1494
  * @public
1415
- * Identifier of the session.
1495
+ * <p>The unique identifier of the session. Reuse the same value to continue the same session with the knowledge base.</p>
1416
1496
  */
1417
1497
  sessionId: string | undefined;
1418
1498
  /**
1419
1499
  * @public
1420
- * Service response of the turn
1500
+ * <p>Contains the response generated from querying the knowledge base.</p>
1421
1501
  */
1422
1502
  output: RetrieveAndGenerateOutput | undefined;
1423
1503
  /**
1424
1504
  * @public
1425
- * List of citations
1505
+ * <p>A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.</p>
1426
1506
  */
1427
1507
  citations?: Citation[];
1428
1508
  }
1429
1509
  /**
1430
1510
  * @public
1431
- * Knowledge base input query.
1511
+ * <p>Contains the query made to the knowledge base.</p>
1432
1512
  */
1433
1513
  export interface KnowledgeBaseQuery {
1434
1514
  /**
1435
1515
  * @public
1436
- * Knowledge base input query in text
1516
+ * <p>The text of the query made to the knowledge base.</p>
1437
1517
  */
1438
1518
  text: string | undefined;
1439
1519
  }
@@ -1443,43 +1523,43 @@ export interface KnowledgeBaseQuery {
1443
1523
  export interface RetrieveRequest {
1444
1524
  /**
1445
1525
  * @public
1446
- * Identifier of the KnowledgeBase
1526
+ * <p>The unique identifier of the knowledge base to query.</p>
1447
1527
  */
1448
1528
  knowledgeBaseId: string | undefined;
1449
1529
  /**
1450
1530
  * @public
1451
- * Knowledge base input query.
1531
+ * <p>The query to send the knowledge base.</p>
1452
1532
  */
1453
1533
  retrievalQuery: KnowledgeBaseQuery | undefined;
1454
1534
  /**
1455
1535
  * @public
1456
- * Search parameters for retrieving from knowledge base.
1536
+ * <p>Contains details about how the results should be returned.</p>
1457
1537
  */
1458
1538
  retrievalConfiguration?: KnowledgeBaseRetrievalConfiguration;
1459
1539
  /**
1460
1540
  * @public
1461
- * Opaque continuation token of previous paginated response.
1541
+ * <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>
1462
1542
  */
1463
1543
  nextToken?: string;
1464
1544
  }
1465
1545
  /**
1466
1546
  * @public
1467
- * Result item returned from a knowledge base retrieval.
1547
+ * <p>Details about a result from querying the knowledge base.</p>
1468
1548
  */
1469
1549
  export interface KnowledgeBaseRetrievalResult {
1470
1550
  /**
1471
1551
  * @public
1472
- * Content of a retrieval result.
1552
+ * <p>Contains a chunk of text from a data source in the knowledge base.</p>
1473
1553
  */
1474
1554
  content: RetrievalResultContent | undefined;
1475
1555
  /**
1476
1556
  * @public
1477
- * The source location of a retrieval result.
1557
+ * <p>Contains information about the location of the data source.</p>
1478
1558
  */
1479
1559
  location?: RetrievalResultLocation;
1480
1560
  /**
1481
1561
  * @public
1482
- * The relevance score of a result.
1562
+ * <p>The level of relevance of the result to the query.</p>
1483
1563
  */
1484
1564
  score?: number;
1485
1565
  }
@@ -1489,12 +1569,12 @@ export interface KnowledgeBaseRetrievalResult {
1489
1569
  export interface RetrieveResponse {
1490
1570
  /**
1491
1571
  * @public
1492
- * List of knowledge base retrieval results
1572
+ * <p>A list of results from querying the knowledge base.</p>
1493
1573
  */
1494
1574
  retrievalResults: KnowledgeBaseRetrievalResult[] | undefined;
1495
1575
  /**
1496
1576
  * @public
1497
- * Opaque continuation token of previous paginated response.
1577
+ * <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>
1498
1578
  */
1499
1579
  nextToken?: string;
1500
1580
  }