@aws-sdk/client-bedrock-agent 3.1069.0 → 3.1071.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 (46) hide show
  1. package/README.md +21 -0
  2. package/dist-cjs/index.js +73 -5
  3. package/dist-cjs/schemas/schemas_0.js +160 -21
  4. package/dist-es/BedrockAgent.js +6 -0
  5. package/dist-es/commands/DeleteResourcePolicyCommand.js +16 -0
  6. package/dist-es/commands/GetResourcePolicyCommand.js +16 -0
  7. package/dist-es/commands/PutResourcePolicyCommand.js +16 -0
  8. package/dist-es/commands/index.js +3 -0
  9. package/dist-es/models/enums.js +26 -4
  10. package/dist-es/schemas/schemas_0.js +146 -21
  11. package/dist-types/BedrockAgent.d.ts +21 -0
  12. package/dist-types/BedrockAgentClient.d.ts +5 -2
  13. package/dist-types/commands/CreateDataSourceCommand.d.ts +41 -5
  14. package/dist-types/commands/CreateKnowledgeBaseCommand.d.ts +58 -4
  15. package/dist-types/commands/DeleteDataSourceCommand.d.ts +1 -1
  16. package/dist-types/commands/DeleteKnowledgeBaseCommand.d.ts +1 -1
  17. package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +96 -0
  18. package/dist-types/commands/GetDataSourceCommand.d.ts +21 -3
  19. package/dist-types/commands/GetIngestionJobCommand.d.ts +1 -0
  20. package/dist-types/commands/GetKnowledgeBaseCommand.d.ts +29 -2
  21. package/dist-types/commands/GetResourcePolicyCommand.d.ts +93 -0
  22. package/dist-types/commands/IngestKnowledgeBaseDocumentsCommand.d.ts +7 -0
  23. package/dist-types/commands/ListDataSourcesCommand.d.ts +1 -1
  24. package/dist-types/commands/ListIngestionJobsCommand.d.ts +1 -0
  25. package/dist-types/commands/ListKnowledgeBasesCommand.d.ts +1 -1
  26. package/dist-types/commands/PutResourcePolicyCommand.d.ts +97 -0
  27. package/dist-types/commands/StartIngestionJobCommand.d.ts +1 -0
  28. package/dist-types/commands/StopIngestionJobCommand.d.ts +1 -0
  29. package/dist-types/commands/UpdateDataSourceCommand.d.ts +41 -5
  30. package/dist-types/commands/UpdateKnowledgeBaseCommand.d.ts +57 -3
  31. package/dist-types/commands/index.d.ts +3 -0
  32. package/dist-types/models/enums.d.ts +66 -12
  33. package/dist-types/models/models_0.d.ts +248 -241
  34. package/dist-types/models/models_1.d.ts +269 -21
  35. package/dist-types/schemas/schemas_0.d.ts +17 -0
  36. package/dist-types/ts3.4/BedrockAgent.d.ts +51 -0
  37. package/dist-types/ts3.4/BedrockAgentClient.d.ts +18 -0
  38. package/dist-types/ts3.4/commands/DeleteResourcePolicyCommand.d.ts +53 -0
  39. package/dist-types/ts3.4/commands/GetResourcePolicyCommand.d.ts +53 -0
  40. package/dist-types/ts3.4/commands/PutResourcePolicyCommand.d.ts +53 -0
  41. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  42. package/dist-types/ts3.4/models/enums.d.ts +36 -6
  43. package/dist-types/ts3.4/models/models_0.d.ts +79 -74
  44. package/dist-types/ts3.4/models/models_1.d.ts +83 -13
  45. package/dist-types/ts3.4/schemas/schemas_0.d.ts +17 -0
  46. package/package.json +3 -3
@@ -1,5 +1,6 @@
1
+ import { AutomaticJsonStringConversion as __AutomaticJsonStringConversion } from "@smithy/core/serde";
1
2
  import type { DocumentType as __DocumentType } from "@smithy/types";
2
- import type { ActionGroupSignature, ActionGroupState, AgentAliasStatus, AgentCollaboration, AgentStatus, AliasInvocationState, CachePointType, ChunkingStrategy, ConcurrencyType, ConfluenceAuthType, ConfluenceHostType, ContentDataSourceType, ContextEnrichmentType, ConversationRole, CrawlFilterConfigurationType, CreationMode, CustomControlMethod, CustomSourceType, DataDeletionPolicy, DataSourceStatus, DataSourceType, DocumentStatus, EnrichmentStrategyMethod, FlowConnectionType, FlowNodeInputCategory, FlowNodeIODataType, FlowStatus, FlowValidationSeverity, FlowValidationType, IncludeExclude, IncompatibleLoopNodeType, IngestionJobFilterAttribute, IngestionJobFilterOperator, IngestionJobSortByAttribute, IngestionJobStatus, InlineContentType, KnowledgeBaseState, MemoryType, MetadataSourceType, MetadataValueType, OrchestrationType, ParsingModality, ParsingStrategy, PerformanceConfigLatency, PromptState, PromptTemplateType, PromptType, QueryEngineType, RedshiftProvisionedAuthType, RedshiftQueryEngineStorageType, RedshiftQueryEngineType, RedshiftServerlessAuthType, RelayConversationHistory, RequireConfirmation, RerankingMetadataSelectionMode, SalesforceAuthType, SharePointAuthType, SharePointHostType, SortOrder, StepType, SupportedLanguages, Type, VectorSearchRerankingConfigurationType, WebScopeType } from "./enums";
3
+ import type { AccessControlAccess, AccessControlPrincipalType, ActionGroupSignature, ActionGroupState, AgentAliasStatus, AgentCollaboration, AgentStatus, AliasInvocationState, CachePointType, ChunkingStrategy, ConcurrencyType, ConfluenceAuthType, ConfluenceHostType, ContentDataSourceType, ContextEnrichmentType, ConversationRole, CrawlFilterConfigurationType, CreationMode, CustomControlMethod, CustomSourceType, DataDeletionPolicy, DataSourceStatus, DataSourceType, DocumentStatus, EmbeddingDataType, EmbeddingModelType, EnabledOrDisabledState, EnrichmentStrategyMethod, FlowConnectionType, FlowNodeInputCategory, FlowNodeIODataType, FlowStatus, FlowValidationSeverity, FlowValidationType, IncompatibleLoopNodeType, IngestionJobFilterAttribute, IngestionJobFilterOperator, IngestionJobSortByAttribute, IngestionJobStatus, InlineContentType, KnowledgeBaseState, MemoryType, MetadataSourceType, MetadataValueType, OrchestrationType, ParsingModality, ParsingStrategy, PerformanceConfigLatency, PromptState, PromptTemplateType, PromptType, RedshiftProvisionedAuthType, RelayConversationHistory, RequireConfirmation, RerankingMetadataSelectionMode, SalesforceAuthType, SharePointAuthType, SharePointHostType, SortOrder, StepType, SupportedLanguages, Type, VectorSearchRerankingConfigurationType, WebScopeType } from "./enums";
3
4
  /**
4
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>
5
6
  * @public
@@ -2144,7 +2145,7 @@ export interface ConfluenceSourceConfiguration {
2144
2145
  credentialsSecretArn: string | undefined;
2145
2146
  }
2146
2147
  /**
2147
- * <p>The configuration information to connect to Confluence as your data source.</p>
2148
+ * <p>The configuration information to connect to Confluence as your data source for self-managed knowledge bases.</p>
2148
2149
  * @public
2149
2150
  */
2150
2151
  export interface ConfluenceDataSourceConfiguration {
@@ -2160,7 +2161,98 @@ export interface ConfluenceDataSourceConfiguration {
2160
2161
  crawlerConfiguration?: ConfluenceCrawlerConfiguration | undefined;
2161
2162
  }
2162
2163
  /**
2163
- * <p>The configuration information to connect to Amazon S3 as your data source.</p>
2164
+ * <p>Configuration for deletion protection.</p>
2165
+ * @public
2166
+ */
2167
+ export interface DeletionProtectionConfiguration {
2168
+ /**
2169
+ * <p>Enable or disable deletion protection for the connector.</p>
2170
+ * @public
2171
+ */
2172
+ deletionProtectionStatus: EnabledOrDisabledState | undefined;
2173
+ /**
2174
+ * <p>The threshold is the maximum percentage of documents that a sync job can delete from your index. If a sync would delete more than this percentage, the sync skips its delete phase, leaving your indexed documents in place. Not supported for the Custom connector.</p>
2175
+ * @public
2176
+ */
2177
+ deletionProtectionThreshold?: number | undefined;
2178
+ }
2179
+ /**
2180
+ * <p>Configuration for audio extraction.</p>
2181
+ * @public
2182
+ */
2183
+ export interface AudioExtractionConfiguration {
2184
+ /**
2185
+ * Whether audio extraction is enabled or disabled.
2186
+ * @public
2187
+ */
2188
+ audioExtractionStatus: EnabledOrDisabledState | undefined;
2189
+ }
2190
+ /**
2191
+ * <p>Configuration for image extraction.</p>
2192
+ * @public
2193
+ */
2194
+ export interface ImageExtractionConfiguration {
2195
+ /**
2196
+ * Whether image extraction is enabled or disabled.
2197
+ * @public
2198
+ */
2199
+ imageExtractionStatus: EnabledOrDisabledState | undefined;
2200
+ }
2201
+ /**
2202
+ * <p>Configuration for video extraction.</p>
2203
+ * @public
2204
+ */
2205
+ export interface VideoExtractionConfiguration {
2206
+ /**
2207
+ * Whether video extraction is enabled or disabled.
2208
+ * @public
2209
+ */
2210
+ videoExtractionStatus: EnabledOrDisabledState | undefined;
2211
+ }
2212
+ /**
2213
+ * <p>Configuration for media extraction settings.</p>
2214
+ * @public
2215
+ */
2216
+ export interface MediaExtractionConfiguration {
2217
+ /**
2218
+ * <p>Configuration for image extraction.</p>
2219
+ * @public
2220
+ */
2221
+ imageExtractionConfiguration?: ImageExtractionConfiguration | undefined;
2222
+ /**
2223
+ * <p>Configuration for audio extraction.</p>
2224
+ * @public
2225
+ */
2226
+ audioExtractionConfiguration?: AudioExtractionConfiguration | undefined;
2227
+ /**
2228
+ * <p>Configuration for video extraction.</p>
2229
+ * @public
2230
+ */
2231
+ videoExtractionConfiguration?: VideoExtractionConfiguration | undefined;
2232
+ }
2233
+ /**
2234
+ * <p>Configuration for managed knowledge base connector data sources.</p>
2235
+ * @public
2236
+ */
2237
+ export interface ManagedKnowledgeBaseConnectorConfiguration {
2238
+ /**
2239
+ * <p>A safeguard against accidental bulk deletion of indexed content.</p>
2240
+ * @public
2241
+ */
2242
+ deletionProtectionConfiguration?: DeletionProtectionConfiguration | undefined;
2243
+ /**
2244
+ * <p>Configuration for extracting media (images, audio, video) from data source files.</p>
2245
+ * @public
2246
+ */
2247
+ mediaExtractionConfiguration?: MediaExtractionConfiguration | undefined;
2248
+ /**
2249
+ * <p>Connector-specific parameters. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-managed-connect-ds.html">Connect a data source</a>.</p>
2250
+ * @public
2251
+ */
2252
+ connectorParameters?: __DocumentType | undefined;
2253
+ }
2254
+ /**
2255
+ * <p>The configuration information to connect to Amazon S3 as your data source for self-managed knowledge bases. To configure this data source for managed knowledge bases, use <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ManagedKnowledgeBaseConnectorConfiguration.html">managedKnowledgeBaseConnectorConfiguration</a>.</p>
2164
2256
  * @public
2165
2257
  */
2166
2258
  export interface S3DataSourceConfiguration {
@@ -2276,7 +2368,7 @@ export interface SharePointSourceConfiguration {
2276
2368
  credentialsSecretArn: string | undefined;
2277
2369
  }
2278
2370
  /**
2279
- * <p>The configuration information to connect to SharePoint as your data source.</p>
2371
+ * <p>The configuration information to connect to SharePoint as your data source for self-managed knowledge bases.</p>
2280
2372
  * @public
2281
2373
  */
2282
2374
  export interface SharePointDataSourceConfiguration {
@@ -2403,33 +2495,38 @@ export interface DataSourceConfiguration {
2403
2495
  */
2404
2496
  type: DataSourceType | undefined;
2405
2497
  /**
2406
- * <p>The configuration information to connect to Amazon S3 as your data source.</p>
2498
+ * <p>Contains the configuration for a data source that connects a managed knowledge base to a supported data source connector. Specify this object when the data source type is <code>MANAGED_KNOWLEDGE_BASE_CONNECTOR</code>.</p>
2499
+ * @public
2500
+ */
2501
+ managedKnowledgeBaseConnectorConfiguration?: ManagedKnowledgeBaseConnectorConfiguration | undefined;
2502
+ /**
2503
+ * <p>The configuration information to connect to Amazon S3 as your data source for self-managed knowledge bases. To configure this data source for managed knowledge bases, use <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ManagedKnowledgeBaseConnectorConfiguration.html">managedKnowledgeBaseConnectorConfiguration</a>.</p>
2407
2504
  * @public
2408
2505
  */
2409
2506
  s3Configuration?: S3DataSourceConfiguration | undefined;
2410
2507
  /**
2411
- * <p>The configuration of web URLs to crawl for your data source. You should be authorized to crawl the URLs.</p> <note> <p>Crawling web URLs as your data source is in preview release and is subject to change.</p> </note>
2508
+ * <p>The configuration of web URLs to crawl for your data source. You should be authorized to crawl the URLs.</p> <note> <p>To configure this data source for managed knowledge bases, use <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ManagedKnowledgeBaseConnectorConfiguration.html">managedKnowledgeBaseConnectorConfiguration</a>. Web crawler data source connector for self-managed knowledge bases is in preview release and is subject to change.</p> </note>
2412
2509
  * @public
2413
2510
  */
2414
2511
  webConfiguration?: WebDataSourceConfiguration | undefined;
2415
2512
  /**
2416
- * <p>The configuration information to connect to Confluence as your data source.</p> <note> <p>Confluence data source connector is in preview release and is subject to change.</p> </note>
2513
+ * <p>The configuration information to connect to Confluence as your data source for self-managed knowledge bases.</p> <note> <p>To configure this data source for managed knowledge bases, use <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ManagedKnowledgeBaseConnectorConfiguration.html">managedKnowledgeBaseConnectorConfiguration</a>. Confluence data source connector for self-managed knowledge bases is in preview release and is subject to change.</p> </note>
2417
2514
  * @public
2418
2515
  */
2419
2516
  confluenceConfiguration?: ConfluenceDataSourceConfiguration | undefined;
2420
2517
  /**
2421
- * <p>The configuration information to connect to Salesforce as your data source.</p> <note> <p>Salesforce data source connector is in preview release and is subject to change.</p> </note>
2518
+ * <p>The configuration information to connect to Salesforce as your data source.</p> <note> <p>Salesforce data source connector for self-managed knowledge bases is in preview release and is subject to change.</p> </note>
2422
2519
  * @public
2423
2520
  */
2424
2521
  salesforceConfiguration?: SalesforceDataSourceConfiguration | undefined;
2425
2522
  /**
2426
- * <p>The configuration information to connect to SharePoint as your data source.</p> <note> <p>SharePoint data source connector is in preview release and is subject to change.</p> </note>
2523
+ * <p>The configuration information to connect to SharePoint as your data source for self-managed knowledge bases.</p> <note> <p>To configure this data source for managed knowledge bases, use <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ManagedKnowledgeBaseConnectorConfiguration.html">managedKnowledgeBaseConnectorConfiguration</a>. SharePoint data source connector for self-managed knowledge bases is in preview release and is subject to change.</p> </note>
2427
2524
  * @public
2428
2525
  */
2429
2526
  sharePointConfiguration?: SharePointDataSourceConfiguration | undefined;
2430
2527
  }
2431
2528
  /**
2432
- * <p>Contains the configuration for server-side encryption.</p>
2529
+ * <p>Contains the configuration for server-side encryption for your managed knowledge base.</p>
2433
2530
  * @public
2434
2531
  */
2435
2532
  export interface ServerSideEncryptionConfiguration {
@@ -2697,7 +2794,7 @@ export interface BedrockFoundationModelConfiguration {
2697
2794
  */
2698
2795
  export interface ParsingConfiguration {
2699
2796
  /**
2700
- * <p>The parsing strategy for the data source.</p>
2797
+ * <p>The parsing strategy for the data source. Only <code>SMART_PARSING</code> can be selected for managed knowledge bases. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-managed-customize-ingestion.html">Customize ingestion for managed knowledge bases</a>.</p>
2701
2798
  * @public
2702
2799
  */
2703
2800
  parsingStrategy: ParsingStrategy | undefined;
@@ -2768,7 +2865,7 @@ export interface CreateDataSourceRequest {
2768
2865
  */
2769
2866
  dataSourceConfiguration: DataSourceConfiguration | undefined;
2770
2867
  /**
2771
- * <p>The data deletion policy for the data source.</p> <p>You can set the data deletion policy to:</p> <ul> <li> <p>DELETE: Deletes all data from your data source that’s converted into vector embeddings upon deletion of a knowledge base or data source resource. Note that the <b>vector store itself is not deleted</b>, only the data. This flag is ignored if an Amazon Web Services account is deleted.</p> </li> <li> <p>RETAIN: Retains all data from your data source that’s converted into vector embeddings upon deletion of a knowledge base or data source resource. Note that the <b>vector store itself is not deleted</b> if you delete a knowledge base or data source resource.</p> </li> </ul>
2868
+ * <p>The data deletion policy for the data source.</p> <p>You can set the data deletion policy to:</p> <ul> <li> <p>DELETE: Deletes all data from your data source that’s converted into vector embeddings upon deletion of a knowledge base or data source resource. Note that the <b>vector store itself is not deleted</b>, only the data. This flag is ignored if an Amazon Web Services account is deleted.</p> </li> <li> <p>RETAIN: Retains all data from your data source that’s converted into vector embeddings upon deletion of a knowledge base or data source resource. Note that the <b>vector store itself is not deleted</b> if you delete a knowledge base or data source resource.</p> </li> </ul> <note> <p>For managed knowledge bases, the only supported option is <code>DELETE</code>, which is also the default.</p> </note>
2772
2869
  * @public
2773
2870
  */
2774
2871
  dataDeletionPolicy?: DataDeletionPolicy | undefined;
@@ -3045,6 +3142,36 @@ export interface UpdateDataSourceResponse {
3045
3142
  */
3046
3143
  dataSource: DataSource | undefined;
3047
3144
  }
3145
+ /**
3146
+ * @public
3147
+ */
3148
+ export interface DeleteResourcePolicyRequest {
3149
+ /**
3150
+ * <p>The Amazon Resource Name (ARN) of the knowledge base to remove the resource policy from.</p>
3151
+ * @public
3152
+ */
3153
+ resourceArn: string | undefined;
3154
+ /**
3155
+ * <p>The expected revision identifier of the resource policy. Use this to prevent conflicts when multiple users update the same policy concurrently.</p>
3156
+ * @public
3157
+ */
3158
+ expectedRevisionId?: string | undefined;
3159
+ }
3160
+ /**
3161
+ * @public
3162
+ */
3163
+ export interface DeleteResourcePolicyResponse {
3164
+ /**
3165
+ * <p>The ARN of the knowledge base that the resource policy was removed from.</p>
3166
+ * @public
3167
+ */
3168
+ resourceArn: string | undefined;
3169
+ /**
3170
+ * <p>The revision identifier after the resource policy was deleted.</p>
3171
+ * @public
3172
+ */
3173
+ revisionId?: string | undefined;
3174
+ }
3048
3175
  /**
3049
3176
  * <p>The configuration of a connection between a condition node and another node.</p>
3050
3177
  * @public
@@ -6757,6 +6884,36 @@ export interface PrepareFlowResponse {
6757
6884
  */
6758
6885
  status: FlowStatus | undefined;
6759
6886
  }
6887
+ /**
6888
+ * @public
6889
+ */
6890
+ export interface GetResourcePolicyRequest {
6891
+ /**
6892
+ * <p>The Amazon Resource Name (ARN) of the knowledge base to retrieve the resource policy for.</p>
6893
+ * @public
6894
+ */
6895
+ resourceArn: string | undefined;
6896
+ }
6897
+ /**
6898
+ * @public
6899
+ */
6900
+ export interface GetResourcePolicyResponse {
6901
+ /**
6902
+ * <p>The ARN of the knowledge base that the resource policy is associated with.</p>
6903
+ * @public
6904
+ */
6905
+ resourceArn: string | undefined;
6906
+ /**
6907
+ * <p>The JSON-formatted resource policy associated with the knowledge base.</p>
6908
+ * @public
6909
+ */
6910
+ policy: __AutomaticJsonStringConversion | string | undefined;
6911
+ /**
6912
+ * <p>The revision identifier of the resource policy.</p>
6913
+ * @public
6914
+ */
6915
+ revisionId: string | undefined;
6916
+ }
6760
6917
  /**
6761
6918
  * @public
6762
6919
  */
@@ -6817,6 +6974,11 @@ export interface IngestionJobStatistics {
6817
6974
  * @public
6818
6975
  */
6819
6976
  numberOfDocumentsFailed?: number | undefined;
6977
+ /**
6978
+ * <p>The number of source documents that were skipped during ingestion.</p>
6979
+ * @public
6980
+ */
6981
+ numberOfDocumentsSkipped?: number | undefined;
6820
6982
  }
6821
6983
  /**
6822
6984
  * <p>Contains details about a data ingestion job. Data sources are ingested into a knowledge base so that Large Language Models (LLMs) can use your data.</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_StartIngestionJob.html#API_agent_StartIngestionJob_ResponseSyntax">StartIngestionJob response</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetIngestionJob.html#API_agent_GetIngestionJob_ResponseSyntax">GetIngestionJob response</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ListIngestionJobs.html#API_agent_ListIngestionJobs_ResponseSyntax">ListIngestionJob response</a> </p> </li> </ul>
@@ -7332,6 +7494,27 @@ export interface DocumentContent {
7332
7494
  */
7333
7495
  s3?: S3Content | undefined;
7334
7496
  }
7497
+ /**
7498
+ * <p>An access control entry specifying a principal and their access level.</p>
7499
+ * @public
7500
+ */
7501
+ export interface DocumentAccessControlEntry {
7502
+ /**
7503
+ * <p>The user identifier.</p>
7504
+ * @public
7505
+ */
7506
+ name: string | undefined;
7507
+ /**
7508
+ * <p>The type of principal.</p>
7509
+ * @public
7510
+ */
7511
+ type: AccessControlPrincipalType | undefined;
7512
+ /**
7513
+ * <p>Whether to allow or deny access.</p>
7514
+ * @public
7515
+ */
7516
+ access: AccessControlAccess | undefined;
7517
+ }
7335
7518
  /**
7336
7519
  * <p>Contains the value of the metadata attribute. Choose a <code>type</code> and include the field that corresponds to it.</p>
7337
7520
  * @public
@@ -7399,6 +7582,11 @@ export interface DocumentMetadata {
7399
7582
  * @public
7400
7583
  */
7401
7584
  s3Location?: CustomS3Location | undefined;
7585
+ /**
7586
+ * <p>Access control list for the document. Used when metadata type is IN_LINE_ATTRIBUTE.</p>
7587
+ * @public
7588
+ */
7589
+ accessControlList?: DocumentAccessControlEntry[] | undefined;
7402
7590
  }
7403
7591
  /**
7404
7592
  * <p>Contains information about a document to ingest into a knowledge base and metadata to associate with it.</p>
@@ -7543,311 +7731,130 @@ export interface KendraKnowledgeBaseConfiguration {
7543
7731
  kendraIndexArn: string | undefined;
7544
7732
  }
7545
7733
  /**
7546
- * <p>Contains configurations for authentication to an Amazon Redshift provisioned data warehouse. Specify the type of authentication to use in the <code>type</code> field and include the corresponding field. If you specify IAM authentication, you don't need to include another field.</p>
7547
- * @public
7548
- */
7549
- export interface RedshiftProvisionedAuthConfiguration {
7550
- /**
7551
- * <p>The type of authentication to use.</p>
7552
- * @public
7553
- */
7554
- type: RedshiftProvisionedAuthType | undefined;
7555
- /**
7556
- * <p>The database username for authentication to an Amazon Redshift provisioned data warehouse.</p>
7557
- * @public
7558
- */
7559
- databaseUser?: string | undefined;
7560
- /**
7561
- * <p>The ARN of an Secrets Manager secret for authentication.</p>
7562
- * @public
7563
- */
7564
- usernamePasswordSecretArn?: string | undefined;
7565
- }
7566
- /**
7567
- * <p>Contains configurations for a provisioned Amazon Redshift query engine.</p>
7568
- * @public
7569
- */
7570
- export interface RedshiftProvisionedConfiguration {
7571
- /**
7572
- * <p>The ID of the Amazon Redshift cluster.</p>
7573
- * @public
7574
- */
7575
- clusterIdentifier: string | undefined;
7576
- /**
7577
- * <p>Specifies configurations for authentication to Amazon Redshift.</p>
7578
- * @public
7579
- */
7580
- authConfiguration: RedshiftProvisionedAuthConfiguration | undefined;
7581
- }
7582
- /**
7583
- * <p>Specifies configurations for authentication to a Redshift Serverless. Specify the type of authentication to use in the <code>type</code> field and include the corresponding field. If you specify IAM authentication, you don't need to include another field.</p>
7584
- * @public
7585
- */
7586
- export interface RedshiftServerlessAuthConfiguration {
7587
- /**
7588
- * <p>The type of authentication to use.</p>
7589
- * @public
7590
- */
7591
- type: RedshiftServerlessAuthType | undefined;
7592
- /**
7593
- * <p>The ARN of an Secrets Manager secret for authentication.</p>
7594
- * @public
7595
- */
7596
- usernamePasswordSecretArn?: string | undefined;
7597
- }
7598
- /**
7599
- * <p>Contains configurations for authentication to Amazon Redshift Serverless.</p>
7600
- * @public
7601
- */
7602
- export interface RedshiftServerlessConfiguration {
7603
- /**
7604
- * <p>The ARN of the Amazon Redshift workgroup.</p>
7605
- * @public
7606
- */
7607
- workgroupArn: string | undefined;
7608
- /**
7609
- * <p>Specifies configurations for authentication to an Amazon Redshift provisioned data warehouse.</p>
7610
- * @public
7611
- */
7612
- authConfiguration: RedshiftServerlessAuthConfiguration | undefined;
7613
- }
7614
- /**
7615
- * <p>Contains configurations for an Amazon Redshift query engine. Specify the type of query engine in <code>type</code> and include the corresponding field. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html">Build a knowledge base by connecting to a structured data source</a> in the Amazon Bedrock User Guide.</p>
7616
- * @public
7617
- */
7618
- export interface RedshiftQueryEngineConfiguration {
7619
- /**
7620
- * <p>The type of query engine.</p>
7621
- * @public
7622
- */
7623
- type: RedshiftQueryEngineType | undefined;
7624
- /**
7625
- * <p>Specifies configurations for a serverless Amazon Redshift query engine.</p>
7626
- * @public
7627
- */
7628
- serverlessConfiguration?: RedshiftServerlessConfiguration | undefined;
7629
- /**
7630
- * <p>Specifies configurations for a provisioned Amazon Redshift query engine.</p>
7631
- * @public
7632
- */
7633
- provisionedConfiguration?: RedshiftProvisionedConfiguration | undefined;
7634
- }
7635
- /**
7636
- * <p>Contains configurations for a query, each of which defines information about example queries to help the query engine generate appropriate SQL queries.</p>
7734
+ * <p>Configuration for segmenting audio content during multimodal knowledge base ingestion. Determines how audio files are divided into chunks for processing.</p>
7637
7735
  * @public
7638
7736
  */
7639
- export interface CuratedQuery {
7640
- /**
7641
- * <p>An example natural language query.</p>
7642
- * @public
7643
- */
7644
- naturalLanguage: string | undefined;
7737
+ export interface AudioSegmentationConfiguration {
7645
7738
  /**
7646
- * <p>The SQL equivalent of the natural language query.</p>
7739
+ * <p>The duration in seconds for each audio segment. Audio files will be divided into chunks of this length for processing.</p>
7647
7740
  * @public
7648
7741
  */
7649
- sql: string | undefined;
7742
+ fixedLengthDuration: number | undefined;
7650
7743
  }
7651
7744
  /**
7652
- * <p>Contains information about a column in the current table for the query engine to consider.</p>
7745
+ * <p>Configuration settings for processing audio content in multimodal knowledge bases.</p>
7653
7746
  * @public
7654
7747
  */
7655
- export interface QueryGenerationColumn {
7656
- /**
7657
- * <p>The name of the column for which the other fields in this object apply.</p>
7658
- * @public
7659
- */
7660
- name?: string | undefined;
7661
- /**
7662
- * <p>A description of the column that helps the query engine understand the contents of the column.</p>
7663
- * @public
7664
- */
7665
- description?: string | undefined;
7748
+ export interface AudioConfiguration {
7666
7749
  /**
7667
- * <p>Specifies whether to include or exclude the column during query generation. If you specify <code>EXCLUDE</code>, the column will be ignored. If you specify <code>INCLUDE</code>, all other columns in the table will be ignored.</p>
7750
+ * <p>Configuration for segmenting audio content during processing.</p>
7668
7751
  * @public
7669
7752
  */
7670
- inclusion?: IncludeExclude | undefined;
7753
+ segmentationConfiguration: AudioSegmentationConfiguration | undefined;
7671
7754
  }
7672
7755
  /**
7673
- * <p>Contains information about a table for the query engine to consider.</p>
7756
+ * <p>Configuration for segmenting video content during multimodal knowledge base ingestion. Determines how video files are divided into chunks for processing.</p>
7674
7757
  * @public
7675
7758
  */
7676
- export interface QueryGenerationTable {
7677
- /**
7678
- * <p>The name of the table for which the other fields in this object apply.</p>
7679
- * @public
7680
- */
7681
- name: string | undefined;
7682
- /**
7683
- * <p>A description of the table that helps the query engine understand the contents of the table.</p>
7684
- * @public
7685
- */
7686
- description?: string | undefined;
7687
- /**
7688
- * <p>Specifies whether to include or exclude the table during query generation. If you specify <code>EXCLUDE</code>, the table will be ignored. If you specify <code>INCLUDE</code>, all other tables will be ignored.</p>
7689
- * @public
7690
- */
7691
- inclusion?: IncludeExclude | undefined;
7759
+ export interface VideoSegmentationConfiguration {
7692
7760
  /**
7693
- * <p>An array of objects, each of which defines information about a column in the table.</p>
7761
+ * <p>The duration in seconds for each video segment. Video files will be divided into chunks of this length for processing.</p>
7694
7762
  * @public
7695
7763
  */
7696
- columns?: QueryGenerationColumn[] | undefined;
7764
+ fixedLengthDuration: number | undefined;
7697
7765
  }
7698
7766
  /**
7699
- * <p>&gt;Contains configurations for context to use during query generation.</p>
7767
+ * <p>Configuration settings for processing video content in multimodal knowledge bases.</p>
7700
7768
  * @public
7701
7769
  */
7702
- export interface QueryGenerationContext {
7703
- /**
7704
- * <p>An array of objects, each of which defines information about a table in the database.</p>
7705
- * @public
7706
- */
7707
- tables?: QueryGenerationTable[] | undefined;
7770
+ export interface VideoConfiguration {
7708
7771
  /**
7709
- * <p>An array of objects, each of which defines information about example queries to help the query engine generate appropriate SQL queries.</p>
7772
+ * <p>Configuration for segmenting video content during processing.</p>
7710
7773
  * @public
7711
7774
  */
7712
- curatedQueries?: CuratedQuery[] | undefined;
7775
+ segmentationConfiguration: VideoSegmentationConfiguration | undefined;
7713
7776
  }
7714
7777
  /**
7715
- * <p>Contains configurations for query generation. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html">Build a knowledge base by connecting to a structured data source</a> in the Amazon Bedrock User Guide..</p>
7778
+ * <p>The vector configuration details for the Bedrock embeddings model.</p>
7716
7779
  * @public
7717
7780
  */
7718
- export interface QueryGenerationConfiguration {
7781
+ export interface BedrockEmbeddingModelConfiguration {
7719
7782
  /**
7720
- * <p>The time after which query generation will time out.</p>
7783
+ * <p>The dimensions details for the vector configuration used on the Bedrock embeddings model.</p>
7721
7784
  * @public
7722
7785
  */
7723
- executionTimeoutSeconds?: number | undefined;
7786
+ dimensions?: number | undefined;
7724
7787
  /**
7725
- * <p>Specifies configurations for context to use during query generation.</p>
7788
+ * <p>The data type for the vectors when using a model to convert text into vector embeddings. The model must support the specified data type for vector embeddings. Floating-point (float32) is the default data type, and is supported by most models for vector embeddings. See <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-supported.html">Supported embeddings models</a> for information on the available models and their vector data types.</p>
7726
7789
  * @public
7727
7790
  */
7728
- generationContext?: QueryGenerationContext | undefined;
7729
- }
7730
- /**
7731
- * <p>Contains configurations for storage in Glue Data Catalog.</p>
7732
- * @public
7733
- */
7734
- export interface RedshiftQueryEngineAwsDataCatalogStorageConfiguration {
7791
+ embeddingDataType?: EmbeddingDataType | undefined;
7735
7792
  /**
7736
- * <p>A list of names of the tables to use.</p>
7793
+ * <p>Configuration settings for processing audio content in multimodal knowledge bases.</p>
7737
7794
  * @public
7738
7795
  */
7739
- tableNames: string[] | undefined;
7740
- }
7741
- /**
7742
- * <p>Contains configurations for storage in Amazon Redshift.</p>
7743
- * @public
7744
- */
7745
- export interface RedshiftQueryEngineRedshiftStorageConfiguration {
7796
+ audio?: AudioConfiguration[] | undefined;
7746
7797
  /**
7747
- * <p>The name of the Amazon Redshift database.</p>
7798
+ * <p>Configuration settings for processing video content in multimodal knowledge bases.</p>
7748
7799
  * @public
7749
7800
  */
7750
- databaseName: string | undefined;
7801
+ video?: VideoConfiguration[] | undefined;
7751
7802
  }
7752
7803
  /**
7753
- * <p>Contains configurations for Amazon Redshift data storage. Specify the data storage service to use in the <code>type</code> field and include the corresponding field. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html">Build a knowledge base by connecting to a structured data source</a> in the Amazon Bedrock User Guide.</p>
7804
+ * <p>The configuration details for the embeddings model.</p>
7754
7805
  * @public
7755
7806
  */
7756
- export interface RedshiftQueryEngineStorageConfiguration {
7807
+ export interface EmbeddingModelConfiguration {
7757
7808
  /**
7758
- * <p>The data storage service to use.</p>
7809
+ * <p>The vector configuration details on the Bedrock embeddings model.</p>
7759
7810
  * @public
7760
7811
  */
7761
- type: RedshiftQueryEngineStorageType | undefined;
7762
- /**
7763
- * <p>Specifies configurations for storage in Glue Data Catalog.</p>
7764
- * @public
7765
- */
7766
- awsDataCatalogConfiguration?: RedshiftQueryEngineAwsDataCatalogStorageConfiguration | undefined;
7767
- /**
7768
- * <p>Specifies configurations for storage in Amazon Redshift.</p>
7769
- * @public
7770
- */
7771
- redshiftConfiguration?: RedshiftQueryEngineRedshiftStorageConfiguration | undefined;
7812
+ bedrockEmbeddingModelConfiguration?: BedrockEmbeddingModelConfiguration | undefined;
7772
7813
  }
7773
7814
  /**
7774
- * <p>Contains configurations for an Amazon Redshift database. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html">Build a knowledge base by connecting to a structured data source</a> in the Amazon Bedrock User Guide.</p>
7815
+ * <p>Configurations for a managed knowledge base.</p>
7775
7816
  * @public
7776
7817
  */
7777
- export interface RedshiftConfiguration {
7778
- /**
7779
- * <p>Specifies configurations for Amazon Redshift database storage.</p>
7780
- * @public
7781
- */
7782
- storageConfigurations: RedshiftQueryEngineStorageConfiguration[] | undefined;
7818
+ export interface ManagedKnowledgeBaseConfiguration {
7783
7819
  /**
7784
- * <p>Specifies configurations for an Amazon Redshift query engine.</p>
7820
+ * <p>Choose <code>CUSTOM</code> to provide your own Bedrock embedding model ARN. Choose <code>MANAGED</code> to use a service-managed embedding model. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-managed-create.html#kb-managed-embedding-models">Embedding model options</a>.</p>
7785
7821
  * @public
7786
7822
  */
7787
- queryEngineConfiguration: RedshiftQueryEngineConfiguration | undefined;
7823
+ embeddingModelType?: EmbeddingModelType | undefined;
7788
7824
  /**
7789
- * <p>Specifies configurations for generating queries.</p>
7825
+ * <p>The ARN for the embeddings model.</p>
7790
7826
  * @public
7791
7827
  */
7792
- queryGenerationConfiguration?: QueryGenerationConfiguration | undefined;
7793
- }
7794
- /**
7795
- * <p>Contains configurations for a knowledge base connected to an SQL database. Specify the SQL database type in the <code>type</code> field and include the corresponding field. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html">Build a knowledge base by connecting to a structured data source</a> in the Amazon Bedrock User Guide.</p>
7796
- * @public
7797
- */
7798
- export interface SqlKnowledgeBaseConfiguration {
7828
+ embeddingModelArn?: string | undefined;
7799
7829
  /**
7800
- * <p>The type of SQL database to connect to the knowledge base.</p>
7830
+ * <p>The configuration details for the embeddings model.</p>
7801
7831
  * @public
7802
7832
  */
7803
- type: QueryEngineType | undefined;
7804
- /**
7805
- * <p>Specifies configurations for a knowledge base connected to an Amazon Redshift database.</p>
7806
- * @public
7807
- */
7808
- redshiftConfiguration?: RedshiftConfiguration | undefined;
7809
- }
7810
- /**
7811
- * <p>Configuration for segmenting audio content during multimodal knowledge base ingestion. Determines how audio files are divided into chunks for processing.</p>
7812
- * @public
7813
- */
7814
- export interface AudioSegmentationConfiguration {
7833
+ embeddingModelConfiguration?: EmbeddingModelConfiguration | undefined;
7815
7834
  /**
7816
- * <p>The duration in seconds for each audio segment. Audio files will be divided into chunks of this length for processing.</p>
7835
+ * <p>Contains the configuration for server-side encryption for your managed knowledge base.</p>
7817
7836
  * @public
7818
7837
  */
7819
- fixedLengthDuration: number | undefined;
7838
+ serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration | undefined;
7820
7839
  }
7821
7840
  /**
7822
- * <p>Configuration settings for processing audio content in multimodal knowledge bases.</p>
7841
+ * <p>Contains configurations for authentication to an Amazon Redshift provisioned data warehouse. Specify the type of authentication to use in the <code>type</code> field and include the corresponding field. If you specify IAM authentication, you don't need to include another field.</p>
7823
7842
  * @public
7824
7843
  */
7825
- export interface AudioConfiguration {
7844
+ export interface RedshiftProvisionedAuthConfiguration {
7826
7845
  /**
7827
- * <p>Configuration for segmenting audio content during processing.</p>
7846
+ * <p>The type of authentication to use.</p>
7828
7847
  * @public
7829
7848
  */
7830
- segmentationConfiguration: AudioSegmentationConfiguration | undefined;
7831
- }
7832
- /**
7833
- * <p>Configuration for segmenting video content during multimodal knowledge base ingestion. Determines how video files are divided into chunks for processing.</p>
7834
- * @public
7835
- */
7836
- export interface VideoSegmentationConfiguration {
7849
+ type: RedshiftProvisionedAuthType | undefined;
7837
7850
  /**
7838
- * <p>The duration in seconds for each video segment. Video files will be divided into chunks of this length for processing.</p>
7851
+ * <p>The database username for authentication to an Amazon Redshift provisioned data warehouse.</p>
7839
7852
  * @public
7840
7853
  */
7841
- fixedLengthDuration: number | undefined;
7842
- }
7843
- /**
7844
- * <p>Configuration settings for processing video content in multimodal knowledge bases.</p>
7845
- * @public
7846
- */
7847
- export interface VideoConfiguration {
7854
+ databaseUser?: string | undefined;
7848
7855
  /**
7849
- * <p>Configuration for segmenting video content during processing.</p>
7856
+ * <p>The ARN of an Secrets Manager secret for authentication.</p>
7850
7857
  * @public
7851
7858
  */
7852
- segmentationConfiguration: VideoSegmentationConfiguration | undefined;
7859
+ usernamePasswordSecretArn?: string | undefined;
7853
7860
  }