CfnAIAgentProps

class aws_cdk.aws_wisdom.CfnAIAgentProps(*, assistant_id, configuration, type, description=None, name=None, tags=None)

Bases: object

Properties for defining a CfnAIAgent.

Parameters:

assistant_id (str) – The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
configuration (Union[IResolvable, AIAgentConfigurationProperty, Dict[str, Any]]) – Configuration for the AI Agent.
type (str) – The type of the AI Agent.
description (Optional[str]) – The description of the AI Agent.
name (Optional[str]) – The name of the AI Agent.
tags (Optional[Mapping[str, str]]) – The tags used to organize, track, or control access for this resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiagent.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_wisdom as wisdom

# annotations: Any
# input_schema: Any
# output_schema: Any

cfn_aIAgent_props = wisdom.CfnAIAgentProps(
    assistant_id="assistantId",
    configuration=wisdom.CfnAIAgent.AIAgentConfigurationProperty(
        answer_recommendation_ai_agent_configuration=wisdom.CfnAIAgent.AnswerRecommendationAIAgentConfigurationProperty(
            answer_generation_ai_guardrail_id="answerGenerationAiGuardrailId",
            answer_generation_ai_prompt_id="answerGenerationAiPromptId",
            association_configurations=[wisdom.CfnAIAgent.AssociationConfigurationProperty(
                association_configuration_data=wisdom.CfnAIAgent.AssociationConfigurationDataProperty(
                    knowledge_base_association_configuration_data=wisdom.CfnAIAgent.KnowledgeBaseAssociationConfigurationDataProperty(
                        content_tag_filter=wisdom.CfnAIAgent.TagFilterProperty(
                            and_conditions=[wisdom.CfnAIAgent.TagConditionProperty(
                                key="key",

                                # the properties below are optional
                                value="value"
                            )],
                            or_conditions=[wisdom.CfnAIAgent.OrConditionProperty(
                                and_conditions=[wisdom.CfnAIAgent.TagConditionProperty(
                                    key="key",

                                    # the properties below are optional
                                    value="value"
                                )],
                                tag_condition=wisdom.CfnAIAgent.TagConditionProperty(
                                    key="key",

                                    # the properties below are optional
                                    value="value"
                                )
                            )],
                            tag_condition=wisdom.CfnAIAgent.TagConditionProperty(
                                key="key",

                                # the properties below are optional
                                value="value"
                            )
                        ),
                        max_results=123,
                        override_knowledge_base_search_type="overrideKnowledgeBaseSearchType"
                    )
                ),
                association_id="associationId",
                association_type="associationType"
            )],
            intent_labeling_generation_ai_prompt_id="intentLabelingGenerationAiPromptId",
            locale="locale",
            query_reformulation_ai_prompt_id="queryReformulationAiPromptId"
        ),
        case_summarization_ai_agent_configuration=wisdom.CfnAIAgent.CaseSummarizationAIAgentConfigurationProperty(
            case_summarization_ai_guardrail_id="caseSummarizationAiGuardrailId",
            case_summarization_ai_prompt_id="caseSummarizationAiPromptId",
            locale="locale"
        ),
        email_generative_answer_ai_agent_configuration=wisdom.CfnAIAgent.EmailGenerativeAnswerAIAgentConfigurationProperty(
            association_configurations=[wisdom.CfnAIAgent.AssociationConfigurationProperty(
                association_configuration_data=wisdom.CfnAIAgent.AssociationConfigurationDataProperty(
                    knowledge_base_association_configuration_data=wisdom.CfnAIAgent.KnowledgeBaseAssociationConfigurationDataProperty(
                        content_tag_filter=wisdom.CfnAIAgent.TagFilterProperty(
                            and_conditions=[wisdom.CfnAIAgent.TagConditionProperty(
                                key="key",

                                # the properties below are optional
                                value="value"
                            )],
                            or_conditions=[wisdom.CfnAIAgent.OrConditionProperty(
                                and_conditions=[wisdom.CfnAIAgent.TagConditionProperty(
                                    key="key",

                                    # the properties below are optional
                                    value="value"
                                )],
                                tag_condition=wisdom.CfnAIAgent.TagConditionProperty(
                                    key="key",

                                    # the properties below are optional
                                    value="value"
                                )
                            )],
                            tag_condition=wisdom.CfnAIAgent.TagConditionProperty(
                                key="key",

                                # the properties below are optional
                                value="value"
                            )
                        ),
                        max_results=123,
                        override_knowledge_base_search_type="overrideKnowledgeBaseSearchType"
                    )
                ),
                association_id="associationId",
                association_type="associationType"
            )],
            email_generative_answer_ai_prompt_id="emailGenerativeAnswerAiPromptId",
            email_query_reformulation_ai_prompt_id="emailQueryReformulationAiPromptId",
            locale="locale"
        ),
        email_overview_ai_agent_configuration=wisdom.CfnAIAgent.EmailOverviewAIAgentConfigurationProperty(
            email_overview_ai_prompt_id="emailOverviewAiPromptId",
            locale="locale"
        ),
        email_response_ai_agent_configuration=wisdom.CfnAIAgent.EmailResponseAIAgentConfigurationProperty(
            association_configurations=[wisdom.CfnAIAgent.AssociationConfigurationProperty(
                association_configuration_data=wisdom.CfnAIAgent.AssociationConfigurationDataProperty(
                    knowledge_base_association_configuration_data=wisdom.CfnAIAgent.KnowledgeBaseAssociationConfigurationDataProperty(
                        content_tag_filter=wisdom.CfnAIAgent.TagFilterProperty(
                            and_conditions=[wisdom.CfnAIAgent.TagConditionProperty(
                                key="key",

                                # the properties below are optional
                                value="value"
                            )],
                            or_conditions=[wisdom.CfnAIAgent.OrConditionProperty(
                                and_conditions=[wisdom.CfnAIAgent.TagConditionProperty(
                                    key="key",

                                    # the properties below are optional
                                    value="value"
                                )],
                                tag_condition=wisdom.CfnAIAgent.TagConditionProperty(
                                    key="key",

                                    # the properties below are optional
                                    value="value"
                                )
                            )],
                            tag_condition=wisdom.CfnAIAgent.TagConditionProperty(
                                key="key",

                                # the properties below are optional
                                value="value"
                            )
                        ),
                        max_results=123,
                        override_knowledge_base_search_type="overrideKnowledgeBaseSearchType"
                    )
                ),
                association_id="associationId",
                association_type="associationType"
            )],
            email_query_reformulation_ai_prompt_id="emailQueryReformulationAiPromptId",
            email_response_ai_prompt_id="emailResponseAiPromptId",
            locale="locale"
        ),
        manual_search_ai_agent_configuration=wisdom.CfnAIAgent.ManualSearchAIAgentConfigurationProperty(
            answer_generation_ai_guardrail_id="answerGenerationAiGuardrailId",
            answer_generation_ai_prompt_id="answerGenerationAiPromptId",
            association_configurations=[wisdom.CfnAIAgent.AssociationConfigurationProperty(
                association_configuration_data=wisdom.CfnAIAgent.AssociationConfigurationDataProperty(
                    knowledge_base_association_configuration_data=wisdom.CfnAIAgent.KnowledgeBaseAssociationConfigurationDataProperty(
                        content_tag_filter=wisdom.CfnAIAgent.TagFilterProperty(
                            and_conditions=[wisdom.CfnAIAgent.TagConditionProperty(
                                key="key",

                                # the properties below are optional
                                value="value"
                            )],
                            or_conditions=[wisdom.CfnAIAgent.OrConditionProperty(
                                and_conditions=[wisdom.CfnAIAgent.TagConditionProperty(
                                    key="key",

                                    # the properties below are optional
                                    value="value"
                                )],
                                tag_condition=wisdom.CfnAIAgent.TagConditionProperty(
                                    key="key",

                                    # the properties below are optional
                                    value="value"
                                )
                            )],
                            tag_condition=wisdom.CfnAIAgent.TagConditionProperty(
                                key="key",

                                # the properties below are optional
                                value="value"
                            )
                        ),
                        max_results=123,
                        override_knowledge_base_search_type="overrideKnowledgeBaseSearchType"
                    )
                ),
                association_id="associationId",
                association_type="associationType"
            )],
            locale="locale"
        ),
        note_taking_ai_agent_configuration=wisdom.CfnAIAgent.NoteTakingAIAgentConfigurationProperty(
            locale="locale",
            note_taking_ai_guardrail_id="noteTakingAiGuardrailId",
            note_taking_ai_prompt_id="noteTakingAiPromptId"
        ),
        orchestration_ai_agent_configuration=wisdom.CfnAIAgent.OrchestrationAIAgentConfigurationProperty(
            orchestration_ai_prompt_id="orchestrationAiPromptId",

            # the properties below are optional
            connect_instance_arn="connectInstanceArn",
            locale="locale",
            orchestration_ai_guardrail_id="orchestrationAiGuardrailId",
            tool_configurations=[wisdom.CfnAIAgent.ToolConfigurationProperty(
                tool_name="toolName",
                tool_type="toolType",

                # the properties below are optional
                annotations=annotations,
                description="description",
                input_schema=input_schema,
                instruction=wisdom.CfnAIAgent.ToolInstructionProperty(
                    examples=["examples"],
                    instruction="instruction"
                ),
                output_filters=[wisdom.CfnAIAgent.ToolOutputFilterProperty(
                    json_path="jsonPath",

                    # the properties below are optional
                    output_configuration=wisdom.CfnAIAgent.ToolOutputConfigurationProperty(
                        output_variable_name_override="outputVariableNameOverride",
                        session_data_namespace="sessionDataNamespace"
                    )
                )],
                output_schema=output_schema,
                override_input_values=[wisdom.CfnAIAgent.ToolOverrideInputValueProperty(
                    json_path="jsonPath",
                    value=wisdom.CfnAIAgent.ToolOverrideInputValueConfigurationProperty(
                        constant=wisdom.CfnAIAgent.ToolOverrideConstantInputValueProperty(
                            type="type",
                            value="value"
                        )
                    )
                )],
                title="title",
                tool_id="toolId",
                user_interaction_configuration=wisdom.CfnAIAgent.UserInteractionConfigurationProperty(
                    is_user_confirmation_required=False
                )
            )]
        ),
        self_service_ai_agent_configuration=wisdom.CfnAIAgent.SelfServiceAIAgentConfigurationProperty(
            association_configurations=[wisdom.CfnAIAgent.AssociationConfigurationProperty(
                association_configuration_data=wisdom.CfnAIAgent.AssociationConfigurationDataProperty(
                    knowledge_base_association_configuration_data=wisdom.CfnAIAgent.KnowledgeBaseAssociationConfigurationDataProperty(
                        content_tag_filter=wisdom.CfnAIAgent.TagFilterProperty(
                            and_conditions=[wisdom.CfnAIAgent.TagConditionProperty(
                                key="key",

                                # the properties below are optional
                                value="value"
                            )],
                            or_conditions=[wisdom.CfnAIAgent.OrConditionProperty(
                                and_conditions=[wisdom.CfnAIAgent.TagConditionProperty(
                                    key="key",

                                    # the properties below are optional
                                    value="value"
                                )],
                                tag_condition=wisdom.CfnAIAgent.TagConditionProperty(
                                    key="key",

                                    # the properties below are optional
                                    value="value"
                                )
                            )],
                            tag_condition=wisdom.CfnAIAgent.TagConditionProperty(
                                key="key",

                                # the properties below are optional
                                value="value"
                            )
                        ),
                        max_results=123,
                        override_knowledge_base_search_type="overrideKnowledgeBaseSearchType"
                    )
                ),
                association_id="associationId",
                association_type="associationType"
            )],
            self_service_ai_guardrail_id="selfServiceAiGuardrailId",
            self_service_answer_generation_ai_prompt_id="selfServiceAnswerGenerationAiPromptId",
            self_service_pre_processing_ai_prompt_id="selfServicePreProcessingAiPromptId"
        )
    ),
    type="type",

    # the properties below are optional
    description="description",
    name="name",
    tags={
        "tags_key": "tags"
    }
)