@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.
- package/dist-cjs/index.js +345 -345
- package/dist-es/index.js +2 -1
- package/dist-es/models/enums.js +330 -0
- package/dist-es/models/errors.js +127 -0
- package/dist-es/models/models_0.js +1 -431
- package/dist-es/schemas/schemas_0.js +1 -1
- package/dist-types/commands/CreateInvocationCommand.d.ts +1 -1
- package/dist-types/commands/CreateSessionCommand.d.ts +1 -1
- package/dist-types/commands/DeleteSessionCommand.d.ts +1 -1
- package/dist-types/commands/EndSessionCommand.d.ts +1 -1
- package/dist-types/commands/GetInvocationStepCommand.d.ts +1 -1
- package/dist-types/commands/GetSessionCommand.d.ts +1 -1
- package/dist-types/commands/InvokeAgentCommand.d.ts +1 -2
- package/dist-types/commands/InvokeInlineAgentCommand.d.ts +1 -2
- package/dist-types/commands/ListInvocationStepsCommand.d.ts +1 -1
- package/dist-types/commands/ListInvocationsCommand.d.ts +1 -1
- package/dist-types/commands/ListSessionsCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/commands/PutInvocationStepCommand.d.ts +1 -1
- package/dist-types/commands/RetrieveAndGenerateCommand.d.ts +1 -1
- package/dist-types/commands/RetrieveAndGenerateStreamCommand.d.ts +1 -1
- package/dist-types/commands/RetrieveCommand.d.ts +1 -1
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateSessionCommand.d.ts +1 -1
- package/dist-types/index.d.ts +3 -1
- package/dist-types/models/enums.d.ts +850 -0
- package/dist-types/models/errors.d.ts +137 -0
- package/dist-types/models/models_0.d.ts +2078 -914
- package/dist-types/ts3.4/commands/CreateInvocationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateSessionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteSessionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/EndSessionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetInvocationStepCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetSessionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/InvokeAgentCommand.d.ts +1 -2
- package/dist-types/ts3.4/commands/InvokeInlineAgentCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/ListInvocationStepsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListInvocationsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListSessionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PutInvocationStepCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/RetrieveAndGenerateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/RetrieveAndGenerateStreamCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/RetrieveCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateSessionCommand.d.ts +1 -1
- package/dist-types/ts3.4/index.d.ts +3 -1
- package/dist-types/ts3.4/models/enums.d.ts +442 -0
- package/dist-types/ts3.4/models/errors.d.ts +73 -0
- package/dist-types/ts3.4/models/models_0.d.ts +968 -479
- package/package.json +19 -19
- package/dist-es/models/index.js +0 -2
- package/dist-es/models/models_1.js +0 -26
- package/dist-types/models/index.d.ts +0 -2
- package/dist-types/models/models_1.d.ts +0 -2151
- package/dist-types/ts3.4/models/index.d.ts +0 -2
- package/dist-types/ts3.4/models/models_1.d.ts +0 -969
|
@@ -1,29 +1,6 @@
|
|
|
1
|
-
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
1
|
import { DocumentType as __DocumentType } from "@smithy/types";
|
|
3
|
-
import {
|
|
4
|
-
|
|
5
|
-
* <p>The request is denied because of missing access permissions. Check your permissions and retry your request.</p>
|
|
6
|
-
* @public
|
|
7
|
-
*/
|
|
8
|
-
export declare class AccessDeniedException extends __BaseException {
|
|
9
|
-
readonly name: "AccessDeniedException";
|
|
10
|
-
readonly $fault: "client";
|
|
11
|
-
/**
|
|
12
|
-
* @internal
|
|
13
|
-
*/
|
|
14
|
-
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
15
|
-
}
|
|
16
|
-
/**
|
|
17
|
-
* @public
|
|
18
|
-
* @enum
|
|
19
|
-
*/
|
|
20
|
-
export declare const CustomControlMethod: {
|
|
21
|
-
readonly RETURN_CONTROL: "RETURN_CONTROL";
|
|
22
|
-
};
|
|
23
|
-
/**
|
|
24
|
-
* @public
|
|
25
|
-
*/
|
|
26
|
-
export type CustomControlMethod = (typeof CustomControlMethod)[keyof typeof CustomControlMethod];
|
|
2
|
+
import { ActionGroupSignature, ActionInvocationType, AgentCollaboration, AttributeType, ConfirmationState, ConversationRole, CreationMode, CustomControlMethod, ExecutionType, ExternalSourceType, FileSourceType, FileUseCase, FlowCompletionReason, FlowControlNodeType, FlowErrorCode, FlowExecutionErrorType, FlowExecutionEventType, FlowExecutionStatus, FlowNodeInputCategory, FlowNodeIODataType, GeneratedQueryType, GuadrailAction, GuardrailAction, GuardrailContentFilterConfidence, GuardrailContentFilterType, GuardrailContentPolicyAction, GuardrailManagedWordType, GuardrailPiiEntityType, GuardrailSensitiveInformationPolicyAction, GuardrailTopicPolicyAction, GuardrailTopicType, GuardrailWordPolicyAction, ImageFormat, ImageInputFormat, InputQueryType, InvocationType, MemoryType, NodeErrorCode, NodeType, OrchestrationType, ParameterType, PayloadType, PerformanceConfigLatency, PromptState, PromptType, QueryTransformationMode, QueryTransformationType, RelayConversationHistory, RequireConfirmation, RerankDocumentType, RerankingConfigurationType, RerankingMetadataSelectionMode, RerankQueryContentType, RerankSourceType, ResponseState, RetrievalResultContentColumnType, RetrievalResultContentType, RetrievalResultLocationType, RetrieveAndGenerateType, SearchType, SessionStatus, Source, TextToSqlConfigurationType, Type, VectorSearchRerankingConfigurationType } from "./enums";
|
|
3
|
+
import { AccessDeniedException, BadGatewayException, ConflictException, DependencyFailedException, InternalServerException, ModelNotReadyException, ResourceNotFoundException, ServiceQuotaExceededException, ThrottlingException, ValidationException } from "./errors";
|
|
27
4
|
/**
|
|
28
5
|
* <p> Contains details about the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user. </p>
|
|
29
6
|
* @public
|
|
@@ -69,18 +46,6 @@ export declare namespace ActionGroupExecutor {
|
|
|
69
46
|
_: (name: string, value: any) => T;
|
|
70
47
|
}
|
|
71
48
|
}
|
|
72
|
-
/**
|
|
73
|
-
* @public
|
|
74
|
-
* @enum
|
|
75
|
-
*/
|
|
76
|
-
export declare const ExecutionType: {
|
|
77
|
-
readonly LAMBDA: "LAMBDA";
|
|
78
|
-
readonly RETURN_CONTROL: "RETURN_CONTROL";
|
|
79
|
-
};
|
|
80
|
-
/**
|
|
81
|
-
* @public
|
|
82
|
-
*/
|
|
83
|
-
export type ExecutionType = (typeof ExecutionType)[keyof typeof ExecutionType];
|
|
84
49
|
/**
|
|
85
50
|
* <p>A parameter for the API request or function.</p>
|
|
86
51
|
* @public
|
|
@@ -227,34 +192,6 @@ export interface ActionGroupInvocationOutput {
|
|
|
227
192
|
*/
|
|
228
193
|
metadata?: Metadata | undefined;
|
|
229
194
|
}
|
|
230
|
-
/**
|
|
231
|
-
* @public
|
|
232
|
-
* @enum
|
|
233
|
-
*/
|
|
234
|
-
export declare const ActionGroupSignature: {
|
|
235
|
-
readonly AMAZON_CODEINTERPRETER: "AMAZON.CodeInterpreter";
|
|
236
|
-
readonly AMAZON_USERINPUT: "AMAZON.UserInput";
|
|
237
|
-
readonly ANTHROPIC_BASH: "ANTHROPIC.Bash";
|
|
238
|
-
readonly ANTHROPIC_COMPUTER: "ANTHROPIC.Computer";
|
|
239
|
-
readonly ANTHROPIC_TEXTEDITOR: "ANTHROPIC.TextEditor";
|
|
240
|
-
};
|
|
241
|
-
/**
|
|
242
|
-
* @public
|
|
243
|
-
*/
|
|
244
|
-
export type ActionGroupSignature = (typeof ActionGroupSignature)[keyof typeof ActionGroupSignature];
|
|
245
|
-
/**
|
|
246
|
-
* @public
|
|
247
|
-
* @enum
|
|
248
|
-
*/
|
|
249
|
-
export declare const ActionInvocationType: {
|
|
250
|
-
readonly RESULT: "RESULT";
|
|
251
|
-
readonly USER_CONFIRMATION: "USER_CONFIRMATION";
|
|
252
|
-
readonly USER_CONFIRMATION_AND_RESULT: "USER_CONFIRMATION_AND_RESULT";
|
|
253
|
-
};
|
|
254
|
-
/**
|
|
255
|
-
* @public
|
|
256
|
-
*/
|
|
257
|
-
export type ActionInvocationType = (typeof ActionInvocationType)[keyof typeof ActionInvocationType];
|
|
258
195
|
/**
|
|
259
196
|
* <p> The identifier information for an Amazon S3 bucket. </p>
|
|
260
197
|
* @public
|
|
@@ -316,21 +253,6 @@ export declare namespace APISchema {
|
|
|
316
253
|
_: (name: string, value: any) => T;
|
|
317
254
|
}
|
|
318
255
|
}
|
|
319
|
-
/**
|
|
320
|
-
* @public
|
|
321
|
-
* @enum
|
|
322
|
-
*/
|
|
323
|
-
export declare const ParameterType: {
|
|
324
|
-
readonly ARRAY: "array";
|
|
325
|
-
readonly BOOLEAN: "boolean";
|
|
326
|
-
readonly INTEGER: "integer";
|
|
327
|
-
readonly NUMBER: "number";
|
|
328
|
-
readonly STRING: "string";
|
|
329
|
-
};
|
|
330
|
-
/**
|
|
331
|
-
* @public
|
|
332
|
-
*/
|
|
333
|
-
export type ParameterType = (typeof ParameterType)[keyof typeof ParameterType];
|
|
334
256
|
/**
|
|
335
257
|
* <p> Contains details about a parameter in a function for an action group. </p>
|
|
336
258
|
* @public
|
|
@@ -352,18 +274,6 @@ export interface ParameterDetail {
|
|
|
352
274
|
*/
|
|
353
275
|
required?: boolean | undefined;
|
|
354
276
|
}
|
|
355
|
-
/**
|
|
356
|
-
* @public
|
|
357
|
-
* @enum
|
|
358
|
-
*/
|
|
359
|
-
export declare const RequireConfirmation: {
|
|
360
|
-
readonly DISABLED: "DISABLED";
|
|
361
|
-
readonly ENABLED: "ENABLED";
|
|
362
|
-
};
|
|
363
|
-
/**
|
|
364
|
-
* @public
|
|
365
|
-
*/
|
|
366
|
-
export type RequireConfirmation = (typeof RequireConfirmation)[keyof typeof RequireConfirmation];
|
|
367
277
|
/**
|
|
368
278
|
* <p> Defines parameters that the agent needs to invoke from the user to complete the function. Corresponds to an action in an action group. </p>
|
|
369
279
|
* @public
|
|
@@ -464,45 +374,6 @@ export interface AgentActionGroup {
|
|
|
464
374
|
*/
|
|
465
375
|
parentActionGroupSignatureParams?: Record<string, string> | undefined;
|
|
466
376
|
}
|
|
467
|
-
/**
|
|
468
|
-
* @public
|
|
469
|
-
* @enum
|
|
470
|
-
*/
|
|
471
|
-
export declare const AgentCollaboration: {
|
|
472
|
-
readonly DISABLED: "DISABLED";
|
|
473
|
-
readonly SUPERVISOR: "SUPERVISOR";
|
|
474
|
-
readonly SUPERVISOR_ROUTER: "SUPERVISOR_ROUTER";
|
|
475
|
-
};
|
|
476
|
-
/**
|
|
477
|
-
* @public
|
|
478
|
-
*/
|
|
479
|
-
export type AgentCollaboration = (typeof AgentCollaboration)[keyof typeof AgentCollaboration];
|
|
480
|
-
/**
|
|
481
|
-
* @public
|
|
482
|
-
* @enum
|
|
483
|
-
*/
|
|
484
|
-
export declare const ConfirmationState: {
|
|
485
|
-
readonly CONFIRM: "CONFIRM";
|
|
486
|
-
readonly DENY: "DENY";
|
|
487
|
-
};
|
|
488
|
-
/**
|
|
489
|
-
* @public
|
|
490
|
-
*/
|
|
491
|
-
export type ConfirmationState = (typeof ConfirmationState)[keyof typeof ConfirmationState];
|
|
492
|
-
/**
|
|
493
|
-
* @public
|
|
494
|
-
* @enum
|
|
495
|
-
*/
|
|
496
|
-
export declare const ImageInputFormat: {
|
|
497
|
-
readonly GIF: "gif";
|
|
498
|
-
readonly JPEG: "jpeg";
|
|
499
|
-
readonly PNG: "png";
|
|
500
|
-
readonly WEBP: "webp";
|
|
501
|
-
};
|
|
502
|
-
/**
|
|
503
|
-
* @public
|
|
504
|
-
*/
|
|
505
|
-
export type ImageInputFormat = (typeof ImageInputFormat)[keyof typeof ImageInputFormat];
|
|
506
377
|
/**
|
|
507
378
|
* <p>Details about the source of an input image in the result from a function in the action group invocation.</p>
|
|
508
379
|
* @public
|
|
@@ -568,18 +439,6 @@ export interface ContentBody {
|
|
|
568
439
|
*/
|
|
569
440
|
images?: ImageInput[] | undefined;
|
|
570
441
|
}
|
|
571
|
-
/**
|
|
572
|
-
* @public
|
|
573
|
-
* @enum
|
|
574
|
-
*/
|
|
575
|
-
export declare const ResponseState: {
|
|
576
|
-
readonly FAILURE: "FAILURE";
|
|
577
|
-
readonly REPROMPT: "REPROMPT";
|
|
578
|
-
};
|
|
579
|
-
/**
|
|
580
|
-
* @public
|
|
581
|
-
*/
|
|
582
|
-
export type ResponseState = (typeof ResponseState)[keyof typeof ResponseState];
|
|
583
442
|
/**
|
|
584
443
|
* <p>Contains information about the API operation that was called from the action group and the response body that was returned.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p>In the <code>returnControlInvocationResults</code> of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_RequestSyntax">InvokeAgent request</a> </p> </li> </ul>
|
|
585
444
|
* @public
|
|
@@ -723,18 +582,6 @@ export interface ReturnControlResults {
|
|
|
723
582
|
*/
|
|
724
583
|
returnControlInvocationResults?: InvocationResultMember[] | undefined;
|
|
725
584
|
}
|
|
726
|
-
/**
|
|
727
|
-
* @public
|
|
728
|
-
* @enum
|
|
729
|
-
*/
|
|
730
|
-
export declare const PayloadType: {
|
|
731
|
-
readonly RETURN_CONTROL: "RETURN_CONTROL";
|
|
732
|
-
readonly TEXT: "TEXT";
|
|
733
|
-
};
|
|
734
|
-
/**
|
|
735
|
-
* @public
|
|
736
|
-
*/
|
|
737
|
-
export type PayloadType = (typeof PayloadType)[keyof typeof PayloadType];
|
|
738
585
|
/**
|
|
739
586
|
* <p>Input for an agent collaborator. The input can be text or an action invocation result.</p>
|
|
740
587
|
* @public
|
|
@@ -1117,59 +964,6 @@ export interface FailureTrace {
|
|
|
1117
964
|
*/
|
|
1118
965
|
metadata?: Metadata | undefined;
|
|
1119
966
|
}
|
|
1120
|
-
/**
|
|
1121
|
-
* @public
|
|
1122
|
-
* @enum
|
|
1123
|
-
*/
|
|
1124
|
-
export declare const GuardrailAction: {
|
|
1125
|
-
readonly INTERVENED: "INTERVENED";
|
|
1126
|
-
readonly NONE: "NONE";
|
|
1127
|
-
};
|
|
1128
|
-
/**
|
|
1129
|
-
* @public
|
|
1130
|
-
*/
|
|
1131
|
-
export type GuardrailAction = (typeof GuardrailAction)[keyof typeof GuardrailAction];
|
|
1132
|
-
/**
|
|
1133
|
-
* @public
|
|
1134
|
-
* @enum
|
|
1135
|
-
*/
|
|
1136
|
-
export declare const GuardrailContentPolicyAction: {
|
|
1137
|
-
readonly BLOCKED: "BLOCKED";
|
|
1138
|
-
};
|
|
1139
|
-
/**
|
|
1140
|
-
* @public
|
|
1141
|
-
*/
|
|
1142
|
-
export type GuardrailContentPolicyAction = (typeof GuardrailContentPolicyAction)[keyof typeof GuardrailContentPolicyAction];
|
|
1143
|
-
/**
|
|
1144
|
-
* @public
|
|
1145
|
-
* @enum
|
|
1146
|
-
*/
|
|
1147
|
-
export declare const GuardrailContentFilterConfidence: {
|
|
1148
|
-
readonly HIGH: "HIGH";
|
|
1149
|
-
readonly LOW: "LOW";
|
|
1150
|
-
readonly MEDIUM: "MEDIUM";
|
|
1151
|
-
readonly NONE: "NONE";
|
|
1152
|
-
};
|
|
1153
|
-
/**
|
|
1154
|
-
* @public
|
|
1155
|
-
*/
|
|
1156
|
-
export type GuardrailContentFilterConfidence = (typeof GuardrailContentFilterConfidence)[keyof typeof GuardrailContentFilterConfidence];
|
|
1157
|
-
/**
|
|
1158
|
-
* @public
|
|
1159
|
-
* @enum
|
|
1160
|
-
*/
|
|
1161
|
-
export declare const GuardrailContentFilterType: {
|
|
1162
|
-
readonly HATE: "HATE";
|
|
1163
|
-
readonly INSULTS: "INSULTS";
|
|
1164
|
-
readonly MISCONDUCT: "MISCONDUCT";
|
|
1165
|
-
readonly PROMPT_ATTACK: "PROMPT_ATTACK";
|
|
1166
|
-
readonly SEXUAL: "SEXUAL";
|
|
1167
|
-
readonly VIOLENCE: "VIOLENCE";
|
|
1168
|
-
};
|
|
1169
|
-
/**
|
|
1170
|
-
* @public
|
|
1171
|
-
*/
|
|
1172
|
-
export type GuardrailContentFilterType = (typeof GuardrailContentFilterType)[keyof typeof GuardrailContentFilterType];
|
|
1173
967
|
/**
|
|
1174
968
|
* <p>Details of the content filter used in the Guardrail.</p>
|
|
1175
969
|
* @public
|
|
@@ -1202,59 +996,6 @@ export interface GuardrailContentPolicyAssessment {
|
|
|
1202
996
|
*/
|
|
1203
997
|
filters?: GuardrailContentFilter[] | undefined;
|
|
1204
998
|
}
|
|
1205
|
-
/**
|
|
1206
|
-
* @public
|
|
1207
|
-
* @enum
|
|
1208
|
-
*/
|
|
1209
|
-
export declare const GuardrailSensitiveInformationPolicyAction: {
|
|
1210
|
-
readonly ANONYMIZED: "ANONYMIZED";
|
|
1211
|
-
readonly BLOCKED: "BLOCKED";
|
|
1212
|
-
};
|
|
1213
|
-
/**
|
|
1214
|
-
* @public
|
|
1215
|
-
*/
|
|
1216
|
-
export type GuardrailSensitiveInformationPolicyAction = (typeof GuardrailSensitiveInformationPolicyAction)[keyof typeof GuardrailSensitiveInformationPolicyAction];
|
|
1217
|
-
/**
|
|
1218
|
-
* @public
|
|
1219
|
-
* @enum
|
|
1220
|
-
*/
|
|
1221
|
-
export declare const GuardrailPiiEntityType: {
|
|
1222
|
-
readonly ADDRESS: "ADDRESS";
|
|
1223
|
-
readonly AGE: "AGE";
|
|
1224
|
-
readonly AWS_ACCESS_KEY: "AWS_ACCESS_KEY";
|
|
1225
|
-
readonly AWS_SECRET_KEY: "AWS_SECRET_KEY";
|
|
1226
|
-
readonly CA_HEALTH_NUMBER: "CA_HEALTH_NUMBER";
|
|
1227
|
-
readonly CA_SOCIAL_INSURANCE_NUMBER: "CA_SOCIAL_INSURANCE_NUMBER";
|
|
1228
|
-
readonly CREDIT_DEBIT_CARD_CVV: "CREDIT_DEBIT_CARD_CVV";
|
|
1229
|
-
readonly CREDIT_DEBIT_CARD_EXPIRY: "CREDIT_DEBIT_CARD_EXPIRY";
|
|
1230
|
-
readonly CREDIT_DEBIT_CARD_NUMBER: "CREDIT_DEBIT_CARD_NUMBER";
|
|
1231
|
-
readonly DRIVER_ID: "DRIVER_ID";
|
|
1232
|
-
readonly EMAIL: "EMAIL";
|
|
1233
|
-
readonly INTERNATIONAL_BANK_ACCOUNT_NUMBER: "INTERNATIONAL_BANK_ACCOUNT_NUMBER";
|
|
1234
|
-
readonly IP_ADDRESS: "IP_ADDRESS";
|
|
1235
|
-
readonly LICENSE_PLATE: "LICENSE_PLATE";
|
|
1236
|
-
readonly MAC_ADDRESS: "MAC_ADDRESS";
|
|
1237
|
-
readonly NAME: "NAME";
|
|
1238
|
-
readonly PASSWORD: "PASSWORD";
|
|
1239
|
-
readonly PHONE: "PHONE";
|
|
1240
|
-
readonly PIN: "PIN";
|
|
1241
|
-
readonly SWIFT_CODE: "SWIFT_CODE";
|
|
1242
|
-
readonly UK_NATIONAL_HEALTH_SERVICE_NUMBER: "UK_NATIONAL_HEALTH_SERVICE_NUMBER";
|
|
1243
|
-
readonly UK_NATIONAL_INSURANCE_NUMBER: "UK_NATIONAL_INSURANCE_NUMBER";
|
|
1244
|
-
readonly UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER: "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER";
|
|
1245
|
-
readonly URL: "URL";
|
|
1246
|
-
readonly USERNAME: "USERNAME";
|
|
1247
|
-
readonly US_BANK_ACCOUNT_NUMBER: "US_BANK_ACCOUNT_NUMBER";
|
|
1248
|
-
readonly US_BANK_ROUTING_NUMBER: "US_BANK_ROUTING_NUMBER";
|
|
1249
|
-
readonly US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER: "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER";
|
|
1250
|
-
readonly US_PASSPORT_NUMBER: "US_PASSPORT_NUMBER";
|
|
1251
|
-
readonly US_SOCIAL_SECURITY_NUMBER: "US_SOCIAL_SECURITY_NUMBER";
|
|
1252
|
-
readonly VEHICLE_IDENTIFICATION_NUMBER: "VEHICLE_IDENTIFICATION_NUMBER";
|
|
1253
|
-
};
|
|
1254
|
-
/**
|
|
1255
|
-
* @public
|
|
1256
|
-
*/
|
|
1257
|
-
export type GuardrailPiiEntityType = (typeof GuardrailPiiEntityType)[keyof typeof GuardrailPiiEntityType];
|
|
1258
999
|
/**
|
|
1259
1000
|
* <p>The Guardrail filter to identify and remove personally identifiable information (PII).</p>
|
|
1260
1001
|
* @public
|
|
@@ -1318,28 +1059,6 @@ export interface GuardrailSensitiveInformationPolicyAssessment {
|
|
|
1318
1059
|
*/
|
|
1319
1060
|
regexes?: GuardrailRegexFilter[] | undefined;
|
|
1320
1061
|
}
|
|
1321
|
-
/**
|
|
1322
|
-
* @public
|
|
1323
|
-
* @enum
|
|
1324
|
-
*/
|
|
1325
|
-
export declare const GuardrailTopicPolicyAction: {
|
|
1326
|
-
readonly BLOCKED: "BLOCKED";
|
|
1327
|
-
};
|
|
1328
|
-
/**
|
|
1329
|
-
* @public
|
|
1330
|
-
*/
|
|
1331
|
-
export type GuardrailTopicPolicyAction = (typeof GuardrailTopicPolicyAction)[keyof typeof GuardrailTopicPolicyAction];
|
|
1332
|
-
/**
|
|
1333
|
-
* @public
|
|
1334
|
-
* @enum
|
|
1335
|
-
*/
|
|
1336
|
-
export declare const GuardrailTopicType: {
|
|
1337
|
-
readonly DENY: "DENY";
|
|
1338
|
-
};
|
|
1339
|
-
/**
|
|
1340
|
-
* @public
|
|
1341
|
-
*/
|
|
1342
|
-
export type GuardrailTopicType = (typeof GuardrailTopicType)[keyof typeof GuardrailTopicType];
|
|
1343
1062
|
/**
|
|
1344
1063
|
* <p>The details for a specific topic defined in the Guardrail.</p>
|
|
1345
1064
|
* @public
|
|
@@ -1372,17 +1091,6 @@ export interface GuardrailTopicPolicyAssessment {
|
|
|
1372
1091
|
*/
|
|
1373
1092
|
topics?: GuardrailTopic[] | undefined;
|
|
1374
1093
|
}
|
|
1375
|
-
/**
|
|
1376
|
-
* @public
|
|
1377
|
-
* @enum
|
|
1378
|
-
*/
|
|
1379
|
-
export declare const GuardrailWordPolicyAction: {
|
|
1380
|
-
readonly BLOCKED: "BLOCKED";
|
|
1381
|
-
};
|
|
1382
|
-
/**
|
|
1383
|
-
* @public
|
|
1384
|
-
*/
|
|
1385
|
-
export type GuardrailWordPolicyAction = (typeof GuardrailWordPolicyAction)[keyof typeof GuardrailWordPolicyAction];
|
|
1386
1094
|
/**
|
|
1387
1095
|
* <p>The custom word details for the filter in the Guardrail.</p>
|
|
1388
1096
|
* @public
|
|
@@ -1399,17 +1107,6 @@ export interface GuardrailCustomWord {
|
|
|
1399
1107
|
*/
|
|
1400
1108
|
action?: GuardrailWordPolicyAction | undefined;
|
|
1401
1109
|
}
|
|
1402
|
-
/**
|
|
1403
|
-
* @public
|
|
1404
|
-
* @enum
|
|
1405
|
-
*/
|
|
1406
|
-
export declare const GuardrailManagedWordType: {
|
|
1407
|
-
readonly PROFANITY: "PROFANITY";
|
|
1408
|
-
};
|
|
1409
|
-
/**
|
|
1410
|
-
* @public
|
|
1411
|
-
*/
|
|
1412
|
-
export type GuardrailManagedWordType = (typeof GuardrailManagedWordType)[keyof typeof GuardrailManagedWordType];
|
|
1413
1110
|
/**
|
|
1414
1111
|
* <p>The managed word details for the filter in the Guardrail.</p>
|
|
1415
1112
|
* @public
|
|
@@ -1520,21 +1217,6 @@ export interface CodeInterpreterInvocationInput {
|
|
|
1520
1217
|
*/
|
|
1521
1218
|
files?: string[] | undefined;
|
|
1522
1219
|
}
|
|
1523
|
-
/**
|
|
1524
|
-
* @public
|
|
1525
|
-
* @enum
|
|
1526
|
-
*/
|
|
1527
|
-
export declare const InvocationType: {
|
|
1528
|
-
readonly ACTION_GROUP: "ACTION_GROUP";
|
|
1529
|
-
readonly ACTION_GROUP_CODE_INTERPRETER: "ACTION_GROUP_CODE_INTERPRETER";
|
|
1530
|
-
readonly AGENT_COLLABORATOR: "AGENT_COLLABORATOR";
|
|
1531
|
-
readonly FINISH: "FINISH";
|
|
1532
|
-
readonly KNOWLEDGE_BASE: "KNOWLEDGE_BASE";
|
|
1533
|
-
};
|
|
1534
|
-
/**
|
|
1535
|
-
* @public
|
|
1536
|
-
*/
|
|
1537
|
-
export type InvocationType = (typeof InvocationType)[keyof typeof InvocationType];
|
|
1538
1220
|
/**
|
|
1539
1221
|
* <p>Contains details about the knowledge base to look up and the query to be made.</p>
|
|
1540
1222
|
* @public
|
|
@@ -1618,33 +1300,6 @@ export interface InferenceConfiguration {
|
|
|
1618
1300
|
*/
|
|
1619
1301
|
stopSequences?: string[] | undefined;
|
|
1620
1302
|
}
|
|
1621
|
-
/**
|
|
1622
|
-
* @public
|
|
1623
|
-
* @enum
|
|
1624
|
-
*/
|
|
1625
|
-
export declare const CreationMode: {
|
|
1626
|
-
readonly DEFAULT: "DEFAULT";
|
|
1627
|
-
readonly OVERRIDDEN: "OVERRIDDEN";
|
|
1628
|
-
};
|
|
1629
|
-
/**
|
|
1630
|
-
* @public
|
|
1631
|
-
*/
|
|
1632
|
-
export type CreationMode = (typeof CreationMode)[keyof typeof CreationMode];
|
|
1633
|
-
/**
|
|
1634
|
-
* @public
|
|
1635
|
-
* @enum
|
|
1636
|
-
*/
|
|
1637
|
-
export declare const PromptType: {
|
|
1638
|
-
readonly KNOWLEDGE_BASE_RESPONSE_GENERATION: "KNOWLEDGE_BASE_RESPONSE_GENERATION";
|
|
1639
|
-
readonly ORCHESTRATION: "ORCHESTRATION";
|
|
1640
|
-
readonly POST_PROCESSING: "POST_PROCESSING";
|
|
1641
|
-
readonly PRE_PROCESSING: "PRE_PROCESSING";
|
|
1642
|
-
readonly ROUTING_CLASSIFIER: "ROUTING_CLASSIFIER";
|
|
1643
|
-
};
|
|
1644
|
-
/**
|
|
1645
|
-
* @public
|
|
1646
|
-
*/
|
|
1647
|
-
export type PromptType = (typeof PromptType)[keyof typeof PromptType];
|
|
1648
1303
|
/**
|
|
1649
1304
|
* <p>The input for the pre-processing step.</p> <ul> <li> <p>The <code>type</code> matches the agent step.</p> </li> <li> <p>The <code>text</code> contains the prompt.</p> </li> <li> <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> </li> </ul>
|
|
1650
1305
|
* @public
|
|
@@ -1836,22 +1491,6 @@ export interface FinalResponse {
|
|
|
1836
1491
|
*/
|
|
1837
1492
|
metadata?: Metadata | undefined;
|
|
1838
1493
|
}
|
|
1839
|
-
/**
|
|
1840
|
-
* @public
|
|
1841
|
-
* @enum
|
|
1842
|
-
*/
|
|
1843
|
-
export declare const RetrievalResultContentColumnType: {
|
|
1844
|
-
readonly BLOB: "BLOB";
|
|
1845
|
-
readonly BOOLEAN: "BOOLEAN";
|
|
1846
|
-
readonly DOUBLE: "DOUBLE";
|
|
1847
|
-
readonly LONG: "LONG";
|
|
1848
|
-
readonly NULL: "NULL";
|
|
1849
|
-
readonly STRING: "STRING";
|
|
1850
|
-
};
|
|
1851
|
-
/**
|
|
1852
|
-
* @public
|
|
1853
|
-
*/
|
|
1854
|
-
export type RetrievalResultContentColumnType = (typeof RetrievalResultContentColumnType)[keyof typeof RetrievalResultContentColumnType];
|
|
1855
1494
|
/**
|
|
1856
1495
|
* <p>Contains information about a column with a cell to return in retrieval.</p>
|
|
1857
1496
|
* @public
|
|
@@ -1873,19 +1512,6 @@ export interface RetrievalResultContentColumn {
|
|
|
1873
1512
|
*/
|
|
1874
1513
|
type?: RetrievalResultContentColumnType | undefined;
|
|
1875
1514
|
}
|
|
1876
|
-
/**
|
|
1877
|
-
* @public
|
|
1878
|
-
* @enum
|
|
1879
|
-
*/
|
|
1880
|
-
export declare const RetrievalResultContentType: {
|
|
1881
|
-
readonly IMAGE: "IMAGE";
|
|
1882
|
-
readonly ROW: "ROW";
|
|
1883
|
-
readonly TEXT: "TEXT";
|
|
1884
|
-
};
|
|
1885
|
-
/**
|
|
1886
|
-
* @public
|
|
1887
|
-
*/
|
|
1888
|
-
export type RetrievalResultContentType = (typeof RetrievalResultContentType)[keyof typeof RetrievalResultContentType];
|
|
1889
1515
|
/**
|
|
1890
1516
|
* <p>Contains information about a chunk of text from a data source in the knowledge base. If the result is from a structured data source, the cell in the database and the type of the value is also identified.</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>content</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_ResponseSyntax">RetrieveAndGenerate response</a> – in the <code>content</code> field</p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a> – in the <code>content</code> field</p> </li> </ul>
|
|
1891
1517
|
* @public
|
|
@@ -1989,24 +1615,6 @@ export interface RetrievalResultSqlLocation {
|
|
|
1989
1615
|
*/
|
|
1990
1616
|
query?: string | undefined;
|
|
1991
1617
|
}
|
|
1992
|
-
/**
|
|
1993
|
-
* @public
|
|
1994
|
-
* @enum
|
|
1995
|
-
*/
|
|
1996
|
-
export declare const RetrievalResultLocationType: {
|
|
1997
|
-
readonly CONFLUENCE: "CONFLUENCE";
|
|
1998
|
-
readonly CUSTOM: "CUSTOM";
|
|
1999
|
-
readonly KENDRA: "KENDRA";
|
|
2000
|
-
readonly S3: "S3";
|
|
2001
|
-
readonly SALESFORCE: "SALESFORCE";
|
|
2002
|
-
readonly SHAREPOINT: "SHAREPOINT";
|
|
2003
|
-
readonly SQL: "SQL";
|
|
2004
|
-
readonly WEB: "WEB";
|
|
2005
|
-
};
|
|
2006
|
-
/**
|
|
2007
|
-
* @public
|
|
2008
|
-
*/
|
|
2009
|
-
export type RetrievalResultLocationType = (typeof RetrievalResultLocationType)[keyof typeof RetrievalResultLocationType];
|
|
2010
1618
|
/**
|
|
2011
1619
|
* <p>The web URL/URLs data source location.</p>
|
|
2012
1620
|
* @public
|
|
@@ -2106,19 +1714,6 @@ export interface KnowledgeBaseLookupOutput {
|
|
|
2106
1714
|
*/
|
|
2107
1715
|
metadata?: Metadata | undefined;
|
|
2108
1716
|
}
|
|
2109
|
-
/**
|
|
2110
|
-
* @public
|
|
2111
|
-
* @enum
|
|
2112
|
-
*/
|
|
2113
|
-
export declare const Source: {
|
|
2114
|
-
readonly ACTION_GROUP: "ACTION_GROUP";
|
|
2115
|
-
readonly KNOWLEDGE_BASE: "KNOWLEDGE_BASE";
|
|
2116
|
-
readonly PARSER: "PARSER";
|
|
2117
|
-
};
|
|
2118
|
-
/**
|
|
2119
|
-
* @public
|
|
2120
|
-
*/
|
|
2121
|
-
export type Source = (typeof Source)[keyof typeof Source];
|
|
2122
1717
|
/**
|
|
2123
1718
|
* <p>Contains details about the agent's response to reprompt the input.</p>
|
|
2124
1719
|
* @public
|
|
@@ -2135,22 +1730,6 @@ export interface RepromptResponse {
|
|
|
2135
1730
|
*/
|
|
2136
1731
|
source?: Source | undefined;
|
|
2137
1732
|
}
|
|
2138
|
-
/**
|
|
2139
|
-
* @public
|
|
2140
|
-
* @enum
|
|
2141
|
-
*/
|
|
2142
|
-
export declare const Type: {
|
|
2143
|
-
readonly ACTION_GROUP: "ACTION_GROUP";
|
|
2144
|
-
readonly AGENT_COLLABORATOR: "AGENT_COLLABORATOR";
|
|
2145
|
-
readonly ASK_USER: "ASK_USER";
|
|
2146
|
-
readonly FINISH: "FINISH";
|
|
2147
|
-
readonly KNOWLEDGE_BASE: "KNOWLEDGE_BASE";
|
|
2148
|
-
readonly REPROMPT: "REPROMPT";
|
|
2149
|
-
};
|
|
2150
|
-
/**
|
|
2151
|
-
* @public
|
|
2152
|
-
*/
|
|
2153
|
-
export type Type = (typeof Type)[keyof typeof Type];
|
|
2154
1733
|
/**
|
|
2155
1734
|
* <p>Contains the result or output of an action group or knowledge base, or the response to the user.</p>
|
|
2156
1735
|
* @public
|
|
@@ -2817,59 +2396,6 @@ export interface GetExecutionFlowSnapshotResponse {
|
|
|
2817
2396
|
*/
|
|
2818
2397
|
customerEncryptionKeyArn?: string | undefined;
|
|
2819
2398
|
}
|
|
2820
|
-
/**
|
|
2821
|
-
* <p>An internal server error occurred. Retry your request.</p>
|
|
2822
|
-
* @public
|
|
2823
|
-
*/
|
|
2824
|
-
export declare class InternalServerException extends __BaseException {
|
|
2825
|
-
readonly name: "InternalServerException";
|
|
2826
|
-
readonly $fault: "server";
|
|
2827
|
-
/**
|
|
2828
|
-
* <p>The reason for the exception. If the reason is <code>BEDROCK_MODEL_INVOCATION_SERVICE_UNAVAILABLE</code>, the model invocation service is unavailable. Retry your request.</p>
|
|
2829
|
-
* @public
|
|
2830
|
-
*/
|
|
2831
|
-
reason?: string | undefined;
|
|
2832
|
-
/**
|
|
2833
|
-
* @internal
|
|
2834
|
-
*/
|
|
2835
|
-
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
2836
|
-
}
|
|
2837
|
-
/**
|
|
2838
|
-
* <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
|
|
2839
|
-
* @public
|
|
2840
|
-
*/
|
|
2841
|
-
export declare class ResourceNotFoundException extends __BaseException {
|
|
2842
|
-
readonly name: "ResourceNotFoundException";
|
|
2843
|
-
readonly $fault: "client";
|
|
2844
|
-
/**
|
|
2845
|
-
* @internal
|
|
2846
|
-
*/
|
|
2847
|
-
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
2848
|
-
}
|
|
2849
|
-
/**
|
|
2850
|
-
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
2851
|
-
* @public
|
|
2852
|
-
*/
|
|
2853
|
-
export declare class ThrottlingException extends __BaseException {
|
|
2854
|
-
readonly name: "ThrottlingException";
|
|
2855
|
-
readonly $fault: "client";
|
|
2856
|
-
/**
|
|
2857
|
-
* @internal
|
|
2858
|
-
*/
|
|
2859
|
-
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
2860
|
-
}
|
|
2861
|
-
/**
|
|
2862
|
-
* <p>Input validation failed. Check your request parameters and retry the request.</p>
|
|
2863
|
-
* @public
|
|
2864
|
-
*/
|
|
2865
|
-
export declare class ValidationException extends __BaseException {
|
|
2866
|
-
readonly name: "ValidationException";
|
|
2867
|
-
readonly $fault: "client";
|
|
2868
|
-
/**
|
|
2869
|
-
* @internal
|
|
2870
|
-
*/
|
|
2871
|
-
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
2872
|
-
}
|
|
2873
2399
|
/**
|
|
2874
2400
|
* @public
|
|
2875
2401
|
*/
|
|
@@ -2890,17 +2416,6 @@ export interface GetFlowExecutionRequest {
|
|
|
2890
2416
|
*/
|
|
2891
2417
|
executionIdentifier: string | undefined;
|
|
2892
2418
|
}
|
|
2893
|
-
/**
|
|
2894
|
-
* @public
|
|
2895
|
-
* @enum
|
|
2896
|
-
*/
|
|
2897
|
-
export declare const FlowExecutionErrorType: {
|
|
2898
|
-
readonly TIMED_OUT: "ExecutionTimedOut";
|
|
2899
|
-
};
|
|
2900
|
-
/**
|
|
2901
|
-
* @public
|
|
2902
|
-
*/
|
|
2903
|
-
export type FlowExecutionErrorType = (typeof FlowExecutionErrorType)[keyof typeof FlowExecutionErrorType];
|
|
2904
2419
|
/**
|
|
2905
2420
|
* <p>Contains information about an error that occurred during an flow execution.</p> <note> <p>Flow executions is in preview release for Amazon Bedrock and is subject to change.</p> </note>
|
|
2906
2421
|
* @public
|
|
@@ -2922,21 +2437,6 @@ export interface FlowExecutionError {
|
|
|
2922
2437
|
*/
|
|
2923
2438
|
message?: string | undefined;
|
|
2924
2439
|
}
|
|
2925
|
-
/**
|
|
2926
|
-
* @public
|
|
2927
|
-
* @enum
|
|
2928
|
-
*/
|
|
2929
|
-
export declare const FlowExecutionStatus: {
|
|
2930
|
-
readonly ABORTED: "Aborted";
|
|
2931
|
-
readonly FAILED: "Failed";
|
|
2932
|
-
readonly RUNNING: "Running";
|
|
2933
|
-
readonly SUCCEEDED: "Succeeded";
|
|
2934
|
-
readonly TIMED_OUT: "TimedOut";
|
|
2935
|
-
};
|
|
2936
|
-
/**
|
|
2937
|
-
* @public
|
|
2938
|
-
*/
|
|
2939
|
-
export type FlowExecutionStatus = (typeof FlowExecutionStatus)[keyof typeof FlowExecutionStatus];
|
|
2940
2440
|
/**
|
|
2941
2441
|
* @public
|
|
2942
2442
|
*/
|
|
@@ -2982,18 +2482,6 @@ export interface GetFlowExecutionResponse {
|
|
|
2982
2482
|
*/
|
|
2983
2483
|
flowVersion: string | undefined;
|
|
2984
2484
|
}
|
|
2985
|
-
/**
|
|
2986
|
-
* @public
|
|
2987
|
-
* @enum
|
|
2988
|
-
*/
|
|
2989
|
-
export declare const FlowExecutionEventType: {
|
|
2990
|
-
readonly FLOW: "Flow";
|
|
2991
|
-
readonly NODE: "Node";
|
|
2992
|
-
};
|
|
2993
|
-
/**
|
|
2994
|
-
* @public
|
|
2995
|
-
*/
|
|
2996
|
-
export type FlowExecutionEventType = (typeof FlowExecutionEventType)[keyof typeof FlowExecutionEventType];
|
|
2997
2485
|
/**
|
|
2998
2486
|
* @public
|
|
2999
2487
|
*/
|
|
@@ -3061,19 +2549,6 @@ export interface ConditionResultEvent {
|
|
|
3061
2549
|
*/
|
|
3062
2550
|
satisfiedConditions: SatisfiedCondition[] | undefined;
|
|
3063
2551
|
}
|
|
3064
|
-
/**
|
|
3065
|
-
* @public
|
|
3066
|
-
* @enum
|
|
3067
|
-
*/
|
|
3068
|
-
export declare const FlowErrorCode: {
|
|
3069
|
-
readonly INTERNAL_SERVER: "INTERNAL_SERVER";
|
|
3070
|
-
readonly NODE_EXECUTION_FAILED: "NODE_EXECUTION_FAILED";
|
|
3071
|
-
readonly VALIDATION: "VALIDATION";
|
|
3072
|
-
};
|
|
3073
|
-
/**
|
|
3074
|
-
* @public
|
|
3075
|
-
*/
|
|
3076
|
-
export type FlowErrorCode = (typeof FlowErrorCode)[keyof typeof FlowErrorCode];
|
|
3077
2552
|
/**
|
|
3078
2553
|
* <p>Contains information about a failure that occurred at the flow level during a flow execution.</p> <note> <p>Flow executions is in preview release for Amazon Bedrock and is subject to change.</p> </note>
|
|
3079
2554
|
* @public
|
|
@@ -3297,20 +2772,6 @@ export interface NodeDependencyEvent {
|
|
|
3297
2772
|
*/
|
|
3298
2773
|
traceElements: NodeTraceElements | undefined;
|
|
3299
2774
|
}
|
|
3300
|
-
/**
|
|
3301
|
-
* @public
|
|
3302
|
-
* @enum
|
|
3303
|
-
*/
|
|
3304
|
-
export declare const NodeErrorCode: {
|
|
3305
|
-
readonly BAD_GATEWAY: "BAD_GATEWAY";
|
|
3306
|
-
readonly DEPENDENCY_FAILED: "DEPENDENCY_FAILED";
|
|
3307
|
-
readonly INTERNAL_SERVER: "INTERNAL_SERVER";
|
|
3308
|
-
readonly VALIDATION: "VALIDATION";
|
|
3309
|
-
};
|
|
3310
|
-
/**
|
|
3311
|
-
* @public
|
|
3312
|
-
*/
|
|
3313
|
-
export type NodeErrorCode = (typeof NodeErrorCode)[keyof typeof NodeErrorCode];
|
|
3314
2775
|
/**
|
|
3315
2776
|
* <p>Contains information about a failure that occurred at a specific node during a flow execution.</p> <note> <p>Flow executions is in preview release for Amazon Bedrock and is subject to change.</p> </note>
|
|
3316
2777
|
* @public
|
|
@@ -3337,19 +2798,6 @@ export interface NodeFailureEvent {
|
|
|
3337
2798
|
*/
|
|
3338
2799
|
errorMessage: string | undefined;
|
|
3339
2800
|
}
|
|
3340
|
-
/**
|
|
3341
|
-
* @public
|
|
3342
|
-
* @enum
|
|
3343
|
-
*/
|
|
3344
|
-
export declare const FlowNodeInputCategory: {
|
|
3345
|
-
readonly EXIT_LOOP: "ExitLoop";
|
|
3346
|
-
readonly LOOP_CONDITION: "LoopCondition";
|
|
3347
|
-
readonly RETURN_VALUE_TO_LOOP_START: "ReturnValueToLoopStart";
|
|
3348
|
-
};
|
|
3349
|
-
/**
|
|
3350
|
-
* @public
|
|
3351
|
-
*/
|
|
3352
|
-
export type FlowNodeInputCategory = (typeof FlowNodeInputCategory)[keyof typeof FlowNodeInputCategory];
|
|
3353
2801
|
/**
|
|
3354
2802
|
* <p>Contains the content of a flow node's input or output field for a flow execution.</p> <note> <p>Flow executions is in preview release for Amazon Bedrock and is subject to change.</p> </note>
|
|
3355
2803
|
* @public
|
|
@@ -3383,18 +2831,6 @@ export declare namespace NodeExecutionContent {
|
|
|
3383
2831
|
_: (name: string, value: any) => T;
|
|
3384
2832
|
}
|
|
3385
2833
|
}
|
|
3386
|
-
/**
|
|
3387
|
-
* @public
|
|
3388
|
-
* @enum
|
|
3389
|
-
*/
|
|
3390
|
-
export declare const FlowControlNodeType: {
|
|
3391
|
-
readonly ITERATOR: "Iterator";
|
|
3392
|
-
readonly LOOP: "Loop";
|
|
3393
|
-
};
|
|
3394
|
-
/**
|
|
3395
|
-
* @public
|
|
3396
|
-
*/
|
|
3397
|
-
export type FlowControlNodeType = (typeof FlowControlNodeType)[keyof typeof FlowControlNodeType];
|
|
3398
2834
|
/**
|
|
3399
2835
|
* <p>Represents an item in the execution chain for node input tracking.</p>
|
|
3400
2836
|
* @public
|
|
@@ -3437,21 +2873,6 @@ export interface NodeInputSource {
|
|
|
3437
2873
|
*/
|
|
3438
2874
|
expression: string | undefined;
|
|
3439
2875
|
}
|
|
3440
|
-
/**
|
|
3441
|
-
* @public
|
|
3442
|
-
* @enum
|
|
3443
|
-
*/
|
|
3444
|
-
export declare const FlowNodeIODataType: {
|
|
3445
|
-
readonly ARRAY: "Array";
|
|
3446
|
-
readonly BOOLEAN: "Boolean";
|
|
3447
|
-
readonly NUMBER: "Number";
|
|
3448
|
-
readonly OBJECT: "Object";
|
|
3449
|
-
readonly STRING: "String";
|
|
3450
|
-
};
|
|
3451
|
-
/**
|
|
3452
|
-
* @public
|
|
3453
|
-
*/
|
|
3454
|
-
export type FlowNodeIODataType = (typeof FlowNodeIODataType)[keyof typeof FlowNodeIODataType];
|
|
3455
2876
|
/**
|
|
3456
2877
|
* <p>Represents an input field provided to a node during a flow execution.</p>
|
|
3457
2878
|
* @public
|
|
@@ -3854,65 +3275,7 @@ export interface ListFlowExecutionsResponse {
|
|
|
3854
3275
|
nextToken?: string | undefined;
|
|
3855
3276
|
}
|
|
3856
3277
|
/**
|
|
3857
|
-
* <p>
|
|
3858
|
-
* @public
|
|
3859
|
-
*/
|
|
3860
|
-
export declare class BadGatewayException extends __BaseException {
|
|
3861
|
-
readonly name: "BadGatewayException";
|
|
3862
|
-
readonly $fault: "server";
|
|
3863
|
-
/**
|
|
3864
|
-
* <p>The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or STS.</p>
|
|
3865
|
-
* @public
|
|
3866
|
-
*/
|
|
3867
|
-
resourceName?: string | undefined;
|
|
3868
|
-
/**
|
|
3869
|
-
* @internal
|
|
3870
|
-
*/
|
|
3871
|
-
constructor(opts: __ExceptionOptionType<BadGatewayException, __BaseException>);
|
|
3872
|
-
}
|
|
3873
|
-
/**
|
|
3874
|
-
* <p>There was a conflict performing an operation. Resolve the conflict and retry your request.</p>
|
|
3875
|
-
* @public
|
|
3876
|
-
*/
|
|
3877
|
-
export declare class ConflictException extends __BaseException {
|
|
3878
|
-
readonly name: "ConflictException";
|
|
3879
|
-
readonly $fault: "client";
|
|
3880
|
-
/**
|
|
3881
|
-
* @internal
|
|
3882
|
-
*/
|
|
3883
|
-
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
3884
|
-
}
|
|
3885
|
-
/**
|
|
3886
|
-
* <p>There was an issue with a dependency. Check the resource configurations and retry the request.</p>
|
|
3887
|
-
* @public
|
|
3888
|
-
*/
|
|
3889
|
-
export declare class DependencyFailedException extends __BaseException {
|
|
3890
|
-
readonly name: "DependencyFailedException";
|
|
3891
|
-
readonly $fault: "client";
|
|
3892
|
-
/**
|
|
3893
|
-
* <p>The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or STS.</p>
|
|
3894
|
-
* @public
|
|
3895
|
-
*/
|
|
3896
|
-
resourceName?: string | undefined;
|
|
3897
|
-
/**
|
|
3898
|
-
* @internal
|
|
3899
|
-
*/
|
|
3900
|
-
constructor(opts: __ExceptionOptionType<DependencyFailedException, __BaseException>);
|
|
3901
|
-
}
|
|
3902
|
-
/**
|
|
3903
|
-
* <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
|
|
3904
|
-
* @public
|
|
3905
|
-
*/
|
|
3906
|
-
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
3907
|
-
readonly name: "ServiceQuotaExceededException";
|
|
3908
|
-
readonly $fault: "client";
|
|
3909
|
-
/**
|
|
3910
|
-
* @internal
|
|
3911
|
-
*/
|
|
3912
|
-
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
3913
|
-
}
|
|
3914
|
-
/**
|
|
3915
|
-
* <p>Contains information about an input into the flow.</p>
|
|
3278
|
+
* <p>Contains information about an input into the flow.</p>
|
|
3916
3279
|
* @public
|
|
3917
3280
|
*/
|
|
3918
3281
|
export type FlowInputContent = FlowInputContent.DocumentMember | FlowInputContent.$UnknownMember;
|
|
@@ -3970,18 +3333,6 @@ export interface FlowInput {
|
|
|
3970
3333
|
*/
|
|
3971
3334
|
nodeInputName?: string | undefined;
|
|
3972
3335
|
}
|
|
3973
|
-
/**
|
|
3974
|
-
* @public
|
|
3975
|
-
* @enum
|
|
3976
|
-
*/
|
|
3977
|
-
export declare const PerformanceConfigLatency: {
|
|
3978
|
-
readonly OPTIMIZED: "optimized";
|
|
3979
|
-
readonly STANDARD: "standard";
|
|
3980
|
-
};
|
|
3981
|
-
/**
|
|
3982
|
-
* @public
|
|
3983
|
-
*/
|
|
3984
|
-
export type PerformanceConfigLatency = (typeof PerformanceConfigLatency)[keyof typeof PerformanceConfigLatency];
|
|
3985
3336
|
/**
|
|
3986
3337
|
* <p>Performance settings for a model.</p>
|
|
3987
3338
|
* @public
|
|
@@ -4114,18 +3465,6 @@ export interface InvokeFlowRequest {
|
|
|
4114
3465
|
*/
|
|
4115
3466
|
executionId?: string | undefined;
|
|
4116
3467
|
}
|
|
4117
|
-
/**
|
|
4118
|
-
* @public
|
|
4119
|
-
* @enum
|
|
4120
|
-
*/
|
|
4121
|
-
export declare const FlowCompletionReason: {
|
|
4122
|
-
readonly INPUT_REQUIRED: "INPUT_REQUIRED";
|
|
4123
|
-
readonly SUCCESS: "SUCCESS";
|
|
4124
|
-
};
|
|
4125
|
-
/**
|
|
4126
|
-
* @public
|
|
4127
|
-
*/
|
|
4128
|
-
export type FlowCompletionReason = (typeof FlowCompletionReason)[keyof typeof FlowCompletionReason];
|
|
4129
3468
|
/**
|
|
4130
3469
|
* <p>Contains information about why a flow completed.</p>
|
|
4131
3470
|
* @public
|
|
@@ -4170,23 +3509,6 @@ export declare namespace FlowMultiTurnInputContent {
|
|
|
4170
3509
|
_: (name: string, value: any) => T;
|
|
4171
3510
|
}
|
|
4172
3511
|
}
|
|
4173
|
-
/**
|
|
4174
|
-
* @public
|
|
4175
|
-
* @enum
|
|
4176
|
-
*/
|
|
4177
|
-
export declare const NodeType: {
|
|
4178
|
-
readonly CONDITION_NODE: "ConditionNode";
|
|
4179
|
-
readonly FLOW_INPUT_NODE: "FlowInputNode";
|
|
4180
|
-
readonly FLOW_OUTPUT_NODE: "FlowOutputNode";
|
|
4181
|
-
readonly KNOWLEDGE_BASE_NODE: "KnowledgeBaseNode";
|
|
4182
|
-
readonly LAMBDA_FUNCTION_NODE: "LambdaFunctionNode";
|
|
4183
|
-
readonly LEX_NODE: "LexNode";
|
|
4184
|
-
readonly PROMPT_NODE: "PromptNode";
|
|
4185
|
-
};
|
|
4186
|
-
/**
|
|
4187
|
-
* @public
|
|
4188
|
-
*/
|
|
4189
|
-
export type NodeType = (typeof NodeType)[keyof typeof NodeType];
|
|
4190
3512
|
/**
|
|
4191
3513
|
* <p>Response object from the flow multi-turn node requesting additional information.</p>
|
|
4192
3514
|
* @public
|
|
@@ -5045,17 +4367,6 @@ export interface InvokeFlowResponse {
|
|
|
5045
4367
|
*/
|
|
5046
4368
|
executionId?: string | undefined;
|
|
5047
4369
|
}
|
|
5048
|
-
/**
|
|
5049
|
-
* @public
|
|
5050
|
-
* @enum
|
|
5051
|
-
*/
|
|
5052
|
-
export declare const InputQueryType: {
|
|
5053
|
-
readonly TEXT: "TEXT";
|
|
5054
|
-
};
|
|
5055
|
-
/**
|
|
5056
|
-
* @public
|
|
5057
|
-
*/
|
|
5058
|
-
export type InputQueryType = (typeof InputQueryType)[keyof typeof InputQueryType];
|
|
5059
4370
|
/**
|
|
5060
4371
|
* <p>Contains information about a natural language query to transform into SQL.</p>
|
|
5061
4372
|
* @public
|
|
@@ -5072,17 +4383,6 @@ export interface QueryGenerationInput {
|
|
|
5072
4383
|
*/
|
|
5073
4384
|
text: string | undefined;
|
|
5074
4385
|
}
|
|
5075
|
-
/**
|
|
5076
|
-
* @public
|
|
5077
|
-
* @enum
|
|
5078
|
-
*/
|
|
5079
|
-
export declare const QueryTransformationMode: {
|
|
5080
|
-
readonly TEXT_TO_SQL: "TEXT_TO_SQL";
|
|
5081
|
-
};
|
|
5082
|
-
/**
|
|
5083
|
-
* @public
|
|
5084
|
-
*/
|
|
5085
|
-
export type QueryTransformationMode = (typeof QueryTransformationMode)[keyof typeof QueryTransformationMode];
|
|
5086
4386
|
/**
|
|
5087
4387
|
* <p>Contains configurations for a knowledge base to use in transformation.</p>
|
|
5088
4388
|
* @public
|
|
@@ -5094,17 +4394,6 @@ export interface TextToSqlKnowledgeBaseConfiguration {
|
|
|
5094
4394
|
*/
|
|
5095
4395
|
knowledgeBaseArn: string | undefined;
|
|
5096
4396
|
}
|
|
5097
|
-
/**
|
|
5098
|
-
* @public
|
|
5099
|
-
* @enum
|
|
5100
|
-
*/
|
|
5101
|
-
export declare const TextToSqlConfigurationType: {
|
|
5102
|
-
readonly KNOWLEDGE_BASE: "KNOWLEDGE_BASE";
|
|
5103
|
-
};
|
|
5104
|
-
/**
|
|
5105
|
-
* @public
|
|
5106
|
-
*/
|
|
5107
|
-
export type TextToSqlConfigurationType = (typeof TextToSqlConfigurationType)[keyof typeof TextToSqlConfigurationType];
|
|
5108
4397
|
/**
|
|
5109
4398
|
* <p>Contains configurations for transforming text to SQL.</p>
|
|
5110
4399
|
* @public
|
|
@@ -5152,17 +4441,6 @@ export interface GenerateQueryRequest {
|
|
|
5152
4441
|
*/
|
|
5153
4442
|
transformationConfiguration: TransformationConfiguration | undefined;
|
|
5154
4443
|
}
|
|
5155
|
-
/**
|
|
5156
|
-
* @public
|
|
5157
|
-
* @enum
|
|
5158
|
-
*/
|
|
5159
|
-
export declare const GeneratedQueryType: {
|
|
5160
|
-
readonly REDSHIFT_SQL: "REDSHIFT_SQL";
|
|
5161
|
-
};
|
|
5162
|
-
/**
|
|
5163
|
-
* @public
|
|
5164
|
-
*/
|
|
5165
|
-
export type GeneratedQueryType = (typeof GeneratedQueryType)[keyof typeof GeneratedQueryType];
|
|
5166
4444
|
/**
|
|
5167
4445
|
* <p>Contains information about a query generated for a natural language query.</p>
|
|
5168
4446
|
* @public
|
|
@@ -5249,18 +4527,6 @@ export declare namespace ContentBlock {
|
|
|
5249
4527
|
_: (name: string, value: any) => T;
|
|
5250
4528
|
}
|
|
5251
4529
|
}
|
|
5252
|
-
/**
|
|
5253
|
-
* @public
|
|
5254
|
-
* @enum
|
|
5255
|
-
*/
|
|
5256
|
-
export declare const ConversationRole: {
|
|
5257
|
-
readonly ASSISTANT: "assistant";
|
|
5258
|
-
readonly USER: "user";
|
|
5259
|
-
};
|
|
5260
|
-
/**
|
|
5261
|
-
* @public
|
|
5262
|
-
*/
|
|
5263
|
-
export type ConversationRole = (typeof ConversationRole)[keyof typeof ConversationRole];
|
|
5264
4530
|
/**
|
|
5265
4531
|
* <p>Details about a message.</p>
|
|
5266
4532
|
* @public
|
|
@@ -5315,18 +4581,6 @@ export interface S3ObjectFile {
|
|
|
5315
4581
|
*/
|
|
5316
4582
|
uri: string | undefined;
|
|
5317
4583
|
}
|
|
5318
|
-
/**
|
|
5319
|
-
* @public
|
|
5320
|
-
* @enum
|
|
5321
|
-
*/
|
|
5322
|
-
export declare const FileSourceType: {
|
|
5323
|
-
readonly BYTE_CONTENT: "BYTE_CONTENT";
|
|
5324
|
-
readonly S3: "S3";
|
|
5325
|
-
};
|
|
5326
|
-
/**
|
|
5327
|
-
* @public
|
|
5328
|
-
*/
|
|
5329
|
-
export type FileSourceType = (typeof FileSourceType)[keyof typeof FileSourceType];
|
|
5330
4584
|
/**
|
|
5331
4585
|
* <p>The source file of the content contained in the wrapper object.</p>
|
|
5332
4586
|
* @public
|
|
@@ -5348,18 +4602,6 @@ export interface FileSource {
|
|
|
5348
4602
|
*/
|
|
5349
4603
|
byteContent?: ByteContentFile | undefined;
|
|
5350
4604
|
}
|
|
5351
|
-
/**
|
|
5352
|
-
* @public
|
|
5353
|
-
* @enum
|
|
5354
|
-
*/
|
|
5355
|
-
export declare const FileUseCase: {
|
|
5356
|
-
readonly CHAT: "CHAT";
|
|
5357
|
-
readonly CODE_INTERPRETER: "CODE_INTERPRETER";
|
|
5358
|
-
};
|
|
5359
|
-
/**
|
|
5360
|
-
* @public
|
|
5361
|
-
*/
|
|
5362
|
-
export type FileUseCase = (typeof FileUseCase)[keyof typeof FileUseCase];
|
|
5363
4605
|
/**
|
|
5364
4606
|
* <p>Contains details of the source files.</p>
|
|
5365
4607
|
* @public
|
|
@@ -5397,20 +4639,6 @@ export interface FilterAttribute {
|
|
|
5397
4639
|
*/
|
|
5398
4640
|
value: __DocumentType | undefined;
|
|
5399
4641
|
}
|
|
5400
|
-
/**
|
|
5401
|
-
* @public
|
|
5402
|
-
* @enum
|
|
5403
|
-
*/
|
|
5404
|
-
export declare const AttributeType: {
|
|
5405
|
-
readonly BOOLEAN: "BOOLEAN";
|
|
5406
|
-
readonly NUMBER: "NUMBER";
|
|
5407
|
-
readonly STRING: "STRING";
|
|
5408
|
-
readonly STRING_LIST: "STRING_LIST";
|
|
5409
|
-
};
|
|
5410
|
-
/**
|
|
5411
|
-
* @public
|
|
5412
|
-
*/
|
|
5413
|
-
export type AttributeType = (typeof AttributeType)[keyof typeof AttributeType];
|
|
5414
4642
|
/**
|
|
5415
4643
|
* <p>Details about a metadata attribute.</p>
|
|
5416
4644
|
* @public
|
|
@@ -5448,30 +4676,6 @@ export interface ImplicitFilterConfiguration {
|
|
|
5448
4676
|
*/
|
|
5449
4677
|
modelArn: string | undefined;
|
|
5450
4678
|
}
|
|
5451
|
-
/**
|
|
5452
|
-
* @public
|
|
5453
|
-
* @enum
|
|
5454
|
-
*/
|
|
5455
|
-
export declare const SearchType: {
|
|
5456
|
-
readonly HYBRID: "HYBRID";
|
|
5457
|
-
readonly SEMANTIC: "SEMANTIC";
|
|
5458
|
-
};
|
|
5459
|
-
/**
|
|
5460
|
-
* @public
|
|
5461
|
-
*/
|
|
5462
|
-
export type SearchType = (typeof SearchType)[keyof typeof SearchType];
|
|
5463
|
-
/**
|
|
5464
|
-
* @public
|
|
5465
|
-
* @enum
|
|
5466
|
-
*/
|
|
5467
|
-
export declare const RerankingMetadataSelectionMode: {
|
|
5468
|
-
readonly ALL: "ALL";
|
|
5469
|
-
readonly SELECTIVE: "SELECTIVE";
|
|
5470
|
-
};
|
|
5471
|
-
/**
|
|
5472
|
-
* @public
|
|
5473
|
-
*/
|
|
5474
|
-
export type RerankingMetadataSelectionMode = (typeof RerankingMetadataSelectionMode)[keyof typeof RerankingMetadataSelectionMode];
|
|
5475
4679
|
/**
|
|
5476
4680
|
* <p>Contains information for a metadata field to include in or exclude from consideration when reranking.</p>
|
|
5477
4681
|
* @public
|
|
@@ -5581,17 +4785,6 @@ export interface VectorSearchBedrockRerankingConfiguration {
|
|
|
5581
4785
|
*/
|
|
5582
4786
|
metadataConfiguration?: MetadataConfigurationForReranking | undefined;
|
|
5583
4787
|
}
|
|
5584
|
-
/**
|
|
5585
|
-
* @public
|
|
5586
|
-
* @enum
|
|
5587
|
-
*/
|
|
5588
|
-
export declare const VectorSearchRerankingConfigurationType: {
|
|
5589
|
-
readonly BEDROCK_RERANKING_MODEL: "BEDROCK_RERANKING_MODEL";
|
|
5590
|
-
};
|
|
5591
|
-
/**
|
|
5592
|
-
* @public
|
|
5593
|
-
*/
|
|
5594
|
-
export type VectorSearchRerankingConfigurationType = (typeof VectorSearchRerankingConfigurationType)[keyof typeof VectorSearchRerankingConfigurationType];
|
|
5595
4788
|
/**
|
|
5596
4789
|
* <p>Contains configurations for reranking the retrieved results.</p>
|
|
5597
4790
|
* @public
|
|
@@ -5742,18 +4935,6 @@ export interface FilePart {
|
|
|
5742
4935
|
*/
|
|
5743
4936
|
files?: OutputFile[] | undefined;
|
|
5744
4937
|
}
|
|
5745
|
-
/**
|
|
5746
|
-
* <p> The model specified in the request is not ready to serve inference requests. The AWS SDK will automatically retry the operation up to 5 times. For information about configuring automatic retries, see <a href="https://docs.aws.amazon.com/sdkref/latest/guide/feature-retry-behavior.html">Retry behavior</a> in the <i>AWS SDKs and Tools</i> reference guide. </p>
|
|
5747
|
-
* @public
|
|
5748
|
-
*/
|
|
5749
|
-
export declare class ModelNotReadyException extends __BaseException {
|
|
5750
|
-
readonly name: "ModelNotReadyException";
|
|
5751
|
-
readonly $fault: "client";
|
|
5752
|
-
/**
|
|
5753
|
-
* @internal
|
|
5754
|
-
*/
|
|
5755
|
-
constructor(opts: __ExceptionOptionType<ModelNotReadyException, __BaseException>);
|
|
5756
|
-
}
|
|
5757
4938
|
/**
|
|
5758
4939
|
* <p>The response from invoking the agent and associated citations and trace information.</p>
|
|
5759
4940
|
* @public
|
|
@@ -6135,18 +5316,6 @@ export interface InlineBedrockModelConfigurations {
|
|
|
6135
5316
|
*/
|
|
6136
5317
|
performanceConfig?: PerformanceConfiguration | undefined;
|
|
6137
5318
|
}
|
|
6138
|
-
/**
|
|
6139
|
-
* @public
|
|
6140
|
-
* @enum
|
|
6141
|
-
*/
|
|
6142
|
-
export declare const RelayConversationHistory: {
|
|
6143
|
-
readonly DISABLED: "DISABLED";
|
|
6144
|
-
readonly TO_COLLABORATOR: "TO_COLLABORATOR";
|
|
6145
|
-
};
|
|
6146
|
-
/**
|
|
6147
|
-
* @public
|
|
6148
|
-
*/
|
|
6149
|
-
export type RelayConversationHistory = (typeof RelayConversationHistory)[keyof typeof RelayConversationHistory];
|
|
6150
5319
|
/**
|
|
6151
5320
|
* <p> Settings of an inline collaborator agent. </p>
|
|
6152
5321
|
* @public
|
|
@@ -6189,18 +5358,6 @@ export interface GuardrailConfigurationWithArn {
|
|
|
6189
5358
|
*/
|
|
6190
5359
|
guardrailVersion: string | undefined;
|
|
6191
5360
|
}
|
|
6192
|
-
/**
|
|
6193
|
-
* @public
|
|
6194
|
-
* @enum
|
|
6195
|
-
*/
|
|
6196
|
-
export declare const PromptState: {
|
|
6197
|
-
readonly DISABLED: "DISABLED";
|
|
6198
|
-
readonly ENABLED: "ENABLED";
|
|
6199
|
-
};
|
|
6200
|
-
/**
|
|
6201
|
-
* @public
|
|
6202
|
-
*/
|
|
6203
|
-
export type PromptState = (typeof PromptState)[keyof typeof PromptState];
|
|
6204
5361
|
/**
|
|
6205
5362
|
* <p> Contains configurations to override a prompt template in one part of an agent sequence. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html">Advanced prompts</a>. </p>
|
|
6206
5363
|
* @public
|
|
@@ -6343,18 +5500,6 @@ export interface InlineSessionState {
|
|
|
6343
5500
|
*/
|
|
6344
5501
|
conversationHistory?: ConversationHistory | undefined;
|
|
6345
5502
|
}
|
|
6346
|
-
/**
|
|
6347
|
-
* @public
|
|
6348
|
-
* @enum
|
|
6349
|
-
*/
|
|
6350
|
-
export declare const OrchestrationType: {
|
|
6351
|
-
readonly CUSTOM_ORCHESTRATION: "CUSTOM_ORCHESTRATION";
|
|
6352
|
-
readonly DEFAULT: "DEFAULT";
|
|
6353
|
-
};
|
|
6354
|
-
/**
|
|
6355
|
-
* @public
|
|
6356
|
-
*/
|
|
6357
|
-
export type OrchestrationType = (typeof OrchestrationType)[keyof typeof OrchestrationType];
|
|
6358
5503
|
/**
|
|
6359
5504
|
* <p>Contains a part of an agent response and citations for it. </p>
|
|
6360
5505
|
* @public
|
|
@@ -6788,17 +5933,6 @@ export interface DeleteAgentMemoryRequest {
|
|
|
6788
5933
|
*/
|
|
6789
5934
|
export interface DeleteAgentMemoryResponse {
|
|
6790
5935
|
}
|
|
6791
|
-
/**
|
|
6792
|
-
* @public
|
|
6793
|
-
* @enum
|
|
6794
|
-
*/
|
|
6795
|
-
export declare const MemoryType: {
|
|
6796
|
-
readonly SESSION_SUMMARY: "SESSION_SUMMARY";
|
|
6797
|
-
};
|
|
6798
|
-
/**
|
|
6799
|
-
* @public
|
|
6800
|
-
*/
|
|
6801
|
-
export type MemoryType = (typeof MemoryType)[keyof typeof MemoryType];
|
|
6802
5936
|
/**
|
|
6803
5937
|
* @public
|
|
6804
5938
|
*/
|
|
@@ -7207,17 +6341,6 @@ export interface RerankTextDocument {
|
|
|
7207
6341
|
*/
|
|
7208
6342
|
text?: string | undefined;
|
|
7209
6343
|
}
|
|
7210
|
-
/**
|
|
7211
|
-
* @public
|
|
7212
|
-
* @enum
|
|
7213
|
-
*/
|
|
7214
|
-
export declare const RerankQueryContentType: {
|
|
7215
|
-
readonly TEXT: "TEXT";
|
|
7216
|
-
};
|
|
7217
|
-
/**
|
|
7218
|
-
* @public
|
|
7219
|
-
*/
|
|
7220
|
-
export type RerankQueryContentType = (typeof RerankQueryContentType)[keyof typeof RerankQueryContentType];
|
|
7221
6344
|
/**
|
|
7222
6345
|
* <p>Contains information about a query to submit to the reranker model.</p>
|
|
7223
6346
|
* @public
|
|
@@ -7266,17 +6389,6 @@ export interface BedrockRerankingConfiguration {
|
|
|
7266
6389
|
*/
|
|
7267
6390
|
modelConfiguration: BedrockRerankingModelConfiguration | undefined;
|
|
7268
6391
|
}
|
|
7269
|
-
/**
|
|
7270
|
-
* @public
|
|
7271
|
-
* @enum
|
|
7272
|
-
*/
|
|
7273
|
-
export declare const RerankingConfigurationType: {
|
|
7274
|
-
readonly BEDROCK_RERANKING_MODEL: "BEDROCK_RERANKING_MODEL";
|
|
7275
|
-
};
|
|
7276
|
-
/**
|
|
7277
|
-
* @public
|
|
7278
|
-
*/
|
|
7279
|
-
export type RerankingConfigurationType = (typeof RerankingConfigurationType)[keyof typeof RerankingConfigurationType];
|
|
7280
6392
|
/**
|
|
7281
6393
|
* <p>Contains configurations for reranking.</p>
|
|
7282
6394
|
* @public
|
|
@@ -7293,18 +6405,6 @@ export interface RerankingConfiguration {
|
|
|
7293
6405
|
*/
|
|
7294
6406
|
bedrockRerankingConfiguration: BedrockRerankingConfiguration | undefined;
|
|
7295
6407
|
}
|
|
7296
|
-
/**
|
|
7297
|
-
* @public
|
|
7298
|
-
* @enum
|
|
7299
|
-
*/
|
|
7300
|
-
export declare const RerankDocumentType: {
|
|
7301
|
-
readonly JSON: "JSON";
|
|
7302
|
-
readonly TEXT: "TEXT";
|
|
7303
|
-
};
|
|
7304
|
-
/**
|
|
7305
|
-
* @public
|
|
7306
|
-
*/
|
|
7307
|
-
export type RerankDocumentType = (typeof RerankDocumentType)[keyof typeof RerankDocumentType];
|
|
7308
6408
|
/**
|
|
7309
6409
|
* <p>Contains information about a document to rerank. Choose the <code>type</code> to define and include the field that corresponds to the type.</p>
|
|
7310
6410
|
* @public
|
|
@@ -7326,17 +6426,6 @@ export interface RerankDocument {
|
|
|
7326
6426
|
*/
|
|
7327
6427
|
jsonDocument?: __DocumentType | undefined;
|
|
7328
6428
|
}
|
|
7329
|
-
/**
|
|
7330
|
-
* @public
|
|
7331
|
-
* @enum
|
|
7332
|
-
*/
|
|
7333
|
-
export declare const RerankSourceType: {
|
|
7334
|
-
readonly INLINE: "INLINE";
|
|
7335
|
-
};
|
|
7336
|
-
/**
|
|
7337
|
-
* @public
|
|
7338
|
-
*/
|
|
7339
|
-
export type RerankSourceType = (typeof RerankSourceType)[keyof typeof RerankSourceType];
|
|
7340
6429
|
/**
|
|
7341
6430
|
* <p>Contains information about a source for reranking.</p>
|
|
7342
6431
|
* @public
|
|
@@ -7552,3 +6641,2078 @@ export interface S3ObjectDoc {
|
|
|
7552
6641
|
*/
|
|
7553
6642
|
uri: string | undefined;
|
|
7554
6643
|
}
|
|
6644
|
+
/**
|
|
6645
|
+
* <p>The unique external source of the content contained in the wrapper object.</p>
|
|
6646
|
+
* @public
|
|
6647
|
+
*/
|
|
6648
|
+
export interface ExternalSource {
|
|
6649
|
+
/**
|
|
6650
|
+
* <p>The source type of the external source wrapper object.</p>
|
|
6651
|
+
* @public
|
|
6652
|
+
*/
|
|
6653
|
+
sourceType: ExternalSourceType | undefined;
|
|
6654
|
+
/**
|
|
6655
|
+
* <p>The S3 location of the external source wrapper object.</p>
|
|
6656
|
+
* @public
|
|
6657
|
+
*/
|
|
6658
|
+
s3Location?: S3ObjectDoc | undefined;
|
|
6659
|
+
/**
|
|
6660
|
+
* <p>The identifier, contentType, and data of the external source wrapper object.</p>
|
|
6661
|
+
* @public
|
|
6662
|
+
*/
|
|
6663
|
+
byteContent?: ByteContentDoc | undefined;
|
|
6664
|
+
}
|
|
6665
|
+
/**
|
|
6666
|
+
* <p>The configurations of the external source wrapper object in the <code>retrieveAndGenerate</code> function.</p>
|
|
6667
|
+
* @public
|
|
6668
|
+
*/
|
|
6669
|
+
export interface ExternalSourcesRetrieveAndGenerateConfiguration {
|
|
6670
|
+
/**
|
|
6671
|
+
* <p>The model Amazon Resource Name (ARN) for the external source wrapper object in the <code>retrieveAndGenerate</code> function.</p>
|
|
6672
|
+
* @public
|
|
6673
|
+
*/
|
|
6674
|
+
modelArn: string | undefined;
|
|
6675
|
+
/**
|
|
6676
|
+
* <p>The document for the external source wrapper object in the <code>retrieveAndGenerate</code> function.</p>
|
|
6677
|
+
* @public
|
|
6678
|
+
*/
|
|
6679
|
+
sources: ExternalSource[] | undefined;
|
|
6680
|
+
/**
|
|
6681
|
+
* <p>The prompt used with the external source wrapper object with the <code>retrieveAndGenerate</code> function.</p>
|
|
6682
|
+
* @public
|
|
6683
|
+
*/
|
|
6684
|
+
generationConfiguration?: ExternalSourcesGenerationConfiguration | undefined;
|
|
6685
|
+
}
|
|
6686
|
+
/**
|
|
6687
|
+
* <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>
|
|
6688
|
+
* @public
|
|
6689
|
+
*/
|
|
6690
|
+
export interface GenerationConfiguration {
|
|
6691
|
+
/**
|
|
6692
|
+
* <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>
|
|
6693
|
+
* @public
|
|
6694
|
+
*/
|
|
6695
|
+
promptTemplate?: PromptTemplate | undefined;
|
|
6696
|
+
/**
|
|
6697
|
+
* <p>The configuration details for the guardrail.</p>
|
|
6698
|
+
* @public
|
|
6699
|
+
*/
|
|
6700
|
+
guardrailConfiguration?: GuardrailConfiguration | undefined;
|
|
6701
|
+
/**
|
|
6702
|
+
* <p> Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source. </p>
|
|
6703
|
+
* @public
|
|
6704
|
+
*/
|
|
6705
|
+
inferenceConfig?: InferenceConfig | undefined;
|
|
6706
|
+
/**
|
|
6707
|
+
* <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>
|
|
6708
|
+
* @public
|
|
6709
|
+
*/
|
|
6710
|
+
additionalModelRequestFields?: Record<string, __DocumentType> | undefined;
|
|
6711
|
+
/**
|
|
6712
|
+
* <p>The latency configuration for the model.</p>
|
|
6713
|
+
* @public
|
|
6714
|
+
*/
|
|
6715
|
+
performanceConfig?: PerformanceConfiguration | undefined;
|
|
6716
|
+
}
|
|
6717
|
+
/**
|
|
6718
|
+
* <p>To split up the prompt and retrieve multiple sources, set the transformation type to <code>QUERY_DECOMPOSITION</code>.</p>
|
|
6719
|
+
* @public
|
|
6720
|
+
*/
|
|
6721
|
+
export interface QueryTransformationConfiguration {
|
|
6722
|
+
/**
|
|
6723
|
+
* <p>The type of transformation to apply to the prompt.</p>
|
|
6724
|
+
* @public
|
|
6725
|
+
*/
|
|
6726
|
+
type: QueryTransformationType | undefined;
|
|
6727
|
+
}
|
|
6728
|
+
/**
|
|
6729
|
+
* <p>Settings for how the model processes the prompt prior to retrieval and generation.</p>
|
|
6730
|
+
* @public
|
|
6731
|
+
*/
|
|
6732
|
+
export interface OrchestrationConfiguration {
|
|
6733
|
+
/**
|
|
6734
|
+
* <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>
|
|
6735
|
+
* @public
|
|
6736
|
+
*/
|
|
6737
|
+
promptTemplate?: PromptTemplate | undefined;
|
|
6738
|
+
/**
|
|
6739
|
+
* <p> Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source. </p>
|
|
6740
|
+
* @public
|
|
6741
|
+
*/
|
|
6742
|
+
inferenceConfig?: InferenceConfig | undefined;
|
|
6743
|
+
/**
|
|
6744
|
+
* <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>
|
|
6745
|
+
* @public
|
|
6746
|
+
*/
|
|
6747
|
+
additionalModelRequestFields?: Record<string, __DocumentType> | undefined;
|
|
6748
|
+
/**
|
|
6749
|
+
* <p>To split up the prompt and retrieve multiple sources, set the transformation type to <code>QUERY_DECOMPOSITION</code>.</p>
|
|
6750
|
+
* @public
|
|
6751
|
+
*/
|
|
6752
|
+
queryTransformationConfiguration?: QueryTransformationConfiguration | undefined;
|
|
6753
|
+
/**
|
|
6754
|
+
* <p>The latency configuration for the model.</p>
|
|
6755
|
+
* @public
|
|
6756
|
+
*/
|
|
6757
|
+
performanceConfig?: PerformanceConfiguration | undefined;
|
|
6758
|
+
}
|
|
6759
|
+
/**
|
|
6760
|
+
* <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>
|
|
6761
|
+
* @public
|
|
6762
|
+
*/
|
|
6763
|
+
export interface RetrieveAndGenerateSessionConfiguration {
|
|
6764
|
+
/**
|
|
6765
|
+
* <p>The ARN of the KMS key encrypting the session.</p>
|
|
6766
|
+
* @public
|
|
6767
|
+
*/
|
|
6768
|
+
kmsKeyArn: string | undefined;
|
|
6769
|
+
}
|
|
6770
|
+
/**
|
|
6771
|
+
* <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>
|
|
6772
|
+
* @public
|
|
6773
|
+
*/
|
|
6774
|
+
export interface RetrieveAndGenerateOutput {
|
|
6775
|
+
/**
|
|
6776
|
+
* <p>The response generated from querying the knowledge base.</p>
|
|
6777
|
+
* @public
|
|
6778
|
+
*/
|
|
6779
|
+
text: string | undefined;
|
|
6780
|
+
}
|
|
6781
|
+
/**
|
|
6782
|
+
* @public
|
|
6783
|
+
*/
|
|
6784
|
+
export interface RetrieveAndGenerateResponse {
|
|
6785
|
+
/**
|
|
6786
|
+
* <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>
|
|
6787
|
+
* @public
|
|
6788
|
+
*/
|
|
6789
|
+
sessionId: string | undefined;
|
|
6790
|
+
/**
|
|
6791
|
+
* <p>Contains the response generated from querying the knowledge base.</p>
|
|
6792
|
+
* @public
|
|
6793
|
+
*/
|
|
6794
|
+
output: RetrieveAndGenerateOutput | undefined;
|
|
6795
|
+
/**
|
|
6796
|
+
* <p>A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.</p>
|
|
6797
|
+
* @public
|
|
6798
|
+
*/
|
|
6799
|
+
citations?: Citation[] | undefined;
|
|
6800
|
+
/**
|
|
6801
|
+
* <p>Specifies if there is a guardrail intervention in the response.</p>
|
|
6802
|
+
* @public
|
|
6803
|
+
*/
|
|
6804
|
+
guardrailAction?: GuadrailAction | undefined;
|
|
6805
|
+
}
|
|
6806
|
+
/**
|
|
6807
|
+
* <p>A citation event.</p>
|
|
6808
|
+
* @public
|
|
6809
|
+
*/
|
|
6810
|
+
export interface CitationEvent {
|
|
6811
|
+
/**
|
|
6812
|
+
* <p>The citation.</p>
|
|
6813
|
+
*
|
|
6814
|
+
* @deprecated Citation is deprecated. Please use GeneratedResponsePart and RetrievedReferences for citation event.
|
|
6815
|
+
* @public
|
|
6816
|
+
*/
|
|
6817
|
+
citation?: Citation | undefined;
|
|
6818
|
+
/**
|
|
6819
|
+
* <p>The generated response to the citation event.</p>
|
|
6820
|
+
* @public
|
|
6821
|
+
*/
|
|
6822
|
+
generatedResponsePart?: GeneratedResponsePart | undefined;
|
|
6823
|
+
/**
|
|
6824
|
+
* <p>The retrieved references of the citation event.</p>
|
|
6825
|
+
* @public
|
|
6826
|
+
*/
|
|
6827
|
+
retrievedReferences?: RetrievedReference[] | undefined;
|
|
6828
|
+
}
|
|
6829
|
+
/**
|
|
6830
|
+
* <p>A guardrail event.</p>
|
|
6831
|
+
* @public
|
|
6832
|
+
*/
|
|
6833
|
+
export interface GuardrailEvent {
|
|
6834
|
+
/**
|
|
6835
|
+
* <p>The guardrail action.</p>
|
|
6836
|
+
* @public
|
|
6837
|
+
*/
|
|
6838
|
+
action?: GuadrailAction | undefined;
|
|
6839
|
+
}
|
|
6840
|
+
/**
|
|
6841
|
+
* <p>A retrieve and generate output event.</p>
|
|
6842
|
+
* @public
|
|
6843
|
+
*/
|
|
6844
|
+
export interface RetrieveAndGenerateOutputEvent {
|
|
6845
|
+
/**
|
|
6846
|
+
* <p>A text response.</p>
|
|
6847
|
+
* @public
|
|
6848
|
+
*/
|
|
6849
|
+
text: string | undefined;
|
|
6850
|
+
}
|
|
6851
|
+
/**
|
|
6852
|
+
* <p>A retrieve and generate stream response output.</p>
|
|
6853
|
+
* @public
|
|
6854
|
+
*/
|
|
6855
|
+
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;
|
|
6856
|
+
/**
|
|
6857
|
+
* @public
|
|
6858
|
+
*/
|
|
6859
|
+
export declare namespace RetrieveAndGenerateStreamResponseOutput {
|
|
6860
|
+
/**
|
|
6861
|
+
* <p>An output event.</p>
|
|
6862
|
+
* @public
|
|
6863
|
+
*/
|
|
6864
|
+
interface OutputMember {
|
|
6865
|
+
output: RetrieveAndGenerateOutputEvent;
|
|
6866
|
+
citation?: never;
|
|
6867
|
+
guardrail?: never;
|
|
6868
|
+
internalServerException?: never;
|
|
6869
|
+
validationException?: never;
|
|
6870
|
+
resourceNotFoundException?: never;
|
|
6871
|
+
serviceQuotaExceededException?: never;
|
|
6872
|
+
throttlingException?: never;
|
|
6873
|
+
accessDeniedException?: never;
|
|
6874
|
+
conflictException?: never;
|
|
6875
|
+
dependencyFailedException?: never;
|
|
6876
|
+
badGatewayException?: never;
|
|
6877
|
+
$unknown?: never;
|
|
6878
|
+
}
|
|
6879
|
+
/**
|
|
6880
|
+
* <p>A citation event.</p>
|
|
6881
|
+
* @public
|
|
6882
|
+
*/
|
|
6883
|
+
interface CitationMember {
|
|
6884
|
+
output?: never;
|
|
6885
|
+
citation: CitationEvent;
|
|
6886
|
+
guardrail?: never;
|
|
6887
|
+
internalServerException?: never;
|
|
6888
|
+
validationException?: never;
|
|
6889
|
+
resourceNotFoundException?: never;
|
|
6890
|
+
serviceQuotaExceededException?: never;
|
|
6891
|
+
throttlingException?: never;
|
|
6892
|
+
accessDeniedException?: never;
|
|
6893
|
+
conflictException?: never;
|
|
6894
|
+
dependencyFailedException?: never;
|
|
6895
|
+
badGatewayException?: never;
|
|
6896
|
+
$unknown?: never;
|
|
6897
|
+
}
|
|
6898
|
+
/**
|
|
6899
|
+
* <p>A guardrail event.</p>
|
|
6900
|
+
* @public
|
|
6901
|
+
*/
|
|
6902
|
+
interface GuardrailMember {
|
|
6903
|
+
output?: never;
|
|
6904
|
+
citation?: never;
|
|
6905
|
+
guardrail: GuardrailEvent;
|
|
6906
|
+
internalServerException?: never;
|
|
6907
|
+
validationException?: never;
|
|
6908
|
+
resourceNotFoundException?: never;
|
|
6909
|
+
serviceQuotaExceededException?: never;
|
|
6910
|
+
throttlingException?: never;
|
|
6911
|
+
accessDeniedException?: never;
|
|
6912
|
+
conflictException?: never;
|
|
6913
|
+
dependencyFailedException?: never;
|
|
6914
|
+
badGatewayException?: never;
|
|
6915
|
+
$unknown?: never;
|
|
6916
|
+
}
|
|
6917
|
+
/**
|
|
6918
|
+
* <p>An internal server error occurred. Retry your request.</p>
|
|
6919
|
+
* @public
|
|
6920
|
+
*/
|
|
6921
|
+
interface InternalServerExceptionMember {
|
|
6922
|
+
output?: never;
|
|
6923
|
+
citation?: never;
|
|
6924
|
+
guardrail?: never;
|
|
6925
|
+
internalServerException: InternalServerException;
|
|
6926
|
+
validationException?: never;
|
|
6927
|
+
resourceNotFoundException?: never;
|
|
6928
|
+
serviceQuotaExceededException?: never;
|
|
6929
|
+
throttlingException?: never;
|
|
6930
|
+
accessDeniedException?: never;
|
|
6931
|
+
conflictException?: never;
|
|
6932
|
+
dependencyFailedException?: never;
|
|
6933
|
+
badGatewayException?: never;
|
|
6934
|
+
$unknown?: never;
|
|
6935
|
+
}
|
|
6936
|
+
/**
|
|
6937
|
+
* <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>
|
|
6938
|
+
* @public
|
|
6939
|
+
*/
|
|
6940
|
+
interface ValidationExceptionMember {
|
|
6941
|
+
output?: never;
|
|
6942
|
+
citation?: never;
|
|
6943
|
+
guardrail?: never;
|
|
6944
|
+
internalServerException?: never;
|
|
6945
|
+
validationException: ValidationException;
|
|
6946
|
+
resourceNotFoundException?: never;
|
|
6947
|
+
serviceQuotaExceededException?: never;
|
|
6948
|
+
throttlingException?: never;
|
|
6949
|
+
accessDeniedException?: never;
|
|
6950
|
+
conflictException?: never;
|
|
6951
|
+
dependencyFailedException?: never;
|
|
6952
|
+
badGatewayException?: never;
|
|
6953
|
+
$unknown?: never;
|
|
6954
|
+
}
|
|
6955
|
+
/**
|
|
6956
|
+
* <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>
|
|
6957
|
+
* @public
|
|
6958
|
+
*/
|
|
6959
|
+
interface ResourceNotFoundExceptionMember {
|
|
6960
|
+
output?: never;
|
|
6961
|
+
citation?: never;
|
|
6962
|
+
guardrail?: never;
|
|
6963
|
+
internalServerException?: never;
|
|
6964
|
+
validationException?: never;
|
|
6965
|
+
resourceNotFoundException: ResourceNotFoundException;
|
|
6966
|
+
serviceQuotaExceededException?: never;
|
|
6967
|
+
throttlingException?: never;
|
|
6968
|
+
accessDeniedException?: never;
|
|
6969
|
+
conflictException?: never;
|
|
6970
|
+
dependencyFailedException?: never;
|
|
6971
|
+
badGatewayException?: never;
|
|
6972
|
+
$unknown?: never;
|
|
6973
|
+
}
|
|
6974
|
+
/**
|
|
6975
|
+
* <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>
|
|
6976
|
+
* @public
|
|
6977
|
+
*/
|
|
6978
|
+
interface ServiceQuotaExceededExceptionMember {
|
|
6979
|
+
output?: never;
|
|
6980
|
+
citation?: never;
|
|
6981
|
+
guardrail?: never;
|
|
6982
|
+
internalServerException?: never;
|
|
6983
|
+
validationException?: never;
|
|
6984
|
+
resourceNotFoundException?: never;
|
|
6985
|
+
serviceQuotaExceededException: ServiceQuotaExceededException;
|
|
6986
|
+
throttlingException?: never;
|
|
6987
|
+
accessDeniedException?: never;
|
|
6988
|
+
conflictException?: never;
|
|
6989
|
+
dependencyFailedException?: never;
|
|
6990
|
+
badGatewayException?: never;
|
|
6991
|
+
$unknown?: never;
|
|
6992
|
+
}
|
|
6993
|
+
/**
|
|
6994
|
+
* <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>
|
|
6995
|
+
* @public
|
|
6996
|
+
*/
|
|
6997
|
+
interface ThrottlingExceptionMember {
|
|
6998
|
+
output?: never;
|
|
6999
|
+
citation?: never;
|
|
7000
|
+
guardrail?: never;
|
|
7001
|
+
internalServerException?: never;
|
|
7002
|
+
validationException?: never;
|
|
7003
|
+
resourceNotFoundException?: never;
|
|
7004
|
+
serviceQuotaExceededException?: never;
|
|
7005
|
+
throttlingException: ThrottlingException;
|
|
7006
|
+
accessDeniedException?: never;
|
|
7007
|
+
conflictException?: never;
|
|
7008
|
+
dependencyFailedException?: never;
|
|
7009
|
+
badGatewayException?: never;
|
|
7010
|
+
$unknown?: never;
|
|
7011
|
+
}
|
|
7012
|
+
/**
|
|
7013
|
+
* <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>
|
|
7014
|
+
* @public
|
|
7015
|
+
*/
|
|
7016
|
+
interface AccessDeniedExceptionMember {
|
|
7017
|
+
output?: never;
|
|
7018
|
+
citation?: never;
|
|
7019
|
+
guardrail?: never;
|
|
7020
|
+
internalServerException?: never;
|
|
7021
|
+
validationException?: never;
|
|
7022
|
+
resourceNotFoundException?: never;
|
|
7023
|
+
serviceQuotaExceededException?: never;
|
|
7024
|
+
throttlingException?: never;
|
|
7025
|
+
accessDeniedException: AccessDeniedException;
|
|
7026
|
+
conflictException?: never;
|
|
7027
|
+
dependencyFailedException?: never;
|
|
7028
|
+
badGatewayException?: never;
|
|
7029
|
+
$unknown?: never;
|
|
7030
|
+
}
|
|
7031
|
+
/**
|
|
7032
|
+
* <p>Error occurred because of a conflict while performing an operation.</p>
|
|
7033
|
+
* @public
|
|
7034
|
+
*/
|
|
7035
|
+
interface ConflictExceptionMember {
|
|
7036
|
+
output?: never;
|
|
7037
|
+
citation?: never;
|
|
7038
|
+
guardrail?: never;
|
|
7039
|
+
internalServerException?: never;
|
|
7040
|
+
validationException?: never;
|
|
7041
|
+
resourceNotFoundException?: never;
|
|
7042
|
+
serviceQuotaExceededException?: never;
|
|
7043
|
+
throttlingException?: never;
|
|
7044
|
+
accessDeniedException?: never;
|
|
7045
|
+
conflictException: ConflictException;
|
|
7046
|
+
dependencyFailedException?: never;
|
|
7047
|
+
badGatewayException?: never;
|
|
7048
|
+
$unknown?: never;
|
|
7049
|
+
}
|
|
7050
|
+
/**
|
|
7051
|
+
* <p>The request failed due to a dependency error.</p>
|
|
7052
|
+
* @public
|
|
7053
|
+
*/
|
|
7054
|
+
interface DependencyFailedExceptionMember {
|
|
7055
|
+
output?: never;
|
|
7056
|
+
citation?: never;
|
|
7057
|
+
guardrail?: never;
|
|
7058
|
+
internalServerException?: never;
|
|
7059
|
+
validationException?: never;
|
|
7060
|
+
resourceNotFoundException?: never;
|
|
7061
|
+
serviceQuotaExceededException?: never;
|
|
7062
|
+
throttlingException?: never;
|
|
7063
|
+
accessDeniedException?: never;
|
|
7064
|
+
conflictException?: never;
|
|
7065
|
+
dependencyFailedException: DependencyFailedException;
|
|
7066
|
+
badGatewayException?: never;
|
|
7067
|
+
$unknown?: never;
|
|
7068
|
+
}
|
|
7069
|
+
/**
|
|
7070
|
+
* <p>The request failed due to a bad gateway error.</p>
|
|
7071
|
+
* @public
|
|
7072
|
+
*/
|
|
7073
|
+
interface BadGatewayExceptionMember {
|
|
7074
|
+
output?: never;
|
|
7075
|
+
citation?: never;
|
|
7076
|
+
guardrail?: never;
|
|
7077
|
+
internalServerException?: never;
|
|
7078
|
+
validationException?: never;
|
|
7079
|
+
resourceNotFoundException?: never;
|
|
7080
|
+
serviceQuotaExceededException?: never;
|
|
7081
|
+
throttlingException?: never;
|
|
7082
|
+
accessDeniedException?: never;
|
|
7083
|
+
conflictException?: never;
|
|
7084
|
+
dependencyFailedException?: never;
|
|
7085
|
+
badGatewayException: BadGatewayException;
|
|
7086
|
+
$unknown?: never;
|
|
7087
|
+
}
|
|
7088
|
+
/**
|
|
7089
|
+
* @public
|
|
7090
|
+
*/
|
|
7091
|
+
interface $UnknownMember {
|
|
7092
|
+
output?: never;
|
|
7093
|
+
citation?: never;
|
|
7094
|
+
guardrail?: never;
|
|
7095
|
+
internalServerException?: never;
|
|
7096
|
+
validationException?: never;
|
|
7097
|
+
resourceNotFoundException?: never;
|
|
7098
|
+
serviceQuotaExceededException?: never;
|
|
7099
|
+
throttlingException?: never;
|
|
7100
|
+
accessDeniedException?: never;
|
|
7101
|
+
conflictException?: never;
|
|
7102
|
+
dependencyFailedException?: never;
|
|
7103
|
+
badGatewayException?: never;
|
|
7104
|
+
$unknown: [string, any];
|
|
7105
|
+
}
|
|
7106
|
+
/**
|
|
7107
|
+
* @deprecated unused in schema-serde mode.
|
|
7108
|
+
*
|
|
7109
|
+
*/
|
|
7110
|
+
interface Visitor<T> {
|
|
7111
|
+
output: (value: RetrieveAndGenerateOutputEvent) => T;
|
|
7112
|
+
citation: (value: CitationEvent) => T;
|
|
7113
|
+
guardrail: (value: GuardrailEvent) => T;
|
|
7114
|
+
internalServerException: (value: InternalServerException) => T;
|
|
7115
|
+
validationException: (value: ValidationException) => T;
|
|
7116
|
+
resourceNotFoundException: (value: ResourceNotFoundException) => T;
|
|
7117
|
+
serviceQuotaExceededException: (value: ServiceQuotaExceededException) => T;
|
|
7118
|
+
throttlingException: (value: ThrottlingException) => T;
|
|
7119
|
+
accessDeniedException: (value: AccessDeniedException) => T;
|
|
7120
|
+
conflictException: (value: ConflictException) => T;
|
|
7121
|
+
dependencyFailedException: (value: DependencyFailedException) => T;
|
|
7122
|
+
badGatewayException: (value: BadGatewayException) => T;
|
|
7123
|
+
_: (name: string, value: any) => T;
|
|
7124
|
+
}
|
|
7125
|
+
}
|
|
7126
|
+
/**
|
|
7127
|
+
* @public
|
|
7128
|
+
*/
|
|
7129
|
+
export interface RetrieveAndGenerateStreamResponse {
|
|
7130
|
+
/**
|
|
7131
|
+
* <p>A stream of events from the model.</p>
|
|
7132
|
+
* @public
|
|
7133
|
+
*/
|
|
7134
|
+
stream: AsyncIterable<RetrieveAndGenerateStreamResponseOutput> | undefined;
|
|
7135
|
+
/**
|
|
7136
|
+
* <p>The session ID.</p>
|
|
7137
|
+
* @public
|
|
7138
|
+
*/
|
|
7139
|
+
sessionId: string | undefined;
|
|
7140
|
+
}
|
|
7141
|
+
/**
|
|
7142
|
+
* <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>
|
|
7143
|
+
* @public
|
|
7144
|
+
*/
|
|
7145
|
+
export interface KnowledgeBaseQuery {
|
|
7146
|
+
/**
|
|
7147
|
+
* <p>The text of the query made to the knowledge base.</p>
|
|
7148
|
+
* @public
|
|
7149
|
+
*/
|
|
7150
|
+
text: string | undefined;
|
|
7151
|
+
}
|
|
7152
|
+
/**
|
|
7153
|
+
* <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>
|
|
7154
|
+
* @public
|
|
7155
|
+
*/
|
|
7156
|
+
export interface KnowledgeBaseRetrievalResult {
|
|
7157
|
+
/**
|
|
7158
|
+
* <p>Contains information about the content of the chunk.</p>
|
|
7159
|
+
* @public
|
|
7160
|
+
*/
|
|
7161
|
+
content: RetrievalResultContent | undefined;
|
|
7162
|
+
/**
|
|
7163
|
+
* <p>Contains information about the location of the data source.</p>
|
|
7164
|
+
* @public
|
|
7165
|
+
*/
|
|
7166
|
+
location?: RetrievalResultLocation | undefined;
|
|
7167
|
+
/**
|
|
7168
|
+
* <p>The level of relevance of the result to the query.</p>
|
|
7169
|
+
* @public
|
|
7170
|
+
*/
|
|
7171
|
+
score?: number | undefined;
|
|
7172
|
+
/**
|
|
7173
|
+
* <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>
|
|
7174
|
+
* @public
|
|
7175
|
+
*/
|
|
7176
|
+
metadata?: Record<string, __DocumentType> | undefined;
|
|
7177
|
+
}
|
|
7178
|
+
/**
|
|
7179
|
+
* @public
|
|
7180
|
+
*/
|
|
7181
|
+
export interface RetrieveResponse {
|
|
7182
|
+
/**
|
|
7183
|
+
* <p>A list of results from querying the knowledge base.</p>
|
|
7184
|
+
* @public
|
|
7185
|
+
*/
|
|
7186
|
+
retrievalResults: KnowledgeBaseRetrievalResult[] | undefined;
|
|
7187
|
+
/**
|
|
7188
|
+
* <p>Specifies if there is a guardrail intervention in the response.</p>
|
|
7189
|
+
* @public
|
|
7190
|
+
*/
|
|
7191
|
+
guardrailAction?: GuadrailAction | undefined;
|
|
7192
|
+
/**
|
|
7193
|
+
* <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>
|
|
7194
|
+
* @public
|
|
7195
|
+
*/
|
|
7196
|
+
nextToken?: string | undefined;
|
|
7197
|
+
}
|
|
7198
|
+
/**
|
|
7199
|
+
* @public
|
|
7200
|
+
*/
|
|
7201
|
+
export interface CreateSessionRequest {
|
|
7202
|
+
/**
|
|
7203
|
+
* <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>
|
|
7204
|
+
* @public
|
|
7205
|
+
*/
|
|
7206
|
+
sessionMetadata?: Record<string, string> | undefined;
|
|
7207
|
+
/**
|
|
7208
|
+
* <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>
|
|
7209
|
+
* @public
|
|
7210
|
+
*/
|
|
7211
|
+
encryptionKeyArn?: string | undefined;
|
|
7212
|
+
/**
|
|
7213
|
+
* <p>Specify the key-value pairs for the tags that you want to attach to the session.</p>
|
|
7214
|
+
* @public
|
|
7215
|
+
*/
|
|
7216
|
+
tags?: Record<string, string> | undefined;
|
|
7217
|
+
}
|
|
7218
|
+
/**
|
|
7219
|
+
* @public
|
|
7220
|
+
*/
|
|
7221
|
+
export interface CreateSessionResponse {
|
|
7222
|
+
/**
|
|
7223
|
+
* <p>The unique identifier for the session.</p>
|
|
7224
|
+
* @public
|
|
7225
|
+
*/
|
|
7226
|
+
sessionId: string | undefined;
|
|
7227
|
+
/**
|
|
7228
|
+
* <p>The Amazon Resource Name (ARN) of the created session.</p>
|
|
7229
|
+
* @public
|
|
7230
|
+
*/
|
|
7231
|
+
sessionArn: string | undefined;
|
|
7232
|
+
/**
|
|
7233
|
+
* <p>The current status of the session.</p>
|
|
7234
|
+
* @public
|
|
7235
|
+
*/
|
|
7236
|
+
sessionStatus: SessionStatus | undefined;
|
|
7237
|
+
/**
|
|
7238
|
+
* <p>The timestamp for when the session was created.</p>
|
|
7239
|
+
* @public
|
|
7240
|
+
*/
|
|
7241
|
+
createdAt: Date | undefined;
|
|
7242
|
+
}
|
|
7243
|
+
/**
|
|
7244
|
+
* @public
|
|
7245
|
+
*/
|
|
7246
|
+
export interface DeleteSessionRequest {
|
|
7247
|
+
/**
|
|
7248
|
+
* <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>
|
|
7249
|
+
* @public
|
|
7250
|
+
*/
|
|
7251
|
+
sessionIdentifier: string | undefined;
|
|
7252
|
+
}
|
|
7253
|
+
/**
|
|
7254
|
+
* @public
|
|
7255
|
+
*/
|
|
7256
|
+
export interface DeleteSessionResponse {
|
|
7257
|
+
}
|
|
7258
|
+
/**
|
|
7259
|
+
* @public
|
|
7260
|
+
*/
|
|
7261
|
+
export interface EndSessionRequest {
|
|
7262
|
+
/**
|
|
7263
|
+
* <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>
|
|
7264
|
+
* @public
|
|
7265
|
+
*/
|
|
7266
|
+
sessionIdentifier: string | undefined;
|
|
7267
|
+
}
|
|
7268
|
+
/**
|
|
7269
|
+
* @public
|
|
7270
|
+
*/
|
|
7271
|
+
export interface EndSessionResponse {
|
|
7272
|
+
/**
|
|
7273
|
+
* <p>The unique identifier of the session you ended.</p>
|
|
7274
|
+
* @public
|
|
7275
|
+
*/
|
|
7276
|
+
sessionId: string | undefined;
|
|
7277
|
+
/**
|
|
7278
|
+
* <p>The Amazon Resource Name (ARN) of the session you ended.</p>
|
|
7279
|
+
* @public
|
|
7280
|
+
*/
|
|
7281
|
+
sessionArn: string | undefined;
|
|
7282
|
+
/**
|
|
7283
|
+
* <p>The current status of the session you ended.</p>
|
|
7284
|
+
* @public
|
|
7285
|
+
*/
|
|
7286
|
+
sessionStatus: SessionStatus | undefined;
|
|
7287
|
+
}
|
|
7288
|
+
/**
|
|
7289
|
+
* @public
|
|
7290
|
+
*/
|
|
7291
|
+
export interface GetSessionRequest {
|
|
7292
|
+
/**
|
|
7293
|
+
* <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>
|
|
7294
|
+
* @public
|
|
7295
|
+
*/
|
|
7296
|
+
sessionIdentifier: string | undefined;
|
|
7297
|
+
}
|
|
7298
|
+
/**
|
|
7299
|
+
* @public
|
|
7300
|
+
*/
|
|
7301
|
+
export interface GetSessionResponse {
|
|
7302
|
+
/**
|
|
7303
|
+
* <p>The unique identifier for the session in UUID format.</p>
|
|
7304
|
+
* @public
|
|
7305
|
+
*/
|
|
7306
|
+
sessionId: string | undefined;
|
|
7307
|
+
/**
|
|
7308
|
+
* <p>The Amazon Resource Name (ARN) of the session.</p>
|
|
7309
|
+
* @public
|
|
7310
|
+
*/
|
|
7311
|
+
sessionArn: string | undefined;
|
|
7312
|
+
/**
|
|
7313
|
+
* <p>The current status of the session.</p>
|
|
7314
|
+
* @public
|
|
7315
|
+
*/
|
|
7316
|
+
sessionStatus: SessionStatus | undefined;
|
|
7317
|
+
/**
|
|
7318
|
+
* <p>The timestamp for when the session was created.</p>
|
|
7319
|
+
* @public
|
|
7320
|
+
*/
|
|
7321
|
+
createdAt: Date | undefined;
|
|
7322
|
+
/**
|
|
7323
|
+
* <p>The timestamp for when the session was last modified.</p>
|
|
7324
|
+
* @public
|
|
7325
|
+
*/
|
|
7326
|
+
lastUpdatedAt: Date | undefined;
|
|
7327
|
+
/**
|
|
7328
|
+
* <p>A map of key-value pairs containing attributes persisted across the session.</p>
|
|
7329
|
+
* @public
|
|
7330
|
+
*/
|
|
7331
|
+
sessionMetadata?: Record<string, string> | undefined;
|
|
7332
|
+
/**
|
|
7333
|
+
* <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>
|
|
7334
|
+
* @public
|
|
7335
|
+
*/
|
|
7336
|
+
encryptionKeyArn?: string | undefined;
|
|
7337
|
+
}
|
|
7338
|
+
/**
|
|
7339
|
+
* @public
|
|
7340
|
+
*/
|
|
7341
|
+
export interface CreateInvocationRequest {
|
|
7342
|
+
/**
|
|
7343
|
+
* <p>A unique identifier for the invocation in UUID format.</p>
|
|
7344
|
+
* @public
|
|
7345
|
+
*/
|
|
7346
|
+
invocationId?: string | undefined;
|
|
7347
|
+
/**
|
|
7348
|
+
* <p>A description for the interactions in the invocation. For example, "User asking about weather in Seattle".</p>
|
|
7349
|
+
* @public
|
|
7350
|
+
*/
|
|
7351
|
+
description?: string | undefined;
|
|
7352
|
+
/**
|
|
7353
|
+
* <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>
|
|
7354
|
+
* @public
|
|
7355
|
+
*/
|
|
7356
|
+
sessionIdentifier: string | undefined;
|
|
7357
|
+
}
|
|
7358
|
+
/**
|
|
7359
|
+
* @public
|
|
7360
|
+
*/
|
|
7361
|
+
export interface CreateInvocationResponse {
|
|
7362
|
+
/**
|
|
7363
|
+
* <p>The unique identifier for the session associated with the invocation.</p>
|
|
7364
|
+
* @public
|
|
7365
|
+
*/
|
|
7366
|
+
sessionId: string | undefined;
|
|
7367
|
+
/**
|
|
7368
|
+
* <p>The unique identifier for the invocation.</p>
|
|
7369
|
+
* @public
|
|
7370
|
+
*/
|
|
7371
|
+
invocationId: string | undefined;
|
|
7372
|
+
/**
|
|
7373
|
+
* <p>The timestamp for when the invocation was created.</p>
|
|
7374
|
+
* @public
|
|
7375
|
+
*/
|
|
7376
|
+
createdAt: Date | undefined;
|
|
7377
|
+
}
|
|
7378
|
+
/**
|
|
7379
|
+
* @public
|
|
7380
|
+
*/
|
|
7381
|
+
export interface ListInvocationsRequest {
|
|
7382
|
+
/**
|
|
7383
|
+
* <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>
|
|
7384
|
+
* @public
|
|
7385
|
+
*/
|
|
7386
|
+
nextToken?: string | undefined;
|
|
7387
|
+
/**
|
|
7388
|
+
* <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>
|
|
7389
|
+
* @public
|
|
7390
|
+
*/
|
|
7391
|
+
maxResults?: number | undefined;
|
|
7392
|
+
/**
|
|
7393
|
+
* <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>
|
|
7394
|
+
* @public
|
|
7395
|
+
*/
|
|
7396
|
+
sessionIdentifier: string | undefined;
|
|
7397
|
+
}
|
|
7398
|
+
/**
|
|
7399
|
+
* <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>
|
|
7400
|
+
* @public
|
|
7401
|
+
*/
|
|
7402
|
+
export interface InvocationSummary {
|
|
7403
|
+
/**
|
|
7404
|
+
* <p>The unique identifier for the session associated with the invocation.</p>
|
|
7405
|
+
* @public
|
|
7406
|
+
*/
|
|
7407
|
+
sessionId: string | undefined;
|
|
7408
|
+
/**
|
|
7409
|
+
* <p>A unique identifier for the invocation in UUID format.</p>
|
|
7410
|
+
* @public
|
|
7411
|
+
*/
|
|
7412
|
+
invocationId: string | undefined;
|
|
7413
|
+
/**
|
|
7414
|
+
* <p>The timestamp for when the invocation was created.</p>
|
|
7415
|
+
* @public
|
|
7416
|
+
*/
|
|
7417
|
+
createdAt: Date | undefined;
|
|
7418
|
+
}
|
|
7419
|
+
/**
|
|
7420
|
+
* @public
|
|
7421
|
+
*/
|
|
7422
|
+
export interface ListInvocationsResponse {
|
|
7423
|
+
/**
|
|
7424
|
+
* <p>A list of invocation summaries associated with the session.</p>
|
|
7425
|
+
* @public
|
|
7426
|
+
*/
|
|
7427
|
+
invocationSummaries: InvocationSummary[] | undefined;
|
|
7428
|
+
/**
|
|
7429
|
+
* <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>
|
|
7430
|
+
* @public
|
|
7431
|
+
*/
|
|
7432
|
+
nextToken?: string | undefined;
|
|
7433
|
+
}
|
|
7434
|
+
/**
|
|
7435
|
+
* @public
|
|
7436
|
+
*/
|
|
7437
|
+
export interface GetInvocationStepRequest {
|
|
7438
|
+
/**
|
|
7439
|
+
* <p>The unique identifier for the invocation in UUID format.</p>
|
|
7440
|
+
* @public
|
|
7441
|
+
*/
|
|
7442
|
+
invocationIdentifier: string | undefined;
|
|
7443
|
+
/**
|
|
7444
|
+
* <p>The unique identifier (in UUID format) for the specific invocation step to retrieve.</p>
|
|
7445
|
+
* @public
|
|
7446
|
+
*/
|
|
7447
|
+
invocationStepId: string | undefined;
|
|
7448
|
+
/**
|
|
7449
|
+
* <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>
|
|
7450
|
+
* @public
|
|
7451
|
+
*/
|
|
7452
|
+
sessionIdentifier: string | undefined;
|
|
7453
|
+
}
|
|
7454
|
+
/**
|
|
7455
|
+
* <p>Information about the Amazon S3 bucket where the image is stored.</p>
|
|
7456
|
+
* @public
|
|
7457
|
+
*/
|
|
7458
|
+
export interface S3Location {
|
|
7459
|
+
/**
|
|
7460
|
+
* <p>The path to the Amazon S3 bucket where the image is stored.</p>
|
|
7461
|
+
* @public
|
|
7462
|
+
*/
|
|
7463
|
+
uri: string | undefined;
|
|
7464
|
+
}
|
|
7465
|
+
/**
|
|
7466
|
+
* <p>The source for an image.</p>
|
|
7467
|
+
* @public
|
|
7468
|
+
*/
|
|
7469
|
+
export type ImageSource = ImageSource.BytesMember | ImageSource.S3LocationMember | ImageSource.$UnknownMember;
|
|
7470
|
+
/**
|
|
7471
|
+
* @public
|
|
7472
|
+
*/
|
|
7473
|
+
export declare namespace ImageSource {
|
|
7474
|
+
/**
|
|
7475
|
+
* <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>
|
|
7476
|
+
* @public
|
|
7477
|
+
*/
|
|
7478
|
+
interface BytesMember {
|
|
7479
|
+
bytes: Uint8Array;
|
|
7480
|
+
s3Location?: never;
|
|
7481
|
+
$unknown?: never;
|
|
7482
|
+
}
|
|
7483
|
+
/**
|
|
7484
|
+
* <p>The path to the Amazon S3 bucket where the image is stored.</p>
|
|
7485
|
+
* @public
|
|
7486
|
+
*/
|
|
7487
|
+
interface S3LocationMember {
|
|
7488
|
+
bytes?: never;
|
|
7489
|
+
s3Location: S3Location;
|
|
7490
|
+
$unknown?: never;
|
|
7491
|
+
}
|
|
7492
|
+
/**
|
|
7493
|
+
* @public
|
|
7494
|
+
*/
|
|
7495
|
+
interface $UnknownMember {
|
|
7496
|
+
bytes?: never;
|
|
7497
|
+
s3Location?: never;
|
|
7498
|
+
$unknown: [string, any];
|
|
7499
|
+
}
|
|
7500
|
+
/**
|
|
7501
|
+
* @deprecated unused in schema-serde mode.
|
|
7502
|
+
*
|
|
7503
|
+
*/
|
|
7504
|
+
interface Visitor<T> {
|
|
7505
|
+
bytes: (value: Uint8Array) => T;
|
|
7506
|
+
s3Location: (value: S3Location) => T;
|
|
7507
|
+
_: (name: string, value: any) => T;
|
|
7508
|
+
}
|
|
7509
|
+
}
|
|
7510
|
+
/**
|
|
7511
|
+
* <p>Image content for an invocation step.</p>
|
|
7512
|
+
* @public
|
|
7513
|
+
*/
|
|
7514
|
+
export interface ImageBlock {
|
|
7515
|
+
/**
|
|
7516
|
+
* <p>The format of the image.</p>
|
|
7517
|
+
* @public
|
|
7518
|
+
*/
|
|
7519
|
+
format: ImageFormat | undefined;
|
|
7520
|
+
/**
|
|
7521
|
+
* <p>The source for the image.</p>
|
|
7522
|
+
* @public
|
|
7523
|
+
*/
|
|
7524
|
+
source: ImageSource | undefined;
|
|
7525
|
+
}
|
|
7526
|
+
/**
|
|
7527
|
+
* <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>
|
|
7528
|
+
* @public
|
|
7529
|
+
*/
|
|
7530
|
+
export type BedrockSessionContentBlock = BedrockSessionContentBlock.ImageMember | BedrockSessionContentBlock.TextMember | BedrockSessionContentBlock.$UnknownMember;
|
|
7531
|
+
/**
|
|
7532
|
+
* @public
|
|
7533
|
+
*/
|
|
7534
|
+
export declare namespace BedrockSessionContentBlock {
|
|
7535
|
+
/**
|
|
7536
|
+
* <p>The text in the invocation step.</p>
|
|
7537
|
+
* @public
|
|
7538
|
+
*/
|
|
7539
|
+
interface TextMember {
|
|
7540
|
+
text: string;
|
|
7541
|
+
image?: never;
|
|
7542
|
+
$unknown?: never;
|
|
7543
|
+
}
|
|
7544
|
+
/**
|
|
7545
|
+
* <p>The image in the invocation step.</p>
|
|
7546
|
+
* @public
|
|
7547
|
+
*/
|
|
7548
|
+
interface ImageMember {
|
|
7549
|
+
text?: never;
|
|
7550
|
+
image: ImageBlock;
|
|
7551
|
+
$unknown?: never;
|
|
7552
|
+
}
|
|
7553
|
+
/**
|
|
7554
|
+
* @public
|
|
7555
|
+
*/
|
|
7556
|
+
interface $UnknownMember {
|
|
7557
|
+
text?: never;
|
|
7558
|
+
image?: never;
|
|
7559
|
+
$unknown: [string, any];
|
|
7560
|
+
}
|
|
7561
|
+
/**
|
|
7562
|
+
* @deprecated unused in schema-serde mode.
|
|
7563
|
+
*
|
|
7564
|
+
*/
|
|
7565
|
+
interface Visitor<T> {
|
|
7566
|
+
text: (value: string) => T;
|
|
7567
|
+
image: (value: ImageBlock) => T;
|
|
7568
|
+
_: (name: string, value: any) => T;
|
|
7569
|
+
}
|
|
7570
|
+
}
|
|
7571
|
+
/**
|
|
7572
|
+
* <p>Payload content, such as text and images, for the invocation step.</p>
|
|
7573
|
+
* @public
|
|
7574
|
+
*/
|
|
7575
|
+
export type InvocationStepPayload = InvocationStepPayload.ContentBlocksMember | InvocationStepPayload.$UnknownMember;
|
|
7576
|
+
/**
|
|
7577
|
+
* @public
|
|
7578
|
+
*/
|
|
7579
|
+
export declare namespace InvocationStepPayload {
|
|
7580
|
+
/**
|
|
7581
|
+
* <p>The content for the invocation step.</p>
|
|
7582
|
+
* @public
|
|
7583
|
+
*/
|
|
7584
|
+
interface ContentBlocksMember {
|
|
7585
|
+
contentBlocks: BedrockSessionContentBlock[];
|
|
7586
|
+
$unknown?: never;
|
|
7587
|
+
}
|
|
7588
|
+
/**
|
|
7589
|
+
* @public
|
|
7590
|
+
*/
|
|
7591
|
+
interface $UnknownMember {
|
|
7592
|
+
contentBlocks?: never;
|
|
7593
|
+
$unknown: [string, any];
|
|
7594
|
+
}
|
|
7595
|
+
/**
|
|
7596
|
+
* @deprecated unused in schema-serde mode.
|
|
7597
|
+
*
|
|
7598
|
+
*/
|
|
7599
|
+
interface Visitor<T> {
|
|
7600
|
+
contentBlocks: (value: BedrockSessionContentBlock[]) => T;
|
|
7601
|
+
_: (name: string, value: any) => T;
|
|
7602
|
+
}
|
|
7603
|
+
}
|
|
7604
|
+
/**
|
|
7605
|
+
* <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>
|
|
7606
|
+
* @public
|
|
7607
|
+
*/
|
|
7608
|
+
export interface InvocationStep {
|
|
7609
|
+
/**
|
|
7610
|
+
* <p>The unique identifier of the session containing the invocation step.</p>
|
|
7611
|
+
* @public
|
|
7612
|
+
*/
|
|
7613
|
+
sessionId: string | undefined;
|
|
7614
|
+
/**
|
|
7615
|
+
* <p>The unique identifier (in UUID format) for the invocation that includes the invocation step.</p>
|
|
7616
|
+
* @public
|
|
7617
|
+
*/
|
|
7618
|
+
invocationId: string | undefined;
|
|
7619
|
+
/**
|
|
7620
|
+
* <p>The unique identifier (in UUID format) for the invocation step.</p>
|
|
7621
|
+
* @public
|
|
7622
|
+
*/
|
|
7623
|
+
invocationStepId: string | undefined;
|
|
7624
|
+
/**
|
|
7625
|
+
* <p>The timestamp for when the invocation step was created.</p>
|
|
7626
|
+
* @public
|
|
7627
|
+
*/
|
|
7628
|
+
invocationStepTime: Date | undefined;
|
|
7629
|
+
/**
|
|
7630
|
+
* <p>Payload content, such as text and images, for the invocation step.</p>
|
|
7631
|
+
* @public
|
|
7632
|
+
*/
|
|
7633
|
+
payload: InvocationStepPayload | undefined;
|
|
7634
|
+
}
|
|
7635
|
+
/**
|
|
7636
|
+
* @public
|
|
7637
|
+
*/
|
|
7638
|
+
export interface GetInvocationStepResponse {
|
|
7639
|
+
/**
|
|
7640
|
+
* <p>The complete details of the requested invocation step.</p>
|
|
7641
|
+
* @public
|
|
7642
|
+
*/
|
|
7643
|
+
invocationStep: InvocationStep | undefined;
|
|
7644
|
+
}
|
|
7645
|
+
/**
|
|
7646
|
+
* @public
|
|
7647
|
+
*/
|
|
7648
|
+
export interface ListInvocationStepsRequest {
|
|
7649
|
+
/**
|
|
7650
|
+
* <p>The unique identifier (in UUID format) for the invocation to list invocation steps for.</p>
|
|
7651
|
+
* @public
|
|
7652
|
+
*/
|
|
7653
|
+
invocationIdentifier?: string | undefined;
|
|
7654
|
+
/**
|
|
7655
|
+
* <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>
|
|
7656
|
+
* @public
|
|
7657
|
+
*/
|
|
7658
|
+
nextToken?: string | undefined;
|
|
7659
|
+
/**
|
|
7660
|
+
* <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>
|
|
7661
|
+
* @public
|
|
7662
|
+
*/
|
|
7663
|
+
maxResults?: number | undefined;
|
|
7664
|
+
/**
|
|
7665
|
+
* <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>
|
|
7666
|
+
* @public
|
|
7667
|
+
*/
|
|
7668
|
+
sessionIdentifier: string | undefined;
|
|
7669
|
+
}
|
|
7670
|
+
/**
|
|
7671
|
+
* <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>
|
|
7672
|
+
* @public
|
|
7673
|
+
*/
|
|
7674
|
+
export interface InvocationStepSummary {
|
|
7675
|
+
/**
|
|
7676
|
+
* <p>The unique identifier for the session associated with the invocation step.</p>
|
|
7677
|
+
* @public
|
|
7678
|
+
*/
|
|
7679
|
+
sessionId: string | undefined;
|
|
7680
|
+
/**
|
|
7681
|
+
* <p>A unique identifier for the invocation in UUID format.</p>
|
|
7682
|
+
* @public
|
|
7683
|
+
*/
|
|
7684
|
+
invocationId: string | undefined;
|
|
7685
|
+
/**
|
|
7686
|
+
* <p>The unique identifier (in UUID format) for the invocation step.</p>
|
|
7687
|
+
* @public
|
|
7688
|
+
*/
|
|
7689
|
+
invocationStepId: string | undefined;
|
|
7690
|
+
/**
|
|
7691
|
+
* <p>The timestamp for when the invocation step was created.</p>
|
|
7692
|
+
* @public
|
|
7693
|
+
*/
|
|
7694
|
+
invocationStepTime: Date | undefined;
|
|
7695
|
+
}
|
|
7696
|
+
/**
|
|
7697
|
+
* @public
|
|
7698
|
+
*/
|
|
7699
|
+
export interface ListInvocationStepsResponse {
|
|
7700
|
+
/**
|
|
7701
|
+
* <p>A list of summaries for each invocation step associated with a session and if you specified it, an invocation within the session.</p>
|
|
7702
|
+
* @public
|
|
7703
|
+
*/
|
|
7704
|
+
invocationStepSummaries: InvocationStepSummary[] | undefined;
|
|
7705
|
+
/**
|
|
7706
|
+
* <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>
|
|
7707
|
+
* @public
|
|
7708
|
+
*/
|
|
7709
|
+
nextToken?: string | undefined;
|
|
7710
|
+
}
|
|
7711
|
+
/**
|
|
7712
|
+
* @public
|
|
7713
|
+
*/
|
|
7714
|
+
export interface PutInvocationStepRequest {
|
|
7715
|
+
/**
|
|
7716
|
+
* <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>
|
|
7717
|
+
* @public
|
|
7718
|
+
*/
|
|
7719
|
+
sessionIdentifier: string | undefined;
|
|
7720
|
+
/**
|
|
7721
|
+
* <p>The unique identifier (in UUID format) of the invocation to add the invocation step to.</p>
|
|
7722
|
+
* @public
|
|
7723
|
+
*/
|
|
7724
|
+
invocationIdentifier: string | undefined;
|
|
7725
|
+
/**
|
|
7726
|
+
* <p>The timestamp for when the invocation step occurred.</p>
|
|
7727
|
+
* @public
|
|
7728
|
+
*/
|
|
7729
|
+
invocationStepTime: Date | undefined;
|
|
7730
|
+
/**
|
|
7731
|
+
* <p>The payload for the invocation step, including text and images for the interaction.</p>
|
|
7732
|
+
* @public
|
|
7733
|
+
*/
|
|
7734
|
+
payload: InvocationStepPayload | undefined;
|
|
7735
|
+
/**
|
|
7736
|
+
* <p>The unique identifier of the invocation step in UUID format.</p>
|
|
7737
|
+
* @public
|
|
7738
|
+
*/
|
|
7739
|
+
invocationStepId?: string | undefined;
|
|
7740
|
+
}
|
|
7741
|
+
/**
|
|
7742
|
+
* @public
|
|
7743
|
+
*/
|
|
7744
|
+
export interface PutInvocationStepResponse {
|
|
7745
|
+
/**
|
|
7746
|
+
* <p>The unique identifier of the invocation step in UUID format.</p>
|
|
7747
|
+
* @public
|
|
7748
|
+
*/
|
|
7749
|
+
invocationStepId: string | undefined;
|
|
7750
|
+
}
|
|
7751
|
+
/**
|
|
7752
|
+
* @public
|
|
7753
|
+
*/
|
|
7754
|
+
export interface ListSessionsRequest {
|
|
7755
|
+
/**
|
|
7756
|
+
* <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>
|
|
7757
|
+
* @public
|
|
7758
|
+
*/
|
|
7759
|
+
maxResults?: number | undefined;
|
|
7760
|
+
/**
|
|
7761
|
+
* <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>
|
|
7762
|
+
* @public
|
|
7763
|
+
*/
|
|
7764
|
+
nextToken?: string | undefined;
|
|
7765
|
+
}
|
|
7766
|
+
/**
|
|
7767
|
+
* <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>
|
|
7768
|
+
* @public
|
|
7769
|
+
*/
|
|
7770
|
+
export interface SessionSummary {
|
|
7771
|
+
/**
|
|
7772
|
+
* <p>The unique identifier for the session.</p>
|
|
7773
|
+
* @public
|
|
7774
|
+
*/
|
|
7775
|
+
sessionId: string | undefined;
|
|
7776
|
+
/**
|
|
7777
|
+
* <p>The Amazon Resource Name (ARN) of the session.</p>
|
|
7778
|
+
* @public
|
|
7779
|
+
*/
|
|
7780
|
+
sessionArn: string | undefined;
|
|
7781
|
+
/**
|
|
7782
|
+
* <p>The current status of the session.</p>
|
|
7783
|
+
* @public
|
|
7784
|
+
*/
|
|
7785
|
+
sessionStatus: SessionStatus | undefined;
|
|
7786
|
+
/**
|
|
7787
|
+
* <p>The timestamp for when the session was created.</p>
|
|
7788
|
+
* @public
|
|
7789
|
+
*/
|
|
7790
|
+
createdAt: Date | undefined;
|
|
7791
|
+
/**
|
|
7792
|
+
* <p>The timestamp for when the session was last modified.</p>
|
|
7793
|
+
* @public
|
|
7794
|
+
*/
|
|
7795
|
+
lastUpdatedAt: Date | undefined;
|
|
7796
|
+
}
|
|
7797
|
+
/**
|
|
7798
|
+
* @public
|
|
7799
|
+
*/
|
|
7800
|
+
export interface ListSessionsResponse {
|
|
7801
|
+
/**
|
|
7802
|
+
* <p>A list of summaries for each session in your Amazon Web Services account.</p>
|
|
7803
|
+
* @public
|
|
7804
|
+
*/
|
|
7805
|
+
sessionSummaries: SessionSummary[] | undefined;
|
|
7806
|
+
/**
|
|
7807
|
+
* <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>
|
|
7808
|
+
* @public
|
|
7809
|
+
*/
|
|
7810
|
+
nextToken?: string | undefined;
|
|
7811
|
+
}
|
|
7812
|
+
/**
|
|
7813
|
+
* @public
|
|
7814
|
+
*/
|
|
7815
|
+
export interface UpdateSessionRequest {
|
|
7816
|
+
/**
|
|
7817
|
+
* <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>
|
|
7818
|
+
* @public
|
|
7819
|
+
*/
|
|
7820
|
+
sessionMetadata?: Record<string, string> | undefined;
|
|
7821
|
+
/**
|
|
7822
|
+
* <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>
|
|
7823
|
+
* @public
|
|
7824
|
+
*/
|
|
7825
|
+
sessionIdentifier: string | undefined;
|
|
7826
|
+
}
|
|
7827
|
+
/**
|
|
7828
|
+
* @public
|
|
7829
|
+
*/
|
|
7830
|
+
export interface UpdateSessionResponse {
|
|
7831
|
+
/**
|
|
7832
|
+
* <p>The unique identifier of the session you updated.</p>
|
|
7833
|
+
* @public
|
|
7834
|
+
*/
|
|
7835
|
+
sessionId: string | undefined;
|
|
7836
|
+
/**
|
|
7837
|
+
* <p>The Amazon Resource Name (ARN) of the session that was updated.</p>
|
|
7838
|
+
* @public
|
|
7839
|
+
*/
|
|
7840
|
+
sessionArn: string | undefined;
|
|
7841
|
+
/**
|
|
7842
|
+
* <p>The status of the session you updated.</p>
|
|
7843
|
+
* @public
|
|
7844
|
+
*/
|
|
7845
|
+
sessionStatus: SessionStatus | undefined;
|
|
7846
|
+
/**
|
|
7847
|
+
* <p>The timestamp for when the session was created.</p>
|
|
7848
|
+
* @public
|
|
7849
|
+
*/
|
|
7850
|
+
createdAt: Date | undefined;
|
|
7851
|
+
/**
|
|
7852
|
+
* <p>The timestamp for when the session was last modified.</p>
|
|
7853
|
+
* @public
|
|
7854
|
+
*/
|
|
7855
|
+
lastUpdatedAt: Date | undefined;
|
|
7856
|
+
}
|
|
7857
|
+
/**
|
|
7858
|
+
* @public
|
|
7859
|
+
*/
|
|
7860
|
+
export interface ListTagsForResourceRequest {
|
|
7861
|
+
/**
|
|
7862
|
+
* <p>The Amazon Resource Name (ARN) of the resource for which to list tags.</p>
|
|
7863
|
+
* @public
|
|
7864
|
+
*/
|
|
7865
|
+
resourceArn: string | undefined;
|
|
7866
|
+
}
|
|
7867
|
+
/**
|
|
7868
|
+
* @public
|
|
7869
|
+
*/
|
|
7870
|
+
export interface ListTagsForResourceResponse {
|
|
7871
|
+
/**
|
|
7872
|
+
* <p>The key-value pairs for the tags associated with the resource.</p>
|
|
7873
|
+
* @public
|
|
7874
|
+
*/
|
|
7875
|
+
tags?: Record<string, string> | undefined;
|
|
7876
|
+
}
|
|
7877
|
+
/**
|
|
7878
|
+
* @public
|
|
7879
|
+
*/
|
|
7880
|
+
export interface TagResourceRequest {
|
|
7881
|
+
/**
|
|
7882
|
+
* <p>The Amazon Resource Name (ARN) of the resource to tag.</p>
|
|
7883
|
+
* @public
|
|
7884
|
+
*/
|
|
7885
|
+
resourceArn: string | undefined;
|
|
7886
|
+
/**
|
|
7887
|
+
* <p>An object containing key-value pairs that define the tags to attach to the resource.</p>
|
|
7888
|
+
* @public
|
|
7889
|
+
*/
|
|
7890
|
+
tags: Record<string, string> | undefined;
|
|
7891
|
+
}
|
|
7892
|
+
/**
|
|
7893
|
+
* @public
|
|
7894
|
+
*/
|
|
7895
|
+
export interface TagResourceResponse {
|
|
7896
|
+
}
|
|
7897
|
+
/**
|
|
7898
|
+
* @public
|
|
7899
|
+
*/
|
|
7900
|
+
export interface UntagResourceRequest {
|
|
7901
|
+
/**
|
|
7902
|
+
* <p>The Amazon Resource Name (ARN) of the resource from which to remove tags.</p>
|
|
7903
|
+
* @public
|
|
7904
|
+
*/
|
|
7905
|
+
resourceArn: string | undefined;
|
|
7906
|
+
/**
|
|
7907
|
+
* <p>A list of keys of the tags to remove from the resource.</p>
|
|
7908
|
+
* @public
|
|
7909
|
+
*/
|
|
7910
|
+
tagKeys: string[] | undefined;
|
|
7911
|
+
}
|
|
7912
|
+
/**
|
|
7913
|
+
* @public
|
|
7914
|
+
*/
|
|
7915
|
+
export interface UntagResourceResponse {
|
|
7916
|
+
}
|
|
7917
|
+
/**
|
|
7918
|
+
* <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>
|
|
7919
|
+
* @public
|
|
7920
|
+
*/
|
|
7921
|
+
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;
|
|
7922
|
+
/**
|
|
7923
|
+
* @public
|
|
7924
|
+
*/
|
|
7925
|
+
export declare namespace RetrievalFilter {
|
|
7926
|
+
/**
|
|
7927
|
+
* <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>
|
|
7928
|
+
* @public
|
|
7929
|
+
*/
|
|
7930
|
+
interface EqualsMember {
|
|
7931
|
+
equals: FilterAttribute;
|
|
7932
|
+
notEquals?: never;
|
|
7933
|
+
greaterThan?: never;
|
|
7934
|
+
greaterThanOrEquals?: never;
|
|
7935
|
+
lessThan?: never;
|
|
7936
|
+
lessThanOrEquals?: never;
|
|
7937
|
+
in?: never;
|
|
7938
|
+
notIn?: never;
|
|
7939
|
+
startsWith?: never;
|
|
7940
|
+
listContains?: never;
|
|
7941
|
+
stringContains?: never;
|
|
7942
|
+
andAll?: never;
|
|
7943
|
+
orAll?: never;
|
|
7944
|
+
$unknown?: never;
|
|
7945
|
+
}
|
|
7946
|
+
/**
|
|
7947
|
+
* <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>
|
|
7948
|
+
* @public
|
|
7949
|
+
*/
|
|
7950
|
+
interface NotEqualsMember {
|
|
7951
|
+
equals?: never;
|
|
7952
|
+
notEquals: FilterAttribute;
|
|
7953
|
+
greaterThan?: never;
|
|
7954
|
+
greaterThanOrEquals?: never;
|
|
7955
|
+
lessThan?: never;
|
|
7956
|
+
lessThanOrEquals?: never;
|
|
7957
|
+
in?: never;
|
|
7958
|
+
notIn?: never;
|
|
7959
|
+
startsWith?: never;
|
|
7960
|
+
listContains?: never;
|
|
7961
|
+
stringContains?: never;
|
|
7962
|
+
andAll?: never;
|
|
7963
|
+
orAll?: never;
|
|
7964
|
+
$unknown?: never;
|
|
7965
|
+
}
|
|
7966
|
+
/**
|
|
7967
|
+
* <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>
|
|
7968
|
+
* @public
|
|
7969
|
+
*/
|
|
7970
|
+
interface GreaterThanMember {
|
|
7971
|
+
equals?: never;
|
|
7972
|
+
notEquals?: never;
|
|
7973
|
+
greaterThan: FilterAttribute;
|
|
7974
|
+
greaterThanOrEquals?: never;
|
|
7975
|
+
lessThan?: never;
|
|
7976
|
+
lessThanOrEquals?: never;
|
|
7977
|
+
in?: never;
|
|
7978
|
+
notIn?: never;
|
|
7979
|
+
startsWith?: never;
|
|
7980
|
+
listContains?: never;
|
|
7981
|
+
stringContains?: never;
|
|
7982
|
+
andAll?: never;
|
|
7983
|
+
orAll?: never;
|
|
7984
|
+
$unknown?: never;
|
|
7985
|
+
}
|
|
7986
|
+
/**
|
|
7987
|
+
* <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>
|
|
7988
|
+
* @public
|
|
7989
|
+
*/
|
|
7990
|
+
interface GreaterThanOrEqualsMember {
|
|
7991
|
+
equals?: never;
|
|
7992
|
+
notEquals?: never;
|
|
7993
|
+
greaterThan?: never;
|
|
7994
|
+
greaterThanOrEquals: FilterAttribute;
|
|
7995
|
+
lessThan?: never;
|
|
7996
|
+
lessThanOrEquals?: never;
|
|
7997
|
+
in?: never;
|
|
7998
|
+
notIn?: never;
|
|
7999
|
+
startsWith?: never;
|
|
8000
|
+
listContains?: never;
|
|
8001
|
+
stringContains?: never;
|
|
8002
|
+
andAll?: never;
|
|
8003
|
+
orAll?: never;
|
|
8004
|
+
$unknown?: never;
|
|
8005
|
+
}
|
|
8006
|
+
/**
|
|
8007
|
+
* <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>
|
|
8008
|
+
* @public
|
|
8009
|
+
*/
|
|
8010
|
+
interface LessThanMember {
|
|
8011
|
+
equals?: never;
|
|
8012
|
+
notEquals?: never;
|
|
8013
|
+
greaterThan?: never;
|
|
8014
|
+
greaterThanOrEquals?: never;
|
|
8015
|
+
lessThan: FilterAttribute;
|
|
8016
|
+
lessThanOrEquals?: never;
|
|
8017
|
+
in?: never;
|
|
8018
|
+
notIn?: never;
|
|
8019
|
+
startsWith?: never;
|
|
8020
|
+
listContains?: never;
|
|
8021
|
+
stringContains?: never;
|
|
8022
|
+
andAll?: never;
|
|
8023
|
+
orAll?: never;
|
|
8024
|
+
$unknown?: never;
|
|
8025
|
+
}
|
|
8026
|
+
/**
|
|
8027
|
+
* <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>
|
|
8028
|
+
* @public
|
|
8029
|
+
*/
|
|
8030
|
+
interface LessThanOrEqualsMember {
|
|
8031
|
+
equals?: never;
|
|
8032
|
+
notEquals?: never;
|
|
8033
|
+
greaterThan?: never;
|
|
8034
|
+
greaterThanOrEquals?: never;
|
|
8035
|
+
lessThan?: never;
|
|
8036
|
+
lessThanOrEquals: FilterAttribute;
|
|
8037
|
+
in?: never;
|
|
8038
|
+
notIn?: never;
|
|
8039
|
+
startsWith?: never;
|
|
8040
|
+
listContains?: never;
|
|
8041
|
+
stringContains?: never;
|
|
8042
|
+
andAll?: never;
|
|
8043
|
+
orAll?: never;
|
|
8044
|
+
$unknown?: never;
|
|
8045
|
+
}
|
|
8046
|
+
/**
|
|
8047
|
+
* <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>
|
|
8048
|
+
* @public
|
|
8049
|
+
*/
|
|
8050
|
+
interface InMember {
|
|
8051
|
+
equals?: never;
|
|
8052
|
+
notEquals?: never;
|
|
8053
|
+
greaterThan?: never;
|
|
8054
|
+
greaterThanOrEquals?: never;
|
|
8055
|
+
lessThan?: never;
|
|
8056
|
+
lessThanOrEquals?: never;
|
|
8057
|
+
in: FilterAttribute;
|
|
8058
|
+
notIn?: never;
|
|
8059
|
+
startsWith?: never;
|
|
8060
|
+
listContains?: never;
|
|
8061
|
+
stringContains?: never;
|
|
8062
|
+
andAll?: never;
|
|
8063
|
+
orAll?: never;
|
|
8064
|
+
$unknown?: never;
|
|
8065
|
+
}
|
|
8066
|
+
/**
|
|
8067
|
+
* <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>
|
|
8068
|
+
* @public
|
|
8069
|
+
*/
|
|
8070
|
+
interface NotInMember {
|
|
8071
|
+
equals?: never;
|
|
8072
|
+
notEquals?: never;
|
|
8073
|
+
greaterThan?: never;
|
|
8074
|
+
greaterThanOrEquals?: never;
|
|
8075
|
+
lessThan?: never;
|
|
8076
|
+
lessThanOrEquals?: never;
|
|
8077
|
+
in?: never;
|
|
8078
|
+
notIn: FilterAttribute;
|
|
8079
|
+
startsWith?: never;
|
|
8080
|
+
listContains?: never;
|
|
8081
|
+
stringContains?: never;
|
|
8082
|
+
andAll?: never;
|
|
8083
|
+
orAll?: never;
|
|
8084
|
+
$unknown?: never;
|
|
8085
|
+
}
|
|
8086
|
+
/**
|
|
8087
|
+
* <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>
|
|
8088
|
+
* @public
|
|
8089
|
+
*/
|
|
8090
|
+
interface StartsWithMember {
|
|
8091
|
+
equals?: never;
|
|
8092
|
+
notEquals?: never;
|
|
8093
|
+
greaterThan?: never;
|
|
8094
|
+
greaterThanOrEquals?: never;
|
|
8095
|
+
lessThan?: never;
|
|
8096
|
+
lessThanOrEquals?: never;
|
|
8097
|
+
in?: never;
|
|
8098
|
+
notIn?: never;
|
|
8099
|
+
startsWith: FilterAttribute;
|
|
8100
|
+
listContains?: never;
|
|
8101
|
+
stringContains?: never;
|
|
8102
|
+
andAll?: never;
|
|
8103
|
+
orAll?: never;
|
|
8104
|
+
$unknown?: never;
|
|
8105
|
+
}
|
|
8106
|
+
/**
|
|
8107
|
+
* <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>
|
|
8108
|
+
* @public
|
|
8109
|
+
*/
|
|
8110
|
+
interface ListContainsMember {
|
|
8111
|
+
equals?: never;
|
|
8112
|
+
notEquals?: never;
|
|
8113
|
+
greaterThan?: never;
|
|
8114
|
+
greaterThanOrEquals?: never;
|
|
8115
|
+
lessThan?: never;
|
|
8116
|
+
lessThanOrEquals?: never;
|
|
8117
|
+
in?: never;
|
|
8118
|
+
notIn?: never;
|
|
8119
|
+
startsWith?: never;
|
|
8120
|
+
listContains: FilterAttribute;
|
|
8121
|
+
stringContains?: never;
|
|
8122
|
+
andAll?: never;
|
|
8123
|
+
orAll?: never;
|
|
8124
|
+
$unknown?: never;
|
|
8125
|
+
}
|
|
8126
|
+
/**
|
|
8127
|
+
* <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>
|
|
8128
|
+
* @public
|
|
8129
|
+
*/
|
|
8130
|
+
interface StringContainsMember {
|
|
8131
|
+
equals?: never;
|
|
8132
|
+
notEquals?: never;
|
|
8133
|
+
greaterThan?: never;
|
|
8134
|
+
greaterThanOrEquals?: never;
|
|
8135
|
+
lessThan?: never;
|
|
8136
|
+
lessThanOrEquals?: never;
|
|
8137
|
+
in?: never;
|
|
8138
|
+
notIn?: never;
|
|
8139
|
+
startsWith?: never;
|
|
8140
|
+
listContains?: never;
|
|
8141
|
+
stringContains: FilterAttribute;
|
|
8142
|
+
andAll?: never;
|
|
8143
|
+
orAll?: never;
|
|
8144
|
+
$unknown?: never;
|
|
8145
|
+
}
|
|
8146
|
+
/**
|
|
8147
|
+
* <p>Knowledge base data sources are returned if their metadata attributes fulfill all the filter conditions inside this list.</p>
|
|
8148
|
+
* @public
|
|
8149
|
+
*/
|
|
8150
|
+
interface AndAllMember {
|
|
8151
|
+
equals?: never;
|
|
8152
|
+
notEquals?: never;
|
|
8153
|
+
greaterThan?: never;
|
|
8154
|
+
greaterThanOrEquals?: never;
|
|
8155
|
+
lessThan?: never;
|
|
8156
|
+
lessThanOrEquals?: never;
|
|
8157
|
+
in?: never;
|
|
8158
|
+
notIn?: never;
|
|
8159
|
+
startsWith?: never;
|
|
8160
|
+
listContains?: never;
|
|
8161
|
+
stringContains?: never;
|
|
8162
|
+
andAll: RetrievalFilter[];
|
|
8163
|
+
orAll?: never;
|
|
8164
|
+
$unknown?: never;
|
|
8165
|
+
}
|
|
8166
|
+
/**
|
|
8167
|
+
* <p>Knowledge base data sources are returned if their metadata attributes fulfill at least one of the filter conditions inside this list.</p>
|
|
8168
|
+
* @public
|
|
8169
|
+
*/
|
|
8170
|
+
interface OrAllMember {
|
|
8171
|
+
equals?: never;
|
|
8172
|
+
notEquals?: never;
|
|
8173
|
+
greaterThan?: never;
|
|
8174
|
+
greaterThanOrEquals?: never;
|
|
8175
|
+
lessThan?: never;
|
|
8176
|
+
lessThanOrEquals?: never;
|
|
8177
|
+
in?: never;
|
|
8178
|
+
notIn?: never;
|
|
8179
|
+
startsWith?: never;
|
|
8180
|
+
listContains?: never;
|
|
8181
|
+
stringContains?: never;
|
|
8182
|
+
andAll?: never;
|
|
8183
|
+
orAll: RetrievalFilter[];
|
|
8184
|
+
$unknown?: never;
|
|
8185
|
+
}
|
|
8186
|
+
/**
|
|
8187
|
+
* @public
|
|
8188
|
+
*/
|
|
8189
|
+
interface $UnknownMember {
|
|
8190
|
+
equals?: never;
|
|
8191
|
+
notEquals?: never;
|
|
8192
|
+
greaterThan?: never;
|
|
8193
|
+
greaterThanOrEquals?: never;
|
|
8194
|
+
lessThan?: never;
|
|
8195
|
+
lessThanOrEquals?: never;
|
|
8196
|
+
in?: never;
|
|
8197
|
+
notIn?: never;
|
|
8198
|
+
startsWith?: never;
|
|
8199
|
+
listContains?: never;
|
|
8200
|
+
stringContains?: never;
|
|
8201
|
+
andAll?: never;
|
|
8202
|
+
orAll?: never;
|
|
8203
|
+
$unknown: [string, any];
|
|
8204
|
+
}
|
|
8205
|
+
/**
|
|
8206
|
+
* @deprecated unused in schema-serde mode.
|
|
8207
|
+
*
|
|
8208
|
+
*/
|
|
8209
|
+
interface Visitor<T> {
|
|
8210
|
+
equals: (value: FilterAttribute) => T;
|
|
8211
|
+
notEquals: (value: FilterAttribute) => T;
|
|
8212
|
+
greaterThan: (value: FilterAttribute) => T;
|
|
8213
|
+
greaterThanOrEquals: (value: FilterAttribute) => T;
|
|
8214
|
+
lessThan: (value: FilterAttribute) => T;
|
|
8215
|
+
lessThanOrEquals: (value: FilterAttribute) => T;
|
|
8216
|
+
in: (value: FilterAttribute) => T;
|
|
8217
|
+
notIn: (value: FilterAttribute) => T;
|
|
8218
|
+
startsWith: (value: FilterAttribute) => T;
|
|
8219
|
+
listContains: (value: FilterAttribute) => T;
|
|
8220
|
+
stringContains: (value: FilterAttribute) => T;
|
|
8221
|
+
andAll: (value: RetrievalFilter[]) => T;
|
|
8222
|
+
orAll: (value: RetrievalFilter[]) => T;
|
|
8223
|
+
_: (name: string, value: any) => T;
|
|
8224
|
+
}
|
|
8225
|
+
}
|
|
8226
|
+
/**
|
|
8227
|
+
* <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>
|
|
8228
|
+
* @public
|
|
8229
|
+
*/
|
|
8230
|
+
export interface KnowledgeBaseVectorSearchConfiguration {
|
|
8231
|
+
/**
|
|
8232
|
+
* <p>The number of source chunks to retrieve.</p>
|
|
8233
|
+
* @public
|
|
8234
|
+
*/
|
|
8235
|
+
numberOfResults?: number | undefined;
|
|
8236
|
+
/**
|
|
8237
|
+
* <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>
|
|
8238
|
+
* @public
|
|
8239
|
+
*/
|
|
8240
|
+
overrideSearchType?: SearchType | undefined;
|
|
8241
|
+
/**
|
|
8242
|
+
* <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>
|
|
8243
|
+
* @public
|
|
8244
|
+
*/
|
|
8245
|
+
filter?: RetrievalFilter | undefined;
|
|
8246
|
+
/**
|
|
8247
|
+
* <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>
|
|
8248
|
+
* @public
|
|
8249
|
+
*/
|
|
8250
|
+
rerankingConfiguration?: VectorSearchRerankingConfiguration | undefined;
|
|
8251
|
+
/**
|
|
8252
|
+
* <p>Settings for implicit filtering.</p>
|
|
8253
|
+
* @public
|
|
8254
|
+
*/
|
|
8255
|
+
implicitFilterConfiguration?: ImplicitFilterConfiguration | undefined;
|
|
8256
|
+
}
|
|
8257
|
+
/**
|
|
8258
|
+
* <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>
|
|
8259
|
+
* @public
|
|
8260
|
+
*/
|
|
8261
|
+
export interface KnowledgeBaseRetrievalConfiguration {
|
|
8262
|
+
/**
|
|
8263
|
+
* <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>
|
|
8264
|
+
* @public
|
|
8265
|
+
*/
|
|
8266
|
+
vectorSearchConfiguration: KnowledgeBaseVectorSearchConfiguration | undefined;
|
|
8267
|
+
}
|
|
8268
|
+
/**
|
|
8269
|
+
* <p> Details of the knowledge base associated withe inline agent. </p>
|
|
8270
|
+
* @public
|
|
8271
|
+
*/
|
|
8272
|
+
export interface KnowledgeBase {
|
|
8273
|
+
/**
|
|
8274
|
+
* <p> The unique identifier for a knowledge base associated with the inline agent. </p>
|
|
8275
|
+
* @public
|
|
8276
|
+
*/
|
|
8277
|
+
knowledgeBaseId: string | undefined;
|
|
8278
|
+
/**
|
|
8279
|
+
* <p> The description of the knowledge base associated with the inline agent. </p>
|
|
8280
|
+
* @public
|
|
8281
|
+
*/
|
|
8282
|
+
description: string | undefined;
|
|
8283
|
+
/**
|
|
8284
|
+
* <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>
|
|
8285
|
+
* @public
|
|
8286
|
+
*/
|
|
8287
|
+
retrievalConfiguration?: KnowledgeBaseRetrievalConfiguration | undefined;
|
|
8288
|
+
}
|
|
8289
|
+
/**
|
|
8290
|
+
* <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>
|
|
8291
|
+
* @public
|
|
8292
|
+
*/
|
|
8293
|
+
export interface KnowledgeBaseConfiguration {
|
|
8294
|
+
/**
|
|
8295
|
+
* <p>The unique identifier for a knowledge base attached to the agent.</p>
|
|
8296
|
+
* @public
|
|
8297
|
+
*/
|
|
8298
|
+
knowledgeBaseId: string | undefined;
|
|
8299
|
+
/**
|
|
8300
|
+
* <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>
|
|
8301
|
+
* @public
|
|
8302
|
+
*/
|
|
8303
|
+
retrievalConfiguration: KnowledgeBaseRetrievalConfiguration | undefined;
|
|
8304
|
+
}
|
|
8305
|
+
/**
|
|
8306
|
+
* <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>
|
|
8307
|
+
* @public
|
|
8308
|
+
*/
|
|
8309
|
+
export interface KnowledgeBaseRetrieveAndGenerateConfiguration {
|
|
8310
|
+
/**
|
|
8311
|
+
* <p>The unique identifier of the knowledge base that is queried.</p>
|
|
8312
|
+
* @public
|
|
8313
|
+
*/
|
|
8314
|
+
knowledgeBaseId: string | undefined;
|
|
8315
|
+
/**
|
|
8316
|
+
* <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>
|
|
8317
|
+
* @public
|
|
8318
|
+
*/
|
|
8319
|
+
modelArn: string | undefined;
|
|
8320
|
+
/**
|
|
8321
|
+
* <p>Contains configurations for how to retrieve and return the knowledge base query.</p>
|
|
8322
|
+
* @public
|
|
8323
|
+
*/
|
|
8324
|
+
retrievalConfiguration?: KnowledgeBaseRetrievalConfiguration | undefined;
|
|
8325
|
+
/**
|
|
8326
|
+
* <p>Contains configurations for response generation based on the knowledge base query results.</p>
|
|
8327
|
+
* @public
|
|
8328
|
+
*/
|
|
8329
|
+
generationConfiguration?: GenerationConfiguration | undefined;
|
|
8330
|
+
/**
|
|
8331
|
+
* <p>Settings for how the model processes the prompt prior to retrieval and generation.</p>
|
|
8332
|
+
* @public
|
|
8333
|
+
*/
|
|
8334
|
+
orchestrationConfiguration?: OrchestrationConfiguration | undefined;
|
|
8335
|
+
}
|
|
8336
|
+
/**
|
|
8337
|
+
* @public
|
|
8338
|
+
*/
|
|
8339
|
+
export interface RetrieveRequest {
|
|
8340
|
+
/**
|
|
8341
|
+
* <p>The unique identifier of the knowledge base to query.</p>
|
|
8342
|
+
* @public
|
|
8343
|
+
*/
|
|
8344
|
+
knowledgeBaseId: string | undefined;
|
|
8345
|
+
/**
|
|
8346
|
+
* <p>Contains the query to send the knowledge base.</p>
|
|
8347
|
+
* @public
|
|
8348
|
+
*/
|
|
8349
|
+
retrievalQuery: KnowledgeBaseQuery | undefined;
|
|
8350
|
+
/**
|
|
8351
|
+
* <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>
|
|
8352
|
+
* @public
|
|
8353
|
+
*/
|
|
8354
|
+
retrievalConfiguration?: KnowledgeBaseRetrievalConfiguration | undefined;
|
|
8355
|
+
/**
|
|
8356
|
+
* <p>Guardrail settings.</p>
|
|
8357
|
+
* @public
|
|
8358
|
+
*/
|
|
8359
|
+
guardrailConfiguration?: GuardrailConfiguration | undefined;
|
|
8360
|
+
/**
|
|
8361
|
+
* <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>
|
|
8362
|
+
* @public
|
|
8363
|
+
*/
|
|
8364
|
+
nextToken?: string | undefined;
|
|
8365
|
+
}
|
|
8366
|
+
/**
|
|
8367
|
+
* <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>
|
|
8368
|
+
* @public
|
|
8369
|
+
*/
|
|
8370
|
+
export interface RetrieveAndGenerateConfiguration {
|
|
8371
|
+
/**
|
|
8372
|
+
* <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>
|
|
8373
|
+
* @public
|
|
8374
|
+
*/
|
|
8375
|
+
type: RetrieveAndGenerateType | undefined;
|
|
8376
|
+
/**
|
|
8377
|
+
* <p>Contains details about the knowledge base for retrieving information and generating responses.</p>
|
|
8378
|
+
* @public
|
|
8379
|
+
*/
|
|
8380
|
+
knowledgeBaseConfiguration?: KnowledgeBaseRetrieveAndGenerateConfiguration | undefined;
|
|
8381
|
+
/**
|
|
8382
|
+
* <p>The configuration for the external source wrapper object in the <code>retrieveAndGenerate</code> function.</p>
|
|
8383
|
+
* @public
|
|
8384
|
+
*/
|
|
8385
|
+
externalSourcesConfiguration?: ExternalSourcesRetrieveAndGenerateConfiguration | undefined;
|
|
8386
|
+
}
|
|
8387
|
+
/**
|
|
8388
|
+
* <p> List of inline collaborators. </p>
|
|
8389
|
+
* @public
|
|
8390
|
+
*/
|
|
8391
|
+
export interface Collaborator {
|
|
8392
|
+
/**
|
|
8393
|
+
* <p> The Amazon Resource Name (ARN) of the AWS KMS key that encrypts the inline collaborator. </p>
|
|
8394
|
+
* @public
|
|
8395
|
+
*/
|
|
8396
|
+
customerEncryptionKeyArn?: string | undefined;
|
|
8397
|
+
/**
|
|
8398
|
+
* <p> The foundation model used by the inline collaborator agent. </p>
|
|
8399
|
+
* @public
|
|
8400
|
+
*/
|
|
8401
|
+
foundationModel: string | undefined;
|
|
8402
|
+
/**
|
|
8403
|
+
* <p> Instruction that tell the inline collaborator agent what it should do and how it should interact with users. </p>
|
|
8404
|
+
* @public
|
|
8405
|
+
*/
|
|
8406
|
+
instruction: string | undefined;
|
|
8407
|
+
/**
|
|
8408
|
+
* <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>
|
|
8409
|
+
* @public
|
|
8410
|
+
*/
|
|
8411
|
+
idleSessionTTLInSeconds?: number | undefined;
|
|
8412
|
+
/**
|
|
8413
|
+
* <p> List of action groups with each action group defining tasks the inline collaborator agent needs to carry out. </p>
|
|
8414
|
+
* @public
|
|
8415
|
+
*/
|
|
8416
|
+
actionGroups?: AgentActionGroup[] | undefined;
|
|
8417
|
+
/**
|
|
8418
|
+
* <p> Knowledge base associated with the inline collaborator agent. </p>
|
|
8419
|
+
* @public
|
|
8420
|
+
*/
|
|
8421
|
+
knowledgeBases?: KnowledgeBase[] | undefined;
|
|
8422
|
+
/**
|
|
8423
|
+
* <p> Details of the guardwrail associated with the inline collaborator. </p>
|
|
8424
|
+
* @public
|
|
8425
|
+
*/
|
|
8426
|
+
guardrailConfiguration?: GuardrailConfigurationWithArn | undefined;
|
|
8427
|
+
/**
|
|
8428
|
+
* <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>
|
|
8429
|
+
* @public
|
|
8430
|
+
*/
|
|
8431
|
+
promptOverrideConfiguration?: PromptOverrideConfiguration | undefined;
|
|
8432
|
+
/**
|
|
8433
|
+
* <p> Defines how the inline supervisor agent handles information across multiple collaborator agents to coordinate a final response. </p>
|
|
8434
|
+
* @public
|
|
8435
|
+
*/
|
|
8436
|
+
agentCollaboration?: AgentCollaboration | undefined;
|
|
8437
|
+
/**
|
|
8438
|
+
* <p> Settings of the collaborator agent. </p>
|
|
8439
|
+
* @public
|
|
8440
|
+
*/
|
|
8441
|
+
collaboratorConfigurations?: CollaboratorConfiguration[] | undefined;
|
|
8442
|
+
/**
|
|
8443
|
+
* <p> Name of the inline collaborator agent which must be the same name as specified for <code>collaboratorName</code>. </p>
|
|
8444
|
+
* @public
|
|
8445
|
+
*/
|
|
8446
|
+
agentName?: string | undefined;
|
|
8447
|
+
}
|
|
8448
|
+
/**
|
|
8449
|
+
* @public
|
|
8450
|
+
*/
|
|
8451
|
+
export interface RetrieveAndGenerateRequest {
|
|
8452
|
+
/**
|
|
8453
|
+
* <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>
|
|
8454
|
+
* @public
|
|
8455
|
+
*/
|
|
8456
|
+
sessionId?: string | undefined;
|
|
8457
|
+
/**
|
|
8458
|
+
* <p>Contains the query to be made to the knowledge base.</p>
|
|
8459
|
+
* @public
|
|
8460
|
+
*/
|
|
8461
|
+
input: RetrieveAndGenerateInput | undefined;
|
|
8462
|
+
/**
|
|
8463
|
+
* <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>
|
|
8464
|
+
* @public
|
|
8465
|
+
*/
|
|
8466
|
+
retrieveAndGenerateConfiguration?: RetrieveAndGenerateConfiguration | undefined;
|
|
8467
|
+
/**
|
|
8468
|
+
* <p>Contains details about the session with the knowledge base.</p>
|
|
8469
|
+
* @public
|
|
8470
|
+
*/
|
|
8471
|
+
sessionConfiguration?: RetrieveAndGenerateSessionConfiguration | undefined;
|
|
8472
|
+
}
|
|
8473
|
+
/**
|
|
8474
|
+
* @public
|
|
8475
|
+
*/
|
|
8476
|
+
export interface RetrieveAndGenerateStreamRequest {
|
|
8477
|
+
/**
|
|
8478
|
+
* <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>
|
|
8479
|
+
* @public
|
|
8480
|
+
*/
|
|
8481
|
+
sessionId?: string | undefined;
|
|
8482
|
+
/**
|
|
8483
|
+
* <p>Contains the query to be made to the knowledge base.</p>
|
|
8484
|
+
* @public
|
|
8485
|
+
*/
|
|
8486
|
+
input: RetrieveAndGenerateInput | undefined;
|
|
8487
|
+
/**
|
|
8488
|
+
* <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>
|
|
8489
|
+
* @public
|
|
8490
|
+
*/
|
|
8491
|
+
retrieveAndGenerateConfiguration?: RetrieveAndGenerateConfiguration | undefined;
|
|
8492
|
+
/**
|
|
8493
|
+
* <p>Contains details about the session with the knowledge base.</p>
|
|
8494
|
+
* @public
|
|
8495
|
+
*/
|
|
8496
|
+
sessionConfiguration?: RetrieveAndGenerateSessionConfiguration | undefined;
|
|
8497
|
+
}
|
|
8498
|
+
/**
|
|
8499
|
+
* <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>
|
|
8500
|
+
* @public
|
|
8501
|
+
*/
|
|
8502
|
+
export interface SessionState {
|
|
8503
|
+
/**
|
|
8504
|
+
* <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>
|
|
8505
|
+
* @public
|
|
8506
|
+
*/
|
|
8507
|
+
sessionAttributes?: Record<string, string> | undefined;
|
|
8508
|
+
/**
|
|
8509
|
+
* <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>
|
|
8510
|
+
* @public
|
|
8511
|
+
*/
|
|
8512
|
+
promptSessionAttributes?: Record<string, string> | undefined;
|
|
8513
|
+
/**
|
|
8514
|
+
* <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>
|
|
8515
|
+
* @public
|
|
8516
|
+
*/
|
|
8517
|
+
returnControlInvocationResults?: InvocationResultMember[] | undefined;
|
|
8518
|
+
/**
|
|
8519
|
+
* <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>
|
|
8520
|
+
* @public
|
|
8521
|
+
*/
|
|
8522
|
+
invocationId?: string | undefined;
|
|
8523
|
+
/**
|
|
8524
|
+
* <p>Contains information about the files used by code interpreter.</p>
|
|
8525
|
+
* @public
|
|
8526
|
+
*/
|
|
8527
|
+
files?: InputFile[] | undefined;
|
|
8528
|
+
/**
|
|
8529
|
+
* <p>An array of configurations, each of which applies to a knowledge base attached to the agent.</p>
|
|
8530
|
+
* @public
|
|
8531
|
+
*/
|
|
8532
|
+
knowledgeBaseConfigurations?: KnowledgeBaseConfiguration[] | undefined;
|
|
8533
|
+
/**
|
|
8534
|
+
* <p>The state's conversation history.</p>
|
|
8535
|
+
* @public
|
|
8536
|
+
*/
|
|
8537
|
+
conversationHistory?: ConversationHistory | undefined;
|
|
8538
|
+
}
|
|
8539
|
+
/**
|
|
8540
|
+
* @public
|
|
8541
|
+
*/
|
|
8542
|
+
export interface InvokeAgentRequest {
|
|
8543
|
+
/**
|
|
8544
|
+
* <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>
|
|
8545
|
+
* @public
|
|
8546
|
+
*/
|
|
8547
|
+
sessionState?: SessionState | undefined;
|
|
8548
|
+
/**
|
|
8549
|
+
* <p>The unique identifier of the agent to use.</p>
|
|
8550
|
+
* @public
|
|
8551
|
+
*/
|
|
8552
|
+
agentId: string | undefined;
|
|
8553
|
+
/**
|
|
8554
|
+
* <p>The alias of the agent to use.</p>
|
|
8555
|
+
* @public
|
|
8556
|
+
*/
|
|
8557
|
+
agentAliasId: string | undefined;
|
|
8558
|
+
/**
|
|
8559
|
+
* <p>The unique identifier of the session. Use the same value across requests to continue the same conversation.</p>
|
|
8560
|
+
* @public
|
|
8561
|
+
*/
|
|
8562
|
+
sessionId: string | undefined;
|
|
8563
|
+
/**
|
|
8564
|
+
* <p>Specifies whether to end the session with the agent or not.</p>
|
|
8565
|
+
* @public
|
|
8566
|
+
*/
|
|
8567
|
+
endSession?: boolean | undefined;
|
|
8568
|
+
/**
|
|
8569
|
+
* <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>
|
|
8570
|
+
* @public
|
|
8571
|
+
*/
|
|
8572
|
+
enableTrace?: boolean | undefined;
|
|
8573
|
+
/**
|
|
8574
|
+
* <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>
|
|
8575
|
+
* @public
|
|
8576
|
+
*/
|
|
8577
|
+
inputText?: string | undefined;
|
|
8578
|
+
/**
|
|
8579
|
+
* <p>The unique identifier of the agent memory.</p>
|
|
8580
|
+
* @public
|
|
8581
|
+
*/
|
|
8582
|
+
memoryId?: string | undefined;
|
|
8583
|
+
/**
|
|
8584
|
+
* <p>Model performance settings for the request.</p>
|
|
8585
|
+
* @public
|
|
8586
|
+
*/
|
|
8587
|
+
bedrockModelConfigurations?: BedrockModelConfigurations | undefined;
|
|
8588
|
+
/**
|
|
8589
|
+
* <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>
|
|
8590
|
+
* @public
|
|
8591
|
+
*/
|
|
8592
|
+
streamingConfigurations?: StreamingConfigurations | undefined;
|
|
8593
|
+
/**
|
|
8594
|
+
* <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>
|
|
8595
|
+
* @public
|
|
8596
|
+
*/
|
|
8597
|
+
promptCreationConfigurations?: PromptCreationConfigurations | undefined;
|
|
8598
|
+
/**
|
|
8599
|
+
* <p>The ARN of the resource making the request.</p>
|
|
8600
|
+
* @public
|
|
8601
|
+
*/
|
|
8602
|
+
sourceArn?: string | undefined;
|
|
8603
|
+
}
|
|
8604
|
+
/**
|
|
8605
|
+
* @public
|
|
8606
|
+
*/
|
|
8607
|
+
export interface InvokeInlineAgentRequest {
|
|
8608
|
+
/**
|
|
8609
|
+
* <p> The Amazon Resource Name (ARN) of the Amazon Web Services KMS key to use to encrypt your inline agent. </p>
|
|
8610
|
+
* @public
|
|
8611
|
+
*/
|
|
8612
|
+
customerEncryptionKeyArn?: string | undefined;
|
|
8613
|
+
/**
|
|
8614
|
+
* <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>
|
|
8615
|
+
* @public
|
|
8616
|
+
*/
|
|
8617
|
+
foundationModel: string | undefined;
|
|
8618
|
+
/**
|
|
8619
|
+
* <p> The instructions that tell the inline agent what it should do and how it should interact with users. </p>
|
|
8620
|
+
* @public
|
|
8621
|
+
*/
|
|
8622
|
+
instruction: string | undefined;
|
|
8623
|
+
/**
|
|
8624
|
+
* <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>
|
|
8625
|
+
* @public
|
|
8626
|
+
*/
|
|
8627
|
+
idleSessionTTLInSeconds?: number | undefined;
|
|
8628
|
+
/**
|
|
8629
|
+
* <p> A list of action groups with each action group defining the action the inline agent needs to carry out. </p>
|
|
8630
|
+
* @public
|
|
8631
|
+
*/
|
|
8632
|
+
actionGroups?: AgentActionGroup[] | undefined;
|
|
8633
|
+
/**
|
|
8634
|
+
* <p> Contains information of the knowledge bases to associate with. </p>
|
|
8635
|
+
* @public
|
|
8636
|
+
*/
|
|
8637
|
+
knowledgeBases?: KnowledgeBase[] | undefined;
|
|
8638
|
+
/**
|
|
8639
|
+
* <p> The <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails.html">guardrails</a> to assign to the inline agent. </p>
|
|
8640
|
+
* @public
|
|
8641
|
+
*/
|
|
8642
|
+
guardrailConfiguration?: GuardrailConfigurationWithArn | undefined;
|
|
8643
|
+
/**
|
|
8644
|
+
* <p> Configurations for advanced prompts used to override the default prompts to enhance the accuracy of the inline agent. </p>
|
|
8645
|
+
* @public
|
|
8646
|
+
*/
|
|
8647
|
+
promptOverrideConfiguration?: PromptOverrideConfiguration | undefined;
|
|
8648
|
+
/**
|
|
8649
|
+
* <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>
|
|
8650
|
+
* @public
|
|
8651
|
+
*/
|
|
8652
|
+
agentCollaboration?: AgentCollaboration | undefined;
|
|
8653
|
+
/**
|
|
8654
|
+
* <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>
|
|
8655
|
+
* @public
|
|
8656
|
+
*/
|
|
8657
|
+
collaboratorConfigurations?: CollaboratorConfiguration[] | undefined;
|
|
8658
|
+
/**
|
|
8659
|
+
* <p>The name for the agent.</p>
|
|
8660
|
+
* @public
|
|
8661
|
+
*/
|
|
8662
|
+
agentName?: string | undefined;
|
|
8663
|
+
/**
|
|
8664
|
+
* <p> The unique identifier of the session. Use the same value across requests to continue the same conversation. </p>
|
|
8665
|
+
* @public
|
|
8666
|
+
*/
|
|
8667
|
+
sessionId: string | undefined;
|
|
8668
|
+
/**
|
|
8669
|
+
* <p> Specifies whether to end the session with the inline agent or not. </p>
|
|
8670
|
+
* @public
|
|
8671
|
+
*/
|
|
8672
|
+
endSession?: boolean | undefined;
|
|
8673
|
+
/**
|
|
8674
|
+
* <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>
|
|
8675
|
+
* @public
|
|
8676
|
+
*/
|
|
8677
|
+
enableTrace?: boolean | undefined;
|
|
8678
|
+
/**
|
|
8679
|
+
* <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>
|
|
8680
|
+
* @public
|
|
8681
|
+
*/
|
|
8682
|
+
inputText?: string | undefined;
|
|
8683
|
+
/**
|
|
8684
|
+
* <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>
|
|
8685
|
+
* @public
|
|
8686
|
+
*/
|
|
8687
|
+
streamingConfigurations?: StreamingConfigurations | undefined;
|
|
8688
|
+
/**
|
|
8689
|
+
* <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>
|
|
8690
|
+
* @public
|
|
8691
|
+
*/
|
|
8692
|
+
promptCreationConfigurations?: PromptCreationConfigurations | undefined;
|
|
8693
|
+
/**
|
|
8694
|
+
* <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>
|
|
8695
|
+
* @public
|
|
8696
|
+
*/
|
|
8697
|
+
inlineSessionState?: InlineSessionState | undefined;
|
|
8698
|
+
/**
|
|
8699
|
+
* <p> List of collaborator inline agents. </p>
|
|
8700
|
+
* @public
|
|
8701
|
+
*/
|
|
8702
|
+
collaborators?: Collaborator[] | undefined;
|
|
8703
|
+
/**
|
|
8704
|
+
* <p>Model settings for the request.</p>
|
|
8705
|
+
* @public
|
|
8706
|
+
*/
|
|
8707
|
+
bedrockModelConfigurations?: InlineBedrockModelConfigurations | undefined;
|
|
8708
|
+
/**
|
|
8709
|
+
* <p>Specifies the type of orchestration strategy for the agent. This is set to DEFAULT orchestration type, by default. </p>
|
|
8710
|
+
* @public
|
|
8711
|
+
*/
|
|
8712
|
+
orchestrationType?: OrchestrationType | undefined;
|
|
8713
|
+
/**
|
|
8714
|
+
* <p>Contains details of the custom orchestration configured for the agent. </p>
|
|
8715
|
+
* @public
|
|
8716
|
+
*/
|
|
8717
|
+
customOrchestration?: CustomOrchestration | undefined;
|
|
8718
|
+
}
|