Package software.amazon.awssdk.services.bedrockagent.model

Class BedrockFoundationModelConfiguration

java.lang.Object

software.amazon.awssdk.services.bedrockagent.model.BedrockFoundationModelConfiguration

All Implemented Interfaces:

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

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

Settings for a foundation model used to parse documents for a data source.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BedrockFoundationModelConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static BedrockFoundationModelConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	modelArn()	The ARN of the foundation model to use for parsing.
ParsingModality	parsingModality()	Specifies whether to enable parsing of multimodal data, including both text and/or images.
String	parsingModalityAsString()	Specifies whether to enable parsing of multimodal data, including both text and/or images.
ParsingPrompt	parsingPrompt()	Instructions for interpreting the contents of a document.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends BedrockFoundationModelConfiguration.Builder>	serializableBuilderClass()
BedrockFoundationModelConfiguration.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

modelArn

public final String modelArn()

The ARN of the foundation model to use for parsing.

Returns:

The ARN of the foundation model to use for parsing.

parsingPrompt

public final ParsingPrompt parsingPrompt()

Instructions for interpreting the contents of a document.

Returns:

Instructions for interpreting the contents of a document.

parsingModality

public final ParsingModality parsingModality()

Specifies whether to enable parsing of multimodal data, including both text and/or images.

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

Returns:

Specifies whether to enable parsing of multimodal data, including both text and/or images.

See Also:

ParsingModality

parsingModalityAsString

public final String parsingModalityAsString()

Specifies whether to enable parsing of multimodal data, including both text and/or images.

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

Returns:

Specifies whether to enable parsing of multimodal data, including both text and/or images.

See Also:

ParsingModality

toBuilder

public BedrockFoundationModelConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BedrockFoundationModelConfiguration.Builder,BedrockFoundationModelConfiguration>

builder

public static BedrockFoundationModelConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends BedrockFoundationModelConfiguration.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