Package software.amazon.awssdk.services.bedrock.model

Class ExternalSourcesRetrieveAndGenerateConfiguration

java.lang.Object

software.amazon.awssdk.services.bedrock.model.ExternalSourcesRetrieveAndGenerateConfiguration

All Implemented Interfaces:

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

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

The configuration of the external source wrapper object in the retrieveAndGenerate function.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ExternalSourcesRetrieveAndGenerateConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static ExternalSourcesRetrieveAndGenerateConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
ExternalSourcesGenerationConfiguration	generationConfiguration()	Contains configurations details for response generation based on retrieved text chunks.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSources()	For responses, this returns true if the service returned a value for the Sources property.
String	modelArn()	The Amazon Resource Name (ARN) of the foundation model or inference profile used to generate responses.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ExternalSourcesRetrieveAndGenerateConfiguration.Builder>	serializableBuilderClass()
List<ExternalSource>	sources()	The document for the external source wrapper object in the retrieveAndGenerate function.
ExternalSourcesRetrieveAndGenerateConfiguration.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 Amazon Resource Name (ARN) of the foundation model or inference profile used to generate responses.

Returns:

The Amazon Resource Name (ARN) of the foundation model or inference profile used to generate responses.

hasSources

public final boolean hasSources()

For responses, this returns true if the service returned a value for the Sources property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

sources

public final List<ExternalSource> sources()

The document for the external source wrapper object in the retrieveAndGenerate function.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSources() method.

Returns:

The document for the external source wrapper object in the retrieveAndGenerate function.

generationConfiguration

public final ExternalSourcesGenerationConfiguration generationConfiguration()

Contains configurations details for response generation based on retrieved text chunks.

Returns:

Contains configurations details for response generation based on retrieved text chunks.

toBuilder

public ExternalSourcesRetrieveAndGenerateConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ExternalSourcesRetrieveAndGenerateConfiguration.Builder,ExternalSourcesRetrieveAndGenerateConfiguration>

builder

public static ExternalSourcesRetrieveAndGenerateConfiguration.Builder builder()

serializableBuilderClass

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