Package software.amazon.awssdk.services.bedrockagentruntime.model

Class RetrieveAndGenerateConfiguration

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.model.RetrieveAndGenerateConfiguration

All Implemented Interfaces:

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

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

Contains details about the resource being queried.

This data type is used in the following API operations:

• RetrieveAndGenerate request – in the retrieveAndGenerateConfiguration field

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RetrieveAndGenerateConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static RetrieveAndGenerateConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
ExternalSourcesRetrieveAndGenerateConfiguration	externalSourcesConfiguration()	The configuration for the external source wrapper object in the retrieveAndGenerate function.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
KnowledgeBaseRetrieveAndGenerateConfiguration	knowledgeBaseConfiguration()	Contains details about the knowledge base for retrieving information and generating responses.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends RetrieveAndGenerateConfiguration.Builder>	serializableBuilderClass()
RetrieveAndGenerateConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
RetrieveAndGenerateType	type()	The type of resource that contains your data for retrieving information and generating responses.
String	typeAsString()	The type of resource that contains your data for retrieving information and generating responses.

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

externalSourcesConfiguration

public final ExternalSourcesRetrieveAndGenerateConfiguration externalSourcesConfiguration()

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

Returns:

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

knowledgeBaseConfiguration

public final KnowledgeBaseRetrieveAndGenerateConfiguration knowledgeBaseConfiguration()

Contains details about the knowledge base for retrieving information and generating responses.

Returns:

Contains details about the knowledge base for retrieving information and generating responses.

type

public final RetrieveAndGenerateType type()

The type of resource that contains your data for retrieving information and generating responses.

If you choose ot use EXTERNAL_SOURCES, then currently only Claude 3 Sonnet models for knowledge bases are supported.

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

Returns:

The type of resource that contains your data for retrieving information and generating responses.

If you choose ot use EXTERNAL_SOURCES, then currently only Claude 3 Sonnet models for knowledge bases are supported.

See Also:

RetrieveAndGenerateType

typeAsString

public final String typeAsString()

The type of resource that contains your data for retrieving information and generating responses.

If you choose ot use EXTERNAL_SOURCES, then currently only Claude 3 Sonnet models for knowledge bases are supported.

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

Returns:

The type of resource that contains your data for retrieving information and generating responses.

If you choose ot use EXTERNAL_SOURCES, then currently only Claude 3 Sonnet models for knowledge bases are supported.

See Also:

RetrieveAndGenerateType

toBuilder

public RetrieveAndGenerateConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RetrieveAndGenerateConfiguration.Builder,RetrieveAndGenerateConfiguration>

builder

public static RetrieveAndGenerateConfiguration.Builder builder()

serializableBuilderClass

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