CfnAIAgentPropsMixin

class aws_cdk.mixins_preview.aws_wisdom.mixins.CfnAIAgentPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates an Amazon Q in Connect AI Agent.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiagent.html
CloudformationResource:: AWS::Wisdom::AIAgent
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_wisdom import mixins as wisdom_mixins

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

cfn_aIAgent_props_mixin = wisdom_mixins.CfnAIAgentPropsMixin(wisdom_mixins.CfnAIAgentMixinProps(
    assistant_id="assistantId",
    configuration=wisdom_mixins.CfnAIAgentPropsMixin.AIAgentConfigurationProperty(
        answer_recommendation_ai_agent_configuration=wisdom_mixins.CfnAIAgentPropsMixin.AnswerRecommendationAIAgentConfigurationProperty(
            answer_generation_ai_guardrail_id="answerGenerationAiGuardrailId",
            answer_generation_ai_prompt_id="answerGenerationAiPromptId",
            association_configurations=[wisdom_mixins.CfnAIAgentPropsMixin.AssociationConfigurationProperty(
                association_configuration_data=wisdom_mixins.CfnAIAgentPropsMixin.AssociationConfigurationDataProperty(
                    knowledge_base_association_configuration_data=wisdom_mixins.CfnAIAgentPropsMixin.KnowledgeBaseAssociationConfigurationDataProperty(
                        content_tag_filter=wisdom_mixins.CfnAIAgentPropsMixin.TagFilterProperty(
                            and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                                key="key",
                                value="value"
                            )],
                            or_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.OrConditionProperty(
                                and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                                    key="key",
                                    value="value"
                                )],
                                tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                                    key="key",
                                    value="value"
                                )
                            )],
                            tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                                key="key",
                                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_mixins.CfnAIAgentPropsMixin.CaseSummarizationAIAgentConfigurationProperty(
            case_summarization_ai_guardrail_id="caseSummarizationAiGuardrailId",
            case_summarization_ai_prompt_id="caseSummarizationAiPromptId",
            locale="locale"
        ),
        email_generative_answer_ai_agent_configuration=wisdom_mixins.CfnAIAgentPropsMixin.EmailGenerativeAnswerAIAgentConfigurationProperty(
            association_configurations=[wisdom_mixins.CfnAIAgentPropsMixin.AssociationConfigurationProperty(
                association_configuration_data=wisdom_mixins.CfnAIAgentPropsMixin.AssociationConfigurationDataProperty(
                    knowledge_base_association_configuration_data=wisdom_mixins.CfnAIAgentPropsMixin.KnowledgeBaseAssociationConfigurationDataProperty(
                        content_tag_filter=wisdom_mixins.CfnAIAgentPropsMixin.TagFilterProperty(
                            and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                                key="key",
                                value="value"
                            )],
                            or_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.OrConditionProperty(
                                and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                                    key="key",
                                    value="value"
                                )],
                                tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                                    key="key",
                                    value="value"
                                )
                            )],
                            tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                                key="key",
                                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_mixins.CfnAIAgentPropsMixin.EmailOverviewAIAgentConfigurationProperty(
            email_overview_ai_prompt_id="emailOverviewAiPromptId",
            locale="locale"
        ),
        email_response_ai_agent_configuration=wisdom_mixins.CfnAIAgentPropsMixin.EmailResponseAIAgentConfigurationProperty(
            association_configurations=[wisdom_mixins.CfnAIAgentPropsMixin.AssociationConfigurationProperty(
                association_configuration_data=wisdom_mixins.CfnAIAgentPropsMixin.AssociationConfigurationDataProperty(
                    knowledge_base_association_configuration_data=wisdom_mixins.CfnAIAgentPropsMixin.KnowledgeBaseAssociationConfigurationDataProperty(
                        content_tag_filter=wisdom_mixins.CfnAIAgentPropsMixin.TagFilterProperty(
                            and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                                key="key",
                                value="value"
                            )],
                            or_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.OrConditionProperty(
                                and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                                    key="key",
                                    value="value"
                                )],
                                tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                                    key="key",
                                    value="value"
                                )
                            )],
                            tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                                key="key",
                                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_mixins.CfnAIAgentPropsMixin.ManualSearchAIAgentConfigurationProperty(
            answer_generation_ai_guardrail_id="answerGenerationAiGuardrailId",
            answer_generation_ai_prompt_id="answerGenerationAiPromptId",
            association_configurations=[wisdom_mixins.CfnAIAgentPropsMixin.AssociationConfigurationProperty(
                association_configuration_data=wisdom_mixins.CfnAIAgentPropsMixin.AssociationConfigurationDataProperty(
                    knowledge_base_association_configuration_data=wisdom_mixins.CfnAIAgentPropsMixin.KnowledgeBaseAssociationConfigurationDataProperty(
                        content_tag_filter=wisdom_mixins.CfnAIAgentPropsMixin.TagFilterProperty(
                            and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                                key="key",
                                value="value"
                            )],
                            or_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.OrConditionProperty(
                                and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                                    key="key",
                                    value="value"
                                )],
                                tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                                    key="key",
                                    value="value"
                                )
                            )],
                            tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                                key="key",
                                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_mixins.CfnAIAgentPropsMixin.NoteTakingAIAgentConfigurationProperty(
            locale="locale",
            note_taking_ai_guardrail_id="noteTakingAiGuardrailId",
            note_taking_ai_prompt_id="noteTakingAiPromptId"
        ),
        orchestration_ai_agent_configuration=wisdom_mixins.CfnAIAgentPropsMixin.OrchestrationAIAgentConfigurationProperty(
            connect_instance_arn="connectInstanceArn",
            locale="locale",
            orchestration_ai_guardrail_id="orchestrationAiGuardrailId",
            orchestration_ai_prompt_id="orchestrationAiPromptId",
            tool_configurations=[wisdom_mixins.CfnAIAgentPropsMixin.ToolConfigurationProperty(
                annotations=annotations,
                description="description",
                input_schema=input_schema,
                instruction=wisdom_mixins.CfnAIAgentPropsMixin.ToolInstructionProperty(
                    examples=["examples"],
                    instruction="instruction"
                ),
                output_filters=[wisdom_mixins.CfnAIAgentPropsMixin.ToolOutputFilterProperty(
                    json_path="jsonPath",
                    output_configuration=wisdom_mixins.CfnAIAgentPropsMixin.ToolOutputConfigurationProperty(
                        output_variable_name_override="outputVariableNameOverride",
                        session_data_namespace="sessionDataNamespace"
                    )
                )],
                output_schema=output_schema,
                override_input_values=[wisdom_mixins.CfnAIAgentPropsMixin.ToolOverrideInputValueProperty(
                    json_path="jsonPath",
                    value=wisdom_mixins.CfnAIAgentPropsMixin.ToolOverrideInputValueConfigurationProperty(
                        constant=wisdom_mixins.CfnAIAgentPropsMixin.ToolOverrideConstantInputValueProperty(
                            type="type",
                            value="value"
                        )
                    )
                )],
                title="title",
                tool_id="toolId",
                tool_name="toolName",
                tool_type="toolType",
                user_interaction_configuration=wisdom_mixins.CfnAIAgentPropsMixin.UserInteractionConfigurationProperty(
                    is_user_confirmation_required=False
                )
            )]
        ),
        self_service_ai_agent_configuration=wisdom_mixins.CfnAIAgentPropsMixin.SelfServiceAIAgentConfigurationProperty(
            association_configurations=[wisdom_mixins.CfnAIAgentPropsMixin.AssociationConfigurationProperty(
                association_configuration_data=wisdom_mixins.CfnAIAgentPropsMixin.AssociationConfigurationDataProperty(
                    knowledge_base_association_configuration_data=wisdom_mixins.CfnAIAgentPropsMixin.KnowledgeBaseAssociationConfigurationDataProperty(
                        content_tag_filter=wisdom_mixins.CfnAIAgentPropsMixin.TagFilterProperty(
                            and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                                key="key",
                                value="value"
                            )],
                            or_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.OrConditionProperty(
                                and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                                    key="key",
                                    value="value"
                                )],
                                tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                                    key="key",
                                    value="value"
                                )
                            )],
                            tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                                key="key",
                                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"
        )
    ),
    description="description",
    name="name",
    tags={
        "tags_key": "tags"
    },
    type="type"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Wisdom::AIAgent.

Parameters:

props (Union[CfnAIAgentMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['assistantId', 'configuration', 'description', 'name', 'tags', 'type']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.

AIAgentConfigurationProperty

class CfnAIAgentPropsMixin.AIAgentConfigurationProperty(*, answer_recommendation_ai_agent_configuration=None, case_summarization_ai_agent_configuration=None, email_generative_answer_ai_agent_configuration=None, email_overview_ai_agent_configuration=None, email_response_ai_agent_configuration=None, manual_search_ai_agent_configuration=None, note_taking_ai_agent_configuration=None, orchestration_ai_agent_configuration=None, self_service_ai_agent_configuration=None)

Bases: object

A typed union that specifies the configuration based on the type of AI Agent.

Parameters:

answer_recommendation_ai_agent_configuration (Union[IResolvable, AnswerRecommendationAIAgentConfigurationProperty, Dict[str, Any], None]) – The configuration for AI Agents of type ANSWER_RECOMMENDATION .
case_summarization_ai_agent_configuration (Union[IResolvable, CaseSummarizationAIAgentConfigurationProperty, Dict[str, Any], None])
email_generative_answer_ai_agent_configuration (Union[IResolvable, EmailGenerativeAnswerAIAgentConfigurationProperty, Dict[str, Any], None]) – Configuration for the EMAIL_GENERATIVE_ANSWER AI agent that provides comprehensive knowledge-based answers for customer queries.
email_overview_ai_agent_configuration (Union[IResolvable, EmailOverviewAIAgentConfigurationProperty, Dict[str, Any], None]) – Configuration for the EMAIL_OVERVIEW AI agent that generates structured overview of email conversations.
email_response_ai_agent_configuration (Union[IResolvable, EmailResponseAIAgentConfigurationProperty, Dict[str, Any], None]) – Configuration for the EMAIL_RESPONSE AI agent that generates professional email responses using knowledge base content.
manual_search_ai_agent_configuration (Union[IResolvable, ManualSearchAIAgentConfigurationProperty, Dict[str, Any], None]) – The configuration for AI Agents of type MANUAL_SEARCH .
note_taking_ai_agent_configuration (Union[IResolvable, NoteTakingAIAgentConfigurationProperty, Dict[str, Any], None])
orchestration_ai_agent_configuration (Union[IResolvable, OrchestrationAIAgentConfigurationProperty, Dict[str, Any], None])
self_service_ai_agent_configuration (Union[IResolvable, SelfServiceAIAgentConfigurationProperty, Dict[str, Any], None]) – The self-service AI agent configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-aiagentconfiguration.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.mixins_preview.aws_wisdom import mixins as wisdom_mixins

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

a_iAgent_configuration_property = wisdom_mixins.CfnAIAgentPropsMixin.AIAgentConfigurationProperty(
    answer_recommendation_ai_agent_configuration=wisdom_mixins.CfnAIAgentPropsMixin.AnswerRecommendationAIAgentConfigurationProperty(
        answer_generation_ai_guardrail_id="answerGenerationAiGuardrailId",
        answer_generation_ai_prompt_id="answerGenerationAiPromptId",
        association_configurations=[wisdom_mixins.CfnAIAgentPropsMixin.AssociationConfigurationProperty(
            association_configuration_data=wisdom_mixins.CfnAIAgentPropsMixin.AssociationConfigurationDataProperty(
                knowledge_base_association_configuration_data=wisdom_mixins.CfnAIAgentPropsMixin.KnowledgeBaseAssociationConfigurationDataProperty(
                    content_tag_filter=wisdom_mixins.CfnAIAgentPropsMixin.TagFilterProperty(
                        and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                            key="key",
                            value="value"
                        )],
                        or_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.OrConditionProperty(
                            and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                                key="key",
                                value="value"
                            )],
                            tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                                key="key",
                                value="value"
                            )
                        )],
                        tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                            key="key",
                            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_mixins.CfnAIAgentPropsMixin.CaseSummarizationAIAgentConfigurationProperty(
        case_summarization_ai_guardrail_id="caseSummarizationAiGuardrailId",
        case_summarization_ai_prompt_id="caseSummarizationAiPromptId",
        locale="locale"
    ),
    email_generative_answer_ai_agent_configuration=wisdom_mixins.CfnAIAgentPropsMixin.EmailGenerativeAnswerAIAgentConfigurationProperty(
        association_configurations=[wisdom_mixins.CfnAIAgentPropsMixin.AssociationConfigurationProperty(
            association_configuration_data=wisdom_mixins.CfnAIAgentPropsMixin.AssociationConfigurationDataProperty(
                knowledge_base_association_configuration_data=wisdom_mixins.CfnAIAgentPropsMixin.KnowledgeBaseAssociationConfigurationDataProperty(
                    content_tag_filter=wisdom_mixins.CfnAIAgentPropsMixin.TagFilterProperty(
                        and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                            key="key",
                            value="value"
                        )],
                        or_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.OrConditionProperty(
                            and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                                key="key",
                                value="value"
                            )],
                            tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                                key="key",
                                value="value"
                            )
                        )],
                        tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                            key="key",
                            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_mixins.CfnAIAgentPropsMixin.EmailOverviewAIAgentConfigurationProperty(
        email_overview_ai_prompt_id="emailOverviewAiPromptId",
        locale="locale"
    ),
    email_response_ai_agent_configuration=wisdom_mixins.CfnAIAgentPropsMixin.EmailResponseAIAgentConfigurationProperty(
        association_configurations=[wisdom_mixins.CfnAIAgentPropsMixin.AssociationConfigurationProperty(
            association_configuration_data=wisdom_mixins.CfnAIAgentPropsMixin.AssociationConfigurationDataProperty(
                knowledge_base_association_configuration_data=wisdom_mixins.CfnAIAgentPropsMixin.KnowledgeBaseAssociationConfigurationDataProperty(
                    content_tag_filter=wisdom_mixins.CfnAIAgentPropsMixin.TagFilterProperty(
                        and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                            key="key",
                            value="value"
                        )],
                        or_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.OrConditionProperty(
                            and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                                key="key",
                                value="value"
                            )],
                            tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                                key="key",
                                value="value"
                            )
                        )],
                        tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                            key="key",
                            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_mixins.CfnAIAgentPropsMixin.ManualSearchAIAgentConfigurationProperty(
        answer_generation_ai_guardrail_id="answerGenerationAiGuardrailId",
        answer_generation_ai_prompt_id="answerGenerationAiPromptId",
        association_configurations=[wisdom_mixins.CfnAIAgentPropsMixin.AssociationConfigurationProperty(
            association_configuration_data=wisdom_mixins.CfnAIAgentPropsMixin.AssociationConfigurationDataProperty(
                knowledge_base_association_configuration_data=wisdom_mixins.CfnAIAgentPropsMixin.KnowledgeBaseAssociationConfigurationDataProperty(
                    content_tag_filter=wisdom_mixins.CfnAIAgentPropsMixin.TagFilterProperty(
                        and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                            key="key",
                            value="value"
                        )],
                        or_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.OrConditionProperty(
                            and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                                key="key",
                                value="value"
                            )],
                            tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                                key="key",
                                value="value"
                            )
                        )],
                        tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                            key="key",
                            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_mixins.CfnAIAgentPropsMixin.NoteTakingAIAgentConfigurationProperty(
        locale="locale",
        note_taking_ai_guardrail_id="noteTakingAiGuardrailId",
        note_taking_ai_prompt_id="noteTakingAiPromptId"
    ),
    orchestration_ai_agent_configuration=wisdom_mixins.CfnAIAgentPropsMixin.OrchestrationAIAgentConfigurationProperty(
        connect_instance_arn="connectInstanceArn",
        locale="locale",
        orchestration_ai_guardrail_id="orchestrationAiGuardrailId",
        orchestration_ai_prompt_id="orchestrationAiPromptId",
        tool_configurations=[wisdom_mixins.CfnAIAgentPropsMixin.ToolConfigurationProperty(
            annotations=annotations,
            description="description",
            input_schema=input_schema,
            instruction=wisdom_mixins.CfnAIAgentPropsMixin.ToolInstructionProperty(
                examples=["examples"],
                instruction="instruction"
            ),
            output_filters=[wisdom_mixins.CfnAIAgentPropsMixin.ToolOutputFilterProperty(
                json_path="jsonPath",
                output_configuration=wisdom_mixins.CfnAIAgentPropsMixin.ToolOutputConfigurationProperty(
                    output_variable_name_override="outputVariableNameOverride",
                    session_data_namespace="sessionDataNamespace"
                )
            )],
            output_schema=output_schema,
            override_input_values=[wisdom_mixins.CfnAIAgentPropsMixin.ToolOverrideInputValueProperty(
                json_path="jsonPath",
                value=wisdom_mixins.CfnAIAgentPropsMixin.ToolOverrideInputValueConfigurationProperty(
                    constant=wisdom_mixins.CfnAIAgentPropsMixin.ToolOverrideConstantInputValueProperty(
                        type="type",
                        value="value"
                    )
                )
            )],
            title="title",
            tool_id="toolId",
            tool_name="toolName",
            tool_type="toolType",
            user_interaction_configuration=wisdom_mixins.CfnAIAgentPropsMixin.UserInteractionConfigurationProperty(
                is_user_confirmation_required=False
            )
        )]
    ),
    self_service_ai_agent_configuration=wisdom_mixins.CfnAIAgentPropsMixin.SelfServiceAIAgentConfigurationProperty(
        association_configurations=[wisdom_mixins.CfnAIAgentPropsMixin.AssociationConfigurationProperty(
            association_configuration_data=wisdom_mixins.CfnAIAgentPropsMixin.AssociationConfigurationDataProperty(
                knowledge_base_association_configuration_data=wisdom_mixins.CfnAIAgentPropsMixin.KnowledgeBaseAssociationConfigurationDataProperty(
                    content_tag_filter=wisdom_mixins.CfnAIAgentPropsMixin.TagFilterProperty(
                        and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                            key="key",
                            value="value"
                        )],
                        or_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.OrConditionProperty(
                            and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                                key="key",
                                value="value"
                            )],
                            tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                                key="key",
                                value="value"
                            )
                        )],
                        tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                            key="key",
                            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"
    )
)

Attributes

answer_recommendation_ai_agent_configuration

The configuration for AI Agents of type ANSWER_RECOMMENDATION .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-aiagentconfiguration.html#cfn-wisdom-aiagent-aiagentconfiguration-answerrecommendationaiagentconfiguration

case_summarization_ai_agent_configuration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-aiagentconfiguration.html#cfn-wisdom-aiagent-aiagentconfiguration-casesummarizationaiagentconfiguration

Type:: see

email_generative_answer_ai_agent_configuration

Configuration for the EMAIL_GENERATIVE_ANSWER AI agent that provides comprehensive knowledge-based answers for customer queries.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-aiagentconfiguration.html#cfn-wisdom-aiagent-aiagentconfiguration-emailgenerativeansweraiagentconfiguration

email_overview_ai_agent_configuration

Configuration for the EMAIL_OVERVIEW AI agent that generates structured overview of email conversations.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-aiagentconfiguration.html#cfn-wisdom-aiagent-aiagentconfiguration-emailoverviewaiagentconfiguration

email_response_ai_agent_configuration

Configuration for the EMAIL_RESPONSE AI agent that generates professional email responses using knowledge base content.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-aiagentconfiguration.html#cfn-wisdom-aiagent-aiagentconfiguration-emailresponseaiagentconfiguration

manual_search_ai_agent_configuration

The configuration for AI Agents of type MANUAL_SEARCH .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-aiagentconfiguration.html#cfn-wisdom-aiagent-aiagentconfiguration-manualsearchaiagentconfiguration

note_taking_ai_agent_configuration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-aiagentconfiguration.html#cfn-wisdom-aiagent-aiagentconfiguration-notetakingaiagentconfiguration

Type:: see

orchestration_ai_agent_configuration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-aiagentconfiguration.html#cfn-wisdom-aiagent-aiagentconfiguration-orchestrationaiagentconfiguration

Type:: see

self_service_ai_agent_configuration

The self-service AI agent configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-aiagentconfiguration.html#cfn-wisdom-aiagent-aiagentconfiguration-selfserviceaiagentconfiguration

AnswerRecommendationAIAgentConfigurationProperty

class CfnAIAgentPropsMixin.AnswerRecommendationAIAgentConfigurationProperty(*, answer_generation_ai_guardrail_id=None, answer_generation_ai_prompt_id=None, association_configurations=None, intent_labeling_generation_ai_prompt_id=None, locale=None, query_reformulation_ai_prompt_id=None)

Bases: object

The configuration for AI Agents of type ANSWER_RECOMMENDATION .

Parameters:

answer_generation_ai_guardrail_id (Optional[str]) – The ID of the answer generation AI guardrail.
answer_generation_ai_prompt_id (Optional[str]) – The AI Prompt identifier for the Answer Generation prompt used by the ANSWER_RECOMMENDATION AI Agent.
association_configurations (Union[IResolvable, Sequence[Union[IResolvable, AssociationConfigurationProperty, Dict[str, Any]]], None]) – The association configurations for overriding behavior on this AI Agent.
intent_labeling_generation_ai_prompt_id (Optional[str]) – The AI Prompt identifier for the Intent Labeling prompt used by the ANSWER_RECOMMENDATION AI Agent.
locale (Optional[str]) – The locale to which specifies the language and region settings that determine the response language for QueryAssistant .
query_reformulation_ai_prompt_id (Optional[str]) – The AI Prompt identifier for the Query Reformulation prompt used by the ANSWER_RECOMMENDATION AI Agent.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-answerrecommendationaiagentconfiguration.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.mixins_preview.aws_wisdom import mixins as wisdom_mixins

answer_recommendation_aIAgent_configuration_property = wisdom_mixins.CfnAIAgentPropsMixin.AnswerRecommendationAIAgentConfigurationProperty(
    answer_generation_ai_guardrail_id="answerGenerationAiGuardrailId",
    answer_generation_ai_prompt_id="answerGenerationAiPromptId",
    association_configurations=[wisdom_mixins.CfnAIAgentPropsMixin.AssociationConfigurationProperty(
        association_configuration_data=wisdom_mixins.CfnAIAgentPropsMixin.AssociationConfigurationDataProperty(
            knowledge_base_association_configuration_data=wisdom_mixins.CfnAIAgentPropsMixin.KnowledgeBaseAssociationConfigurationDataProperty(
                content_tag_filter=wisdom_mixins.CfnAIAgentPropsMixin.TagFilterProperty(
                    and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                        key="key",
                        value="value"
                    )],
                    or_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.OrConditionProperty(
                        and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                            key="key",
                            value="value"
                        )],
                        tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                            key="key",
                            value="value"
                        )
                    )],
                    tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                        key="key",
                        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"
)

Attributes

answer_generation_ai_guardrail_id

The ID of the answer generation AI guardrail.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-answerrecommendationaiagentconfiguration.html#cfn-wisdom-aiagent-answerrecommendationaiagentconfiguration-answergenerationaiguardrailid

answer_generation_ai_prompt_id

The AI Prompt identifier for the Answer Generation prompt used by the ANSWER_RECOMMENDATION AI Agent.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-answerrecommendationaiagentconfiguration.html#cfn-wisdom-aiagent-answerrecommendationaiagentconfiguration-answergenerationaipromptid

association_configurations

The association configurations for overriding behavior on this AI Agent.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-answerrecommendationaiagentconfiguration.html#cfn-wisdom-aiagent-answerrecommendationaiagentconfiguration-associationconfigurations

intent_labeling_generation_ai_prompt_id

The AI Prompt identifier for the Intent Labeling prompt used by the ANSWER_RECOMMENDATION AI Agent.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-answerrecommendationaiagentconfiguration.html#cfn-wisdom-aiagent-answerrecommendationaiagentconfiguration-intentlabelinggenerationaipromptid

locale

The locale to which specifies the language and region settings that determine the response language for QueryAssistant .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-answerrecommendationaiagentconfiguration.html#cfn-wisdom-aiagent-answerrecommendationaiagentconfiguration-locale

query_reformulation_ai_prompt_id

The AI Prompt identifier for the Query Reformulation prompt used by the ANSWER_RECOMMENDATION AI Agent.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-answerrecommendationaiagentconfiguration.html#cfn-wisdom-aiagent-answerrecommendationaiagentconfiguration-queryreformulationaipromptid

AssociationConfigurationDataProperty

class CfnAIAgentPropsMixin.AssociationConfigurationDataProperty(*, knowledge_base_association_configuration_data=None)

Bases: object

A typed union of the data of the configuration for an Amazon Q in Connect Assistant Association.

Parameters:: knowledge_base_association_configuration_data (Union[IResolvable, KnowledgeBaseAssociationConfigurationDataProperty, Dict[str, Any], None]) – The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-associationconfigurationdata.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.mixins_preview.aws_wisdom import mixins as wisdom_mixins

association_configuration_data_property = wisdom_mixins.CfnAIAgentPropsMixin.AssociationConfigurationDataProperty(
    knowledge_base_association_configuration_data=wisdom_mixins.CfnAIAgentPropsMixin.KnowledgeBaseAssociationConfigurationDataProperty(
        content_tag_filter=wisdom_mixins.CfnAIAgentPropsMixin.TagFilterProperty(
            and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                key="key",
                value="value"
            )],
            or_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.OrConditionProperty(
                and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                    key="key",
                    value="value"
                )],
                tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                    key="key",
                    value="value"
                )
            )],
            tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                key="key",
                value="value"
            )
        ),
        max_results=123,
        override_knowledge_base_search_type="overrideKnowledgeBaseSearchType"
    )
)

Attributes

knowledge_base_association_configuration_data

The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-associationconfigurationdata.html#cfn-wisdom-aiagent-associationconfigurationdata-knowledgebaseassociationconfigurationdata

AssociationConfigurationProperty

class CfnAIAgentPropsMixin.AssociationConfigurationProperty(*, association_configuration_data=None, association_id=None, association_type=None)

Bases: object

The configuration for an Amazon Q in Connect Assistant Association.

Parameters:

association_configuration_data (Union[IResolvable, AssociationConfigurationDataProperty, Dict[str, Any], None]) – A typed union of the data of the configuration for an Amazon Q in Connect Assistant Association.
association_id (Optional[str]) – The identifier of the association for this Association Configuration.
association_type (Optional[str]) – The type of the association for this Association Configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-associationconfiguration.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.mixins_preview.aws_wisdom import mixins as wisdom_mixins

association_configuration_property = wisdom_mixins.CfnAIAgentPropsMixin.AssociationConfigurationProperty(
    association_configuration_data=wisdom_mixins.CfnAIAgentPropsMixin.AssociationConfigurationDataProperty(
        knowledge_base_association_configuration_data=wisdom_mixins.CfnAIAgentPropsMixin.KnowledgeBaseAssociationConfigurationDataProperty(
            content_tag_filter=wisdom_mixins.CfnAIAgentPropsMixin.TagFilterProperty(
                and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                    key="key",
                    value="value"
                )],
                or_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.OrConditionProperty(
                    and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                        key="key",
                        value="value"
                    )],
                    tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                        key="key",
                        value="value"
                    )
                )],
                tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                    key="key",
                    value="value"
                )
            ),
            max_results=123,
            override_knowledge_base_search_type="overrideKnowledgeBaseSearchType"
        )
    ),
    association_id="associationId",
    association_type="associationType"
)

Attributes

association_configuration_data

A typed union of the data of the configuration for an Amazon Q in Connect Assistant Association.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-associationconfiguration.html#cfn-wisdom-aiagent-associationconfiguration-associationconfigurationdata

association_id

The identifier of the association for this Association Configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-associationconfiguration.html#cfn-wisdom-aiagent-associationconfiguration-associationid

association_type

The type of the association for this Association Configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-associationconfiguration.html#cfn-wisdom-aiagent-associationconfiguration-associationtype

CaseSummarizationAIAgentConfigurationProperty

class CfnAIAgentPropsMixin.CaseSummarizationAIAgentConfigurationProperty(*, case_summarization_ai_guardrail_id=None, case_summarization_ai_prompt_id=None, locale=None)

Bases: object

Parameters:

case_summarization_ai_guardrail_id (Optional[str])
case_summarization_ai_prompt_id (Optional[str])
locale (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-casesummarizationaiagentconfiguration.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.mixins_preview.aws_wisdom import mixins as wisdom_mixins

case_summarization_aIAgent_configuration_property = wisdom_mixins.CfnAIAgentPropsMixin.CaseSummarizationAIAgentConfigurationProperty(
    case_summarization_ai_guardrail_id="caseSummarizationAiGuardrailId",
    case_summarization_ai_prompt_id="caseSummarizationAiPromptId",
    locale="locale"
)

Attributes

case_summarization_ai_guardrail_id

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-casesummarizationaiagentconfiguration.html#cfn-wisdom-aiagent-casesummarizationaiagentconfiguration-casesummarizationaiguardrailid

Type:: see

case_summarization_ai_prompt_id

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-casesummarizationaiagentconfiguration.html#cfn-wisdom-aiagent-casesummarizationaiagentconfiguration-casesummarizationaipromptid

Type:: see

locale

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-casesummarizationaiagentconfiguration.html#cfn-wisdom-aiagent-casesummarizationaiagentconfiguration-locale

Type:: see

EmailGenerativeAnswerAIAgentConfigurationProperty

class CfnAIAgentPropsMixin.EmailGenerativeAnswerAIAgentConfigurationProperty(*, association_configurations=None, email_generative_answer_ai_prompt_id=None, email_query_reformulation_ai_prompt_id=None, locale=None)

Bases: object

Configuration settings for the EMAIL_GENERATIVE_ANSWER AI agent including prompts, locale, and knowledge base associations.

Parameters:

association_configurations (Union[IResolvable, Sequence[Union[IResolvable, AssociationConfigurationProperty, Dict[str, Any]]], None]) – Configuration settings for knowledge base associations used by the email generative answer agent.
email_generative_answer_ai_prompt_id (Optional[str]) – The ID of the System AI prompt used for generating comprehensive knowledge-based answers from email queries.
email_query_reformulation_ai_prompt_id (Optional[str]) – The ID of the System AI prompt used for reformulating email queries to optimize knowledge base search results.
locale (Optional[str]) – The locale setting for language-specific email processing and response generation (for example, en_US, es_ES).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-emailgenerativeansweraiagentconfiguration.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.mixins_preview.aws_wisdom import mixins as wisdom_mixins

email_generative_answer_aIAgent_configuration_property = wisdom_mixins.CfnAIAgentPropsMixin.EmailGenerativeAnswerAIAgentConfigurationProperty(
    association_configurations=[wisdom_mixins.CfnAIAgentPropsMixin.AssociationConfigurationProperty(
        association_configuration_data=wisdom_mixins.CfnAIAgentPropsMixin.AssociationConfigurationDataProperty(
            knowledge_base_association_configuration_data=wisdom_mixins.CfnAIAgentPropsMixin.KnowledgeBaseAssociationConfigurationDataProperty(
                content_tag_filter=wisdom_mixins.CfnAIAgentPropsMixin.TagFilterProperty(
                    and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                        key="key",
                        value="value"
                    )],
                    or_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.OrConditionProperty(
                        and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                            key="key",
                            value="value"
                        )],
                        tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                            key="key",
                            value="value"
                        )
                    )],
                    tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                        key="key",
                        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"
)

Attributes

association_configurations

Configuration settings for knowledge base associations used by the email generative answer agent.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-emailgenerativeansweraiagentconfiguration.html#cfn-wisdom-aiagent-emailgenerativeansweraiagentconfiguration-associationconfigurations

email_generative_answer_ai_prompt_id

The ID of the System AI prompt used for generating comprehensive knowledge-based answers from email queries.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-emailgenerativeansweraiagentconfiguration.html#cfn-wisdom-aiagent-emailgenerativeansweraiagentconfiguration-emailgenerativeansweraipromptid

email_query_reformulation_ai_prompt_id

The ID of the System AI prompt used for reformulating email queries to optimize knowledge base search results.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-emailgenerativeansweraiagentconfiguration.html#cfn-wisdom-aiagent-emailgenerativeansweraiagentconfiguration-emailqueryreformulationaipromptid

locale

The locale setting for language-specific email processing and response generation (for example, en_US, es_ES).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-emailgenerativeansweraiagentconfiguration.html#cfn-wisdom-aiagent-emailgenerativeansweraiagentconfiguration-locale

EmailOverviewAIAgentConfigurationProperty

class CfnAIAgentPropsMixin.EmailOverviewAIAgentConfigurationProperty(*, email_overview_ai_prompt_id=None, locale=None)

Bases: object

Configuration settings for the EMAIL_OVERVIEW AI agent including prompt ID and locale settings.

Parameters:

email_overview_ai_prompt_id (Optional[str]) – The ID of the System AI prompt used for generating structured email conversation summaries.
locale (Optional[str]) – The locale setting for language-specific email overview processing (for example, en_US, es_ES).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-emailoverviewaiagentconfiguration.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.mixins_preview.aws_wisdom import mixins as wisdom_mixins

email_overview_aIAgent_configuration_property = wisdom_mixins.CfnAIAgentPropsMixin.EmailOverviewAIAgentConfigurationProperty(
    email_overview_ai_prompt_id="emailOverviewAiPromptId",
    locale="locale"
)

Attributes

email_overview_ai_prompt_id

The ID of the System AI prompt used for generating structured email conversation summaries.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-emailoverviewaiagentconfiguration.html#cfn-wisdom-aiagent-emailoverviewaiagentconfiguration-emailoverviewaipromptid

locale

The locale setting for language-specific email overview processing (for example, en_US, es_ES).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-emailoverviewaiagentconfiguration.html#cfn-wisdom-aiagent-emailoverviewaiagentconfiguration-locale

EmailResponseAIAgentConfigurationProperty

class CfnAIAgentPropsMixin.EmailResponseAIAgentConfigurationProperty(*, association_configurations=None, email_query_reformulation_ai_prompt_id=None, email_response_ai_prompt_id=None, locale=None)

Bases: object

Configuration settings for the EMAIL_RESPONSE AI agent including prompts, locale, and knowledge base associations.

Parameters:

association_configurations (Union[IResolvable, Sequence[Union[IResolvable, AssociationConfigurationProperty, Dict[str, Any]]], None]) – Configuration settings for knowledge base associations used by the email response agent.
email_query_reformulation_ai_prompt_id (Optional[str]) – The ID of the System AI prompt used for reformulating email queries to optimize knowledge base search for response generation.
email_response_ai_prompt_id (Optional[str]) – The ID of the System AI prompt used for generating professional email responses based on knowledge base content.
locale (Optional[str]) – The locale setting for language-specific email response generation (for example, en_US, es_ES).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-emailresponseaiagentconfiguration.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.mixins_preview.aws_wisdom import mixins as wisdom_mixins

email_response_aIAgent_configuration_property = wisdom_mixins.CfnAIAgentPropsMixin.EmailResponseAIAgentConfigurationProperty(
    association_configurations=[wisdom_mixins.CfnAIAgentPropsMixin.AssociationConfigurationProperty(
        association_configuration_data=wisdom_mixins.CfnAIAgentPropsMixin.AssociationConfigurationDataProperty(
            knowledge_base_association_configuration_data=wisdom_mixins.CfnAIAgentPropsMixin.KnowledgeBaseAssociationConfigurationDataProperty(
                content_tag_filter=wisdom_mixins.CfnAIAgentPropsMixin.TagFilterProperty(
                    and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                        key="key",
                        value="value"
                    )],
                    or_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.OrConditionProperty(
                        and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                            key="key",
                            value="value"
                        )],
                        tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                            key="key",
                            value="value"
                        )
                    )],
                    tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                        key="key",
                        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"
)

Attributes

association_configurations

Configuration settings for knowledge base associations used by the email response agent.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-emailresponseaiagentconfiguration.html#cfn-wisdom-aiagent-emailresponseaiagentconfiguration-associationconfigurations

email_query_reformulation_ai_prompt_id

The ID of the System AI prompt used for reformulating email queries to optimize knowledge base search for response generation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-emailresponseaiagentconfiguration.html#cfn-wisdom-aiagent-emailresponseaiagentconfiguration-emailqueryreformulationaipromptid

email_response_ai_prompt_id

The ID of the System AI prompt used for generating professional email responses based on knowledge base content.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-emailresponseaiagentconfiguration.html#cfn-wisdom-aiagent-emailresponseaiagentconfiguration-emailresponseaipromptid

locale

The locale setting for language-specific email response generation (for example, en_US, es_ES).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-emailresponseaiagentconfiguration.html#cfn-wisdom-aiagent-emailresponseaiagentconfiguration-locale

KnowledgeBaseAssociationConfigurationDataProperty

class CfnAIAgentPropsMixin.KnowledgeBaseAssociationConfigurationDataProperty(*, content_tag_filter=None, max_results=None, override_knowledge_base_search_type=None)

Bases: object

The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.

Parameters:

content_tag_filter (Union[IResolvable, TagFilterProperty, Dict[str, Any], None]) – An object that can be used to specify Tag conditions.
max_results (Union[int, float, None]) – The maximum number of results to return per page.
override_knowledge_base_search_type (Optional[str]) – The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-knowledgebaseassociationconfigurationdata.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.mixins_preview.aws_wisdom import mixins as wisdom_mixins

knowledge_base_association_configuration_data_property = wisdom_mixins.CfnAIAgentPropsMixin.KnowledgeBaseAssociationConfigurationDataProperty(
    content_tag_filter=wisdom_mixins.CfnAIAgentPropsMixin.TagFilterProperty(
        and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
            key="key",
            value="value"
        )],
        or_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.OrConditionProperty(
            and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                key="key",
                value="value"
            )],
            tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                key="key",
                value="value"
            )
        )],
        tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
            key="key",
            value="value"
        )
    ),
    max_results=123,
    override_knowledge_base_search_type="overrideKnowledgeBaseSearchType"
)

Attributes

content_tag_filter

An object that can be used to specify Tag conditions.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-knowledgebaseassociationconfigurationdata.html#cfn-wisdom-aiagent-knowledgebaseassociationconfigurationdata-contenttagfilter

max_results

The maximum number of results to return per page.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-knowledgebaseassociationconfigurationdata.html#cfn-wisdom-aiagent-knowledgebaseassociationconfigurationdata-maxresults

override_knowledge_base_search_type

The search type to be used against the Knowledge Base for this request.

The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-knowledgebaseassociationconfigurationdata.html#cfn-wisdom-aiagent-knowledgebaseassociationconfigurationdata-overrideknowledgebasesearchtype

ManualSearchAIAgentConfigurationProperty

class CfnAIAgentPropsMixin.ManualSearchAIAgentConfigurationProperty(*, answer_generation_ai_guardrail_id=None, answer_generation_ai_prompt_id=None, association_configurations=None, locale=None)

Bases: object

The configuration for AI Agents of type MANUAL_SEARCH .

Parameters:

answer_generation_ai_guardrail_id (Optional[str]) – The ID of the answer generation AI guardrail.
answer_generation_ai_prompt_id (Optional[str]) – The AI Prompt identifier for the Answer Generation prompt used by the ANSWER_RECOMMENDATION AI Agent.
association_configurations (Union[IResolvable, Sequence[Union[IResolvable, AssociationConfigurationProperty, Dict[str, Any]]], None]) – The association configurations for overriding behavior on this AI Agent.
locale (Optional[str]) –
The locale to which specifies the language and region settings that determine the response language for QueryAssistant .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-manualsearchaiagentconfiguration.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.mixins_preview.aws_wisdom import mixins as wisdom_mixins

manual_search_aIAgent_configuration_property = wisdom_mixins.CfnAIAgentPropsMixin.ManualSearchAIAgentConfigurationProperty(
    answer_generation_ai_guardrail_id="answerGenerationAiGuardrailId",
    answer_generation_ai_prompt_id="answerGenerationAiPromptId",
    association_configurations=[wisdom_mixins.CfnAIAgentPropsMixin.AssociationConfigurationProperty(
        association_configuration_data=wisdom_mixins.CfnAIAgentPropsMixin.AssociationConfigurationDataProperty(
            knowledge_base_association_configuration_data=wisdom_mixins.CfnAIAgentPropsMixin.KnowledgeBaseAssociationConfigurationDataProperty(
                content_tag_filter=wisdom_mixins.CfnAIAgentPropsMixin.TagFilterProperty(
                    and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                        key="key",
                        value="value"
                    )],
                    or_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.OrConditionProperty(
                        and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                            key="key",
                            value="value"
                        )],
                        tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                            key="key",
                            value="value"
                        )
                    )],
                    tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                        key="key",
                        value="value"
                    )
                ),
                max_results=123,
                override_knowledge_base_search_type="overrideKnowledgeBaseSearchType"
            )
        ),
        association_id="associationId",
        association_type="associationType"
    )],
    locale="locale"
)

Attributes

answer_generation_ai_guardrail_id

The ID of the answer generation AI guardrail.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-manualsearchaiagentconfiguration.html#cfn-wisdom-aiagent-manualsearchaiagentconfiguration-answergenerationaiguardrailid

answer_generation_ai_prompt_id

The AI Prompt identifier for the Answer Generation prompt used by the ANSWER_RECOMMENDATION AI Agent.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-manualsearchaiagentconfiguration.html#cfn-wisdom-aiagent-manualsearchaiagentconfiguration-answergenerationaipromptid

association_configurations

The association configurations for overriding behavior on this AI Agent.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-manualsearchaiagentconfiguration.html#cfn-wisdom-aiagent-manualsearchaiagentconfiguration-associationconfigurations

locale

The locale to which specifies the language and region settings that determine the response language for QueryAssistant .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-manualsearchaiagentconfiguration.html#cfn-wisdom-aiagent-manualsearchaiagentconfiguration-locale

NoteTakingAIAgentConfigurationProperty

class CfnAIAgentPropsMixin.NoteTakingAIAgentConfigurationProperty(*, locale=None, note_taking_ai_guardrail_id=None, note_taking_ai_prompt_id=None)

Bases: object

Parameters:

locale (Optional[str])
note_taking_ai_guardrail_id (Optional[str])
note_taking_ai_prompt_id (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-notetakingaiagentconfiguration.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.mixins_preview.aws_wisdom import mixins as wisdom_mixins

note_taking_aIAgent_configuration_property = wisdom_mixins.CfnAIAgentPropsMixin.NoteTakingAIAgentConfigurationProperty(
    locale="locale",
    note_taking_ai_guardrail_id="noteTakingAiGuardrailId",
    note_taking_ai_prompt_id="noteTakingAiPromptId"
)

Attributes

locale

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-notetakingaiagentconfiguration.html#cfn-wisdom-aiagent-notetakingaiagentconfiguration-locale

Type:: see

note_taking_ai_guardrail_id

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-notetakingaiagentconfiguration.html#cfn-wisdom-aiagent-notetakingaiagentconfiguration-notetakingaiguardrailid

Type:: see

note_taking_ai_prompt_id

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-notetakingaiagentconfiguration.html#cfn-wisdom-aiagent-notetakingaiagentconfiguration-notetakingaipromptid

Type:: see

OrConditionProperty

class CfnAIAgentPropsMixin.OrConditionProperty(*, and_conditions=None, tag_condition=None)

Bases: object

A list of conditions which would be applied together with an OR condition.

Parameters:

and_conditions (Union[IResolvable, Sequence[Union[IResolvable, TagConditionProperty, Dict[str, Any]]], None]) – A list of conditions which would be applied together with an AND condition.
tag_condition (Union[IResolvable, TagConditionProperty, Dict[str, Any], None]) – A leaf node condition which can be used to specify a tag condition.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-orcondition.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.mixins_preview.aws_wisdom import mixins as wisdom_mixins

or_condition_property = wisdom_mixins.CfnAIAgentPropsMixin.OrConditionProperty(
    and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
        key="key",
        value="value"
    )],
    tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
        key="key",
        value="value"
    )
)

Attributes

and_conditions

A list of conditions which would be applied together with an AND condition.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-orcondition.html#cfn-wisdom-aiagent-orcondition-andconditions

tag_condition

A leaf node condition which can be used to specify a tag condition.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-orcondition.html#cfn-wisdom-aiagent-orcondition-tagcondition

OrchestrationAIAgentConfigurationProperty

class CfnAIAgentPropsMixin.OrchestrationAIAgentConfigurationProperty(*, connect_instance_arn=None, locale=None, orchestration_ai_guardrail_id=None, orchestration_ai_prompt_id=None, tool_configurations=None)

Bases: object

Parameters:

connect_instance_arn (Optional[str])
locale (Optional[str])
orchestration_ai_guardrail_id (Optional[str])
orchestration_ai_prompt_id (Optional[str])
tool_configurations (Union[IResolvable, Sequence[Union[IResolvable, ToolConfigurationProperty, Dict[str, Any]]], None])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-orchestrationaiagentconfiguration.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.mixins_preview.aws_wisdom import mixins as wisdom_mixins

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

orchestration_aIAgent_configuration_property = wisdom_mixins.CfnAIAgentPropsMixin.OrchestrationAIAgentConfigurationProperty(
    connect_instance_arn="connectInstanceArn",
    locale="locale",
    orchestration_ai_guardrail_id="orchestrationAiGuardrailId",
    orchestration_ai_prompt_id="orchestrationAiPromptId",
    tool_configurations=[wisdom_mixins.CfnAIAgentPropsMixin.ToolConfigurationProperty(
        annotations=annotations,
        description="description",
        input_schema=input_schema,
        instruction=wisdom_mixins.CfnAIAgentPropsMixin.ToolInstructionProperty(
            examples=["examples"],
            instruction="instruction"
        ),
        output_filters=[wisdom_mixins.CfnAIAgentPropsMixin.ToolOutputFilterProperty(
            json_path="jsonPath",
            output_configuration=wisdom_mixins.CfnAIAgentPropsMixin.ToolOutputConfigurationProperty(
                output_variable_name_override="outputVariableNameOverride",
                session_data_namespace="sessionDataNamespace"
            )
        )],
        output_schema=output_schema,
        override_input_values=[wisdom_mixins.CfnAIAgentPropsMixin.ToolOverrideInputValueProperty(
            json_path="jsonPath",
            value=wisdom_mixins.CfnAIAgentPropsMixin.ToolOverrideInputValueConfigurationProperty(
                constant=wisdom_mixins.CfnAIAgentPropsMixin.ToolOverrideConstantInputValueProperty(
                    type="type",
                    value="value"
                )
            )
        )],
        title="title",
        tool_id="toolId",
        tool_name="toolName",
        tool_type="toolType",
        user_interaction_configuration=wisdom_mixins.CfnAIAgentPropsMixin.UserInteractionConfigurationProperty(
            is_user_confirmation_required=False
        )
    )]
)

Attributes

connect_instance_arn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-orchestrationaiagentconfiguration.html#cfn-wisdom-aiagent-orchestrationaiagentconfiguration-connectinstancearn

Type:: see

locale

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-orchestrationaiagentconfiguration.html#cfn-wisdom-aiagent-orchestrationaiagentconfiguration-locale

Type:: see

orchestration_ai_guardrail_id

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-orchestrationaiagentconfiguration.html#cfn-wisdom-aiagent-orchestrationaiagentconfiguration-orchestrationaiguardrailid

Type:: see

orchestration_ai_prompt_id

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-orchestrationaiagentconfiguration.html#cfn-wisdom-aiagent-orchestrationaiagentconfiguration-orchestrationaipromptid

Type:: see

tool_configurations

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-orchestrationaiagentconfiguration.html#cfn-wisdom-aiagent-orchestrationaiagentconfiguration-toolconfigurations

Type:: see

SelfServiceAIAgentConfigurationProperty

class CfnAIAgentPropsMixin.SelfServiceAIAgentConfigurationProperty(*, association_configurations=None, self_service_ai_guardrail_id=None, self_service_answer_generation_ai_prompt_id=None, self_service_pre_processing_ai_prompt_id=None)

Bases: object

The configuration of the self-service AI agent.

Parameters:

association_configurations (Union[IResolvable, Sequence[Union[IResolvable, AssociationConfigurationProperty, Dict[str, Any]]], None]) – The association configuration of the self-service AI agent.
self_service_ai_guardrail_id (Optional[str]) – The ID of the self-service AI guardrail.
self_service_answer_generation_ai_prompt_id (Optional[str]) – The ID of the self-service answer generation AI prompt.
self_service_pre_processing_ai_prompt_id (Optional[str]) – The ID of the self-service preprocessing AI prompt.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-selfserviceaiagentconfiguration.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.mixins_preview.aws_wisdom import mixins as wisdom_mixins

self_service_aIAgent_configuration_property = wisdom_mixins.CfnAIAgentPropsMixin.SelfServiceAIAgentConfigurationProperty(
    association_configurations=[wisdom_mixins.CfnAIAgentPropsMixin.AssociationConfigurationProperty(
        association_configuration_data=wisdom_mixins.CfnAIAgentPropsMixin.AssociationConfigurationDataProperty(
            knowledge_base_association_configuration_data=wisdom_mixins.CfnAIAgentPropsMixin.KnowledgeBaseAssociationConfigurationDataProperty(
                content_tag_filter=wisdom_mixins.CfnAIAgentPropsMixin.TagFilterProperty(
                    and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                        key="key",
                        value="value"
                    )],
                    or_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.OrConditionProperty(
                        and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                            key="key",
                            value="value"
                        )],
                        tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                            key="key",
                            value="value"
                        )
                    )],
                    tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
                        key="key",
                        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"
)

Attributes

association_configurations

The association configuration of the self-service AI agent.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-selfserviceaiagentconfiguration.html#cfn-wisdom-aiagent-selfserviceaiagentconfiguration-associationconfigurations

self_service_ai_guardrail_id

The ID of the self-service AI guardrail.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-selfserviceaiagentconfiguration.html#cfn-wisdom-aiagent-selfserviceaiagentconfiguration-selfserviceaiguardrailid

self_service_answer_generation_ai_prompt_id

The ID of the self-service answer generation AI prompt.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-selfserviceaiagentconfiguration.html#cfn-wisdom-aiagent-selfserviceaiagentconfiguration-selfserviceanswergenerationaipromptid

self_service_pre_processing_ai_prompt_id

The ID of the self-service preprocessing AI prompt.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-selfserviceaiagentconfiguration.html#cfn-wisdom-aiagent-selfserviceaiagentconfiguration-selfservicepreprocessingaipromptid

TagConditionProperty

class CfnAIAgentPropsMixin.TagConditionProperty(*, key=None, value=None)

Bases: object

An object that can be used to specify tag conditions.

Parameters:

key (Optional[str]) – The tag key in the tag condition.
value (Optional[str]) – The tag value in the tag condition.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-tagcondition.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.mixins_preview.aws_wisdom import mixins as wisdom_mixins

tag_condition_property = wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
    key="key",
    value="value"
)

Attributes

key

The tag key in the tag condition.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-tagcondition.html#cfn-wisdom-aiagent-tagcondition-key

value

The tag value in the tag condition.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-tagcondition.html#cfn-wisdom-aiagent-tagcondition-value

TagFilterProperty

class CfnAIAgentPropsMixin.TagFilterProperty(*, and_conditions=None, or_conditions=None, tag_condition=None)

Bases: object

An object that can be used to specify tag conditions.

Parameters:

and_conditions (Union[IResolvable, Sequence[Union[IResolvable, TagConditionProperty, Dict[str, Any]]], None]) – A list of conditions which would be applied together with an AND condition.
or_conditions (Union[IResolvable, Sequence[Union[IResolvable, OrConditionProperty, Dict[str, Any]]], None]) – A list of conditions which would be applied together with an OR condition.
tag_condition (Union[IResolvable, TagConditionProperty, Dict[str, Any], None]) – A leaf node condition which can be used to specify a tag condition.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-tagfilter.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.mixins_preview.aws_wisdom import mixins as wisdom_mixins

tag_filter_property = wisdom_mixins.CfnAIAgentPropsMixin.TagFilterProperty(
    and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
        key="key",
        value="value"
    )],
    or_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.OrConditionProperty(
        and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
            key="key",
            value="value"
        )],
        tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
            key="key",
            value="value"
        )
    )],
    tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty(
        key="key",
        value="value"
    )
)

Attributes

and_conditions

A list of conditions which would be applied together with an AND condition.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-tagfilter.html#cfn-wisdom-aiagent-tagfilter-andconditions

or_conditions

A list of conditions which would be applied together with an OR condition.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-tagfilter.html#cfn-wisdom-aiagent-tagfilter-orconditions

tag_condition

A leaf node condition which can be used to specify a tag condition.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-tagfilter.html#cfn-wisdom-aiagent-tagfilter-tagcondition

ToolConfigurationProperty

class CfnAIAgentPropsMixin.ToolConfigurationProperty(*, annotations=None, description=None, input_schema=None, instruction=None, output_filters=None, output_schema=None, override_input_values=None, title=None, tool_id=None, tool_name=None, tool_type=None, user_interaction_configuration=None)

Bases: object

Parameters:

annotations (Any)
description (Optional[str])
input_schema (Any)
instruction (Union[IResolvable, ToolInstructionProperty, Dict[str, Any], None])
output_filters (Union[IResolvable, Sequence[Union[IResolvable, ToolOutputFilterProperty, Dict[str, Any]]], None])
output_schema (Any)
override_input_values (Union[IResolvable, Sequence[Union[IResolvable, ToolOverrideInputValueProperty, Dict[str, Any]]], None])
title (Optional[str])
tool_id (Optional[str])
tool_name (Optional[str])
tool_type (Optional[str])
user_interaction_configuration (Union[IResolvable, UserInteractionConfigurationProperty, Dict[str, Any], None])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-toolconfiguration.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.mixins_preview.aws_wisdom import mixins as wisdom_mixins

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

tool_configuration_property = wisdom_mixins.CfnAIAgentPropsMixin.ToolConfigurationProperty(
    annotations=annotations,
    description="description",
    input_schema=input_schema,
    instruction=wisdom_mixins.CfnAIAgentPropsMixin.ToolInstructionProperty(
        examples=["examples"],
        instruction="instruction"
    ),
    output_filters=[wisdom_mixins.CfnAIAgentPropsMixin.ToolOutputFilterProperty(
        json_path="jsonPath",
        output_configuration=wisdom_mixins.CfnAIAgentPropsMixin.ToolOutputConfigurationProperty(
            output_variable_name_override="outputVariableNameOverride",
            session_data_namespace="sessionDataNamespace"
        )
    )],
    output_schema=output_schema,
    override_input_values=[wisdom_mixins.CfnAIAgentPropsMixin.ToolOverrideInputValueProperty(
        json_path="jsonPath",
        value=wisdom_mixins.CfnAIAgentPropsMixin.ToolOverrideInputValueConfigurationProperty(
            constant=wisdom_mixins.CfnAIAgentPropsMixin.ToolOverrideConstantInputValueProperty(
                type="type",
                value="value"
            )
        )
    )],
    title="title",
    tool_id="toolId",
    tool_name="toolName",
    tool_type="toolType",
    user_interaction_configuration=wisdom_mixins.CfnAIAgentPropsMixin.UserInteractionConfigurationProperty(
        is_user_confirmation_required=False
    )
)

Attributes

annotations

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-toolconfiguration.html#cfn-wisdom-aiagent-toolconfiguration-annotations

Type:: see

description

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

Type:: see

input_schema

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-toolconfiguration.html#cfn-wisdom-aiagent-toolconfiguration-inputschema

Type:: see

instruction

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-toolconfiguration.html#cfn-wisdom-aiagent-toolconfiguration-instruction

Type:: see

output_filters

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-toolconfiguration.html#cfn-wisdom-aiagent-toolconfiguration-outputfilters

Type:: see

output_schema

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-toolconfiguration.html#cfn-wisdom-aiagent-toolconfiguration-outputschema

Type:: see

override_input_values

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-toolconfiguration.html#cfn-wisdom-aiagent-toolconfiguration-overrideinputvalues

Type:: see

title

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-toolconfiguration.html#cfn-wisdom-aiagent-toolconfiguration-title

Type:: see

tool_id

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-toolconfiguration.html#cfn-wisdom-aiagent-toolconfiguration-toolid

Type:: see

tool_name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-toolconfiguration.html#cfn-wisdom-aiagent-toolconfiguration-toolname

Type:: see

tool_type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-toolconfiguration.html#cfn-wisdom-aiagent-toolconfiguration-tooltype

Type:: see

user_interaction_configuration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-toolconfiguration.html#cfn-wisdom-aiagent-toolconfiguration-userinteractionconfiguration

Type:: see

ToolInstructionProperty

class CfnAIAgentPropsMixin.ToolInstructionProperty(*, examples=None, instruction=None)

Bases: object

Parameters:

examples (Optional[Sequence[str]])
instruction (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-toolinstruction.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.mixins_preview.aws_wisdom import mixins as wisdom_mixins

tool_instruction_property = wisdom_mixins.CfnAIAgentPropsMixin.ToolInstructionProperty(
    examples=["examples"],
    instruction="instruction"
)

Attributes

examples

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-toolinstruction.html#cfn-wisdom-aiagent-toolinstruction-examples

Type:: see

instruction

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-toolinstruction.html#cfn-wisdom-aiagent-toolinstruction-instruction

Type:: see

ToolOutputConfigurationProperty

class CfnAIAgentPropsMixin.ToolOutputConfigurationProperty(*, output_variable_name_override=None, session_data_namespace=None)

Bases: object

Parameters:

output_variable_name_override (Optional[str])
session_data_namespace (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-tooloutputconfiguration.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.mixins_preview.aws_wisdom import mixins as wisdom_mixins

tool_output_configuration_property = wisdom_mixins.CfnAIAgentPropsMixin.ToolOutputConfigurationProperty(
    output_variable_name_override="outputVariableNameOverride",
    session_data_namespace="sessionDataNamespace"
)

Attributes

output_variable_name_override

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-tooloutputconfiguration.html#cfn-wisdom-aiagent-tooloutputconfiguration-outputvariablenameoverride

Type:: see

session_data_namespace

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-tooloutputconfiguration.html#cfn-wisdom-aiagent-tooloutputconfiguration-sessiondatanamespace

Type:: see

ToolOutputFilterProperty

class CfnAIAgentPropsMixin.ToolOutputFilterProperty(*, json_path=None, output_configuration=None)

Bases: object

Parameters:

json_path (Optional[str])
output_configuration (Union[IResolvable, ToolOutputConfigurationProperty, Dict[str, Any], None])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-tooloutputfilter.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.mixins_preview.aws_wisdom import mixins as wisdom_mixins

tool_output_filter_property = wisdom_mixins.CfnAIAgentPropsMixin.ToolOutputFilterProperty(
    json_path="jsonPath",
    output_configuration=wisdom_mixins.CfnAIAgentPropsMixin.ToolOutputConfigurationProperty(
        output_variable_name_override="outputVariableNameOverride",
        session_data_namespace="sessionDataNamespace"
    )
)

Attributes

json_path

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-tooloutputfilter.html#cfn-wisdom-aiagent-tooloutputfilter-jsonpath

Type:: see

output_configuration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-tooloutputfilter.html#cfn-wisdom-aiagent-tooloutputfilter-outputconfiguration

Type:: see

ToolOverrideConstantInputValueProperty

class CfnAIAgentPropsMixin.ToolOverrideConstantInputValueProperty(*, type=None, value=None)

Bases: object

Parameters:

type (Optional[str])
value (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-tooloverrideconstantinputvalue.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.mixins_preview.aws_wisdom import mixins as wisdom_mixins

tool_override_constant_input_value_property = wisdom_mixins.CfnAIAgentPropsMixin.ToolOverrideConstantInputValueProperty(
    type="type",
    value="value"
)

Attributes

type

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

Type:: see

value

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-tooloverrideconstantinputvalue.html#cfn-wisdom-aiagent-tooloverrideconstantinputvalue-value

Type:: see

ToolOverrideInputValueConfigurationProperty

class CfnAIAgentPropsMixin.ToolOverrideInputValueConfigurationProperty(*, constant=None)

Bases: object

Parameters:: constant (Union[IResolvable, ToolOverrideConstantInputValueProperty, Dict[str, Any], None])
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-tooloverrideinputvalueconfiguration.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.mixins_preview.aws_wisdom import mixins as wisdom_mixins

tool_override_input_value_configuration_property = wisdom_mixins.CfnAIAgentPropsMixin.ToolOverrideInputValueConfigurationProperty(
    constant=wisdom_mixins.CfnAIAgentPropsMixin.ToolOverrideConstantInputValueProperty(
        type="type",
        value="value"
    )
)

Attributes

constant

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-tooloverrideinputvalueconfiguration.html#cfn-wisdom-aiagent-tooloverrideinputvalueconfiguration-constant

Type:: see

ToolOverrideInputValueProperty

class CfnAIAgentPropsMixin.ToolOverrideInputValueProperty(*, json_path=None, value=None)

Bases: object

Parameters:

json_path (Optional[str])
value (Union[IResolvable, ToolOverrideInputValueConfigurationProperty, Dict[str, Any], None])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-tooloverrideinputvalue.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.mixins_preview.aws_wisdom import mixins as wisdom_mixins

tool_override_input_value_property = wisdom_mixins.CfnAIAgentPropsMixin.ToolOverrideInputValueProperty(
    json_path="jsonPath",
    value=wisdom_mixins.CfnAIAgentPropsMixin.ToolOverrideInputValueConfigurationProperty(
        constant=wisdom_mixins.CfnAIAgentPropsMixin.ToolOverrideConstantInputValueProperty(
            type="type",
            value="value"
        )
    )
)

Attributes

json_path

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-tooloverrideinputvalue.html#cfn-wisdom-aiagent-tooloverrideinputvalue-jsonpath

Type:: see

value

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-tooloverrideinputvalue.html#cfn-wisdom-aiagent-tooloverrideinputvalue-value

Type:: see

UserInteractionConfigurationProperty

class CfnAIAgentPropsMixin.UserInteractionConfigurationProperty(*, is_user_confirmation_required=None)

Bases: object

Parameters:: is_user_confirmation_required (Union[bool, IResolvable, None])
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-userinteractionconfiguration.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.mixins_preview.aws_wisdom import mixins as wisdom_mixins

user_interaction_configuration_property = wisdom_mixins.CfnAIAgentPropsMixin.UserInteractionConfigurationProperty(
    is_user_confirmation_required=False
)

Attributes

is_user_confirmation_required

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-userinteractionconfiguration.html#cfn-wisdom-aiagent-userinteractionconfiguration-isuserconfirmationrequired

Type:: see