interface CfnAIAgentProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Wisdom.CfnAIAgentProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awswisdom#CfnAIAgentProps |
![]() | software.amazon.awscdk.services.wisdom.CfnAIAgentProps |
![]() | aws_cdk.aws_wisdom.CfnAIAgentProps |
![]() | aws-cdk-lib » aws_wisdom » CfnAIAgentProps |
Properties for defining a CfnAIAgent
.
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-lib';
const cfnAIAgentProps: wisdom.CfnAIAgentProps = {
assistantId: 'assistantId',
configuration: {
answerRecommendationAiAgentConfiguration: {
answerGenerationAiGuardrailId: 'answerGenerationAiGuardrailId',
answerGenerationAiPromptId: 'answerGenerationAiPromptId',
associationConfigurations: [{
associationConfigurationData: {
knowledgeBaseAssociationConfigurationData: {
contentTagFilter: {
andConditions: [{
key: 'key',
// the properties below are optional
value: 'value',
}],
orConditions: [{
andConditions: [{
key: 'key',
// the properties below are optional
value: 'value',
}],
tagCondition: {
key: 'key',
// the properties below are optional
value: 'value',
},
}],
tagCondition: {
key: 'key',
// the properties below are optional
value: 'value',
},
},
maxResults: 123,
overrideKnowledgeBaseSearchType: 'overrideKnowledgeBaseSearchType',
},
},
associationId: 'associationId',
associationType: 'associationType',
}],
intentLabelingGenerationAiPromptId: 'intentLabelingGenerationAiPromptId',
queryReformulationAiPromptId: 'queryReformulationAiPromptId',
},
manualSearchAiAgentConfiguration: {
answerGenerationAiGuardrailId: 'answerGenerationAiGuardrailId',
answerGenerationAiPromptId: 'answerGenerationAiPromptId',
associationConfigurations: [{
associationConfigurationData: {
knowledgeBaseAssociationConfigurationData: {
contentTagFilter: {
andConditions: [{
key: 'key',
// the properties below are optional
value: 'value',
}],
orConditions: [{
andConditions: [{
key: 'key',
// the properties below are optional
value: 'value',
}],
tagCondition: {
key: 'key',
// the properties below are optional
value: 'value',
},
}],
tagCondition: {
key: 'key',
// the properties below are optional
value: 'value',
},
},
maxResults: 123,
overrideKnowledgeBaseSearchType: 'overrideKnowledgeBaseSearchType',
},
},
associationId: 'associationId',
associationType: 'associationType',
}],
},
selfServiceAiAgentConfiguration: {
associationConfigurations: [{
associationConfigurationData: {
knowledgeBaseAssociationConfigurationData: {
contentTagFilter: {
andConditions: [{
key: 'key',
// the properties below are optional
value: 'value',
}],
orConditions: [{
andConditions: [{
key: 'key',
// the properties below are optional
value: 'value',
}],
tagCondition: {
key: 'key',
// the properties below are optional
value: 'value',
},
}],
tagCondition: {
key: 'key',
// the properties below are optional
value: 'value',
},
},
maxResults: 123,
overrideKnowledgeBaseSearchType: 'overrideKnowledgeBaseSearchType',
},
},
associationId: 'associationId',
associationType: 'associationType',
}],
selfServiceAiGuardrailId: 'selfServiceAiGuardrailId',
selfServiceAnswerGenerationAiPromptId: 'selfServiceAnswerGenerationAiPromptId',
selfServicePreProcessingAiPromptId: 'selfServicePreProcessingAiPromptId',
},
},
type: 'type',
// the properties below are optional
description: 'description',
name: 'name',
tags: {
tagsKey: 'tags',
},
};
Properties
Name | Type | Description |
---|---|---|
assistant | string | The identifier of the Amazon Q in Connect assistant. |
configuration | IResolvable | AIAgent | Configuration for the AI Agent. |
type | string | The type of 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. |
assistantId
Type:
string
The identifier of the Amazon Q in Connect assistant.
Can be either the ID or the ARN. URLs cannot contain the ARN.
configuration
Type:
IResolvable
|
AIAgent
Configuration for the AI Agent.
type
Type:
string
The type of the AI Agent.
description?
Type:
string
(optional)
The description of the AI Agent.
name?
Type:
string
(optional)
The name of the AI Agent.
tags?
Type:
{ [string]: string }
(optional)
The tags used to organize, track, or control access for this resource.