AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Container for the parameters to the CreateKnowledgeBase operation.
Creates a knowledge base. A knowledge base contains your data sources so that Large
Language Models (LLMs) can use your data. To create a knowledge base, you must first
set up your data sources and configure a supported vector store. For more information,
see Set
up a knowledge base.
If you prefer to let Amazon Bedrock create and manage a vector store for you in Amazon
OpenSearch Service, use the console. For more information, see Create
a knowledge base.
Provide the name
and an optional description
.
Provide the Amazon Resource Name (ARN) with permissions to create a knowledge base
in the roleArn
field.
Provide the embedding model to use in the embeddingModelArn
field in the knowledgeBaseConfiguration
object.
Provide the configuration for your vector store in the storageConfiguration
object.
For an Amazon OpenSearch Service database, use the opensearchServerlessConfiguration
object. For more information, see Create
a vector store in Amazon OpenSearch Service.
For an Amazon Aurora database, use the RdsConfiguration
object. For more information,
see Create
a vector store in Amazon Aurora.
For a Pinecone database, use the pineconeConfiguration
object. For more information,
see Create
a vector store in Pinecone.
For a Redis Enterprise Cloud database, use the redisEnterpriseCloudConfiguration
object. For more information, see Create
a vector store in Redis Enterprise Cloud.
Namespace: Amazon.BedrockAgent.Model
Assembly: AWSSDK.BedrockAgent.dll
Version: 3.x.y.z
public class CreateKnowledgeBaseRequest : AmazonBedrockAgentRequest IAmazonWebServiceRequest
The CreateKnowledgeBaseRequest type exposes the following members
Name | Description | |
---|---|---|
CreateKnowledgeBaseRequest() |
Name | Type | Description | |
---|---|---|---|
ClientToken | System.String |
Gets and sets the property ClientToken. A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency. |
|
Description | System.String |
Gets and sets the property Description. A description of the knowledge base. |
|
KnowledgeBaseConfiguration | Amazon.BedrockAgent.Model.KnowledgeBaseConfiguration |
Gets and sets the property KnowledgeBaseConfiguration. Contains details about the embeddings model used for the knowledge base. |
|
Name | System.String |
Gets and sets the property Name. A name for the knowledge base. |
|
RoleArn | System.String |
Gets and sets the property RoleArn. The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base. |
|
StorageConfiguration | Amazon.BedrockAgent.Model.StorageConfiguration |
Gets and sets the property StorageConfiguration. Contains details about the configuration of the vector database used for the knowledge base. |
|
Tags | System.Collections.Generic.Dictionary<System.String, System.String> |
Gets and sets the property Tags. Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5