CfnAIAgentMixinProps
- class aws_cdk.mixins_preview.aws_wisdom.mixins.CfnAIAgentMixinProps(*, assistant_id=None, configuration=None, description=None, name=None, tags=None, type=None)
Bases:
objectProperties for CfnAIAgentPropsMixin.
- Parameters:
assistant_id (
Optional[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],None]) – Configuration for 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.type (
Optional[str]) – The type of the AI Agent.
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiagent.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.mixins_preview.aws_wisdom import mixins as wisdom_mixins # annotations: Any # input_schema: Any # output_schema: Any cfn_aIAgent_mixin_props = wisdom_mixins.CfnAIAgentMixinProps( assistant_id="assistantId", configuration=wisdom_mixins.CfnAIAgentPropsMixin.AIAgentConfigurationProperty( answer_recommendation_ai_agent_configuration=wisdom_mixins.CfnAIAgentPropsMixin.AnswerRecommendationAIAgentConfigurationProperty( answer_generation_ai_guardrail_id="answerGenerationAiGuardrailId", answer_generation_ai_prompt_id="answerGenerationAiPromptId", association_configurations=[wisdom_mixins.CfnAIAgentPropsMixin.AssociationConfigurationProperty( association_configuration_data=wisdom_mixins.CfnAIAgentPropsMixin.AssociationConfigurationDataProperty( knowledge_base_association_configuration_data=wisdom_mixins.CfnAIAgentPropsMixin.KnowledgeBaseAssociationConfigurationDataProperty( content_tag_filter=wisdom_mixins.CfnAIAgentPropsMixin.TagFilterProperty( and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty( key="key", value="value" )], or_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.OrConditionProperty( and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty( key="key", value="value" )], tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty( key="key", value="value" ) )], tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty( key="key", value="value" ) ), max_results=123, override_knowledge_base_search_type="overrideKnowledgeBaseSearchType" ) ), association_id="associationId", association_type="associationType" )], intent_labeling_generation_ai_prompt_id="intentLabelingGenerationAiPromptId", locale="locale", query_reformulation_ai_prompt_id="queryReformulationAiPromptId" ), case_summarization_ai_agent_configuration=wisdom_mixins.CfnAIAgentPropsMixin.CaseSummarizationAIAgentConfigurationProperty( case_summarization_ai_guardrail_id="caseSummarizationAiGuardrailId", case_summarization_ai_prompt_id="caseSummarizationAiPromptId", locale="locale" ), email_generative_answer_ai_agent_configuration=wisdom_mixins.CfnAIAgentPropsMixin.EmailGenerativeAnswerAIAgentConfigurationProperty( association_configurations=[wisdom_mixins.CfnAIAgentPropsMixin.AssociationConfigurationProperty( association_configuration_data=wisdom_mixins.CfnAIAgentPropsMixin.AssociationConfigurationDataProperty( knowledge_base_association_configuration_data=wisdom_mixins.CfnAIAgentPropsMixin.KnowledgeBaseAssociationConfigurationDataProperty( content_tag_filter=wisdom_mixins.CfnAIAgentPropsMixin.TagFilterProperty( and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty( key="key", value="value" )], or_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.OrConditionProperty( and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty( key="key", value="value" )], tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty( key="key", value="value" ) )], tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty( key="key", value="value" ) ), max_results=123, override_knowledge_base_search_type="overrideKnowledgeBaseSearchType" ) ), association_id="associationId", association_type="associationType" )], email_generative_answer_ai_prompt_id="emailGenerativeAnswerAiPromptId", email_query_reformulation_ai_prompt_id="emailQueryReformulationAiPromptId", locale="locale" ), email_overview_ai_agent_configuration=wisdom_mixins.CfnAIAgentPropsMixin.EmailOverviewAIAgentConfigurationProperty( email_overview_ai_prompt_id="emailOverviewAiPromptId", locale="locale" ), email_response_ai_agent_configuration=wisdom_mixins.CfnAIAgentPropsMixin.EmailResponseAIAgentConfigurationProperty( association_configurations=[wisdom_mixins.CfnAIAgentPropsMixin.AssociationConfigurationProperty( association_configuration_data=wisdom_mixins.CfnAIAgentPropsMixin.AssociationConfigurationDataProperty( knowledge_base_association_configuration_data=wisdom_mixins.CfnAIAgentPropsMixin.KnowledgeBaseAssociationConfigurationDataProperty( content_tag_filter=wisdom_mixins.CfnAIAgentPropsMixin.TagFilterProperty( and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty( key="key", value="value" )], or_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.OrConditionProperty( and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty( key="key", value="value" )], tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty( key="key", value="value" ) )], tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty( key="key", value="value" ) ), max_results=123, override_knowledge_base_search_type="overrideKnowledgeBaseSearchType" ) ), association_id="associationId", association_type="associationType" )], email_query_reformulation_ai_prompt_id="emailQueryReformulationAiPromptId", email_response_ai_prompt_id="emailResponseAiPromptId", locale="locale" ), manual_search_ai_agent_configuration=wisdom_mixins.CfnAIAgentPropsMixin.ManualSearchAIAgentConfigurationProperty( answer_generation_ai_guardrail_id="answerGenerationAiGuardrailId", answer_generation_ai_prompt_id="answerGenerationAiPromptId", association_configurations=[wisdom_mixins.CfnAIAgentPropsMixin.AssociationConfigurationProperty( association_configuration_data=wisdom_mixins.CfnAIAgentPropsMixin.AssociationConfigurationDataProperty( knowledge_base_association_configuration_data=wisdom_mixins.CfnAIAgentPropsMixin.KnowledgeBaseAssociationConfigurationDataProperty( content_tag_filter=wisdom_mixins.CfnAIAgentPropsMixin.TagFilterProperty( and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty( key="key", value="value" )], or_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.OrConditionProperty( and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty( key="key", value="value" )], tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty( key="key", value="value" ) )], tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty( key="key", value="value" ) ), max_results=123, override_knowledge_base_search_type="overrideKnowledgeBaseSearchType" ) ), association_id="associationId", association_type="associationType" )], locale="locale" ), note_taking_ai_agent_configuration=wisdom_mixins.CfnAIAgentPropsMixin.NoteTakingAIAgentConfigurationProperty( locale="locale", note_taking_ai_guardrail_id="noteTakingAiGuardrailId", note_taking_ai_prompt_id="noteTakingAiPromptId" ), orchestration_ai_agent_configuration=wisdom_mixins.CfnAIAgentPropsMixin.OrchestrationAIAgentConfigurationProperty( connect_instance_arn="connectInstanceArn", locale="locale", orchestration_ai_guardrail_id="orchestrationAiGuardrailId", orchestration_ai_prompt_id="orchestrationAiPromptId", tool_configurations=[wisdom_mixins.CfnAIAgentPropsMixin.ToolConfigurationProperty( annotations=annotations, description="description", input_schema=input_schema, instruction=wisdom_mixins.CfnAIAgentPropsMixin.ToolInstructionProperty( examples=["examples"], instruction="instruction" ), output_filters=[wisdom_mixins.CfnAIAgentPropsMixin.ToolOutputFilterProperty( json_path="jsonPath", output_configuration=wisdom_mixins.CfnAIAgentPropsMixin.ToolOutputConfigurationProperty( output_variable_name_override="outputVariableNameOverride", session_data_namespace="sessionDataNamespace" ) )], output_schema=output_schema, override_input_values=[wisdom_mixins.CfnAIAgentPropsMixin.ToolOverrideInputValueProperty( json_path="jsonPath", value=wisdom_mixins.CfnAIAgentPropsMixin.ToolOverrideInputValueConfigurationProperty( constant=wisdom_mixins.CfnAIAgentPropsMixin.ToolOverrideConstantInputValueProperty( type="type", value="value" ) ) )], title="title", tool_id="toolId", tool_name="toolName", tool_type="toolType", user_interaction_configuration=wisdom_mixins.CfnAIAgentPropsMixin.UserInteractionConfigurationProperty( is_user_confirmation_required=False ) )] ), self_service_ai_agent_configuration=wisdom_mixins.CfnAIAgentPropsMixin.SelfServiceAIAgentConfigurationProperty( association_configurations=[wisdom_mixins.CfnAIAgentPropsMixin.AssociationConfigurationProperty( association_configuration_data=wisdom_mixins.CfnAIAgentPropsMixin.AssociationConfigurationDataProperty( knowledge_base_association_configuration_data=wisdom_mixins.CfnAIAgentPropsMixin.KnowledgeBaseAssociationConfigurationDataProperty( content_tag_filter=wisdom_mixins.CfnAIAgentPropsMixin.TagFilterProperty( and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty( key="key", value="value" )], or_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.OrConditionProperty( and_conditions=[wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty( key="key", value="value" )], tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty( key="key", value="value" ) )], tag_condition=wisdom_mixins.CfnAIAgentPropsMixin.TagConditionProperty( key="key", value="value" ) ), max_results=123, override_knowledge_base_search_type="overrideKnowledgeBaseSearchType" ) ), association_id="associationId", association_type="associationType" )], self_service_ai_guardrail_id="selfServiceAiGuardrailId", self_service_answer_generation_ai_prompt_id="selfServiceAnswerGenerationAiPromptId", self_service_pre_processing_ai_prompt_id="selfServicePreProcessingAiPromptId" ) ), description="description", name="name", tags={ "tags_key": "tags" }, type="type" )
Attributes
- assistant_id
The identifier of the Amazon Q in Connect assistant.
Can be either the ID or the ARN. URLs cannot contain the ARN.
- configuration
Configuration for the AI Agent.
- description
The description of the AI Agent.
- name
The name of the AI Agent.
- tags
The tags used to organize, track, or control access for this resource.
- type
The type of the AI Agent.