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

Class DocumentBlock

java.lang.Object

software.amazon.awssdk.services.bedrockruntime.model.DocumentBlock

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DocumentBlock.Builder,DocumentBlock>

@Generated("software.amazon.awssdk:codegen")
public final class DocumentBlock
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DocumentBlock.Builder,DocumentBlock>

A document to include in a message.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DocumentBlock.Builder

Method Summary

Modifier and Type	Method	Description
static DocumentBlock.Builder	builder()
CitationsConfig	citations()	Configuration settings that control how citations should be generated for this specific document.
String	context()	Contextual information about how the document should be processed or interpreted by the model when generating citations.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
DocumentFormat	format()	The format of a document, or its extension.
String	formatAsString()	The format of a document, or its extension.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name()	A name for the document.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DocumentBlock.Builder>	serializableBuilderClass()
DocumentSource	source()	Contains the content of the document.
DocumentBlock.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

format

public final DocumentFormat format()

The format of a document, or its extension.

If the service returns an enum value that is not available in the current SDK version, format will return DocumentFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from formatAsString().

Returns:

The format of a document, or its extension.

See Also:

DocumentFormat

formatAsString

public final String formatAsString()

The format of a document, or its extension.

If the service returns an enum value that is not available in the current SDK version, format will return DocumentFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from formatAsString().

Returns:

The format of a document, or its extension.

See Also:

DocumentFormat

name

public final 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.

Returns:

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.

source

public final DocumentSource source()

Contains the content of the document.

Returns:

Contains the content of the document.

context

public final String context()

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

Returns:

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

citations

public final CitationsConfig citations()

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

Returns:

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

toBuilder

public DocumentBlock.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DocumentBlock.Builder,DocumentBlock>

builder

public static DocumentBlock.Builder builder()

serializableBuilderClass

public static Class<? extends DocumentBlock.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo