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

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"
        ),
        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"
        ),
        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:

IConstruct

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)

(experimental) 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.

Stability:

experimental

AIAgentConfigurationProperty

class CfnAIAgentPropsMixin.AIAgentConfigurationProperty(*, answer_recommendation_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, self_service_ai_agent_configuration=None)

Bases: object

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

Parameters:
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

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"
    ),
    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"
    ),
    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

email_generative_answer_ai_agent_configuration

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

Type:

see

email_overview_ai_agent_configuration

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

Type:

see

email_response_ai_agent_configuration

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

Type:

see

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

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

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

Parameters:
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

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

Type:

see

email_generative_answer_ai_prompt_id

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

Type:

see

email_query_reformulation_ai_prompt_id

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

Type:

see

locale

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

Type:

see

EmailOverviewAIAgentConfigurationProperty

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

Bases: object

Parameters:
  • email_overview_ai_prompt_id (Optional[str])

  • locale (Optional[str])

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

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

Type:

see

locale

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

Type:

see

EmailResponseAIAgentConfigurationProperty

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

Bases: object

Parameters:
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

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

Type:

see

email_query_reformulation_ai_prompt_id

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

Type:

see

email_response_ai_prompt_id

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

Type:

see

locale

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

Type:

see

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])

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

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

Type:

see

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

OrConditionProperty

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

Bases: object

Parameters:
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

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

Type:

see

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

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:
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