Class OrchestrationConfiguration

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:

  • Method Details

    • 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()
      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<OrchestrationConfiguration.Builder,OrchestrationConfiguration>
      Returns:
      a builder for type T

    • 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)
      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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.