Class HandoffAgentConfiguration

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

A collaborator agent configuration in which the Orchestration AI Agent transfers control of the conversation to the collaborator agent.

See Also:

  • Method Details

    • agentTarget

      public final AgentTarget agentTarget()

      The collaborator agent to hand off to.

      Returns:
      The collaborator agent to hand off to.

    • instruction

      public final MultiAgentInstruction instruction()

      The instruction that tells the Orchestration AI Agent when and how to hand off to this collaborator agent.

      Returns:
      The instruction that tells the Orchestration AI Agent when and how to hand off to this collaborator agent.

    • audioStreamingEnabled

      public final Boolean audioStreamingEnabled()

      Specifies whether the caller's audio is streamed directly to the collaborator agent and the collaborator's audio response is played back during the handoff. This applies only to voice handoffs.

      Returns:
      Specifies whether the caller's audio is streamed directly to the collaborator agent and the collaborator's audio response is played back during the handoff. This applies only to voice handoffs.

    • immediateHandoff

      public final Boolean immediateHandoff()

      Specifies whether the conversation is handed off to this collaborator agent immediately on the first turn, without any orchestration reasoning. At most one handoff in an AI Agent's configuration can set this to true.

      Returns:
      Specifies whether the conversation is handed off to this collaborator agent immediately on the first turn, without any orchestration reasoning. At most one handoff in an AI Agent's configuration can set this to true.

    • toBuilder

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

    • builder

      public static HandoffAgentConfiguration.Builder builder()

    • serializableBuilderClass

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