java.lang.Object
- software.amazon.awssdk.services.bedrockagentruntime.model.OrchestrationConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<OrchestrationConfiguration.Builder,OrchestrationConfiguration>
```
@Generated("software.amazon.awssdk:codegen")
public final class OrchestrationConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<OrchestrationConfiguration.Builder,OrchestrationConfiguration>
```
Settings for how the model processes the prompt prior to retrieval and generation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface OrchestrationConfiguration.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Map<String,Document>`	`additionalModelRequestFields()`	Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base.
`static OrchestrationConfiguration.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()`
`InferenceConfig`	`inferenceConfig()`	Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source.
`PerformanceConfiguration`	`performanceConfig()`	The latency configuration for the model.
`PromptTemplate`	`promptTemplate()`	Contains the template for the prompt that's sent to the model.
`QueryTransformationConfiguration`	`queryTransformationConfiguration()`	To split up the prompt and retrieve multiple sources, set the transformation type to `QUERY_DECOMPOSITION`.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends OrchestrationConfiguration.Builder>`	`serializableBuilderClass()`
`OrchestrationConfiguration.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
  - 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()
```
    Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows users to provide custom model parameters specific to the language model being used.
    
    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:
    
    Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows users to provide custom model parameters specific to the language model being used.
  - inferenceConfig
```
public final InferenceConfig inferenceConfig()
```
    Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source.
    
    Returns:
    
    Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source.
  - performanceConfig
```
public final PerformanceConfiguration performanceConfig()
```
    The latency configuration for the model.
    
    Returns:
    
    The latency configuration for the model.
  - promptTemplate
```
public final PromptTemplate promptTemplate()
```
    Contains the template for the prompt that's sent to the model. Orchestration prompts must include the $conversation_history$ and $output_format_instructions$ variables. For more information, see Use placeholder variables in the user guide.
    
    Returns:
    
    Contains the template for the prompt that's sent to the model. Orchestration prompts must include the $conversation_history$ and $output_format_instructions$ variables. For more information, see Use placeholder variables in the user guide.
  - queryTransformationConfiguration
```
public final QueryTransformationConfiguration queryTransformationConfiguration()
```
    To split up the prompt and retrieve multiple sources, set the transformation type to QUERY_DECOMPOSITION.
    
    Returns:
    
    To split up the prompt and retrieve multiple sources, set the transformation type to QUERY_DECOMPOSITION.
  - toBuilder
```
public OrchestrationConfiguration.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<OrchestrationConfiguration.Builder,OrchestrationConfiguration>
  - builder
```
public static OrchestrationConfiguration.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends OrchestrationConfiguration.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

Class OrchestrationConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

hasAdditionalModelRequestFields

additionalModelRequestFields

inferenceConfig

performanceConfig

promptTemplate

queryTransformationConfiguration

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField