Class OrchestrationAIAgentConfiguration

java.lang.Object
software.amazon.awssdk.services.qconnect.model.OrchestrationAIAgentConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<OrchestrationAIAgentConfiguration.Builder,OrchestrationAIAgentConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class OrchestrationAIAgentConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<OrchestrationAIAgentConfiguration.Builder,OrchestrationAIAgentConfiguration>

The configuration for AI Agents of type ORCHESTRATION.

See Also:

  • Method Details

    • orchestrationAIPromptId

      public final String orchestrationAIPromptId()

      The AI Prompt identifier used by the Orchestration AI Agent.

      Returns:
      The AI Prompt identifier used by the Orchestration AI Agent.

    • orchestrationAIGuardrailId

      public final String orchestrationAIGuardrailId()

      The AI Guardrail identifier used by the Orchestration AI Agent.

      Returns:
      The AI Guardrail identifier used by the Orchestration AI Agent.

    • hasToolConfigurations

      public final boolean hasToolConfigurations()
      For responses, this returns true if the service returned a value for the ToolConfigurations 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.

    • toolConfigurations

      public final List<ToolConfiguration> toolConfigurations()

      The tool configurations used by the Orchestration AI Agent.

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

      Returns:
      The tool configurations used by the Orchestration AI Agent.

    • hasMultiAgentConfigurations

      public final boolean hasMultiAgentConfigurations()
      For responses, this returns true if the service returned a value for the MultiAgentConfigurations 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.

    • multiAgentConfigurations

      public final List<MultiAgentConfiguration> multiAgentConfigurations()

      The collaborator agents that the Orchestration AI Agent can work with. Each entry defines another agent that the orchestrator either delegates to or hands the conversation off to.

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

      Returns:
      The collaborator agents that the Orchestration AI Agent can work with. Each entry defines another agent that the orchestrator either delegates to or hands the conversation off to.

    • connectInstanceArn

      public final String connectInstanceArn()

      The Amazon Resource Name (ARN) of the Amazon Connect instance used by the Orchestration AI Agent.

      Returns:
      The Amazon Resource Name (ARN) of the Amazon Connect instance used by the Orchestration AI Agent.

    • locale

      public final String locale()

      The locale setting for the Orchestration AI Agent.

      Returns:
      The locale setting for the Orchestration AI Agent.

    • hasInputSchemas

      public final boolean hasInputSchemas()
      For responses, this returns true if the service returned a value for the InputSchemas 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.

    • inputSchemas

      public final List<Document> inputSchemas()

      The JSON schemas that define the structure of the structured data input accepted by the Orchestration AI Agent. The data in a DATA message sent to the agent is validated against these schemas. You can specify at most one schema.

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

      Returns:
      The JSON schemas that define the structure of the structured data input accepted by the Orchestration AI Agent. The data in a DATA message sent to the agent is validated against these schemas. You can specify at most one schema.

    • hasOutputSchemas

      public final boolean hasOutputSchemas()
      For responses, this returns true if the service returned a value for the OutputSchemas 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.

    • outputSchemas

      public final List<Document> outputSchemas()

      The JSON schemas that define the structure of the structured output generated by the Orchestration AI Agent. You can specify at most one schema.

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

      Returns:
      The JSON schemas that define the structure of the structured output generated by the Orchestration AI Agent. You can specify at most one schema.

    • toBuilder

      public OrchestrationAIAgentConfiguration.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<OrchestrationAIAgentConfiguration.Builder,OrchestrationAIAgentConfiguration>
      Returns:
      a builder for type T

    • builder

      public static OrchestrationAIAgentConfiguration.Builder builder()

    • serializableBuilderClass

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