All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnAIAgent.AIAgentConfigurationProperty.Jsii$Proxy

Enclosing class:: CfnAIAgent

@Stability(Stable) public static interface CfnAIAgent.AIAgentConfigurationProperty extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.wisdom.*;
 Object annotations;
 Object inputSchema;
 Object outputSchema;
 AIAgentConfigurationProperty aIAgentConfigurationProperty = AIAgentConfigurationProperty.builder()
         .answerRecommendationAiAgentConfiguration(AnswerRecommendationAIAgentConfigurationProperty.builder()
                 .answerGenerationAiGuardrailId("answerGenerationAiGuardrailId")
                 .answerGenerationAiPromptId("answerGenerationAiPromptId")
                 .associationConfigurations(List.of(AssociationConfigurationProperty.builder()
                         .associationConfigurationData(AssociationConfigurationDataProperty.builder()
                                 .knowledgeBaseAssociationConfigurationData(KnowledgeBaseAssociationConfigurationDataProperty.builder()
                                         .contentTagFilter(TagFilterProperty.builder()
                                                 .andConditions(List.of(TagConditionProperty.builder()
                                                         .key("key")
                                                         // the properties below are optional
                                                         .value("value")
                                                         .build()))
                                                 .orConditions(List.of(OrConditionProperty.builder()
                                                         .andConditions(List.of(TagConditionProperty.builder()
                                                                 .key("key")
                                                                 // the properties below are optional
                                                                 .value("value")
                                                                 .build()))
                                                         .tagCondition(TagConditionProperty.builder()
                                                                 .key("key")
                                                                 // the properties below are optional
                                                                 .value("value")
                                                                 .build())
                                                         .build()))
                                                 .tagCondition(TagConditionProperty.builder()
                                                         .key("key")
                                                         // the properties below are optional
                                                         .value("value")
                                                         .build())
                                                 .build())
                                         .maxResults(123)
                                         .overrideKnowledgeBaseSearchType("overrideKnowledgeBaseSearchType")
                                         .build())
                                 .build())
                         .associationId("associationId")
                         .associationType("associationType")
                         .build()))
                 .intentLabelingGenerationAiPromptId("intentLabelingGenerationAiPromptId")
                 .locale("locale")
                 .queryReformulationAiPromptId("queryReformulationAiPromptId")
                 .build())
         .caseSummarizationAiAgentConfiguration(CaseSummarizationAIAgentConfigurationProperty.builder()
                 .caseSummarizationAiGuardrailId("caseSummarizationAiGuardrailId")
                 .caseSummarizationAiPromptId("caseSummarizationAiPromptId")
                 .locale("locale")
                 .build())
         .emailGenerativeAnswerAiAgentConfiguration(EmailGenerativeAnswerAIAgentConfigurationProperty.builder()
                 .associationConfigurations(List.of(AssociationConfigurationProperty.builder()
                         .associationConfigurationData(AssociationConfigurationDataProperty.builder()
                                 .knowledgeBaseAssociationConfigurationData(KnowledgeBaseAssociationConfigurationDataProperty.builder()
                                         .contentTagFilter(TagFilterProperty.builder()
                                                 .andConditions(List.of(TagConditionProperty.builder()
                                                         .key("key")
                                                         // the properties below are optional
                                                         .value("value")
                                                         .build()))
                                                 .orConditions(List.of(OrConditionProperty.builder()
                                                         .andConditions(List.of(TagConditionProperty.builder()
                                                                 .key("key")
                                                                 // the properties below are optional
                                                                 .value("value")
                                                                 .build()))
                                                         .tagCondition(TagConditionProperty.builder()
                                                                 .key("key")
                                                                 // the properties below are optional
                                                                 .value("value")
                                                                 .build())
                                                         .build()))
                                                 .tagCondition(TagConditionProperty.builder()
                                                         .key("key")
                                                         // the properties below are optional
                                                         .value("value")
                                                         .build())
                                                 .build())
                                         .maxResults(123)
                                         .overrideKnowledgeBaseSearchType("overrideKnowledgeBaseSearchType")
                                         .build())
                                 .build())
                         .associationId("associationId")
                         .associationType("associationType")
                         .build()))
                 .emailGenerativeAnswerAiPromptId("emailGenerativeAnswerAiPromptId")
                 .emailQueryReformulationAiPromptId("emailQueryReformulationAiPromptId")
                 .locale("locale")
                 .build())
         .emailOverviewAiAgentConfiguration(EmailOverviewAIAgentConfigurationProperty.builder()
                 .emailOverviewAiPromptId("emailOverviewAiPromptId")
                 .locale("locale")
                 .build())
         .emailResponseAiAgentConfiguration(EmailResponseAIAgentConfigurationProperty.builder()
                 .associationConfigurations(List.of(AssociationConfigurationProperty.builder()
                         .associationConfigurationData(AssociationConfigurationDataProperty.builder()
                                 .knowledgeBaseAssociationConfigurationData(KnowledgeBaseAssociationConfigurationDataProperty.builder()
                                         .contentTagFilter(TagFilterProperty.builder()
                                                 .andConditions(List.of(TagConditionProperty.builder()
                                                         .key("key")
                                                         // the properties below are optional
                                                         .value("value")
                                                         .build()))
                                                 .orConditions(List.of(OrConditionProperty.builder()
                                                         .andConditions(List.of(TagConditionProperty.builder()
                                                                 .key("key")
                                                                 // the properties below are optional
                                                                 .value("value")
                                                                 .build()))
                                                         .tagCondition(TagConditionProperty.builder()
                                                                 .key("key")
                                                                 // the properties below are optional
                                                                 .value("value")
                                                                 .build())
                                                         .build()))
                                                 .tagCondition(TagConditionProperty.builder()
                                                         .key("key")
                                                         // the properties below are optional
                                                         .value("value")
                                                         .build())
                                                 .build())
                                         .maxResults(123)
                                         .overrideKnowledgeBaseSearchType("overrideKnowledgeBaseSearchType")
                                         .build())
                                 .build())
                         .associationId("associationId")
                         .associationType("associationType")
                         .build()))
                 .emailQueryReformulationAiPromptId("emailQueryReformulationAiPromptId")
                 .emailResponseAiPromptId("emailResponseAiPromptId")
                 .locale("locale")
                 .build())
         .manualSearchAiAgentConfiguration(ManualSearchAIAgentConfigurationProperty.builder()
                 .answerGenerationAiGuardrailId("answerGenerationAiGuardrailId")
                 .answerGenerationAiPromptId("answerGenerationAiPromptId")
                 .associationConfigurations(List.of(AssociationConfigurationProperty.builder()
                         .associationConfigurationData(AssociationConfigurationDataProperty.builder()
                                 .knowledgeBaseAssociationConfigurationData(KnowledgeBaseAssociationConfigurationDataProperty.builder()
                                         .contentTagFilter(TagFilterProperty.builder()
                                                 .andConditions(List.of(TagConditionProperty.builder()
                                                         .key("key")
                                                         // the properties below are optional
                                                         .value("value")
                                                         .build()))
                                                 .orConditions(List.of(OrConditionProperty.builder()
                                                         .andConditions(List.of(TagConditionProperty.builder()
                                                                 .key("key")
                                                                 // the properties below are optional
                                                                 .value("value")
                                                                 .build()))
                                                         .tagCondition(TagConditionProperty.builder()
                                                                 .key("key")
                                                                 // the properties below are optional
                                                                 .value("value")
                                                                 .build())
                                                         .build()))
                                                 .tagCondition(TagConditionProperty.builder()
                                                         .key("key")
                                                         // the properties below are optional
                                                         .value("value")
                                                         .build())
                                                 .build())
                                         .maxResults(123)
                                         .overrideKnowledgeBaseSearchType("overrideKnowledgeBaseSearchType")
                                         .build())
                                 .build())
                         .associationId("associationId")
                         .associationType("associationType")
                         .build()))
                 .locale("locale")
                 .build())
         .noteTakingAiAgentConfiguration(NoteTakingAIAgentConfigurationProperty.builder()
                 .locale("locale")
                 .noteTakingAiGuardrailId("noteTakingAiGuardrailId")
                 .noteTakingAiPromptId("noteTakingAiPromptId")
                 .build())
         .orchestrationAiAgentConfiguration(OrchestrationAIAgentConfigurationProperty.builder()
                 .orchestrationAiPromptId("orchestrationAiPromptId")
                 // the properties below are optional
                 .connectInstanceArn("connectInstanceArn")
                 .locale("locale")
                 .orchestrationAiGuardrailId("orchestrationAiGuardrailId")
                 .toolConfigurations(List.of(ToolConfigurationProperty.builder()
                         .toolName("toolName")
                         .toolType("toolType")
                         // the properties below are optional
                         .annotations(annotations)
                         .description("description")
                         .inputSchema(inputSchema)
                         .instruction(ToolInstructionProperty.builder()
                                 .examples(List.of("examples"))
                                 .instruction("instruction")
                                 .build())
                         .outputFilters(List.of(ToolOutputFilterProperty.builder()
                                 .jsonPath("jsonPath")
                                 // the properties below are optional
                                 .outputConfiguration(ToolOutputConfigurationProperty.builder()
                                         .outputVariableNameOverride("outputVariableNameOverride")
                                         .sessionDataNamespace("sessionDataNamespace")
                                         .build())
                                 .build()))
                         .outputSchema(outputSchema)
                         .overrideInputValues(List.of(ToolOverrideInputValueProperty.builder()
                                 .jsonPath("jsonPath")
                                 .value(ToolOverrideInputValueConfigurationProperty.builder()
                                         .constant(ToolOverrideConstantInputValueProperty.builder()
                                                 .type("type")
                                                 .value("value")
                                                 .build())
                                         .build())
                                 .build()))
                         .title("title")
                         .toolId("toolId")
                         .userInteractionConfiguration(UserInteractionConfigurationProperty.builder()
                                 .isUserConfirmationRequired(false)
                                 .build())
                         .build()))
                 .build())
         .selfServiceAiAgentConfiguration(SelfServiceAIAgentConfigurationProperty.builder()
                 .associationConfigurations(List.of(AssociationConfigurationProperty.builder()
                         .associationConfigurationData(AssociationConfigurationDataProperty.builder()
                                 .knowledgeBaseAssociationConfigurationData(KnowledgeBaseAssociationConfigurationDataProperty.builder()
                                         .contentTagFilter(TagFilterProperty.builder()
                                                 .andConditions(List.of(TagConditionProperty.builder()
                                                         .key("key")
                                                         // the properties below are optional
                                                         .value("value")
                                                         .build()))
                                                 .orConditions(List.of(OrConditionProperty.builder()
                                                         .andConditions(List.of(TagConditionProperty.builder()
                                                                 .key("key")
                                                                 // the properties below are optional
                                                                 .value("value")
                                                                 .build()))
                                                         .tagCondition(TagConditionProperty.builder()
                                                                 .key("key")
                                                                 // the properties below are optional
                                                                 .value("value")
                                                                 .build())
                                                         .build()))
                                                 .tagCondition(TagConditionProperty.builder()
                                                         .key("key")
                                                         // the properties below are optional
                                                         .value("value")
                                                         .build())
                                                 .build())
                                         .maxResults(123)
                                         .overrideKnowledgeBaseSearchType("overrideKnowledgeBaseSearchType")
                                         .build())
                                 .build())
                         .associationId("associationId")
                         .associationType("associationType")
                         .build()))
                 .selfServiceAiGuardrailId("selfServiceAiGuardrailId")
                 .selfServiceAnswerGenerationAiPromptId("selfServiceAnswerGenerationAiPromptId")
                 .selfServicePreProcessingAiPromptId("selfServicePreProcessingAiPromptId")
                 .build())
         .build();

See Also:

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static final class

CfnAIAgent.AIAgentConfigurationProperty.Builder

A builder for CfnAIAgent.AIAgentConfigurationProperty

static final class

CfnAIAgent.AIAgentConfigurationProperty.Jsii$Proxy

An implementation for CfnAIAgent.AIAgentConfigurationProperty
Method Summary

Modifier and Type

Method

Description

static CfnAIAgent.AIAgentConfigurationProperty.Builder

builder()

default Object

getAnswerRecommendationAiAgentConfiguration()

The configuration for AI Agents of type ANSWER_RECOMMENDATION .

default Object

getCaseSummarizationAiAgentConfiguration()

Returns union: either IResolvable or CfnAIAgent.CaseSummarizationAIAgentConfigurationProperty

default Object

getEmailGenerativeAnswerAiAgentConfiguration()

Configuration for the EMAIL_GENERATIVE_ANSWER AI agent that provides comprehensive knowledge-based answers for customer queries.

default Object

getEmailOverviewAiAgentConfiguration()

Configuration for the EMAIL_OVERVIEW AI agent that generates structured overview of email conversations.

default Object

getEmailResponseAiAgentConfiguration()

Configuration for the EMAIL_RESPONSE AI agent that generates professional email responses using knowledge base content.

default Object

getManualSearchAiAgentConfiguration()

The configuration for AI Agents of type MANUAL_SEARCH .

default Object

getNoteTakingAiAgentConfiguration()

Returns union: either IResolvable or CfnAIAgent.NoteTakingAIAgentConfigurationProperty

default Object

getOrchestrationAiAgentConfiguration()

Returns union: either IResolvable or CfnAIAgent.OrchestrationAIAgentConfigurationProperty

default Object

getSelfServiceAiAgentConfiguration()

The self-service AI agent configuration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

Method Details
- getAnswerRecommendationAiAgentConfiguration
  
  @Stability(Stable) @Nullable default Object getAnswerRecommendationAiAgentConfiguration()
  
  The configuration for AI Agents of type ANSWER_RECOMMENDATION .
  Returns union: either IResolvable or CfnAIAgent.AnswerRecommendationAIAgentConfigurationProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-aiagentconfiguration.html#cfn-wisdom-aiagent-aiagentconfiguration-answerrecommendationaiagentconfiguration
- getCaseSummarizationAiAgentConfiguration
  
  @Stability(Stable) @Nullable default Object getCaseSummarizationAiAgentConfiguration()
  
  Returns union: either IResolvable or CfnAIAgent.CaseSummarizationAIAgentConfigurationProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-aiagentconfiguration.html#cfn-wisdom-aiagent-aiagentconfiguration-casesummarizationaiagentconfiguration
- getEmailGenerativeAnswerAiAgentConfiguration
  
  @Stability(Stable) @Nullable default Object getEmailGenerativeAnswerAiAgentConfiguration()
  
  Configuration for the EMAIL_GENERATIVE_ANSWER AI agent that provides comprehensive knowledge-based answers for customer queries.
  Returns union: either IResolvable or CfnAIAgent.EmailGenerativeAnswerAIAgentConfigurationProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-aiagentconfiguration.html#cfn-wisdom-aiagent-aiagentconfiguration-emailgenerativeansweraiagentconfiguration
- getEmailOverviewAiAgentConfiguration
  
  @Stability(Stable) @Nullable default Object getEmailOverviewAiAgentConfiguration()
  
  Configuration for the EMAIL_OVERVIEW AI agent that generates structured overview of email conversations.
  Returns union: either IResolvable or CfnAIAgent.EmailOverviewAIAgentConfigurationProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-aiagentconfiguration.html#cfn-wisdom-aiagent-aiagentconfiguration-emailoverviewaiagentconfiguration
- getEmailResponseAiAgentConfiguration
  
  @Stability(Stable) @Nullable default Object getEmailResponseAiAgentConfiguration()
  
  Configuration for the EMAIL_RESPONSE AI agent that generates professional email responses using knowledge base content.
  Returns union: either IResolvable or CfnAIAgent.EmailResponseAIAgentConfigurationProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-aiagentconfiguration.html#cfn-wisdom-aiagent-aiagentconfiguration-emailresponseaiagentconfiguration
- getManualSearchAiAgentConfiguration
  
  @Stability(Stable) @Nullable default Object getManualSearchAiAgentConfiguration()
  
  The configuration for AI Agents of type MANUAL_SEARCH .
  Returns union: either IResolvable or CfnAIAgent.ManualSearchAIAgentConfigurationProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-aiagentconfiguration.html#cfn-wisdom-aiagent-aiagentconfiguration-manualsearchaiagentconfiguration
- getNoteTakingAiAgentConfiguration
  
  @Stability(Stable) @Nullable default Object getNoteTakingAiAgentConfiguration()
  
  Returns union: either IResolvable or CfnAIAgent.NoteTakingAIAgentConfigurationProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-aiagentconfiguration.html#cfn-wisdom-aiagent-aiagentconfiguration-notetakingaiagentconfiguration
- getOrchestrationAiAgentConfiguration
  
  @Stability(Stable) @Nullable default Object getOrchestrationAiAgentConfiguration()
  
  Returns union: either IResolvable or CfnAIAgent.OrchestrationAIAgentConfigurationProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-aiagentconfiguration.html#cfn-wisdom-aiagent-aiagentconfiguration-orchestrationaiagentconfiguration
- getSelfServiceAiAgentConfiguration
  
  @Stability(Stable) @Nullable default Object getSelfServiceAiAgentConfiguration()
  
  The self-service AI agent configuration.
  Returns union: either IResolvable or CfnAIAgent.SelfServiceAIAgentConfigurationProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-aiagentconfiguration.html#cfn-wisdom-aiagent-aiagentconfiguration-selfserviceaiagentconfiguration
- builder
  
  @Stability(Stable) static CfnAIAgent.AIAgentConfigurationProperty.Builder builder()
  
  Returns:
  
  a CfnAIAgent.AIAgentConfigurationProperty.Builder of CfnAIAgent.AIAgentConfigurationProperty

Interface CfnAIAgent.AIAgentConfigurationProperty

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Details

getAnswerRecommendationAiAgentConfiguration

getCaseSummarizationAiAgentConfiguration

getEmailGenerativeAnswerAiAgentConfiguration

getEmailOverviewAiAgentConfiguration

getEmailResponseAiAgentConfiguration

getManualSearchAiAgentConfiguration

getNoteTakingAiAgentConfiguration

getOrchestrationAiAgentConfiguration

getSelfServiceAiAgentConfiguration

builder