Interface IngestKnowledgeBaseDocumentsRequest.Builder

All Superinterfaces:

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

Enclosing class:

IngestKnowledgeBaseDocumentsRequest

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

Method Summary

Modifier and Type	Method	Description
IngestKnowledgeBaseDocumentsRequest.Builder	clientToken(String clientToken)	A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
IngestKnowledgeBaseDocumentsRequest.Builder	dataSourceId(String dataSourceId)	The unique identifier of the data source connected to the knowledge base that you're adding documents to.
IngestKnowledgeBaseDocumentsRequest.Builder	documents(Collection<KnowledgeBaseDocument> documents)	A list of objects, each of which contains information about the documents to add.
IngestKnowledgeBaseDocumentsRequest.Builder	documents(Consumer<KnowledgeBaseDocument.Builder>... documents)	A list of objects, each of which contains information about the documents to add.
IngestKnowledgeBaseDocumentsRequest.Builder	documents(KnowledgeBaseDocument... documents)	A list of objects, each of which contains information about the documents to add.
IngestKnowledgeBaseDocumentsRequest.Builder	knowledgeBaseId(String knowledgeBaseId)	The unique identifier of the knowledge base to ingest the documents into.
IngestKnowledgeBaseDocumentsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
IngestKnowledgeBaseDocumentsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.

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

IngestKnowledgeBaseDocumentsRequest.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.

dataSourceId

IngestKnowledgeBaseDocumentsRequest.Builder dataSourceId(String dataSourceId)

The unique identifier of the data source connected to the knowledge base that you're adding documents to.

Parameters:

dataSourceId - The unique identifier of the data source connected to the knowledge base that you're adding documents to.

Returns:

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

documents

IngestKnowledgeBaseDocumentsRequest.Builder documents(Collection<KnowledgeBaseDocument> documents)

A list of objects, each of which contains information about the documents to add.

Parameters:

documents - A list of objects, each of which contains information about the documents to add.

Returns:

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

documents

IngestKnowledgeBaseDocumentsRequest.Builder documents(KnowledgeBaseDocument... documents)

A list of objects, each of which contains information about the documents to add.

Parameters:

documents - A list of objects, each of which contains information about the documents to add.

Returns:

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

documents

IngestKnowledgeBaseDocumentsRequest.Builder documents(Consumer<KnowledgeBaseDocument.Builder>... documents)

A list of objects, each of which contains information about the documents to add.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to documents(List<KnowledgeBaseDocument>).

Parameters:

documents - a consumer that will call methods on KnowledgeBaseDocument.Builder

Returns:

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

See Also:

• documents(java.util.Collection<KnowledgeBaseDocument>)

knowledgeBaseId

IngestKnowledgeBaseDocumentsRequest.Builder knowledgeBaseId(String knowledgeBaseId)

The unique identifier of the knowledge base to ingest the documents into.

Parameters:

knowledgeBaseId - The unique identifier of the knowledge base to ingest the documents into.

Returns:

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

overrideConfiguration

IngestKnowledgeBaseDocumentsRequest.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

IngestKnowledgeBaseDocumentsRequest.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.