CfnAIAgent

class aws_cdk.aws_wisdom.CfnAIAgent(scope, id, *, assistant_id, configuration, type, description=None, name=None, tags=None)

Bases: CfnResource

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

ExampleMetadata:

fixture=_generated

Example:

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

cfn_aIAgent = wisdom.CfnAIAgent(self, "MyCfnAIAgent",
    assistant_id="assistantId",
    configuration=wisdom.CfnAIAgent.AIAgentConfigurationProperty(
        answer_recommendation_ai_agent_configuration=wisdom.CfnAIAgent.AnswerRecommendationAIAgentConfigurationProperty(
            answer_generation_ai_prompt_id="answerGenerationAiPromptId",
            association_configurations=[wisdom.CfnAIAgent.AssociationConfigurationProperty(
                association_configuration_data=wisdom.CfnAIAgent.AssociationConfigurationDataProperty(
                    knowledge_base_association_configuration_data=wisdom.CfnAIAgent.KnowledgeBaseAssociationConfigurationDataProperty(
                        content_tag_filter=wisdom.CfnAIAgent.TagFilterProperty(
                            and_conditions=[wisdom.CfnAIAgent.TagConditionProperty(
                                key="key",

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

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

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

                                # the properties below are optional
                                value="value"
                            )
                        ),
                        max_results=123,
                        override_knowledge_base_search_type="overrideKnowledgeBaseSearchType"
                    )
                ),
                association_id="associationId",
                association_type="associationType"
            )],
            intent_labeling_generation_ai_prompt_id="intentLabelingGenerationAiPromptId",
            query_reformulation_ai_prompt_id="queryReformulationAiPromptId"
        ),
        manual_search_ai_agent_configuration=wisdom.CfnAIAgent.ManualSearchAIAgentConfigurationProperty(
            answer_generation_ai_prompt_id="answerGenerationAiPromptId",
            association_configurations=[wisdom.CfnAIAgent.AssociationConfigurationProperty(
                association_configuration_data=wisdom.CfnAIAgent.AssociationConfigurationDataProperty(
                    knowledge_base_association_configuration_data=wisdom.CfnAIAgent.KnowledgeBaseAssociationConfigurationDataProperty(
                        content_tag_filter=wisdom.CfnAIAgent.TagFilterProperty(
                            and_conditions=[wisdom.CfnAIAgent.TagConditionProperty(
                                key="key",

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

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

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

                                # the properties below are optional
                                value="value"
                            )
                        ),
                        max_results=123,
                        override_knowledge_base_search_type="overrideKnowledgeBaseSearchType"
                    )
                ),
                association_id="associationId",
                association_type="associationType"
            )]
        )
    ),
    type="type",

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

  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

  • assistant_id (str) – The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • configuration (Union[IResolvable, AIAgentConfigurationProperty, Dict[str, Any]]) – Configuration for the AI Agent.

  • type (str) – The type of the AI Agent.

  • description (Optional[str]) – The description of the AI Agent.

  • name (Optional[str]) – The name of the AI Agent.

  • tags (Optional[Mapping[str, str]]) – The tags used to organize, track, or control access for this resource.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (str) –

  • value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

  • attribute_name (str) – The name of the attribute.

  • type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Wisdom::AIAgent'
assistant_id

The identifier of the Amazon Q in Connect assistant.

attr_ai_agent_arn

The Amazon Resource Name (ARN) of the AI agent.

CloudformationAttribute:

AIAgentArn

attr_ai_agent_id

The identifier of the AI Agent.

CloudformationAttribute:

AIAgentId

attr_assistant_arn

The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

CloudformationAttribute:

AssistantArn

cdk_tag_manager

Tag Manager which manages the tags for this resource.

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

configuration

Configuration for the AI Agent.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

description

The description of the AI Agent.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

name

The name of the AI Agent.

node

The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags

The tags used to organize, track, or control access for this resource.

type

The type of the AI Agent.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

AIAgentConfigurationProperty

class CfnAIAgent.AIAgentConfigurationProperty(*, answer_recommendation_ai_agent_configuration=None, manual_search_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 import aws_wisdom as wisdom

a_iAgent_configuration_property = wisdom.CfnAIAgent.AIAgentConfigurationProperty(
    answer_recommendation_ai_agent_configuration=wisdom.CfnAIAgent.AnswerRecommendationAIAgentConfigurationProperty(
        answer_generation_ai_prompt_id="answerGenerationAiPromptId",
        association_configurations=[wisdom.CfnAIAgent.AssociationConfigurationProperty(
            association_configuration_data=wisdom.CfnAIAgent.AssociationConfigurationDataProperty(
                knowledge_base_association_configuration_data=wisdom.CfnAIAgent.KnowledgeBaseAssociationConfigurationDataProperty(
                    content_tag_filter=wisdom.CfnAIAgent.TagFilterProperty(
                        and_conditions=[wisdom.CfnAIAgent.TagConditionProperty(
                            key="key",

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

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

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

                            # the properties below are optional
                            value="value"
                        )
                    ),
                    max_results=123,
                    override_knowledge_base_search_type="overrideKnowledgeBaseSearchType"
                )
            ),
            association_id="associationId",
            association_type="associationType"
        )],
        intent_labeling_generation_ai_prompt_id="intentLabelingGenerationAiPromptId",
        query_reformulation_ai_prompt_id="queryReformulationAiPromptId"
    ),
    manual_search_ai_agent_configuration=wisdom.CfnAIAgent.ManualSearchAIAgentConfigurationProperty(
        answer_generation_ai_prompt_id="answerGenerationAiPromptId",
        association_configurations=[wisdom.CfnAIAgent.AssociationConfigurationProperty(
            association_configuration_data=wisdom.CfnAIAgent.AssociationConfigurationDataProperty(
                knowledge_base_association_configuration_data=wisdom.CfnAIAgent.KnowledgeBaseAssociationConfigurationDataProperty(
                    content_tag_filter=wisdom.CfnAIAgent.TagFilterProperty(
                        and_conditions=[wisdom.CfnAIAgent.TagConditionProperty(
                            key="key",

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

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

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

                            # the properties below are optional
                            value="value"
                        )
                    ),
                    max_results=123,
                    override_knowledge_base_search_type="overrideKnowledgeBaseSearchType"
                )
            ),
            association_id="associationId",
            association_type="associationType"
        )]
    )
)

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

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

AnswerRecommendationAIAgentConfigurationProperty

class CfnAIAgent.AnswerRecommendationAIAgentConfigurationProperty(*, answer_generation_ai_prompt_id=None, association_configurations=None, intent_labeling_generation_ai_prompt_id=None, query_reformulation_ai_prompt_id=None)

Bases: object

The configuration for AI Agents of type ANSWER_RECOMMENDATION .

Parameters:

  • 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.

  • 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 import aws_wisdom as wisdom

answer_recommendation_aIAgent_configuration_property = wisdom.CfnAIAgent.AnswerRecommendationAIAgentConfigurationProperty(
    answer_generation_ai_prompt_id="answerGenerationAiPromptId",
    association_configurations=[wisdom.CfnAIAgent.AssociationConfigurationProperty(
        association_configuration_data=wisdom.CfnAIAgent.AssociationConfigurationDataProperty(
            knowledge_base_association_configuration_data=wisdom.CfnAIAgent.KnowledgeBaseAssociationConfigurationDataProperty(
                content_tag_filter=wisdom.CfnAIAgent.TagFilterProperty(
                    and_conditions=[wisdom.CfnAIAgent.TagConditionProperty(
                        key="key",

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

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

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

                        # the properties below are optional
                        value="value"
                    )
                ),
                max_results=123,
                override_knowledge_base_search_type="overrideKnowledgeBaseSearchType"
            )
        ),
        association_id="associationId",
        association_type="associationType"
    )],
    intent_labeling_generation_ai_prompt_id="intentLabelingGenerationAiPromptId",
    query_reformulation_ai_prompt_id="queryReformulationAiPromptId"
)

Attributes

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

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 CfnAIAgent.AssociationConfigurationDataProperty(*, knowledge_base_association_configuration_data)

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]]) – 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 import aws_wisdom as wisdom

association_configuration_data_property = wisdom.CfnAIAgent.AssociationConfigurationDataProperty(
    knowledge_base_association_configuration_data=wisdom.CfnAIAgent.KnowledgeBaseAssociationConfigurationDataProperty(
        content_tag_filter=wisdom.CfnAIAgent.TagFilterProperty(
            and_conditions=[wisdom.CfnAIAgent.TagConditionProperty(
                key="key",

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

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

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

                # the properties below are optional
                value="value"
            )
        ),
        max_results=123,
        override_knowledge_base_search_type="overrideKnowledgeBaseSearchType"
    )
)

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 CfnAIAgent.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 import aws_wisdom as wisdom

association_configuration_property = wisdom.CfnAIAgent.AssociationConfigurationProperty(
    association_configuration_data=wisdom.CfnAIAgent.AssociationConfigurationDataProperty(
        knowledge_base_association_configuration_data=wisdom.CfnAIAgent.KnowledgeBaseAssociationConfigurationDataProperty(
            content_tag_filter=wisdom.CfnAIAgent.TagFilterProperty(
                and_conditions=[wisdom.CfnAIAgent.TagConditionProperty(
                    key="key",

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

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

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

                    # the properties below are optional
                    value="value"
                )
            ),
            max_results=123,
            override_knowledge_base_search_type="overrideKnowledgeBaseSearchType"
        )
    ),
    association_id="associationId",
    association_type="associationType"
)

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

KnowledgeBaseAssociationConfigurationDataProperty

class CfnAIAgent.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 import aws_wisdom as wisdom

knowledge_base_association_configuration_data_property = wisdom.CfnAIAgent.KnowledgeBaseAssociationConfigurationDataProperty(
    content_tag_filter=wisdom.CfnAIAgent.TagFilterProperty(
        and_conditions=[wisdom.CfnAIAgent.TagConditionProperty(
            key="key",

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

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

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

            # the properties below are optional
            value="value"
        )
    ),
    max_results=123,
    override_knowledge_base_search_type="overrideKnowledgeBaseSearchType"
)

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 CfnAIAgent.ManualSearchAIAgentConfigurationProperty(*, answer_generation_ai_prompt_id=None, association_configurations=None)

Bases: object

The configuration for AI Agents of type MANUAL_SEARCH .

Parameters:

  • 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.

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 import aws_wisdom as wisdom

manual_search_aIAgent_configuration_property = wisdom.CfnAIAgent.ManualSearchAIAgentConfigurationProperty(
    answer_generation_ai_prompt_id="answerGenerationAiPromptId",
    association_configurations=[wisdom.CfnAIAgent.AssociationConfigurationProperty(
        association_configuration_data=wisdom.CfnAIAgent.AssociationConfigurationDataProperty(
            knowledge_base_association_configuration_data=wisdom.CfnAIAgent.KnowledgeBaseAssociationConfigurationDataProperty(
                content_tag_filter=wisdom.CfnAIAgent.TagFilterProperty(
                    and_conditions=[wisdom.CfnAIAgent.TagConditionProperty(
                        key="key",

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

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

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

                        # the properties below are optional
                        value="value"
                    )
                ),
                max_results=123,
                override_knowledge_base_search_type="overrideKnowledgeBaseSearchType"
            )
        ),
        association_id="associationId",
        association_type="associationType"
    )]
)

Attributes

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

OrConditionProperty

class CfnAIAgent.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 import aws_wisdom as wisdom

or_condition_property = wisdom.CfnAIAgent.OrConditionProperty(
    and_conditions=[wisdom.CfnAIAgent.TagConditionProperty(
        key="key",

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

        # the properties below are optional
        value="value"
    )
)

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

TagConditionProperty

class CfnAIAgent.TagConditionProperty(*, key, value=None)

Bases: object

An object that can be used to specify tag conditions.

Parameters:

  • key (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 import aws_wisdom as wisdom

tag_condition_property = wisdom.CfnAIAgent.TagConditionProperty(
    key="key",

    # the properties below are optional
    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 CfnAIAgent.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 import aws_wisdom as wisdom

tag_filter_property = wisdom.CfnAIAgent.TagFilterProperty(
    and_conditions=[wisdom.CfnAIAgent.TagConditionProperty(
        key="key",

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

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

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

        # the properties below are optional
        value="value"
    )
)

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