Skip to content

AIAgentConfigurationData

Source code in docs_src/capo_qconnect/types/ai_agent_configuration_data.py
class AIAgentConfigurationData(TypedDict, closed=True):
    ai_agent_id: "capo_qconnect.types.uuid_with_qualifier.UuidWithQualifier"
    """<p>The ID of the AI Agent to be configured.</p>"""
    enabled: NotRequired["bool"]
    """<p>Indicates whether the AI Agent configured for this AI Agent type is enabled. When this value is omitted or set to true, the configured AI Agent runs; when set to false, the AI Agent ID is retained but no AI Agent runs for the AI Agent type. Setting this value to false is currently supported only for the <code>ANSWER_RECOMMENDATION</code> AI Agent type; other requests to set it to false are rejected with a validation error.</p>"""

ai_agent_id instance-attribute

ai_agent_id: UuidWithQualifier

The ID of the AI Agent to be configured.

enabled instance-attribute

enabled: NotRequired[bool]

Indicates whether the AI Agent configured for this AI Agent type is enabled. When this value is omitted or set to true, the configured AI Agent runs; when set to false, the AI Agent ID is retained but no AI Agent runs for the AI Agent type. Setting this value to false is currently supported only for the ANSWER_RECOMMENDATION AI Agent type; other requests to set it to false are rejected with a validation error.