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

cfn_aIAgent_props = wisdom.CfnAIAgentProps(
    assistant_id="assistantId",
    configuration=wisdom.CfnAIAgent.AIAgentConfigurationProperty(
        answer_recommendation_ai_agent_configuration=wisdom.CfnAIAgent.AnswerRecommendationAIAgentConfigurationProperty(
            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",
            query_reformulation_ai_prompt_id="queryReformulationAiPromptId"
        ),
        manual_search_ai_agent_configuration=wisdom.CfnAIAgent.ManualSearchAIAgentConfigurationProperty(
            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"
            )]
        )
    ),
    type="type",

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

Attributes

assistant_id

The identifier of the Amazon Q in Connect assistant.

Can be either the ID or the ARN. URLs cannot contain the ARN.

See:

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

configuration

Configuration for the AI Agent.

See:

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

description

The description of the AI Agent.

See:

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

name

The name of the AI Agent.

See:

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

tags

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#cfn-wisdom-aiagent-tags

type

The type of the AI Agent.

See:

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