Class KnowledgeBaseRetrieveAndGenerateConfiguration

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.model.KnowledgeBaseRetrieveAndGenerateConfiguration

All Implemented Interfaces:

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

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

Contains details about the resource being queried.

This data type is used in the following API operations:

• Retrieve request – in the knowledgeBaseConfiguration field

• RetrieveAndGenerate request – in the knowledgeBaseConfiguration field

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	KnowledgeBaseRetrieveAndGenerateConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static KnowledgeBaseRetrieveAndGenerateConfiguration.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final GenerationConfiguration	generationConfiguration()	Contains configurations for response generation based on the knowledge base query results.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final String	knowledgeBaseId()	The unique identifier of the knowledge base that is queried.
final String	modelArn()	The ARN of the foundation model or inference profile used to generate a response.
final OrchestrationConfiguration	orchestrationConfiguration()	Settings for how the model processes the prompt prior to retrieval and generation.
final KnowledgeBaseRetrievalConfiguration	retrievalConfiguration()	Contains configurations for how to retrieve and return the knowledge base query.
final List<SdkField<?>>	sdkFields()
static Class<? extends KnowledgeBaseRetrieveAndGenerateConfiguration.Builder>	serializableBuilderClass()
KnowledgeBaseRetrieveAndGenerateConfiguration.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Details

generationConfiguration

public final GenerationConfiguration generationConfiguration()

Contains configurations for response generation based on the knowledge base query results.

Returns:

Contains configurations for response generation based on the knowledge base query results.

knowledgeBaseId

public final String knowledgeBaseId()

The unique identifier of the knowledge base that is queried.

Returns:

The unique identifier of the knowledge base that is queried.

modelArn

public final String modelArn()

The ARN of the foundation model or inference profile used to generate a response.

Returns:

The ARN of the foundation model or inference profile used to generate a response.

orchestrationConfiguration

public final OrchestrationConfiguration orchestrationConfiguration()

Settings for how the model processes the prompt prior to retrieval and generation.

Returns:

Settings for how the model processes the prompt prior to retrieval and generation.

retrievalConfiguration

public final KnowledgeBaseRetrievalConfiguration retrievalConfiguration()

Contains configurations for how to retrieve and return the knowledge base query.

Returns:

Contains configurations for how to retrieve and return the knowledge base query.

toBuilder

public KnowledgeBaseRetrieveAndGenerateConfiguration.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<KnowledgeBaseRetrieveAndGenerateConfiguration.Builder,KnowledgeBaseRetrieveAndGenerateConfiguration>

Returns:

a builder for type T

builder

public static KnowledgeBaseRetrieveAndGenerateConfiguration.Builder builder()

serializableBuilderClass

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

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.