Interface OrchestrationAIAgentConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<OrchestrationAIAgentConfiguration.Builder,OrchestrationAIAgentConfiguration>, SdkBuilder<OrchestrationAIAgentConfiguration.Builder,OrchestrationAIAgentConfiguration>, SdkPojo
Enclosing class:
OrchestrationAIAgentConfiguration
@Mutable @NotThreadSafe public static interface OrchestrationAIAgentConfiguration.Builder extends SdkPojo, CopyableBuilder<OrchestrationAIAgentConfiguration.Builder,OrchestrationAIAgentConfiguration>

  • Method Details

    • orchestrationAIPromptId

      OrchestrationAIAgentConfiguration.Builder orchestrationAIPromptId(String orchestrationAIPromptId)

      The AI Prompt identifier used by the Orchestration AI Agent.

      Parameters:
      orchestrationAIPromptId - The AI Prompt identifier used by the Orchestration AI Agent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • orchestrationAIGuardrailId

      OrchestrationAIAgentConfiguration.Builder orchestrationAIGuardrailId(String orchestrationAIGuardrailId)

      The AI Guardrail identifier used by the Orchestration AI Agent.

      Parameters:
      orchestrationAIGuardrailId - The AI Guardrail identifier used by the Orchestration AI Agent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • toolConfigurations

      OrchestrationAIAgentConfiguration.Builder toolConfigurations(Collection<ToolConfiguration> toolConfigurations)

      The tool configurations used by the Orchestration AI Agent.

      Parameters:
      toolConfigurations - The tool configurations used by the Orchestration AI Agent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • toolConfigurations

      OrchestrationAIAgentConfiguration.Builder toolConfigurations(ToolConfiguration... toolConfigurations)

      The tool configurations used by the Orchestration AI Agent.

      Parameters:
      toolConfigurations - The tool configurations used by the Orchestration AI Agent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • toolConfigurations

      OrchestrationAIAgentConfiguration.Builder toolConfigurations(Consumer<ToolConfiguration.Builder>... toolConfigurations)

      The tool configurations used by the Orchestration AI Agent.

      This is a convenience method that creates an instance of the ToolConfiguration.Builder avoiding the need to create one manually via ToolConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to toolConfigurations(List<ToolConfiguration>).

      Parameters:
      toolConfigurations - a consumer that will call methods on ToolConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • multiAgentConfigurations

      OrchestrationAIAgentConfiguration.Builder multiAgentConfigurations(Collection<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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • multiAgentConfigurations

      OrchestrationAIAgentConfiguration.Builder multiAgentConfigurations(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • multiAgentConfigurations

      OrchestrationAIAgentConfiguration.Builder multiAgentConfigurations(Consumer<MultiAgentConfiguration.Builder>... 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.

      This is a convenience method that creates an instance of the MultiAgentConfiguration.Builder avoiding the need to create one manually via MultiAgentConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to multiAgentConfigurations(List<MultiAgentConfiguration>).

      Parameters:
      multiAgentConfigurations - a consumer that will call methods on MultiAgentConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • connectInstanceArn

      OrchestrationAIAgentConfiguration.Builder connectInstanceArn(String connectInstanceArn)

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

      Parameters:
      connectInstanceArn - The Amazon Resource Name (ARN) of the Amazon Connect instance used by the Orchestration AI Agent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • locale

      OrchestrationAIAgentConfiguration.Builder locale(String locale)

      The locale setting for the Orchestration AI Agent.

      Parameters:
      locale - The locale setting for the Orchestration AI Agent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inputSchemas

      OrchestrationAIAgentConfiguration.Builder inputSchemas(Collection<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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inputSchemas

      OrchestrationAIAgentConfiguration.Builder inputSchemas(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputSchemas

      OrchestrationAIAgentConfiguration.Builder outputSchemas(Collection<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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputSchemas

      OrchestrationAIAgentConfiguration.Builder outputSchemas(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.