@aws-sdk/client-bedrock-agent-runtime 3.1110.0 → 3.1112.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (52) hide show
  1. package/README.md +15 -1
  2. package/dist-cjs/index.js +302 -85
  3. package/dist-es/BedrockAgentRuntime.js +4 -0
  4. package/dist-es/commands/CheckIngestedDocumentAclCommand.js +4 -0
  5. package/dist-es/commands/GetIngestedDocumentAclCommand.js +4 -0
  6. package/dist-es/commands/index.js +2 -0
  7. package/dist-es/models/enums.js +26 -0
  8. package/dist-es/schemas/schemas_0.js +243 -84
  9. package/dist-types/BedrockAgentRuntime.d.ts +15 -1
  10. package/dist-types/BedrockAgentRuntimeClient.d.ts +5 -3
  11. package/dist-types/commands/AgenticRetrieveStreamCommand.d.ts +44 -2
  12. package/dist-types/commands/CheckIngestedDocumentAclCommand.d.ts +91 -0
  13. package/dist-types/commands/CreateInvocationCommand.d.ts +1 -1
  14. package/dist-types/commands/CreateSessionCommand.d.ts +1 -1
  15. package/dist-types/commands/DeleteSessionCommand.d.ts +1 -1
  16. package/dist-types/commands/EndSessionCommand.d.ts +1 -1
  17. package/dist-types/commands/GetIngestedDocumentAclCommand.d.ts +129 -0
  18. package/dist-types/commands/GetSessionCommand.d.ts +1 -1
  19. package/dist-types/commands/InvokeAgentCommand.d.ts +1 -1
  20. package/dist-types/commands/RetrieveAndGenerateStreamCommand.d.ts +1 -2
  21. package/dist-types/commands/RetrieveCommand.d.ts +1 -2
  22. package/dist-types/commands/index.d.ts +2 -0
  23. package/dist-types/index.d.ts +1 -1
  24. package/dist-types/models/enums.d.ts +100 -0
  25. package/dist-types/models/models_0.d.ts +454 -607
  26. package/dist-types/models/models_1.d.ts +582 -6
  27. package/dist-types/runtimeConfig.browser.d.ts +39 -39
  28. package/dist-types/runtimeConfig.d.ts +36 -36
  29. package/dist-types/runtimeConfig.native.d.ts +38 -38
  30. package/dist-types/runtimeConfig.shared.d.ts +2 -2
  31. package/dist-types/schemas/schemas_0.d.ts +19 -0
  32. package/dist-types/ts3.4/BedrockAgentRuntime.d.ts +34 -0
  33. package/dist-types/ts3.4/BedrockAgentRuntimeClient.d.ts +12 -0
  34. package/dist-types/ts3.4/commands/CheckIngestedDocumentAclCommand.d.ts +42 -0
  35. package/dist-types/ts3.4/commands/CreateInvocationCommand.d.ts +1 -1
  36. package/dist-types/ts3.4/commands/CreateSessionCommand.d.ts +1 -1
  37. package/dist-types/ts3.4/commands/DeleteSessionCommand.d.ts +1 -1
  38. package/dist-types/ts3.4/commands/EndSessionCommand.d.ts +1 -1
  39. package/dist-types/ts3.4/commands/GetIngestedDocumentAclCommand.d.ts +39 -0
  40. package/dist-types/ts3.4/commands/GetSessionCommand.d.ts +1 -1
  41. package/dist-types/ts3.4/commands/RetrieveAndGenerateStreamCommand.d.ts +4 -2
  42. package/dist-types/ts3.4/commands/RetrieveCommand.d.ts +1 -2
  43. package/dist-types/ts3.4/commands/index.d.ts +2 -0
  44. package/dist-types/ts3.4/models/enums.d.ts +34 -0
  45. package/dist-types/ts3.4/models/models_0.d.ts +155 -302
  46. package/dist-types/ts3.4/models/models_1.d.ts +320 -1
  47. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +55 -57
  48. package/dist-types/ts3.4/runtimeConfig.d.ts +58 -58
  49. package/dist-types/ts3.4/runtimeConfig.native.d.ts +59 -61
  50. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +3 -3
  51. package/dist-types/ts3.4/schemas/schemas_0.d.ts +19 -0
  52. package/package.json +5 -5
@@ -1,5 +1,5 @@
1
1
  import type { DocumentType as __DocumentType } from "@smithy/types";
2
- import type { ActionGroupSignature, ActionInvocationType, AgenticRetrieveRerankingConfigurationType, AgenticRetrieveRerankingModelType, AgenticRetrieveStatus, AgenticRetrieveStep, AgenticRetrieveType, AttributeType, ConfirmationState, ConversationRole, CreationMode, CustomControlMethod, DocumentOutputFormat, ExecutionType, ExternalSourceType, FileSourceType, FileUseCase, FlowCompletionReason, FlowControlNodeType, FlowErrorCode, FlowExecutionErrorType, FlowExecutionEventType, FlowExecutionStatus, FlowNodeInputCategory, FlowNodeIODataType, FoundationModelConfigurationType, FoundationModelType, GeneratedQueryType, GuadrailAction, GuardrailAction, GuardrailContentFilterConfidence, GuardrailContentFilterType, GuardrailContentPolicyAction, GuardrailManagedWordType, GuardrailPiiEntityType, GuardrailSensitiveInformationPolicyAction, GuardrailTopicPolicyAction, GuardrailTopicType, GuardrailWordPolicyAction, ImageInputFormat, InputImageFormat, InputQueryType, InvocationType, KnowledgeBaseQueryType, ManagedSearchRerankingConfigurationType, MemoryType, NodeErrorCode, NodeType, ParameterType, PayloadType, PerformanceConfigLatency, PromptState, PromptType, QueryTransformationMode, QueryTransformationType, RelayConversationHistory, RequireConfirmation, RerankDocumentType, RerankingConfigurationType, RerankingMetadataSelectionMode, RerankQueryContentType, RerankSourceType, ResponseState, RetrievalResultContentColumnType, RetrievalResultContentType, RetrievalResultLocationType, SessionStatus, Source, TextToSqlConfigurationType, Type, VectorSearchRerankingConfigurationType } from "./enums";
2
+ import type { ActionGroupSignature, ActionInvocationType, AgenticRetrieveMemoryMetadataFilterOperator, AgenticRetrieveMemoryPersistenceMode, AgenticRetrieveRerankingConfigurationType, AgenticRetrieveRerankingModelType, AgenticRetrieveStatus, AgenticRetrieveStep, AgenticRetrieveType, AttributeType, ConfirmationState, ConversationRole, CreationMode, CustomControlMethod, DocumentAclMemberRelation, DocumentAclMembershipType, DocumentOutputFormat, ExecutionType, ExternalSourceType, FileSourceType, FileUseCase, FlowCompletionReason, FlowControlNodeType, FlowErrorCode, FlowExecutionErrorType, FlowExecutionEventType, FlowExecutionStatus, FlowNodeInputCategory, FlowNodeIODataType, FoundationModelConfigurationType, FoundationModelType, GeneratedQueryType, GuadrailAction, GuardrailAction, GuardrailContentFilterConfidence, GuardrailContentFilterType, GuardrailContentPolicyAction, GuardrailManagedWordType, GuardrailPiiEntityType, GuardrailSensitiveInformationPolicyAction, GuardrailTopicPolicyAction, GuardrailTopicType, GuardrailWordPolicyAction, ImageInputFormat, InputQueryType, InvocationType, ManagedSearchRerankingConfigurationType, MemoryType, NodeErrorCode, NodeType, ParameterType, PayloadType, PerformanceConfigLatency, PromptState, PromptType, QueryTransformationMode, QueryTransformationType, RelayConversationHistory, RequireConfirmation, RerankDocumentType, RerankingConfigurationType, RerankingMetadataSelectionMode, RerankQueryContentType, RerankSourceType, ResponseState, RetrievalResultContentColumnType, RetrievalResultContentType, RetrievalResultLocationType, Source, TextToSqlConfigurationType, Type, VectorSearchRerankingConfigurationType } from "./enums";
3
3
  import type { AccessDeniedException, BadGatewayException, ConflictException, DependencyFailedException, InternalServerException, ModelNotReadyException, ResourceNotFoundException, ServiceQuotaExceededException, ThrottlingException, ValidationException } from "./errors";
4
4
  /**
5
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>
@@ -916,6 +916,37 @@ export interface AgenticRetrieveMessageContent {
916
916
  */
917
917
  text?: string | undefined;
918
918
  }
919
+ /**
920
+ * <p>A long-term memory retrieval that the agent chose to perform. The record reports the query and the namespace. The corresponding Retrieval step reports the results.</p>
921
+ * @public
922
+ */
923
+ export interface AgenticRetrieveMemoryRetrieveDetails {
924
+ /**
925
+ * <p>The query that the agent composed.</p>
926
+ * @public
927
+ */
928
+ inputQuery: AgenticRetrieveMessageContent | undefined;
929
+ /**
930
+ * <p>The identifier of the AgentCore Memory resource retrieved from.</p>
931
+ * @public
932
+ */
933
+ memoryId: string | undefined;
934
+ /**
935
+ * <p>The namespace prefix retrieved from, as supplied in the request. This field is present when the request specified namespace.</p>
936
+ * @public
937
+ */
938
+ namespace?: string | undefined;
939
+ /**
940
+ * <p>The parent namespace retrieved from hierarchically, as supplied in the request. This field is present when the request specified namespacePath.</p>
941
+ * @public
942
+ */
943
+ namespacePath?: string | undefined;
944
+ /**
945
+ * <p>The extraction strategy that restricted retrieval, if the request specified one.</p>
946
+ * @public
947
+ */
948
+ strategyId?: string | undefined;
949
+ }
919
950
  /**
920
951
  * <p>Details of a retrieve action including the query and target retrievers.</p>
921
952
  * @public
@@ -947,6 +978,11 @@ export interface AgenticRetrieveAction {
947
978
  * @public
948
979
  */
949
980
  fullDocumentExpansion?: AgenticRetrieveFullDocExpansionDetails | undefined;
981
+ /**
982
+ * <p>The details of a long-term memory retrieval that the agent chose to perform.</p>
983
+ * @public
984
+ */
985
+ memoryRetrieve?: AgenticRetrieveMemoryRetrieveDetails | undefined;
950
986
  }
951
987
  /**
952
988
  * <p>Configuration for a Bedrock guardrail applied during agentic retrieval.</p>
@@ -1156,6 +1192,236 @@ export interface AgenticRetrieveGuardrailWarning {
1156
1192
  */
1157
1193
  message?: string | undefined;
1158
1194
  }
1195
+ /**
1196
+ * <p>The left operand of a metadata filter expression. Set exactly one member.</p>
1197
+ * @public
1198
+ */
1199
+ export type AgenticRetrieveMemoryMetadataFilterLeft = AgenticRetrieveMemoryMetadataFilterLeft.MetadataKeyMember | AgenticRetrieveMemoryMetadataFilterLeft.$UnknownMember;
1200
+ /**
1201
+ * @public
1202
+ */
1203
+ export declare namespace AgenticRetrieveMemoryMetadataFilterLeft {
1204
+ /**
1205
+ * <p>The metadata key to filter on.</p>
1206
+ * @public
1207
+ */
1208
+ interface MetadataKeyMember {
1209
+ metadataKey: string;
1210
+ $unknown?: never;
1211
+ }
1212
+ /**
1213
+ * @public
1214
+ */
1215
+ interface $UnknownMember {
1216
+ metadataKey?: never;
1217
+ $unknown: [string, any];
1218
+ }
1219
+ /**
1220
+ * @deprecated unused in schema-serde mode.
1221
+ *
1222
+ */
1223
+ interface Visitor<T> {
1224
+ metadataKey: (value: string) => T;
1225
+ _: (name: string, value: any) => T;
1226
+ }
1227
+ }
1228
+ /**
1229
+ * <p>A metadata value that a filter expression compares against. Set exactly one member.</p>
1230
+ * @public
1231
+ */
1232
+ export type AgenticRetrieveMemoryMetadataValue = AgenticRetrieveMemoryMetadataValue.DateTimeValueMember | AgenticRetrieveMemoryMetadataValue.NumberValueMember | AgenticRetrieveMemoryMetadataValue.StringListValueMember | AgenticRetrieveMemoryMetadataValue.StringValueMember | AgenticRetrieveMemoryMetadataValue.$UnknownMember;
1233
+ /**
1234
+ * @public
1235
+ */
1236
+ export declare namespace AgenticRetrieveMemoryMetadataValue {
1237
+ /**
1238
+ * <p>A string value.</p>
1239
+ * @public
1240
+ */
1241
+ interface StringValueMember {
1242
+ stringValue: string;
1243
+ numberValue?: never;
1244
+ stringListValue?: never;
1245
+ dateTimeValue?: never;
1246
+ $unknown?: never;
1247
+ }
1248
+ /**
1249
+ * <p>A numeric value.</p>
1250
+ * @public
1251
+ */
1252
+ interface NumberValueMember {
1253
+ stringValue?: never;
1254
+ numberValue: number;
1255
+ stringListValue?: never;
1256
+ dateTimeValue?: never;
1257
+ $unknown?: never;
1258
+ }
1259
+ /**
1260
+ * <p>A list of string values.</p>
1261
+ * @public
1262
+ */
1263
+ interface StringListValueMember {
1264
+ stringValue?: never;
1265
+ numberValue?: never;
1266
+ stringListValue: string[];
1267
+ dateTimeValue?: never;
1268
+ $unknown?: never;
1269
+ }
1270
+ /**
1271
+ * <p>A timestamp value in ISO 8601 UTC format.</p>
1272
+ * @public
1273
+ */
1274
+ interface DateTimeValueMember {
1275
+ stringValue?: never;
1276
+ numberValue?: never;
1277
+ stringListValue?: never;
1278
+ dateTimeValue: Date;
1279
+ $unknown?: never;
1280
+ }
1281
+ /**
1282
+ * @public
1283
+ */
1284
+ interface $UnknownMember {
1285
+ stringValue?: never;
1286
+ numberValue?: never;
1287
+ stringListValue?: never;
1288
+ dateTimeValue?: never;
1289
+ $unknown: [string, any];
1290
+ }
1291
+ /**
1292
+ * @deprecated unused in schema-serde mode.
1293
+ *
1294
+ */
1295
+ interface Visitor<T> {
1296
+ stringValue: (value: string) => T;
1297
+ numberValue: (value: number) => T;
1298
+ stringListValue: (value: string[]) => T;
1299
+ dateTimeValue: (value: Date) => T;
1300
+ _: (name: string, value: any) => T;
1301
+ }
1302
+ }
1303
+ /**
1304
+ * <p>The right operand of a metadata filter expression. Set exactly one member.</p>
1305
+ * @public
1306
+ */
1307
+ export type AgenticRetrieveMemoryMetadataFilterRight = AgenticRetrieveMemoryMetadataFilterRight.MetadataValueMember | AgenticRetrieveMemoryMetadataFilterRight.$UnknownMember;
1308
+ /**
1309
+ * @public
1310
+ */
1311
+ export declare namespace AgenticRetrieveMemoryMetadataFilterRight {
1312
+ /**
1313
+ * <p>The value to compare the metadata key against.</p>
1314
+ * @public
1315
+ */
1316
+ interface MetadataValueMember {
1317
+ metadataValue: AgenticRetrieveMemoryMetadataValue;
1318
+ $unknown?: never;
1319
+ }
1320
+ /**
1321
+ * @public
1322
+ */
1323
+ interface $UnknownMember {
1324
+ metadataValue?: never;
1325
+ $unknown: [string, any];
1326
+ }
1327
+ /**
1328
+ * @deprecated unused in schema-serde mode.
1329
+ *
1330
+ */
1331
+ interface Visitor<T> {
1332
+ metadataValue: (value: AgenticRetrieveMemoryMetadataValue) => T;
1333
+ _: (name: string, value: any) => T;
1334
+ }
1335
+ }
1336
+ /**
1337
+ * <p>A metadata filter expression, in the form accepted by the AgentCore Memory RetrieveMemoryRecords operation. The expression has a left operand that names the metadata key, an operator, and a right operand. For the EXISTS and NOT_EXISTS operators, omit the right operand.</p>
1338
+ * @public
1339
+ */
1340
+ export interface AgenticRetrieveMemoryMetadataFilter {
1341
+ /**
1342
+ * <p>The metadata key that the expression evaluates.</p>
1343
+ * @public
1344
+ */
1345
+ left: AgenticRetrieveMemoryMetadataFilterLeft | undefined;
1346
+ /**
1347
+ * <p>The relationship that the metadata key and value must have for a memory record to match.</p>
1348
+ * @public
1349
+ */
1350
+ operator: AgenticRetrieveMemoryMetadataFilterOperator | undefined;
1351
+ /**
1352
+ * <p>The value that the expression compares the metadata key against. Supply this value for every operator except EXISTS and NOT_EXISTS.</p>
1353
+ * @public
1354
+ */
1355
+ right?: AgenticRetrieveMemoryMetadataFilterRight | undefined;
1356
+ }
1357
+ /**
1358
+ * <p>The long-term memory namespace that the agent might retrieve memory records from, and the filters applied to that retrieval. You must specify either namespace or namespacePath.</p>
1359
+ * @public
1360
+ */
1361
+ export interface AgenticRetrieveMemoryRetrievalConfig {
1362
+ /**
1363
+ * <p>The namespace prefix to filter memory records by. The agent retrieves memory records in namespaces that start with the provided prefix. You must specify either namespace or namespacePath.</p>
1364
+ * @public
1365
+ */
1366
+ namespace?: string | undefined;
1367
+ /**
1368
+ * <p>The parent namespace to use for hierarchical retrievals. The agent retrieves all memory records whose namespace falls under the same parent hierarchy. You must specify either namespace or namespacePath.</p>
1369
+ * @public
1370
+ */
1371
+ namespacePath?: string | undefined;
1372
+ /**
1373
+ * <p>The extraction strategy ID that restricts retrieval to memory records produced by a single strategy. Omit this parameter to retrieve records from every strategy on the memory resource.</p>
1374
+ * @public
1375
+ */
1376
+ strategyId?: string | undefined;
1377
+ /**
1378
+ * <p>The metadata filter expressions that restrict retrieval to matching memory records. You can specify a maximum of 5 expressions.</p>
1379
+ * @public
1380
+ */
1381
+ metadataFilters?: AgenticRetrieveMemoryMetadataFilter[] | undefined;
1382
+ }
1383
+ /**
1384
+ * <p>The short-term memory session that this retrieval reads from and writes to.</p>
1385
+ * @public
1386
+ */
1387
+ export interface AgenticRetrieveMemorySessionBinding {
1388
+ /**
1389
+ * <p>The identifier of the end user or agent that the session belongs to. This identifier scopes session history so that one actor's history is never returned for another. You are responsible for sending the correct actor value.</p>
1390
+ * @public
1391
+ */
1392
+ actorId: string | undefined;
1393
+ /**
1394
+ * <p>The identifier of the session to restore and continue. You are responsible for sending the correct session value.</p>
1395
+ * @public
1396
+ */
1397
+ sessionId: string | undefined;
1398
+ }
1399
+ /**
1400
+ * <p>Specifies an AgentCore Memory resource and how this retrieval uses it. Set sessionBinding to restore and continue a session. Set retrievalConfigs to let the agent retrieve from long-term memory. You must specify at least one of the two.</p>
1401
+ * @public
1402
+ */
1403
+ export interface AgenticRetrieveMemoryConfiguration {
1404
+ /**
1405
+ * <p>The identifier of the AgentCore Memory resource to use. The resource must exist in your account and be in the ACTIVE state.</p>
1406
+ * @public
1407
+ */
1408
+ memoryId: string | undefined;
1409
+ /**
1410
+ * <p>The short-term memory session whose history is restored for this retrieval. To persist the agent-generated answer to the session, omit persistenceMode or set it to DEFAULT. To leave the session unchanged, set persistenceMode to NONE. Supply session history through the existing messages parameter or through short-term memory, but not both.</p>
1411
+ * @public
1412
+ */
1413
+ sessionBinding?: AgenticRetrieveMemorySessionBinding | undefined;
1414
+ /**
1415
+ * <p>Specifies the long-term memory configuration the agent can retrieve from. The agent decides whether to retrieve and composes its own query. This field currently accepts at most one entry.</p>
1416
+ * @public
1417
+ */
1418
+ retrievalConfigs?: AgenticRetrieveMemoryRetrievalConfig[] | undefined;
1419
+ /**
1420
+ * <p>Specifies whether the agent-generated answer is written back to the given short-term memory session, and applies only when sessionBinding is set. Valid values:</p> <ul> <li> <p> <code>DEFAULT</code> (default) – Specifies that the question and the agent-generated answer are persisted to the session as a single event. This value requires generateResponse to be true.</p> </li> <li> <p> <code>NONE</code> – Specifies that the session is left unchanged.</p> </li> </ul>
1421
+ * @public
1422
+ */
1423
+ persistenceMode?: AgenticRetrieveMemoryPersistenceMode | undefined;
1424
+ }
1159
1425
  /**
1160
1426
  * <p>A message in the agentic retrieval conversation.</p>
1161
1427
  * @public
@@ -3267,6 +3533,41 @@ export interface TracePart {
3267
3533
  */
3268
3534
  agentVersion?: string | undefined;
3269
3535
  }
3536
+ /**
3537
+ * @public
3538
+ */
3539
+ export interface CheckIngestedDocumentAclRequest {
3540
+ /**
3541
+ * <p>The unique identifier of the knowledge base that contains the document.</p>
3542
+ * @public
3543
+ */
3544
+ knowledgeBaseId: string | undefined;
3545
+ /**
3546
+ * <p>The unique identifier of the data source that contains the document.</p>
3547
+ * @public
3548
+ */
3549
+ dataSourceId: string | undefined;
3550
+ /**
3551
+ * <p>The unique identifier of the document to check access for.</p>
3552
+ * @public
3553
+ */
3554
+ documentId: string | undefined;
3555
+ /**
3556
+ * <p>The context object containing identity information for access control filtering, including user ID and optional group memberships used to evaluate the document access control list (ACL).</p>
3557
+ * @public
3558
+ */
3559
+ userContext: UserContext | undefined;
3560
+ }
3561
+ /**
3562
+ * @public
3563
+ */
3564
+ export interface CheckIngestedDocumentAclResponse {
3565
+ /**
3566
+ * <p>Specifies whether the user has access to the document based on the ingested access control list (ACL). Returns <code>true</code> if the user is allowed access, and <code>false</code> otherwise.</p>
3567
+ * @public
3568
+ */
3569
+ hasAccess: boolean | undefined;
3570
+ }
3270
3571
  /**
3271
3572
  * @public
3272
3573
  */
@@ -5418,7 +5719,7 @@ export interface GetDocumentContentRequest {
5418
5719
  */
5419
5720
  outputFormat?: DocumentOutputFormat | undefined;
5420
5721
  /**
5421
- * <p>Contains information about the user making the request. Use this to pass user identity information for access control filtering, so that retrieval results only include documents the user is authorized to access.</p>
5722
+ * <p>Contains information about the user making the request. This is used for access control filtering to ensure that results only include documents the user is authorized to access.</p>
5422
5723
  * @public
5423
5724
  */
5424
5725
  userContext?: UserContext | undefined;
@@ -5444,86 +5745,201 @@ export interface GetDocumentContentResponse {
5444
5745
  documentContentLength?: number | undefined;
5445
5746
  }
5446
5747
  /**
5447
- * <p>Settings for a model called with <a>InvokeAgent</a>.</p>
5448
5748
  * @public
5449
5749
  */
5450
- export interface BedrockModelConfigurations {
5750
+ export interface GetIngestedDocumentAclRequest {
5451
5751
  /**
5452
- * <p>The performance configuration for the model.</p>
5752
+ * <p>The unique identifier of the knowledge base that contains the document.</p>
5453
5753
  * @public
5454
5754
  */
5455
- performanceConfig?: PerformanceConfiguration | undefined;
5755
+ knowledgeBaseId: string | undefined;
5756
+ /**
5757
+ * <p>The unique identifier of the data source that contains the document.</p>
5758
+ * @public
5759
+ */
5760
+ dataSourceId: string | undefined;
5761
+ /**
5762
+ * <p>The unique identifier of the document to retrieve the ingested access control list (ACL) for.</p>
5763
+ * @public
5764
+ */
5765
+ documentId: string | undefined;
5456
5766
  }
5457
5767
  /**
5458
- * <p>Specifies parameters that control how the service populates the agent prompt for an <code>InvokeAgent</code> or <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>
5768
+ * <p>A group entry within a document access control list (ACL) condition.</p>
5459
5769
  * @public
5460
5770
  */
5461
- export interface PromptCreationConfigurations {
5771
+ export interface DocumentAclGroup {
5462
5772
  /**
5463
- * <p>The number of previous conversations from the ongoing agent session to include in the conversation history of the agent prompt, during the current invocation. This gives you more granular control over the context that the model is made aware of, and helps the model remove older context which is no longer useful during the ongoing agent session.</p>
5773
+ * <p>The identifier of the group.</p>
5464
5774
  * @public
5465
5775
  */
5466
- previousConversationTurnsToInclude?: number | undefined;
5776
+ id: string | undefined;
5467
5777
  /**
5468
- * <p>If <code>true</code>, the service removes any content between <code>&lt;thinking&gt;</code> tags from previous conversations in an agent session. The service will only remove content from already processed turns. This helps you remove content which might not be useful for current and subsequent invocations. This can reduce the input token count and potentially save costs. The default value is <code>false</code>.</p>
5778
+ * <p>The membership type indicating the scope of the group entry.</p>
5469
5779
  * @public
5470
5780
  */
5471
- excludePreviousThinkingSteps?: boolean | undefined;
5781
+ type: DocumentAclMembershipType | undefined;
5472
5782
  }
5473
5783
  /**
5474
- * <p>A content block.</p>
5784
+ * <p>A user entry within a document access control list (ACL) condition.</p>
5475
5785
  * @public
5476
5786
  */
5477
- export type ContentBlock = ContentBlock.TextMember | ContentBlock.$UnknownMember;
5787
+ export interface DocumentAclUser {
5788
+ /**
5789
+ * <p>The identifier of the user.</p>
5790
+ * @public
5791
+ */
5792
+ id: string | undefined;
5793
+ /**
5794
+ * <p>The membership type indicating the scope of the user entry.</p>
5795
+ * @public
5796
+ */
5797
+ type: DocumentAclMembershipType | undefined;
5798
+ }
5478
5799
  /**
5800
+ * <p>A condition within a document access control list (ACL) membership, specifying users and groups that are evaluated together.</p>
5479
5801
  * @public
5480
5802
  */
5481
- export declare namespace ContentBlock {
5803
+ export interface DocumentAclCondition {
5482
5804
  /**
5483
- * <p>The block's text.</p>
5805
+ * <p>The logical operator for combining users and groups within this condition. Valid values: <code>AND</code> – Both a user match and a group match are required. <code>OR</code> – Either a user match or a group match is sufficient.</p>
5484
5806
  * @public
5485
5807
  */
5486
- interface TextMember {
5487
- text: string;
5488
- $unknown?: never;
5489
- }
5808
+ conditionOperator?: DocumentAclMemberRelation | undefined;
5490
5809
  /**
5810
+ * <p>The list of user entries in this condition.</p>
5491
5811
  * @public
5492
5812
  */
5493
- interface $UnknownMember {
5494
- text?: never;
5495
- $unknown: [string, any];
5496
- }
5813
+ users?: DocumentAclUser[] | undefined;
5497
5814
  /**
5498
- * @deprecated unused in schema-serde mode.
5499
- *
5815
+ * <p>The list of group entries in this condition.</p>
5816
+ * @public
5500
5817
  */
5501
- interface Visitor<T> {
5502
- text: (value: string) => T;
5503
- _: (name: string, value: any) => T;
5504
- }
5818
+ groups?: DocumentAclGroup[] | undefined;
5505
5819
  }
5506
5820
  /**
5507
- * <p>Details about a message.</p>
5821
+ * <p>The membership entry for a document access control list (ACL), containing conditions and their logical relation.</p>
5508
5822
  * @public
5509
5823
  */
5510
- export interface Message {
5824
+ export interface DocumentAclMembership {
5511
5825
  /**
5512
- * <p>The message's role.</p>
5826
+ * <p>The logical relation between conditions. Valid values: <code>AND</code> – All conditions must match. <code>OR</code> – At least one condition must match.</p>
5513
5827
  * @public
5514
5828
  */
5515
- role: ConversationRole | undefined;
5829
+ memberRelation?: DocumentAclMemberRelation | undefined;
5516
5830
  /**
5517
- * <p>The message's content.</p>
5831
+ * <p>The list of conditions that determine membership.</p>
5518
5832
  * @public
5519
5833
  */
5520
- content: ContentBlock[] | undefined;
5834
+ conditions?: DocumentAclCondition[] | undefined;
5521
5835
  }
5522
5836
  /**
5523
- * <p>A conversation history.</p>
5837
+ * <p>The access control list for a document, containing allow and deny membership lists. Each list specifies conditions that determine which users and groups are granted or denied access.</p>
5524
5838
  * @public
5525
5839
  */
5526
- export interface ConversationHistory {
5840
+ export interface DocumentAcl {
5841
+ /**
5842
+ * <p>The list of principals allowed access to the document.</p>
5843
+ * @public
5844
+ */
5845
+ allowList?: DocumentAclMembership | undefined;
5846
+ /**
5847
+ * <p>The list of principals denied access to the document.</p>
5848
+ * @public
5849
+ */
5850
+ denyList?: DocumentAclMembership | undefined;
5851
+ }
5852
+ /**
5853
+ * @public
5854
+ */
5855
+ export interface GetIngestedDocumentAclResponse {
5856
+ /**
5857
+ * <p>The ingested document access control list (ACL) containing allow and deny membership information.</p>
5858
+ * @public
5859
+ */
5860
+ documentAcl: DocumentAcl | undefined;
5861
+ }
5862
+ /**
5863
+ * <p>Settings for a model called with <a>InvokeAgent</a>.</p>
5864
+ * @public
5865
+ */
5866
+ export interface BedrockModelConfigurations {
5867
+ /**
5868
+ * <p>The performance configuration for the model.</p>
5869
+ * @public
5870
+ */
5871
+ performanceConfig?: PerformanceConfiguration | undefined;
5872
+ }
5873
+ /**
5874
+ * <p>Specifies parameters that control how the service populates the agent prompt for an <code>InvokeAgent</code> or <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>
5875
+ * @public
5876
+ */
5877
+ export interface PromptCreationConfigurations {
5878
+ /**
5879
+ * <p>The number of previous conversations from the ongoing agent session to include in the conversation history of the agent prompt, during the current invocation. This gives you more granular control over the context that the model is made aware of, and helps the model remove older context which is no longer useful during the ongoing agent session.</p>
5880
+ * @public
5881
+ */
5882
+ previousConversationTurnsToInclude?: number | undefined;
5883
+ /**
5884
+ * <p>If <code>true</code>, the service removes any content between <code>&lt;thinking&gt;</code> tags from previous conversations in an agent session. The service will only remove content from already processed turns. This helps you remove content which might not be useful for current and subsequent invocations. This can reduce the input token count and potentially save costs. The default value is <code>false</code>.</p>
5885
+ * @public
5886
+ */
5887
+ excludePreviousThinkingSteps?: boolean | undefined;
5888
+ }
5889
+ /**
5890
+ * <p>A content block.</p>
5891
+ * @public
5892
+ */
5893
+ export type ContentBlock = ContentBlock.TextMember | ContentBlock.$UnknownMember;
5894
+ /**
5895
+ * @public
5896
+ */
5897
+ export declare namespace ContentBlock {
5898
+ /**
5899
+ * <p>The block's text.</p>
5900
+ * @public
5901
+ */
5902
+ interface TextMember {
5903
+ text: string;
5904
+ $unknown?: never;
5905
+ }
5906
+ /**
5907
+ * @public
5908
+ */
5909
+ interface $UnknownMember {
5910
+ text?: never;
5911
+ $unknown: [string, any];
5912
+ }
5913
+ /**
5914
+ * @deprecated unused in schema-serde mode.
5915
+ *
5916
+ */
5917
+ interface Visitor<T> {
5918
+ text: (value: string) => T;
5919
+ _: (name: string, value: any) => T;
5920
+ }
5921
+ }
5922
+ /**
5923
+ * <p>Details about a message.</p>
5924
+ * @public
5925
+ */
5926
+ export interface Message {
5927
+ /**
5928
+ * <p>The message's role.</p>
5929
+ * @public
5930
+ */
5931
+ role: ConversationRole | undefined;
5932
+ /**
5933
+ * <p>The message's content.</p>
5934
+ * @public
5935
+ */
5936
+ content: ContentBlock[] | undefined;
5937
+ }
5938
+ /**
5939
+ * <p>A conversation history.</p>
5940
+ * @public
5941
+ */
5942
+ export interface ConversationHistory {
5527
5943
  /**
5528
5944
  * <p>The conversation's messages.</p>
5529
5945
  * @public
@@ -7850,572 +8266,3 @@ export interface GuardrailEvent {
7850
8266
  */
7851
8267
  action?: GuadrailAction | undefined;
7852
8268
  }
7853
- /**
7854
- * <p>A retrieve and generate output event.</p>
7855
- * @public
7856
- */
7857
- export interface RetrieveAndGenerateOutputEvent {
7858
- /**
7859
- * <p>A text response.</p>
7860
- * @public
7861
- */
7862
- text: string | undefined;
7863
- }
7864
- /**
7865
- * <p>A retrieve and generate stream response output.</p>
7866
- * @public
7867
- */
7868
- 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;
7869
- /**
7870
- * @public
7871
- */
7872
- export declare namespace RetrieveAndGenerateStreamResponseOutput {
7873
- /**
7874
- * <p>An output event.</p>
7875
- * @public
7876
- */
7877
- interface OutputMember {
7878
- output: RetrieveAndGenerateOutputEvent;
7879
- citation?: never;
7880
- guardrail?: never;
7881
- internalServerException?: never;
7882
- validationException?: never;
7883
- resourceNotFoundException?: never;
7884
- serviceQuotaExceededException?: never;
7885
- throttlingException?: never;
7886
- accessDeniedException?: never;
7887
- conflictException?: never;
7888
- dependencyFailedException?: never;
7889
- badGatewayException?: never;
7890
- $unknown?: never;
7891
- }
7892
- /**
7893
- * <p>A citation event.</p>
7894
- * @public
7895
- */
7896
- interface CitationMember {
7897
- output?: never;
7898
- citation: CitationEvent;
7899
- guardrail?: never;
7900
- internalServerException?: never;
7901
- validationException?: never;
7902
- resourceNotFoundException?: never;
7903
- serviceQuotaExceededException?: never;
7904
- throttlingException?: never;
7905
- accessDeniedException?: never;
7906
- conflictException?: never;
7907
- dependencyFailedException?: never;
7908
- badGatewayException?: never;
7909
- $unknown?: never;
7910
- }
7911
- /**
7912
- * <p>A guardrail event.</p>
7913
- * @public
7914
- */
7915
- interface GuardrailMember {
7916
- output?: never;
7917
- citation?: never;
7918
- guardrail: GuardrailEvent;
7919
- internalServerException?: never;
7920
- validationException?: never;
7921
- resourceNotFoundException?: never;
7922
- serviceQuotaExceededException?: never;
7923
- throttlingException?: never;
7924
- accessDeniedException?: never;
7925
- conflictException?: never;
7926
- dependencyFailedException?: never;
7927
- badGatewayException?: never;
7928
- $unknown?: never;
7929
- }
7930
- /**
7931
- * <p>An internal server error occurred. Retry your request.</p>
7932
- * @public
7933
- */
7934
- interface InternalServerExceptionMember {
7935
- output?: never;
7936
- citation?: never;
7937
- guardrail?: never;
7938
- internalServerException: InternalServerException;
7939
- validationException?: never;
7940
- resourceNotFoundException?: never;
7941
- serviceQuotaExceededException?: never;
7942
- throttlingException?: never;
7943
- accessDeniedException?: never;
7944
- conflictException?: never;
7945
- dependencyFailedException?: never;
7946
- badGatewayException?: never;
7947
- $unknown?: never;
7948
- }
7949
- /**
7950
- * <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>
7951
- * @public
7952
- */
7953
- interface ValidationExceptionMember {
7954
- output?: never;
7955
- citation?: never;
7956
- guardrail?: never;
7957
- internalServerException?: never;
7958
- validationException: ValidationException;
7959
- resourceNotFoundException?: never;
7960
- serviceQuotaExceededException?: never;
7961
- throttlingException?: never;
7962
- accessDeniedException?: never;
7963
- conflictException?: never;
7964
- dependencyFailedException?: never;
7965
- badGatewayException?: never;
7966
- $unknown?: never;
7967
- }
7968
- /**
7969
- * <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>
7970
- * @public
7971
- */
7972
- interface ResourceNotFoundExceptionMember {
7973
- output?: never;
7974
- citation?: never;
7975
- guardrail?: never;
7976
- internalServerException?: never;
7977
- validationException?: never;
7978
- resourceNotFoundException: ResourceNotFoundException;
7979
- serviceQuotaExceededException?: never;
7980
- throttlingException?: never;
7981
- accessDeniedException?: never;
7982
- conflictException?: never;
7983
- dependencyFailedException?: never;
7984
- badGatewayException?: never;
7985
- $unknown?: never;
7986
- }
7987
- /**
7988
- * <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>
7989
- * @public
7990
- */
7991
- interface ServiceQuotaExceededExceptionMember {
7992
- output?: never;
7993
- citation?: never;
7994
- guardrail?: never;
7995
- internalServerException?: never;
7996
- validationException?: never;
7997
- resourceNotFoundException?: never;
7998
- serviceQuotaExceededException: ServiceQuotaExceededException;
7999
- throttlingException?: never;
8000
- accessDeniedException?: never;
8001
- conflictException?: never;
8002
- dependencyFailedException?: never;
8003
- badGatewayException?: never;
8004
- $unknown?: never;
8005
- }
8006
- /**
8007
- * <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>
8008
- * @public
8009
- */
8010
- interface ThrottlingExceptionMember {
8011
- output?: never;
8012
- citation?: never;
8013
- guardrail?: never;
8014
- internalServerException?: never;
8015
- validationException?: never;
8016
- resourceNotFoundException?: never;
8017
- serviceQuotaExceededException?: never;
8018
- throttlingException: ThrottlingException;
8019
- accessDeniedException?: never;
8020
- conflictException?: never;
8021
- dependencyFailedException?: never;
8022
- badGatewayException?: never;
8023
- $unknown?: never;
8024
- }
8025
- /**
8026
- * <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>
8027
- * @public
8028
- */
8029
- interface AccessDeniedExceptionMember {
8030
- output?: never;
8031
- citation?: never;
8032
- guardrail?: never;
8033
- internalServerException?: never;
8034
- validationException?: never;
8035
- resourceNotFoundException?: never;
8036
- serviceQuotaExceededException?: never;
8037
- throttlingException?: never;
8038
- accessDeniedException: AccessDeniedException;
8039
- conflictException?: never;
8040
- dependencyFailedException?: never;
8041
- badGatewayException?: never;
8042
- $unknown?: never;
8043
- }
8044
- /**
8045
- * <p>Error occurred because of a conflict while performing an operation.</p>
8046
- * @public
8047
- */
8048
- interface ConflictExceptionMember {
8049
- output?: never;
8050
- citation?: never;
8051
- guardrail?: never;
8052
- internalServerException?: never;
8053
- validationException?: never;
8054
- resourceNotFoundException?: never;
8055
- serviceQuotaExceededException?: never;
8056
- throttlingException?: never;
8057
- accessDeniedException?: never;
8058
- conflictException: ConflictException;
8059
- dependencyFailedException?: never;
8060
- badGatewayException?: never;
8061
- $unknown?: never;
8062
- }
8063
- /**
8064
- * <p>The request failed due to a dependency error.</p>
8065
- * @public
8066
- */
8067
- interface DependencyFailedExceptionMember {
8068
- output?: never;
8069
- citation?: never;
8070
- guardrail?: never;
8071
- internalServerException?: never;
8072
- validationException?: never;
8073
- resourceNotFoundException?: never;
8074
- serviceQuotaExceededException?: never;
8075
- throttlingException?: never;
8076
- accessDeniedException?: never;
8077
- conflictException?: never;
8078
- dependencyFailedException: DependencyFailedException;
8079
- badGatewayException?: never;
8080
- $unknown?: never;
8081
- }
8082
- /**
8083
- * <p>The request failed due to a bad gateway error.</p>
8084
- * @public
8085
- */
8086
- interface BadGatewayExceptionMember {
8087
- output?: never;
8088
- citation?: never;
8089
- guardrail?: never;
8090
- internalServerException?: never;
8091
- validationException?: never;
8092
- resourceNotFoundException?: never;
8093
- serviceQuotaExceededException?: never;
8094
- throttlingException?: never;
8095
- accessDeniedException?: never;
8096
- conflictException?: never;
8097
- dependencyFailedException?: never;
8098
- badGatewayException: BadGatewayException;
8099
- $unknown?: never;
8100
- }
8101
- /**
8102
- * @public
8103
- */
8104
- interface $UnknownMember {
8105
- output?: never;
8106
- citation?: never;
8107
- guardrail?: never;
8108
- internalServerException?: never;
8109
- validationException?: never;
8110
- resourceNotFoundException?: never;
8111
- serviceQuotaExceededException?: never;
8112
- throttlingException?: never;
8113
- accessDeniedException?: never;
8114
- conflictException?: never;
8115
- dependencyFailedException?: never;
8116
- badGatewayException?: never;
8117
- $unknown: [string, any];
8118
- }
8119
- /**
8120
- * @deprecated unused in schema-serde mode.
8121
- *
8122
- */
8123
- interface Visitor<T> {
8124
- output: (value: RetrieveAndGenerateOutputEvent) => T;
8125
- citation: (value: CitationEvent) => T;
8126
- guardrail: (value: GuardrailEvent) => T;
8127
- internalServerException: (value: InternalServerException) => T;
8128
- validationException: (value: ValidationException) => T;
8129
- resourceNotFoundException: (value: ResourceNotFoundException) => T;
8130
- serviceQuotaExceededException: (value: ServiceQuotaExceededException) => T;
8131
- throttlingException: (value: ThrottlingException) => T;
8132
- accessDeniedException: (value: AccessDeniedException) => T;
8133
- conflictException: (value: ConflictException) => T;
8134
- dependencyFailedException: (value: DependencyFailedException) => T;
8135
- badGatewayException: (value: BadGatewayException) => T;
8136
- _: (name: string, value: any) => T;
8137
- }
8138
- }
8139
- /**
8140
- * @public
8141
- */
8142
- export interface RetrieveAndGenerateStreamResponse {
8143
- /**
8144
- * <p>A stream of events from the model.</p>
8145
- * @public
8146
- */
8147
- stream: AsyncIterable<RetrieveAndGenerateStreamResponseOutput> | undefined;
8148
- /**
8149
- * <p>The session ID.</p>
8150
- * @public
8151
- */
8152
- sessionId: string | undefined;
8153
- }
8154
- /**
8155
- * <p>Contains the image data for multimodal knowledge base queries, including format and content.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax">Retrieve request</a> – in the <code>image</code> field</p> </li> </ul>
8156
- * @public
8157
- */
8158
- export interface InputImage {
8159
- /**
8160
- * <p>The format of the input image. Supported formats include png, gif, jpeg, and webp.</p>
8161
- * @public
8162
- */
8163
- format: InputImageFormat | undefined;
8164
- /**
8165
- * <p>The base64-encoded image data for inline image content. Maximum size is 5MB.</p>
8166
- * @public
8167
- */
8168
- inlineContent: Uint8Array | undefined;
8169
- }
8170
- /**
8171
- * <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>
8172
- * @public
8173
- */
8174
- export interface KnowledgeBaseQuery {
8175
- /**
8176
- * <p>The type of query being performed.</p>
8177
- * @public
8178
- */
8179
- type?: KnowledgeBaseQueryType | undefined;
8180
- /**
8181
- * <p>The text of the query made to the knowledge base.</p>
8182
- * @public
8183
- */
8184
- text?: string | undefined;
8185
- /**
8186
- * <p>An image to include in the knowledge base query for multimodal retrieval.</p>
8187
- * @public
8188
- */
8189
- image?: InputImage | undefined;
8190
- }
8191
- /**
8192
- * <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>
8193
- * @public
8194
- */
8195
- export interface KnowledgeBaseRetrievalResult {
8196
- /**
8197
- * <p>Contains information about the content of the chunk.</p>
8198
- * @public
8199
- */
8200
- content: RetrievalResultContent | undefined;
8201
- /**
8202
- * <p>Contains information about the location of the data source.</p>
8203
- * @public
8204
- */
8205
- location?: RetrievalResultLocation | undefined;
8206
- /**
8207
- * <p>The level of relevance of the result to the query.</p>
8208
- * @public
8209
- */
8210
- score?: number | undefined;
8211
- /**
8212
- * <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>
8213
- * @public
8214
- */
8215
- metadata?: Record<string, __DocumentType> | undefined;
8216
- /**
8217
- * <p>The unique identifier of the document. Use with <code>GetDocumentContent</code> to retrieve the full document.</p>
8218
- * @public
8219
- */
8220
- documentId?: string | undefined;
8221
- }
8222
- /**
8223
- * @public
8224
- */
8225
- export interface RetrieveResponse {
8226
- /**
8227
- * <p>A list of results from querying the knowledge base.</p>
8228
- * @public
8229
- */
8230
- retrievalResults: KnowledgeBaseRetrievalResult[] | undefined;
8231
- /**
8232
- * <p>Specifies if there is a guardrail intervention in the response.</p>
8233
- * @public
8234
- */
8235
- guardrailAction?: GuadrailAction | undefined;
8236
- /**
8237
- * <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>
8238
- * @public
8239
- */
8240
- nextToken?: string | undefined;
8241
- }
8242
- /**
8243
- * @public
8244
- */
8245
- export interface CreateSessionRequest {
8246
- /**
8247
- * <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>
8248
- * @public
8249
- */
8250
- sessionMetadata?: Record<string, string> | undefined;
8251
- /**
8252
- * <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>
8253
- * @public
8254
- */
8255
- encryptionKeyArn?: string | undefined;
8256
- /**
8257
- * <p>Specify the key-value pairs for the tags that you want to attach to the session.</p>
8258
- * @public
8259
- */
8260
- tags?: Record<string, string> | undefined;
8261
- }
8262
- /**
8263
- * @public
8264
- */
8265
- export interface CreateSessionResponse {
8266
- /**
8267
- * <p>The unique identifier for the session.</p>
8268
- * @public
8269
- */
8270
- sessionId: string | undefined;
8271
- /**
8272
- * <p>The Amazon Resource Name (ARN) of the created session.</p>
8273
- * @public
8274
- */
8275
- sessionArn: string | undefined;
8276
- /**
8277
- * <p>The current status of the session.</p>
8278
- * @public
8279
- */
8280
- sessionStatus: SessionStatus | undefined;
8281
- /**
8282
- * <p>The timestamp for when the session was created.</p>
8283
- * @public
8284
- */
8285
- createdAt: Date | undefined;
8286
- }
8287
- /**
8288
- * @public
8289
- */
8290
- export interface DeleteSessionRequest {
8291
- /**
8292
- * <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>
8293
- * @public
8294
- */
8295
- sessionIdentifier: string | undefined;
8296
- }
8297
- /**
8298
- * @public
8299
- */
8300
- export interface DeleteSessionResponse {
8301
- }
8302
- /**
8303
- * @public
8304
- */
8305
- export interface EndSessionRequest {
8306
- /**
8307
- * <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>
8308
- * @public
8309
- */
8310
- sessionIdentifier: string | undefined;
8311
- }
8312
- /**
8313
- * @public
8314
- */
8315
- export interface EndSessionResponse {
8316
- /**
8317
- * <p>The unique identifier of the session you ended.</p>
8318
- * @public
8319
- */
8320
- sessionId: string | undefined;
8321
- /**
8322
- * <p>The Amazon Resource Name (ARN) of the session you ended.</p>
8323
- * @public
8324
- */
8325
- sessionArn: string | undefined;
8326
- /**
8327
- * <p>The current status of the session you ended.</p>
8328
- * @public
8329
- */
8330
- sessionStatus: SessionStatus | undefined;
8331
- }
8332
- /**
8333
- * @public
8334
- */
8335
- export interface GetSessionRequest {
8336
- /**
8337
- * <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>
8338
- * @public
8339
- */
8340
- sessionIdentifier: string | undefined;
8341
- }
8342
- /**
8343
- * @public
8344
- */
8345
- export interface GetSessionResponse {
8346
- /**
8347
- * <p>The unique identifier for the session in UUID format.</p>
8348
- * @public
8349
- */
8350
- sessionId: string | undefined;
8351
- /**
8352
- * <p>The Amazon Resource Name (ARN) of the session.</p>
8353
- * @public
8354
- */
8355
- sessionArn: string | undefined;
8356
- /**
8357
- * <p>The current status of the session.</p>
8358
- * @public
8359
- */
8360
- sessionStatus: SessionStatus | undefined;
8361
- /**
8362
- * <p>The timestamp for when the session was created.</p>
8363
- * @public
8364
- */
8365
- createdAt: Date | undefined;
8366
- /**
8367
- * <p>The timestamp for when the session was last modified.</p>
8368
- * @public
8369
- */
8370
- lastUpdatedAt: Date | undefined;
8371
- /**
8372
- * <p>A map of key-value pairs containing attributes persisted across the session.</p>
8373
- * @public
8374
- */
8375
- sessionMetadata?: Record<string, string> | undefined;
8376
- /**
8377
- * <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>
8378
- * @public
8379
- */
8380
- encryptionKeyArn?: string | undefined;
8381
- }
8382
- /**
8383
- * @public
8384
- */
8385
- export interface CreateInvocationRequest {
8386
- /**
8387
- * <p>A unique identifier for the invocation in UUID format.</p>
8388
- * @public
8389
- */
8390
- invocationId?: string | undefined;
8391
- /**
8392
- * <p>A description for the interactions in the invocation. For example, "User asking about weather in Seattle".</p>
8393
- * @public
8394
- */
8395
- description?: string | undefined;
8396
- /**
8397
- * <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>
8398
- * @public
8399
- */
8400
- sessionIdentifier: string | undefined;
8401
- }
8402
- /**
8403
- * @public
8404
- */
8405
- export interface CreateInvocationResponse {
8406
- /**
8407
- * <p>The unique identifier for the session associated with the invocation.</p>
8408
- * @public
8409
- */
8410
- sessionId: string | undefined;
8411
- /**
8412
- * <p>The unique identifier for the invocation.</p>
8413
- * @public
8414
- */
8415
- invocationId: string | undefined;
8416
- /**
8417
- * <p>The timestamp for when the invocation was created.</p>
8418
- * @public
8419
- */
8420
- createdAt: Date | undefined;
8421
- }