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

Class KnowledgeBaseOrchestrationConfiguration

java.lang.Object

software.amazon.awssdk.services.bedrockagent.model.KnowledgeBaseOrchestrationConfiguration

All Implemented Interfaces:

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

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

Configures how the knowledge base orchestrates the retrieval and generation process, allowing for customization of prompts, inference parameters, and performance settings.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	KnowledgeBaseOrchestrationConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
Map<String,Document>	additionalModelRequestFields()	The additional model-specific request parameters as key-value pairs to be included in the request to the foundation model.
static KnowledgeBaseOrchestrationConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAdditionalModelRequestFields()	For responses, this returns true if the service returned a value for the AdditionalModelRequestFields property.
int	hashCode()
PromptInferenceConfiguration	inferenceConfig()	Contains inference configurations for the prompt.
PerformanceConfiguration	performanceConfig()	The performance configuration options for the knowledge base retrieval and generation process.
KnowledgeBasePromptTemplate	promptTemplate()	A custom prompt template for orchestrating the retrieval and generation process.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends KnowledgeBaseOrchestrationConfiguration.Builder>	serializableBuilderClass()
KnowledgeBaseOrchestrationConfiguration.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

promptTemplate

public final KnowledgeBasePromptTemplate promptTemplate()

A custom prompt template for orchestrating the retrieval and generation process.

Returns:

A custom prompt template for orchestrating the retrieval and generation process.

inferenceConfig

public final PromptInferenceConfiguration inferenceConfig()

Contains inference configurations for the prompt.

Returns:

Contains inference configurations for the prompt.

hasAdditionalModelRequestFields

public final boolean hasAdditionalModelRequestFields()

For responses, this returns true if the service returned a value for the AdditionalModelRequestFields 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.

additionalModelRequestFields

public final Map<String,Document> additionalModelRequestFields()

The additional model-specific request parameters as key-value pairs to be included in the request to the foundation model.

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 hasAdditionalModelRequestFields() method.

Returns:

The additional model-specific request parameters as key-value pairs to be included in the request to the foundation model.

performanceConfig

public final PerformanceConfiguration performanceConfig()

The performance configuration options for the knowledge base retrieval and generation process.

Returns:

The performance configuration options for the knowledge base retrieval and generation process.

toBuilder

public KnowledgeBaseOrchestrationConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<KnowledgeBaseOrchestrationConfiguration.Builder,KnowledgeBaseOrchestrationConfiguration>

builder

public static KnowledgeBaseOrchestrationConfiguration.Builder builder()

serializableBuilderClass

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