Skip to content

OrchestrationAIAgentConfiguration

Source code in docs_src/capo_qconnect/types/orchestration_ai_agent_configuration.py
class OrchestrationAIAgentConfiguration(TypedDict, closed=True):
    orchestration_ai_prompt_id: NotRequired[
        "capo_qconnect.types.uuid_with_qualifier.UuidWithQualifier"
    ]
    """<p>The AI Prompt identifier used by the Orchestration AI Agent.</p>"""
    orchestration_ai_guardrail_id: NotRequired[
        "capo_qconnect.types.uuid_with_qualifier.UuidWithQualifier"
    ]
    """<p>The AI Guardrail identifier used by the Orchestration AI Agent.</p>"""
    tool_configurations: NotRequired[
        "capo_qconnect.types.tool_configuration_list.ToolConfigurationList"
    ]
    """<p>The tool configurations used by the Orchestration AI Agent.</p>"""
    multi_agent_configurations: NotRequired[
        "capo_qconnect.types.multi_agent_configuration_list.MultiAgentConfigurationList"
    ]
    """<p>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.</p>"""
    connect_instance_arn: NotRequired["capo_qconnect.types.generic_arn.GenericArn"]
    """<p>The Amazon Resource Name (ARN) of the Amazon Connect instance used by the Orchestration AI Agent.</p>"""
    locale: NotRequired["capo_qconnect.types.non_empty_string.NonEmptyString"]
    """<p>The locale setting for the Orchestration AI Agent.</p>"""
    input_schemas: NotRequired[
        "capo_qconnect.types.json_document_list.JSONDocumentList"
    ]
    """<p>The JSON schemas that define the structure of the structured data input accepted by the Orchestration AI Agent. The data in a <code>DATA</code> message sent to the agent is validated against these schemas. You can specify at most one schema.</p>"""
    output_schemas: NotRequired[
        "capo_qconnect.types.json_document_list.JSONDocumentList"
    ]
    """<p>The JSON schemas that define the structure of the structured output generated by the Orchestration AI Agent. You can specify at most one schema.</p>"""

connect_instance_arn instance-attribute

connect_instance_arn: NotRequired[GenericArn]

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

input_schemas instance-attribute

input_schemas: NotRequired[JSONDocumentList]

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.

locale instance-attribute

locale: NotRequired[NonEmptyString]

The locale setting for the Orchestration AI Agent.

multi_agent_configurations instance-attribute

multi_agent_configurations: NotRequired[MultiAgentConfigurationList]

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.

orchestration_ai_guardrail_id instance-attribute

orchestration_ai_guardrail_id: NotRequired[UuidWithQualifier]

The AI Guardrail identifier used by the Orchestration AI Agent.

orchestration_ai_prompt_id instance-attribute

orchestration_ai_prompt_id: NotRequired[UuidWithQualifier]

The AI Prompt identifier used by the Orchestration AI Agent.

output_schemas instance-attribute

output_schemas: NotRequired[JSONDocumentList]

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

tool_configurations instance-attribute

tool_configurations: NotRequired[ToolConfigurationList]

The tool configurations used by the Orchestration AI Agent.