Struct aws_sdk_bedrockagent::operation::create_knowledge_base::builders::CreateKnowledgeBaseFluentBuilder

pub struct CreateKnowledgeBaseFluentBuilder { /* private fields */ }

Fluent builder constructing a request to CreateKnowledgeBase.

Creates a knowledge base that contains data sources from which information can be queried and used by LLMs. 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 your data for ingestion.

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.

Implementations

impl CreateKnowledgeBaseFluentBuilder

pub fn as_input(&self) -> &CreateKnowledgeBaseInputBuilder

Access the CreateKnowledgeBase as a reference.

pub async fn send( self ) -> Result<CreateKnowledgeBaseOutput, SdkError<CreateKnowledgeBaseError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<CreateKnowledgeBaseOutput, CreateKnowledgeBaseError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn client_token(self, input: impl Into<String>) -> Self

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.

pub fn set_client_token(self, input: Option<String>) -> Self

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.

pub fn get_client_token(&self) -> &Option<String>

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.

pub fn name(self, input: impl Into<String>) -> Self

A name for the knowledge base.

pub fn set_name(self, input: Option<String>) -> Self

A name for the knowledge base.

pub fn get_name(&self) -> &Option<String>

A name for the knowledge base.

pub fn description(self, input: impl Into<String>) -> Self

A description of the knowledge base.

pub fn set_description(self, input: Option<String>) -> Self

A description of the knowledge base.

pub fn get_description(&self) -> &Option<String>

A description of the knowledge base.

pub fn role_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.

pub fn set_role_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.

pub fn get_role_arn(&self) -> &Option<String>

The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.

pub fn knowledge_base_configuration( self, input: KnowledgeBaseConfiguration ) -> Self

Contains details about the embeddings model used for the knowledge base.

pub fn set_knowledge_base_configuration( self, input: Option<KnowledgeBaseConfiguration> ) -> Self

Contains details about the embeddings model used for the knowledge base.

pub fn get_knowledge_base_configuration( &self ) -> &Option<KnowledgeBaseConfiguration>

Contains details about the embeddings model used for the knowledge base.

pub fn storage_configuration(self, input: StorageConfiguration) -> Self

Contains details about the configuration of the vector database used for the knowledge base.

pub fn set_storage_configuration( self, input: Option<StorageConfiguration> ) -> Self

Contains details about the configuration of the vector database used for the knowledge base.

pub fn get_storage_configuration(&self) -> &Option<StorageConfiguration>

Contains details about the configuration of the vector database used for the knowledge base.

pub fn tags(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to tags.

To override the contents of this collection use set_tags.

Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.

pub fn set_tags(self, input: Option<HashMap<String, String>>) -> Self

Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.

pub fn get_tags(&self) -> &Option<HashMap<String, String>>

Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.

Trait Implementations

impl Clone for CreateKnowledgeBaseFluentBuilder

fn clone(&self) -> CreateKnowledgeBaseFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateKnowledgeBaseFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.