> **Experimental**
>
> `@aws-cdk/aws-bedrock-alpha` is an [**experimental**](/stability) (alpha) package: its API may change in any release, without a major version bump.
# KnowledgeBaseProps

Properties for a knowledge base.

Used as props by: [KnowledgeBase](/cdk/api/v2/docs/@aws-cdk_aws-bedrock-alpha.KnowledgeBase.html)

- Stability: [Experimental](/cdk/api/stability.html)
- Source: [`bedrock/knowledge-bases/knowledge-base.ts`](https://github.com/aws/aws-cdk/blob/v2.277.0/packages/@aws-cdk/aws-bedrock-alpha/bedrock/knowledge-bases/knowledge-base.ts#L73)
- Type last changed: v2.274.0-alpha.0 · 21 Oct 2026

## Example

TypeScript:

```ts
declare const collection: opensearchserverless.ICollectionRef;

const knowledgeBase = new bedrock.KnowledgeBase(this, 'KnowledgeBase', {
  type: bedrock.KnowledgeBaseType.vector({
    embeddingsModel: bedrock.BedrockFoundationModel.TITAN_EMBED_TEXT_V2_1024,
    vectorStore: bedrock.VectorStore.openSearchServerless({
      collection,
      vectorIndexName: 'bedrock-knowledge-base-default-index',
      vectorField: 'bedrock-knowledge-base-default-vector',
      textField: 'AMAZON_BEDROCK_TEXT_CHUNK',
      metadataField: 'AMAZON_BEDROCK_METADATA',
    }),
  }),
});
```

Python:

```python
# collection: opensearchserverless.ICollectionRef

knowledge_base = bedrock.KnowledgeBase(self, "KnowledgeBase",
    type=bedrock.KnowledgeBaseType.vector(
        embeddings_model=bedrock.BedrockFoundationModel.TITAN_EMBED_TEXT_V2_1024,
        vector_store=bedrock.VectorStore.open_search_serverless(
            collection=collection,
            vector_index_name="bedrock-knowledge-base-default-index",
            vector_field="bedrock-knowledge-base-default-vector",
            text_field="AMAZON_BEDROCK_TEXT_CHUNK",
            metadata_field="AMAZON_BEDROCK_METADATA"
        )
    )
)
```

Java:

```java
ICollectionRef collection;

KnowledgeBase knowledgeBase = KnowledgeBase.Builder.create(this, "KnowledgeBase")
        .type(KnowledgeBaseType.vector(VectorKnowledgeBaseTypeProps.builder()
                .embeddingsModel(BedrockFoundationModel.TITAN_EMBED_TEXT_V2_1024)
                .vectorStore(VectorStore.openSearchServerless(OpenSearchServerlessVectorStoreProps.builder()
                        .collection(collection)
                        .vectorIndexName("bedrock-knowledge-base-default-index")
                        .vectorField("bedrock-knowledge-base-default-vector")
                        .textField("AMAZON_BEDROCK_TEXT_CHUNK")
                        .metadataField("AMAZON_BEDROCK_METADATA")
                        .build()))
                .build()))
        .build();
```

C# / .NET:

```csharp
// Install: dotnet add package Amazon.CDK.AWS.Bedrock.Alpha
ICollectionRef collection;

var knowledgeBase = new KnowledgeBase(this, "KnowledgeBase", new KnowledgeBaseProps {
    Type = KnowledgeBaseType.Vector(new VectorKnowledgeBaseTypeProps {
        EmbeddingsModel = BedrockFoundationModel.TITAN_EMBED_TEXT_V2_1024,
        VectorStore = VectorStore.OpenSearchServerless(new OpenSearchServerlessVectorStoreProps {
            Collection = collection,
            VectorIndexName = "bedrock-knowledge-base-default-index",
            VectorField = "bedrock-knowledge-base-default-vector",
            TextField = "AMAZON_BEDROCK_TEXT_CHUNK",
            MetadataField = "AMAZON_BEDROCK_METADATA"
        })
    })
});
```

Golang:

```go
// Install: go get github.com/aws/aws-cdk-go/awsbedrockalpha/v2
var collection ICollectionRef

knowledgeBase := bedrock.NewKnowledgeBase(this, jsii.String("KnowledgeBase"), &KnowledgeBaseProps{
	Type: bedrock.KnowledgeBaseType_Vector(&VectorKnowledgeBaseTypeProps{
		EmbeddingsModel: bedrock.BedrockFoundationModel_TITAN_EMBED_TEXT_V2_1024(),
		VectorStore: bedrock.VectorStore_OpenSearchServerless(&OpenSearchServerlessVectorStoreProps{
			Collection: *Collection,
			VectorIndexName: jsii.String("bedrock-knowledge-base-default-index"),
			VectorField: jsii.String("bedrock-knowledge-base-default-vector"),
			TextField: jsii.String("AMAZON_BEDROCK_TEXT_CHUNK"),
			MetadataField: jsii.String("AMAZON_BEDROCK_METADATA"),
		}),
	}),
})
```

## Properties

- `description`: string — A description of the knowledge base.

  **Default:** no description

  Must be 1-200 characters.

- `knowledgeBaseName`: string — The name of the knowledge base.

  **Default:** a unique name is generated

  Must be 1-100 characters of letters, digits, hyphens and underscores, and
  must not contain consecutive hyphens or underscores.

- `role`: any — The service role that Amazon Bedrock assumes to operate the knowledge base.

  **Default:** a new role is created, trusted by `bedrock.amazonaws.com` and scoped to knowledge bases in this account

  The permissions the knowledge base needs to reach its data store and
  models are granted to this role.

- `tags`: { [key: string]: string } — Tags to apply to the knowledge base.

  **Default:** no tags

- `type`: [KnowledgeBaseType](/cdk/api/v2/docs/@aws-cdk_aws-bedrock-alpha.KnowledgeBaseType.html) (required) — The type of the knowledge base and its type-specific configuration.
