class CfnAIAgentPropsMixin (mixin)

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.Wisdom.CfnAIAgentPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awswisdom#CfnAIAgentPropsMixin
Java	software.amazon.awscdk.cfnpropertymixins.services.wisdom.CfnAIAgentPropsMixin
Python	aws_cdk.cfn_property_mixins.aws_wisdom.CfnAIAgentPropsMixin
TypeScript	@aws-cdk/cfn-property-mixins » aws_wisdom » CfnAIAgentPropsMixin

Implements IMixin

Extends Mixin

Creates an Amazon Q in Connect AI Agent.

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 { aws_wisdom as wisdom } from '@aws-cdk/cfn-property-mixins';
import * as cdk from 'aws-cdk-lib';

declare const annotations: any;
declare const inputSchema: any;
declare const mergeStrategy: cdk.IMergeStrategy;
declare const outputSchema: any;
const cfnAIAgentPropsMixin = new wisdom.CfnAIAgentPropsMixin({
  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',
    },
    caseSummarizationAiAgentConfiguration: {
      caseSummarizationAiGuardrailId: 'caseSummarizationAiGuardrailId',
      caseSummarizationAiPromptId: 'caseSummarizationAiPromptId',
      locale: 'locale',
    },
    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',
    },
    noteTakingAiAgentConfiguration: {
      locale: 'locale',
      noteTakingAiGuardrailId: 'noteTakingAiGuardrailId',
      noteTakingAiPromptId: 'noteTakingAiPromptId',
    },
    orchestrationAiAgentConfiguration: {
      connectInstanceArn: 'connectInstanceArn',
      locale: 'locale',
      orchestrationAiGuardrailId: 'orchestrationAiGuardrailId',
      orchestrationAiPromptId: 'orchestrationAiPromptId',
      toolConfigurations: [{
        annotations: annotations,
        description: 'description',
        inputSchema: inputSchema,
        instruction: {
          examples: ['examples'],
          instruction: 'instruction',
        },
        outputFilters: [{
          jsonPath: 'jsonPath',
          outputConfiguration: {
            outputVariableNameOverride: 'outputVariableNameOverride',
            sessionDataNamespace: 'sessionDataNamespace',
          },
        }],
        outputSchema: outputSchema,
        overrideInputValues: [{
          jsonPath: 'jsonPath',
          value: {
            constant: {
              type: 'type',
              value: 'value',
            },
          },
        }],
        title: 'title',
        toolId: 'toolId',
        toolName: 'toolName',
        toolType: 'toolType',
        userInteractionConfiguration: {
          isUserConfirmationRequired: false,
        },
      }],
    },
    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',
}, /* all optional props */ {
  strategy: mergeStrategy,
});

Initializer

new CfnAIAgentPropsMixin(props: CfnAIAgentMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnAIAgentMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

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

Properties

Name	Type	Description
props	CfnAIAgentMixinProps
strategy	IMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnAIAgentMixinProps

---

strategy

Type: IMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): void

Parameters

• construct IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.