@propulsionworks/cloudformation 0.0.2 → 0.1.0

package/out/exports/resources.generated/aws-bedrock-knowledgebase.d.ts

@@ -0,0 +1,936 @@
+import type { ResourceDefinitionWithAttributes } from "../main.ts";
+export type BedrockKnowledgeBase = ResourceDefinitionWithAttributes<"AWS::Bedrock::KnowledgeBase", BedrockKnowledgeBaseProps, BedrockKnowledgeBaseAttribs>;
+/**
+ * Specifies a knowledge base as a resource in a top-level template. Minimally, you must specify the following properties:
+ *
+ * - Name – Specify a name for the knowledge base.
+ * - RoleArn – Specify the Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base. For more information, see [Create a service role for Knowledge base for Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/kb-permissions.html) .
+ * - KnowledgeBaseConfiguration – Specify the embeddings configuration of the knowledge base. The following sub-properties are required:
+ *
+ * - Type – Specify the value `VECTOR` .
+ * - StorageConfiguration – Specify information about the vector store in which the data source is stored. The following sub-properties are required:
+ *
+ * - Type – Specify the vector store service that you are using.
+ *
+ * > Redis Enterprise Cloud vector stores are currently unsupported in AWS CloudFormation .
+ *
+ * For more information about using knowledge bases in Amazon Bedrock , see [Knowledge base for Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base.html) .
+ *
+ * See the *Properties* section below for descriptions of both the required and optional properties.
+ */
+export type BedrockKnowledgeBaseProps = {
+    /**
+     * The description of the knowledge base associated with the inline agent.
+     * @minLength 1
+     * @maxLength 200
+     */
+    Description?: string | undefined;
+    /**
+     * Contains details about the embeddings configuration of the knowledge base.
+     */
+    KnowledgeBaseConfiguration: KnowledgeBaseConfiguration;
+    /**
+     * The name of the knowledge base.
+     * @pattern ^([0-9a-zA-Z][_-]?){1,100}$
+     */
+    Name: string;
+    /**
+     * The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
+     * @maxLength 2048
+     * @pattern ^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+$
+     */
+    RoleArn: string;
+    /**
+     * Contains details about the storage configuration of the knowledge base.
+     */
+    StorageConfiguration?: StorageConfiguration | undefined;
+    /**
+     * Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:
+     *
+     * - [Tag naming limits and requirements](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-conventions)
+     * - [Tagging best practices](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-best-practices)
+     */
+    Tags?: Record<string, string> | undefined;
+};
+export type BedrockKnowledgeBaseAttribs = {
+    /**
+     * The time the knowledge base was created.
+     */
+    CreatedAt: string;
+    /**
+     * A list of reasons that the API operation on the knowledge base failed.
+     */
+    FailureReasons: string[];
+    /**
+     * The Amazon Resource Name (ARN) of the knowledge base.
+     * @minLength 0
+     * @maxLength 128
+     * @pattern ^arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:knowledge-base/[0-9a-zA-Z]+$
+     */
+    KnowledgeBaseArn: string;
+    /**
+     * The unique identifier for a knowledge base associated with the inline agent.
+     * @pattern ^[0-9a-zA-Z]{10}$
+     */
+    KnowledgeBaseId: string;
+    /**
+     * The status of the knowledge base.
+     */
+    Status: KnowledgeBaseStatus;
+    /**
+     * The time the knowledge base was last updated.
+     */
+    UpdatedAt: string;
+};
+/**
+ * The vector configuration details for the Bedrock embeddings model.
+ */
+export type BedrockEmbeddingModelConfiguration = {
+    /**
+     * The dimensions details for the vector configuration used on the Bedrock embeddings model.
+     * @min 0
+     * @max 4096
+     */
+    Dimensions?: number | undefined;
+    /**
+     * 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 [Supported embeddings models](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-supported.html) for information on the available models and their vector data types.
+     */
+    EmbeddingDataType?: "FLOAT32" | "BINARY" | undefined;
+};
+/**
+ * Contains configurations for a query, each of which defines information about example queries to help the query engine generate appropriate SQL queries.
+ */
+export type CuratedQuery = {
+    /**
+     * An example natural language query.
+     */
+    NaturalLanguage: string;
+    /**
+     * The SQL equivalent of the natural language query.
+     */
+    Sql: string;
+};
+/**
+ * The configuration details for the embeddings model.
+ */
+export type EmbeddingModelConfiguration = {
+    /**
+     * The vector configuration details on the Bedrock embeddings model.
+     */
+    BedrockEmbeddingModelConfiguration?: BedrockEmbeddingModelConfiguration | undefined;
+};
+/**
+ * Include or Exclude status for an entity
+ */
+export type InclusionType = "INCLUDE" | "EXCLUDE";
+/**
+ * Settings for an Amazon Kendra knowledge base.
+ */
+export type KendraKnowledgeBaseConfiguration = {
+    /**
+     * The ARN of the Amazon Kendra index.
+     */
+    KendraIndexArn: string;
+};
+/**
+ * Configurations to apply to a knowledge base attached to the agent during query. For more information, see [Knowledge base retrieval configurations](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html#session-state-kb) .
+ */
+export type KnowledgeBaseConfiguration = {
+    /**
+     * Settings for an Amazon Kendra knowledge base.
+     */
+    KendraKnowledgeBaseConfiguration?: KendraKnowledgeBaseConfiguration | undefined;
+    /**
+     * Specifies configurations for a knowledge base connected to an SQL database.
+     */
+    SqlKnowledgeBaseConfiguration?: SqlKnowledgeBaseConfiguration | undefined;
+    /**
+     * The type of data that the data source is converted into for the knowledge base.
+     */
+    Type: KnowledgeBaseType;
+    /**
+     * Contains details about the model that's used to convert the data source into vector embeddings.
+     */
+    VectorKnowledgeBaseConfiguration?: VectorKnowledgeBaseConfiguration | undefined;
+};
+/**
+ * The status of a knowledge base.
+ */
+export type KnowledgeBaseStatus = "CREATING" | "ACTIVE" | "DELETING" | "UPDATING" | "FAILED" | "DELETE_UNSUCCESSFUL";
+/**
+ * The storage type of a knowledge base.
+ */
+export type KnowledgeBaseStorageType = "OPENSEARCH_SERVERLESS" | "PINECONE" | "RDS" | "MONGO_DB_ATLAS" | "NEPTUNE_ANALYTICS" | "OPENSEARCH_MANAGED_CLUSTER";
+/**
+ * The type of a knowledge base.
+ */
+export type KnowledgeBaseType = "VECTOR" | "KENDRA" | "SQL";
+/**
+ * Contains details about the storage configuration of the knowledge base in MongoDB Atlas.
+ */
+export type MongoDbAtlasConfiguration = {
+    /**
+     * The collection name of the knowledge base in MongoDB Atlas.
+     * @maxLength 63
+     * @pattern ^.*$
+     */
+    CollectionName: string;
+    /**
+     * The Amazon Resource Name (ARN) of the secret that you created in AWS Secrets Manager that contains user credentials for your MongoDB Atlas cluster.
+     * @pattern ^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$
+     */
+    CredentialsSecretArn: string;
+    /**
+     * The database name in your MongoDB Atlas cluster for your knowledge base.
+     * @maxLength 63
+     * @pattern ^.*$
+     */
+    DatabaseName: string;
+    /**
+     * The endpoint URL of your MongoDB Atlas cluster for your knowledge base.
+     * @maxLength 2048
+     * @pattern ^[a-zA-Z0-9_-]+\.[a-zA-Z0-9_-]+\.mongodb\.net$
+     */
+    Endpoint: string;
+    /**
+     * The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.
+     * @maxLength 255
+     * @pattern ^(?:arn:aws(?:-us-gov|-cn|-iso|-iso-[a-z])*:.+:.*:\d+:.+/.+$|[a-zA-Z0-9*]+[a-zA-Z0-9._-]*)$
+     */
+    EndpointServiceName?: string | undefined;
+    /**
+     * Contains the names of the fields to which to map information about the vector store.
+     */
+    FieldMapping: MongoDbAtlasFieldMapping;
+    /**
+     * The name of the text search index in the MongoDB collection. This is required for using the hybrid search feature.
+     * @maxLength 2048
+     * @pattern ^.*$
+     */
+    TextIndexName?: string | undefined;
+    /**
+     * The name of the MongoDB Atlas vector search index.
+     * @maxLength 2048
+     * @pattern ^.*$
+     */
+    VectorIndexName: string;
+};
+/**
+ * Contains the names of the fields to which to map information about the vector store.
+ */
+export type MongoDbAtlasFieldMapping = {
+    /**
+     * The name of the field in which Amazon Bedrock stores metadata about the vector store.
+     * @maxLength 2048
+     * @pattern ^.*$
+     */
+    MetadataField: string;
+    /**
+     * The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
+     * @maxLength 2048
+     * @pattern ^.*$
+     */
+    TextField: string;
+    /**
+     * The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
+     * @maxLength 2048
+     * @pattern ^.*$
+     */
+    VectorField: string;
+};
+/**
+ * Contains details about the storage configuration of the knowledge base in Amazon Neptune Analytics. For more information, see [Create a vector index in Amazon Neptune Analytics](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-neptune.html) .
+ */
+export type NeptuneAnalyticsConfiguration = {
+    /**
+     * Contains the names of the fields to which to map information about the vector store.
+     */
+    FieldMapping: NeptuneAnalyticsFieldMapping;
+    /**
+     * The Amazon Resource Name (ARN) of the Neptune Analytics vector store.
+     * @minLength 1
+     * @maxLength 255
+     * @pattern ^arn:aws(|-cn|-us-gov):neptune-graph:[a-zA-Z0-9-]*:[0-9]{12}:graph\/g-[a-zA-Z0-9]{10}$
+     */
+    GraphArn: string;
+};
+/**
+ * Contains the names of the fields to which to map information about the vector store.
+ */
+export type NeptuneAnalyticsFieldMapping = {
+    /**
+     * The name of the field in which Amazon Bedrock stores metadata about the vector store.
+     * @maxLength 2048
+     * @pattern ^.*$
+     */
+    MetadataField: string;
+    /**
+     * The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
+     * @maxLength 2048
+     * @pattern ^.*$
+     */
+    TextField: string;
+};
+/**
+ * Contains details about the Managed Cluster configuration of the knowledge base in Amazon OpenSearch Service. For more information, see [Create a vector index in OpenSearch Managed Cluster](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-osm.html) .
+ */
+export type OpenSearchManagedClusterConfiguration = {
+    /**
+     * The Amazon Resource Name (ARN) of the OpenSearch domain.
+     * @maxLength 2048
+     * @pattern ^arn:aws(|-cn|-us-gov|-iso):es:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:domain/[a-z][a-z0-9-]{3,28}$
+     */
+    DomainArn: string;
+    /**
+     * The endpoint URL the OpenSearch domain.
+     * @maxLength 2048
+     * @pattern ^https://.*$
+     */
+    DomainEndpoint: string;
+    /**
+     * Contains the names of the fields to which to map information about the vector store.
+     */
+    FieldMapping: OpenSearchManagedClusterFieldMapping;
+    /**
+     * The name of the vector store.
+     * @minLength 1
+     * @maxLength 2048
+     * @pattern ^(?![\-_+.])[a-z0-9][a-z0-9\-_\.]*$
+     */
+    VectorIndexName: string;
+};
+/**
+ * Contains the names of the fields to which to map information about the vector store.
+ */
+export type OpenSearchManagedClusterFieldMapping = {
+    /**
+     * The name of the field in which Amazon Bedrock stores metadata about the vector store.
+     * @maxLength 2048
+     * @pattern ^.*$
+     */
+    MetadataField: string;
+    /**
+     * The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
+     * @maxLength 2048
+     * @pattern ^.*$
+     */
+    TextField: string;
+    /**
+     * The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
+     * @maxLength 2048
+     * @pattern ^.*$
+     */
+    VectorField: string;
+};
+/**
+ * Contains details about the storage configuration of the knowledge base in Amazon OpenSearch Service. For more information, see [Create a vector index in Amazon OpenSearch Service](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-oss.html) .
+ */
+export type OpenSearchServerlessConfiguration = {
+    /**
+     * The Amazon Resource Name (ARN) of the OpenSearch Service vector store.
+     * @maxLength 2048
+     * @pattern ^arn:aws(|-cn|-us-gov|-iso):aoss:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:collection/[a-z0-9-]{3,32}$
+     */
+    CollectionArn: string;
+    /**
+     * Contains the names of the fields to which to map information about the vector store.
+     */
+    FieldMapping: OpenSearchServerlessFieldMapping;
+    /**
+     * The name of the vector store.
+     * @maxLength 2048
+     * @pattern ^.*$
+     */
+    VectorIndexName: string;
+};
+/**
+ * Contains the names of the fields to which to map information about the vector store.
+ */
+export type OpenSearchServerlessFieldMapping = {
+    /**
+     * The name of the field in which Amazon Bedrock stores metadata about the vector store.
+     * @maxLength 2048
+     * @pattern ^.*$
+     */
+    MetadataField: string;
+    /**
+     * The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
+     * @maxLength 2048
+     * @pattern ^.*$
+     */
+    TextField: string;
+    /**
+     * The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
+     * @maxLength 2048
+     * @pattern ^.*$
+     */
+    VectorField: string;
+};
+/**
+ * Contains details about the storage configuration of the knowledge base in Pinecone. For more information, see [Create a vector index in Pinecone](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-pinecone.html) .
+ */
+export type PineconeConfiguration = {
+    /**
+     * The endpoint URL for your index management page.
+     * @maxLength 2048
+     * @pattern ^.*$
+     */
+    ConnectionString: string;
+    /**
+     * The Amazon Resource Name (ARN) of the secret that you created in AWS Secrets Manager that is linked to your Pinecone API key.
+     * @pattern ^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$
+     */
+    CredentialsSecretArn: string;
+    /**
+     * Contains the names of the fields to which to map information about the vector store.
+     */
+    FieldMapping: PineconeFieldMapping;
+    /**
+     * The namespace to be used to write new data to your database.
+     * @maxLength 2048
+     * @pattern ^.*$
+     */
+    Namespace?: string | undefined;
+};
+/**
+ * Contains the names of the fields to which to map information about the vector store.
+ */
+export type PineconeFieldMapping = {
+    /**
+     * The name of the field in which Amazon Bedrock stores metadata about the vector store.
+     * @maxLength 2048
+     * @pattern ^.*$
+     */
+    MetadataField: string;
+    /**
+     * The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
+     * @maxLength 2048
+     * @pattern ^.*$
+     */
+    TextField: string;
+};
+/**
+ * SQL query engine type
+ */
+export type QueryEngineType = "REDSHIFT";
+/**
+ * Contains information about a column in the current table for the query engine to consider.
+ */
+export type QueryGenerationColumn = {
+    /**
+     * A description of the column that helps the query engine understand the contents of the column.
+     */
+    Description?: string | undefined;
+    /**
+     * Specifies whether to include or exclude the column during query generation. If you specify `EXCLUDE` , the column will be ignored. If you specify `INCLUDE` , all other columns in the table will be ignored.
+     */
+    Inclusion?: InclusionType | undefined;
+    /**
+     * The name of the column for which the other fields in this object apply.
+     */
+    Name?: string | undefined;
+};
+/**
+ * Contains configurations for query generation. For more information, see [Build a knowledge base by connecting to a structured data source](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html) in the Amazon Bedrock User Guide..
+ */
+export type QueryGenerationConfiguration = {
+    /**
+     * The time after which query generation will time out.
+     */
+    ExecutionTimeoutSeconds?: number | undefined;
+    /**
+     * Specifies configurations for context to use during query generation.
+     */
+    GenerationContext?: QueryGenerationContext | undefined;
+};
+/**
+ * >Contains configurations for context to use during query generation.
+ */
+export type QueryGenerationContext = {
+    /**
+     * An array of objects, each of which defines information about example queries to help the query engine generate appropriate SQL queries.
+     */
+    CuratedQueries?: CuratedQuery[] | undefined;
+    /**
+     * An array of objects, each of which defines information about a table in the database.
+     */
+    Tables?: QueryGenerationTable[] | undefined;
+};
+/**
+ * Contains information about a table for the query engine to consider.
+ */
+export type QueryGenerationTable = {
+    /**
+     * An array of objects, each of which defines information about a column in the table.
+     */
+    Columns?: QueryGenerationColumn[] | undefined;
+    /**
+     * A description of the table that helps the query engine understand the contents of the table.
+     */
+    Description?: string | undefined;
+    /**
+     * Specifies whether to include or exclude the table during query generation. If you specify `EXCLUDE` , the table will be ignored. If you specify `INCLUDE` , all other tables will be ignored.
+     */
+    Inclusion?: InclusionType | undefined;
+    /**
+     * The name of the table for which the other fields in this object apply.
+     */
+    Name: string;
+};
+/**
+ * Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see [Create a vector index in Amazon RDS](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html) .
+ */
+export type RdsConfiguration = {
+    /**
+     * The Amazon Resource Name (ARN) of the secret that you created in AWS Secrets Manager that is linked to your Amazon RDS database.
+     * @pattern ^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$
+     */
+    CredentialsSecretArn: string;
+    /**
+     * The name of your Amazon RDS database.
+     * @maxLength 63
+     * @pattern ^[a-zA-Z0-9_\-]+$
+     */
+    DatabaseName: string;
+    /**
+     * Contains the names of the fields to which to map information about the vector store.
+     */
+    FieldMapping: RdsFieldMapping;
+    /**
+     * The Amazon Resource Name (ARN) of the vector store.
+     * @pattern ^arn:aws(|-cn|-us-gov):rds:[a-zA-Z0-9-]*:[0-9]{12}:cluster:[a-zA-Z0-9-]{1,63}$
+     */
+    ResourceArn: string;
+    /**
+     * The name of the table in the database.
+     * @maxLength 63
+     * @pattern ^[a-zA-Z0-9_\.\-]+$
+     */
+    TableName: string;
+};
+/**
+ * Contains the names of the fields to which to map information about the vector store.
+ */
+export type RdsFieldMapping = {
+    /**
+     * Provide a name for the universal metadata field where Amazon Bedrock will store any custom metadata from your data source.
+     * @maxLength 63
+     * @pattern ^[a-zA-Z0-9_\-]+$
+     */
+    CustomMetadataField?: string | undefined;
+    /**
+     * The name of the field in which Amazon Bedrock stores metadata about the vector store.
+     * @maxLength 63
+     * @pattern ^[a-zA-Z0-9_\-]+$
+     */
+    MetadataField: string;
+    /**
+     * The name of the field in which Amazon Bedrock stores the ID for each entry.
+     * @maxLength 63
+     * @pattern ^[a-zA-Z0-9_\-]+$
+     */
+    PrimaryKeyField: string;
+    /**
+     * The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
+     * @maxLength 63
+     * @pattern ^[a-zA-Z0-9_\-]+$
+     */
+    TextField: string;
+    /**
+     * The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
+     * @maxLength 63
+     * @pattern ^[a-zA-Z0-9_\-]+$
+     */
+    VectorField: string;
+};
+/**
+ * Contains configurations for an Amazon Redshift database. For more information, see [Build a knowledge base by connecting to a structured data source](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html) in the Amazon Bedrock User Guide.
+ */
+export type RedshiftConfiguration = {
+    /**
+     * Specifies configurations for an Amazon Redshift query engine.
+     */
+    QueryEngineConfiguration: RedshiftQueryEngineConfiguration;
+    /**
+     * Specifies configurations for generating queries.
+     */
+    QueryGenerationConfiguration?: QueryGenerationConfiguration | undefined;
+    /**
+     * Specifies configurations for Amazon Redshift database storage.
+     */
+    StorageConfigurations: RedshiftQueryEngineStorageConfiguration[];
+};
+/**
+ * Contains configurations for authentication to an Amazon Redshift provisioned data warehouse. Specify the type of authentication to use in the `type` field and include the corresponding field. If you specify IAM authentication, you don't need to include another field.
+ */
+export type RedshiftProvisionedAuthConfiguration = {
+    /**
+     * The database username for authentication to an Amazon Redshift provisioned data warehouse.
+     */
+    DatabaseUser?: string | undefined;
+    /**
+     * The type of authentication to use.
+     */
+    Type: RedshiftProvisionedAuthType;
+    /**
+     * The ARN of an Secrets Manager secret for authentication.
+     */
+    UsernamePasswordSecretArn?: string | undefined;
+};
+/**
+ * Provisioned Redshift auth type
+ */
+export type RedshiftProvisionedAuthType = "IAM" | "USERNAME_PASSWORD" | "USERNAME";
+/**
+ * Contains configurations for a provisioned Amazon Redshift query engine.
+ */
+export type RedshiftProvisionedConfiguration = {
+    /**
+     * Specifies configurations for authentication to Amazon Redshift.
+     */
+    AuthConfiguration: RedshiftProvisionedAuthConfiguration;
+    /**
+     * The ID of the Amazon Redshift cluster.
+     */
+    ClusterIdentifier: string;
+};
+/**
+ * Contains configurations for storage in AWS Glue Data Catalog.
+ */
+export type RedshiftQueryEngineAwsDataCatalogStorageConfiguration = {
+    /**
+     * A list of names of the tables to use.
+     */
+    TableNames: string[];
+};
+/**
+ * Contains configurations for an Amazon Redshift query engine. Specify the type of query engine in `type` and include the corresponding field. For more information, see [Build a knowledge base by connecting to a structured data source](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html) in the Amazon Bedrock User Guide.
+ */
+export type RedshiftQueryEngineConfiguration = {
+    /**
+     * Specifies configurations for a provisioned Amazon Redshift query engine.
+     */
+    ProvisionedConfiguration?: RedshiftProvisionedConfiguration | undefined;
+    /**
+     * Specifies configurations for a serverless Amazon Redshift query engine.
+     */
+    ServerlessConfiguration?: RedshiftServerlessConfiguration | undefined;
+    /**
+     * The type of query engine.
+     */
+    Type: RedshiftQueryEngineType;
+};
+/**
+ * Contains configurations for storage in Amazon Redshift.
+ */
+export type RedshiftQueryEngineRedshiftStorageConfiguration = {
+    /**
+     * The name of the Amazon Redshift database.
+     */
+    DatabaseName: string;
+};
+/**
+ * Contains configurations for Amazon Redshift data storage. Specify the data storage service to use in the `type` field and include the corresponding field. For more information, see [Build a knowledge base by connecting to a structured data source](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html) in the Amazon Bedrock User Guide.
+ */
+export type RedshiftQueryEngineStorageConfiguration = {
+    /**
+     * Specifies configurations for storage in AWS Glue Data Catalog.
+     */
+    AwsDataCatalogConfiguration?: RedshiftQueryEngineAwsDataCatalogStorageConfiguration | undefined;
+    /**
+     * Specifies configurations for storage in Amazon Redshift.
+     */
+    RedshiftConfiguration?: RedshiftQueryEngineRedshiftStorageConfiguration | undefined;
+    /**
+     * The data storage service to use.
+     */
+    Type: RedshiftQueryEngineStorageType;
+};
+/**
+ * Redshift query engine storage type
+ */
+export type RedshiftQueryEngineStorageType = "REDSHIFT" | "AWS_DATA_CATALOG";
+/**
+ * Redshift query engine type
+ */
+export type RedshiftQueryEngineType = "SERVERLESS" | "PROVISIONED";
+/**
+ * Specifies configurations for authentication to a Redshift Serverless. Specify the type of authentication to use in the `type` field and include the corresponding field. If you specify IAM authentication, you don't need to include another field.
+ */
+export type RedshiftServerlessAuthConfiguration = {
+    /**
+     * The type of authentication to use.
+     */
+    Type: RedshiftServerlessAuthType;
+    /**
+     * The ARN of an Secrets Manager secret for authentication.
+     */
+    UsernamePasswordSecretArn?: string | undefined;
+};
+/**
+ * Serverless Redshift auth type
+ */
+export type RedshiftServerlessAuthType = "IAM" | "USERNAME_PASSWORD";
+/**
+ * Contains configurations for authentication to Amazon Redshift Serverless.
+ */
+export type RedshiftServerlessConfiguration = {
+    /**
+     * Specifies configurations for authentication to an Amazon Redshift provisioned data warehouse.
+     */
+    AuthConfiguration: RedshiftServerlessAuthConfiguration;
+    /**
+     * The ARN of the Amazon Redshift workgroup.
+     */
+    WorkgroupArn: string;
+};
+/**
+ * A storage location in an Amazon S3 bucket.
+ */
+export type S3Location = {
+    /**
+     * An object URI starting with `s3://` .
+     * @minLength 1
+     * @maxLength 2048
+     * @pattern ^s3://.{1,128}$
+     */
+    URI: string;
+};
+/**
+ * Contains configurations for a knowledge base connected to an SQL database. Specify the SQL database type in the `type` field and include the corresponding field. For more information, see [Build a knowledge base by connecting to a structured data source](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html) in the Amazon Bedrock User Guide.
+ */
+export type SqlKnowledgeBaseConfiguration = {
+    /**
+     * Specifies configurations for a knowledge base connected to an Amazon Redshift database.
+     */
+    RedshiftConfiguration?: RedshiftConfiguration | undefined;
+    /**
+     * The type of SQL database to connect to the knowledge base.
+     */
+    Type: QueryEngineType;
+};
+/**
+ * Contains the storage configuration of the knowledge base.
+ */
+export type StorageConfiguration = {
+    /**
+     * Contains the storage configuration of the knowledge base in MongoDB Atlas.
+     */
+    MongoDbAtlasConfiguration?: MongoDbAtlasConfiguration | undefined;
+    /**
+     * Contains details about the Neptune Analytics configuration of the knowledge base in Amazon Neptune. For more information, see [Create a vector index in Amazon Neptune Analytics.](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-neptune.html) .
+     */
+    NeptuneAnalyticsConfiguration?: NeptuneAnalyticsConfiguration | undefined;
+    /**
+     * Contains details about the storage configuration of the knowledge base in OpenSearch Managed Cluster. For more information, see [Create a vector index in Amazon OpenSearch Service](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-osm.html) .
+     */
+    OpensearchManagedClusterConfiguration?: OpenSearchManagedClusterConfiguration | undefined;
+    /**
+     * Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
+     */
+    OpensearchServerlessConfiguration: OpenSearchServerlessConfiguration;
+    /**
+     * Contains the storage configuration of the knowledge base in Pinecone.
+     */
+    PineconeConfiguration?: PineconeConfiguration | undefined;
+    /**
+     * Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see [Create a vector index in Amazon RDS](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html) .
+     */
+    RdsConfiguration?: RdsConfiguration | undefined;
+    /**
+     * The vector store service in which the knowledge base is stored.
+     */
+    Type: KnowledgeBaseStorageType;
+} | {
+    /**
+     * Contains the storage configuration of the knowledge base in MongoDB Atlas.
+     */
+    MongoDbAtlasConfiguration?: MongoDbAtlasConfiguration | undefined;
+    /**
+     * Contains details about the Neptune Analytics configuration of the knowledge base in Amazon Neptune. For more information, see [Create a vector index in Amazon Neptune Analytics.](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-neptune.html) .
+     */
+    NeptuneAnalyticsConfiguration?: NeptuneAnalyticsConfiguration | undefined;
+    /**
+     * Contains details about the storage configuration of the knowledge base in OpenSearch Managed Cluster. For more information, see [Create a vector index in Amazon OpenSearch Service](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-osm.html) .
+     */
+    OpensearchManagedClusterConfiguration?: OpenSearchManagedClusterConfiguration | undefined;
+    /**
+     * Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
+     */
+    OpensearchServerlessConfiguration?: OpenSearchServerlessConfiguration | undefined;
+    /**
+     * Contains the storage configuration of the knowledge base in Pinecone.
+     */
+    PineconeConfiguration: PineconeConfiguration;
+    /**
+     * Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see [Create a vector index in Amazon RDS](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html) .
+     */
+    RdsConfiguration?: RdsConfiguration | undefined;
+    /**
+     * The vector store service in which the knowledge base is stored.
+     */
+    Type: KnowledgeBaseStorageType;
+} | {
+    /**
+     * Contains the storage configuration of the knowledge base in MongoDB Atlas.
+     */
+    MongoDbAtlasConfiguration?: MongoDbAtlasConfiguration | undefined;
+    /**
+     * Contains details about the Neptune Analytics configuration of the knowledge base in Amazon Neptune. For more information, see [Create a vector index in Amazon Neptune Analytics.](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-neptune.html) .
+     */
+    NeptuneAnalyticsConfiguration?: NeptuneAnalyticsConfiguration | undefined;
+    /**
+     * Contains details about the storage configuration of the knowledge base in OpenSearch Managed Cluster. For more information, see [Create a vector index in Amazon OpenSearch Service](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-osm.html) .
+     */
+    OpensearchManagedClusterConfiguration?: OpenSearchManagedClusterConfiguration | undefined;
+    /**
+     * Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
+     */
+    OpensearchServerlessConfiguration?: OpenSearchServerlessConfiguration | undefined;
+    /**
+     * Contains the storage configuration of the knowledge base in Pinecone.
+     */
+    PineconeConfiguration?: PineconeConfiguration | undefined;
+    /**
+     * Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see [Create a vector index in Amazon RDS](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html) .
+     */
+    RdsConfiguration: RdsConfiguration;
+    /**
+     * The vector store service in which the knowledge base is stored.
+     */
+    Type: KnowledgeBaseStorageType;
+} | {
+    /**
+     * Contains the storage configuration of the knowledge base in MongoDB Atlas.
+     */
+    MongoDbAtlasConfiguration?: MongoDbAtlasConfiguration | undefined;
+    /**
+     * Contains details about the Neptune Analytics configuration of the knowledge base in Amazon Neptune. For more information, see [Create a vector index in Amazon Neptune Analytics.](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-neptune.html) .
+     */
+    NeptuneAnalyticsConfiguration: NeptuneAnalyticsConfiguration;
+    /**
+     * Contains details about the storage configuration of the knowledge base in OpenSearch Managed Cluster. For more information, see [Create a vector index in Amazon OpenSearch Service](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-osm.html) .
+     */
+    OpensearchManagedClusterConfiguration?: OpenSearchManagedClusterConfiguration | undefined;
+    /**
+     * Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
+     */
+    OpensearchServerlessConfiguration?: OpenSearchServerlessConfiguration | undefined;
+    /**
+     * Contains the storage configuration of the knowledge base in Pinecone.
+     */
+    PineconeConfiguration?: PineconeConfiguration | undefined;
+    /**
+     * Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see [Create a vector index in Amazon RDS](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html) .
+     */
+    RdsConfiguration?: RdsConfiguration | undefined;
+    /**
+     * The vector store service in which the knowledge base is stored.
+     */
+    Type: KnowledgeBaseStorageType;
+} | {
+    /**
+     * Contains the storage configuration of the knowledge base in MongoDB Atlas.
+     */
+    MongoDbAtlasConfiguration: MongoDbAtlasConfiguration;
+    /**
+     * Contains details about the Neptune Analytics configuration of the knowledge base in Amazon Neptune. For more information, see [Create a vector index in Amazon Neptune Analytics.](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-neptune.html) .
+     */
+    NeptuneAnalyticsConfiguration?: NeptuneAnalyticsConfiguration | undefined;
+    /**
+     * Contains details about the storage configuration of the knowledge base in OpenSearch Managed Cluster. For more information, see [Create a vector index in Amazon OpenSearch Service](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-osm.html) .
+     */
+    OpensearchManagedClusterConfiguration?: OpenSearchManagedClusterConfiguration | undefined;
+    /**
+     * Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
+     */
+    OpensearchServerlessConfiguration?: OpenSearchServerlessConfiguration | undefined;
+    /**
+     * Contains the storage configuration of the knowledge base in Pinecone.
+     */
+    PineconeConfiguration?: PineconeConfiguration | undefined;
+    /**
+     * Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see [Create a vector index in Amazon RDS](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html) .
+     */
+    RdsConfiguration?: RdsConfiguration | undefined;
+    /**
+     * The vector store service in which the knowledge base is stored.
+     */
+    Type: KnowledgeBaseStorageType;
+} | {
+    /**
+     * Contains the storage configuration of the knowledge base in MongoDB Atlas.
+     */
+    MongoDbAtlasConfiguration?: MongoDbAtlasConfiguration | undefined;
+    /**
+     * Contains details about the Neptune Analytics configuration of the knowledge base in Amazon Neptune. For more information, see [Create a vector index in Amazon Neptune Analytics.](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-neptune.html) .
+     */
+    NeptuneAnalyticsConfiguration?: NeptuneAnalyticsConfiguration | undefined;
+    /**
+     * Contains details about the storage configuration of the knowledge base in OpenSearch Managed Cluster. For more information, see [Create a vector index in Amazon OpenSearch Service](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-osm.html) .
+     */
+    OpensearchManagedClusterConfiguration: OpenSearchManagedClusterConfiguration;
+    /**
+     * Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
+     */
+    OpensearchServerlessConfiguration?: OpenSearchServerlessConfiguration | undefined;
+    /**
+     * Contains the storage configuration of the knowledge base in Pinecone.
+     */
+    PineconeConfiguration?: PineconeConfiguration | undefined;
+    /**
+     * Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see [Create a vector index in Amazon RDS](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html) .
+     */
+    RdsConfiguration?: RdsConfiguration | undefined;
+    /**
+     * The vector store service in which the knowledge base is stored.
+     */
+    Type: KnowledgeBaseStorageType;
+};
+/**
+ * Specifies configurations for the storage location of the images extracted from multimodal documents in your data source. These images can be retrieved and returned to the end user.
+ */
+export type SupplementalDataStorageConfiguration = {
+    /**
+     * List of supplemental data storage locations.
+     */
+    SupplementalDataStorageLocations: SupplementalDataStorageLocation[];
+};
+/**
+ * Contains information about a storage location for images extracted from multimodal documents in your data source.
+ */
+export type SupplementalDataStorageLocation = {
+    /**
+     * Contains information about the Amazon S3 location for the extracted images.
+     */
+    S3Location?: S3Location | undefined;
+    /**
+     * Supplemental data storage location type.
+     */
+    SupplementalDataStorageLocationType: SupplementalDataStorageLocationType;
+};
+/**
+ * Supplemental data storage location type.
+ */
+export type SupplementalDataStorageLocationType = "S3";
+/**
+ * Contains details about the model used to create vector embeddings for the knowledge base.
+ */
+export type VectorKnowledgeBaseConfiguration = {
+    /**
+     * The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.
+     * @minLength 20
+     * @maxLength 2048
+     * @pattern ^(arn:aws(-[^:]+)?:[a-z0-9-]+:[a-z0-9-]{1,20}:[0-9]{0,12}:[a-zA-Z0-9-:/._+]+)$
+     */
+    EmbeddingModelArn: string;
+    /**
+     * The embeddings model configuration details for the vector model used in Knowledge Base.
+     */
+    EmbeddingModelConfiguration?: EmbeddingModelConfiguration | undefined;
+    /**
+     * If you include multimodal data from your data source, use this object to specify configurations for the storage location of the images extracted from your documents. These images can be retrieved and returned to the end user. They can also be used in generation when using [RetrieveAndGenerate](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html) .
+     */
+    SupplementalDataStorageConfiguration?: SupplementalDataStorageConfiguration | undefined;
+};
+//# sourceMappingURL=aws-bedrock-knowledgebase.d.ts.map