Package software.amazon.awssdk.services.bedrockruntime.model

Interface DocumentBlock.Builder

All Superinterfaces:

Buildable, CopyableBuilder<DocumentBlock.Builder,DocumentBlock>, SdkBuilder<DocumentBlock.Builder,DocumentBlock>, SdkPojo

Enclosing class:

DocumentBlock

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

Method Summary

Modifier and Type	Method	Description
default DocumentBlock.Builder	citations(Consumer<CitationsConfig.Builder> citations)	Configuration settings that control how citations should be generated for this specific document.
DocumentBlock.Builder	citations(CitationsConfig citations)	Configuration settings that control how citations should be generated for this specific document.
DocumentBlock.Builder	context(String context)	Contextual information about how the document should be processed or interpreted by the model when generating citations.
DocumentBlock.Builder	format(String format)	The format of a document, or its extension.
DocumentBlock.Builder	format(DocumentFormat format)	The format of a document, or its extension.
DocumentBlock.Builder	name(String name)	A name for the document.
default DocumentBlock.Builder	source(Consumer<DocumentSource.Builder> source)	Contains the content of the document.
DocumentBlock.Builder	source(DocumentSource source)	Contains the content of the document.

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 Detail

format

DocumentBlock.Builder format(String format)

The format of a document, or its extension.

Parameters:

format - The format of a document, or its extension.

Returns:

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

See Also:

DocumentFormat, DocumentFormat

format

DocumentBlock.Builder format(DocumentFormat format)

The format of a document, or its extension.

Parameters:

format - The format of a document, or its extension.

Returns:

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

See Also:

DocumentFormat, DocumentFormat

name

DocumentBlock.Builder name(String name)

A name for the document. The name can only contain the following characters:

• Alphanumeric characters

• Whitespace characters (no more than one in a row)

• Hyphens

• Parentheses

• Square brackets

This field is vulnerable to prompt injections, because the model might inadvertently interpret it as instructions. Therefore, we recommend that you specify a neutral name.

Parameters:

name - A name for the document. The name can only contain the following characters:

• Alphanumeric characters

• Whitespace characters (no more than one in a row)

• Hyphens

• Parentheses

• Square brackets

This field is vulnerable to prompt injections, because the model might inadvertently interpret it as instructions. Therefore, we recommend that you specify a neutral name.

Returns:

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

source

DocumentBlock.Builder source(DocumentSource source)

Contains the content of the document.

Parameters:

source - Contains the content of the document.

Returns:

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

source

default DocumentBlock.Builder source(Consumer<DocumentSource.Builder> source)

Contains the content of the document.

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

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

Parameters:

source - a consumer that will call methods on DocumentSource.Builder

Returns:

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

See Also:

source(DocumentSource)

context

DocumentBlock.Builder context(String context)

Contextual information about how the document should be processed or interpreted by the model when generating citations.

Parameters:

context - Contextual information about how the document should be processed or interpreted by the model when generating citations.

Returns:

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

citations

DocumentBlock.Builder citations(CitationsConfig citations)

Configuration settings that control how citations should be generated for this specific document.

Parameters:

citations - Configuration settings that control how citations should be generated for this specific document.

Returns:

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

citations

default DocumentBlock.Builder citations(Consumer<CitationsConfig.Builder> citations)

Configuration settings that control how citations should be generated for this specific document.

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

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

Parameters:

citations - a consumer that will call methods on CitationsConfig.Builder

Returns:

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

See Also:

citations(CitationsConfig)