interface CfnAIAgentMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Wisdom.Mixins.CfnAIAgentMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awswisdom/mixins#CfnAIAgentMixinProps
Java	software.amazon.awscdk.mixins.preview.services.wisdom.mixins.CfnAIAgentMixinProps
Python	aws_cdk.mixins_preview.aws_wisdom.mixins.CfnAIAgentMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_wisdom » mixins » CfnAIAgentMixinProps

Properties for CfnAIAgentPropsMixin.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as wisdom_mixins } from '@aws-cdk/mixins-preview/aws-wisdom';
const cfnAIAgentMixinProps: wisdom_mixins.CfnAIAgentMixinProps = {
  assistantId: 'assistantId',
  configuration: {
    answerRecommendationAiAgentConfiguration: {
      answerGenerationAiGuardrailId: 'answerGenerationAiGuardrailId',
      answerGenerationAiPromptId: 'answerGenerationAiPromptId',
      associationConfigurations: [{
        associationConfigurationData: {
          knowledgeBaseAssociationConfigurationData: {
            contentTagFilter: {
              andConditions: [{
                key: 'key',
                value: 'value',
              }],
              orConditions: [{
                andConditions: [{
                  key: 'key',
                  value: 'value',
                }],
                tagCondition: {
                  key: 'key',
                  value: 'value',
                },
              }],
              tagCondition: {
                key: 'key',
                value: 'value',
              },
            },
            maxResults: 123,
            overrideKnowledgeBaseSearchType: 'overrideKnowledgeBaseSearchType',
          },
        },
        associationId: 'associationId',
        associationType: 'associationType',
      }],
      intentLabelingGenerationAiPromptId: 'intentLabelingGenerationAiPromptId',
      locale: 'locale',
      queryReformulationAiPromptId: 'queryReformulationAiPromptId',
    },
    emailGenerativeAnswerAiAgentConfiguration: {
      associationConfigurations: [{
        associationConfigurationData: {
          knowledgeBaseAssociationConfigurationData: {
            contentTagFilter: {
              andConditions: [{
                key: 'key',
                value: 'value',
              }],
              orConditions: [{
                andConditions: [{
                  key: 'key',
                  value: 'value',
                }],
                tagCondition: {
                  key: 'key',
                  value: 'value',
                },
              }],
              tagCondition: {
                key: 'key',
                value: 'value',
              },
            },
            maxResults: 123,
            overrideKnowledgeBaseSearchType: 'overrideKnowledgeBaseSearchType',
          },
        },
        associationId: 'associationId',
        associationType: 'associationType',
      }],
      emailGenerativeAnswerAiPromptId: 'emailGenerativeAnswerAiPromptId',
      emailQueryReformulationAiPromptId: 'emailQueryReformulationAiPromptId',
      locale: 'locale',
    },
    emailOverviewAiAgentConfiguration: {
      emailOverviewAiPromptId: 'emailOverviewAiPromptId',
      locale: 'locale',
    },
    emailResponseAiAgentConfiguration: {
      associationConfigurations: [{
        associationConfigurationData: {
          knowledgeBaseAssociationConfigurationData: {
            contentTagFilter: {
              andConditions: [{
                key: 'key',
                value: 'value',
              }],
              orConditions: [{
                andConditions: [{
                  key: 'key',
                  value: 'value',
                }],
                tagCondition: {
                  key: 'key',
                  value: 'value',
                },
              }],
              tagCondition: {
                key: 'key',
                value: 'value',
              },
            },
            maxResults: 123,
            overrideKnowledgeBaseSearchType: 'overrideKnowledgeBaseSearchType',
          },
        },
        associationId: 'associationId',
        associationType: 'associationType',
      }],
      emailQueryReformulationAiPromptId: 'emailQueryReformulationAiPromptId',
      emailResponseAiPromptId: 'emailResponseAiPromptId',
      locale: 'locale',
    },
    manualSearchAiAgentConfiguration: {
      answerGenerationAiGuardrailId: 'answerGenerationAiGuardrailId',
      answerGenerationAiPromptId: 'answerGenerationAiPromptId',
      associationConfigurations: [{
        associationConfigurationData: {
          knowledgeBaseAssociationConfigurationData: {
            contentTagFilter: {
              andConditions: [{
                key: 'key',
                value: 'value',
              }],
              orConditions: [{
                andConditions: [{
                  key: 'key',
                  value: 'value',
                }],
                tagCondition: {
                  key: 'key',
                  value: 'value',
                },
              }],
              tagCondition: {
                key: 'key',
                value: 'value',
              },
            },
            maxResults: 123,
            overrideKnowledgeBaseSearchType: 'overrideKnowledgeBaseSearchType',
          },
        },
        associationId: 'associationId',
        associationType: 'associationType',
      }],
      locale: 'locale',
    },
    selfServiceAiAgentConfiguration: {
      associationConfigurations: [{
        associationConfigurationData: {
          knowledgeBaseAssociationConfigurationData: {
            contentTagFilter: {
              andConditions: [{
                key: 'key',
                value: 'value',
              }],
              orConditions: [{
                andConditions: [{
                  key: 'key',
                  value: 'value',
                }],
                tagCondition: {
                  key: 'key',
                  value: 'value',
                },
              }],
              tagCondition: {
                key: 'key',
                value: 'value',
              },
            },
            maxResults: 123,
            overrideKnowledgeBaseSearchType: 'overrideKnowledgeBaseSearchType',
          },
        },
        associationId: 'associationId',
        associationType: 'associationType',
      }],
      selfServiceAiGuardrailId: 'selfServiceAiGuardrailId',
      selfServiceAnswerGenerationAiPromptId: 'selfServiceAnswerGenerationAiPromptId',
      selfServicePreProcessingAiPromptId: 'selfServicePreProcessingAiPromptId',
    },
  },
  description: 'description',
  name: 'name',
  tags: {
    tagsKey: 'tags',
  },
  type: 'type',
};

Properties

Name	Type	Description
assistantId?	string	The identifier of the Amazon Q in Connect assistant.
configuration?	IResolvable | AIAgentConfigurationProperty	Configuration for the AI Agent.
description?	string	The description of the AI Agent.
name?	string	The name of the AI Agent.
tags?	{ [string]: string }	The tags used to organize, track, or control access for this resource.
type?	string	The type of the AI Agent.

---

assistantId?

Type: string (optional)

The identifier of the Amazon Q in Connect assistant.

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

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

---

configuration?

Type: IResolvable | AIAgentConfigurationProperty (optional)

Configuration for the AI Agent.

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

---

description?

Type: string (optional)

The description of the AI Agent.

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

---

name?

Type: string (optional)

The name of the AI Agent.

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

---

tags?

Type: { [string]: string } (optional)

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

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

---

type?

Type: string (optional)

The type of the AI Agent.

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