Interface CreateKnowledgeBaseRequest.Builder

All Superinterfaces:

AwsRequest.Builder, BedrockAgentRequest.Builder, Buildable, CopyableBuilder<CreateKnowledgeBaseRequest.Builder,CreateKnowledgeBaseRequest>, SdkBuilder<CreateKnowledgeBaseRequest.Builder,CreateKnowledgeBaseRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateKnowledgeBaseRequest

@Mutable
@NotThreadSafe
public static interface CreateKnowledgeBaseRequest.Builder
extends BedrockAgentRequest.Builder, SdkPojo, CopyableBuilder<CreateKnowledgeBaseRequest.Builder,CreateKnowledgeBaseRequest>

Method Summary

Modifier and Type	Method	Description
CreateKnowledgeBaseRequest.Builder	clientToken(String clientToken)	A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
CreateKnowledgeBaseRequest.Builder	description(String description)	A description of the knowledge base.
default CreateKnowledgeBaseRequest.Builder	knowledgeBaseConfiguration(Consumer<KnowledgeBaseConfiguration.Builder> knowledgeBaseConfiguration)	Contains details about the embeddings model used for the knowledge base.
CreateKnowledgeBaseRequest.Builder	knowledgeBaseConfiguration(KnowledgeBaseConfiguration knowledgeBaseConfiguration)	Contains details about the embeddings model used for the knowledge base.
CreateKnowledgeBaseRequest.Builder	name(String name)	A name for the knowledge base.
CreateKnowledgeBaseRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateKnowledgeBaseRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateKnowledgeBaseRequest.Builder	roleArn(String roleArn)	The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
default CreateKnowledgeBaseRequest.Builder	storageConfiguration(Consumer<StorageConfiguration.Builder> storageConfiguration)	Contains details about the configuration of the vector database used for the knowledge base.
CreateKnowledgeBaseRequest.Builder	storageConfiguration(StorageConfiguration storageConfiguration)	Contains details about the configuration of the vector database used for the knowledge base.
CreateKnowledgeBaseRequest.Builder	tags(Map<String,String> tags)	Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.bedrockagent.model.BedrockAgentRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

clientToken

CreateKnowledgeBaseRequest.Builder clientToken(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

description

CreateKnowledgeBaseRequest.Builder description(String description)

A description of the knowledge base.

Parameters:

description - A description of the knowledge base.

Returns:

Returns a reference to this object so that method calls can be chained together.

knowledgeBaseConfiguration

CreateKnowledgeBaseRequest.Builder knowledgeBaseConfiguration(KnowledgeBaseConfiguration knowledgeBaseConfiguration)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

knowledgeBaseConfiguration

default CreateKnowledgeBaseRequest.Builder knowledgeBaseConfiguration(Consumer<KnowledgeBaseConfiguration.Builder> knowledgeBaseConfiguration)

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

This is a convenience method that creates an instance of the KnowledgeBaseConfiguration.Builder avoiding the need to create one manually via KnowledgeBaseConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to knowledgeBaseConfiguration(KnowledgeBaseConfiguration).

Parameters:

knowledgeBaseConfiguration - a consumer that will call methods on KnowledgeBaseConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• knowledgeBaseConfiguration(KnowledgeBaseConfiguration)

name

CreateKnowledgeBaseRequest.Builder name(String name)

A name for the knowledge base.

Parameters:

name - A name for the knowledge base.

Returns:

Returns a reference to this object so that method calls can be chained together.

roleArn

CreateKnowledgeBaseRequest.Builder roleArn(String roleArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

storageConfiguration

CreateKnowledgeBaseRequest.Builder storageConfiguration(StorageConfiguration storageConfiguration)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

storageConfiguration

default CreateKnowledgeBaseRequest.Builder storageConfiguration(Consumer<StorageConfiguration.Builder> storageConfiguration)

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

This is a convenience method that creates an instance of the StorageConfiguration.Builder avoiding the need to create one manually via StorageConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to storageConfiguration(StorageConfiguration).

Parameters:

storageConfiguration - a consumer that will call methods on StorageConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• storageConfiguration(StorageConfiguration)

tags

CreateKnowledgeBaseRequest.Builder tags(Map<String,String> tags)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

CreateKnowledgeBaseRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateKnowledgeBaseRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.