2026/09/18 - Amazon Q Connect - 10 updated api methods
Changes Amazon Connect AI Agents now support multi-agent orchestration and structured JSON input and output messaging for orchestration agents.
{'configuration': {'orchestrationAIAgentConfiguration': {'inputSchemas': [{}],
'multiAgentConfigurations': [{'delegateAgentConfiguration': {'agentTarget': {'aiAgentId': 'string',
'applicationId': 'string'},
'instruction': {'examples': ['string'],
'instruction': 'string'}},
'handoffAgentConfiguration': {'agentTarget': {'aiAgentId': 'string',
'applicationId': 'string'},
'audioStreamingEnabled': 'boolean',
'immediateHandoff': 'boolean',
'instruction': {'examples': ['string'],
'instruction': 'string'}}}],
'outputSchemas': [{}]}}}
Response {'aiAgent': {'configuration': {'orchestrationAIAgentConfiguration': {'inputSchemas': [{}],
'multiAgentConfigurations': [{'delegateAgentConfiguration': {'agentTarget': {'aiAgentId': 'string',
'applicationId': 'string'},
'instruction': {'examples': ['string'],
'instruction': 'string'}},
'handoffAgentConfiguration': {'agentTarget': {'aiAgentId': 'string',
'applicationId': 'string'},
'audioStreamingEnabled': 'boolean',
'immediateHandoff': 'boolean',
'instruction': {'examples': ['string'],
'instruction': 'string'}}}],
'outputSchemas': [{}]}}}}
Creates an Amazon Q in Connect AI Agent.
See also: AWS API Documentation
Request Syntax
client.create_ai_agent(
clientToken='string',
assistantId='string',
name='string',
type='MANUAL_SEARCH'|'ANSWER_RECOMMENDATION'|'SELF_SERVICE'|'EMAIL_RESPONSE'|'EMAIL_OVERVIEW'|'EMAIL_GENERATIVE_ANSWER'|'ORCHESTRATION'|'NOTE_TAKING'|'CASE_SUMMARIZATION',
configuration={
'manualSearchAIAgentConfiguration': {
'answerGenerationAIPromptId': 'string',
'answerGenerationAIGuardrailId': 'string',
'associationConfigurations': [
{
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE',
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'tagCondition': {
'key': 'string',
'value': 'string'
},
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
]
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
}
},
],
'locale': 'string'
},
'answerRecommendationAIAgentConfiguration': {
'intentLabelingGenerationAIPromptId': 'string',
'queryReformulationAIPromptId': 'string',
'answerGenerationAIPromptId': 'string',
'answerGenerationAIGuardrailId': 'string',
'associationConfigurations': [
{
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE',
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'tagCondition': {
'key': 'string',
'value': 'string'
},
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
]
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
}
},
],
'locale': 'string',
'suggestedMessages': [
'string',
]
},
'selfServiceAIAgentConfiguration': {
'selfServicePreProcessingAIPromptId': 'string',
'selfServiceAnswerGenerationAIPromptId': 'string',
'selfServiceAIGuardrailId': 'string',
'associationConfigurations': [
{
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE',
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'tagCondition': {
'key': 'string',
'value': 'string'
},
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
]
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
}
},
]
},
'emailResponseAIAgentConfiguration': {
'emailResponseAIPromptId': 'string',
'emailQueryReformulationAIPromptId': 'string',
'locale': 'string',
'associationConfigurations': [
{
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE',
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'tagCondition': {
'key': 'string',
'value': 'string'
},
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
]
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
}
},
]
},
'emailOverviewAIAgentConfiguration': {
'emailOverviewAIPromptId': 'string',
'locale': 'string'
},
'emailGenerativeAnswerAIAgentConfiguration': {
'emailGenerativeAnswerAIPromptId': 'string',
'emailQueryReformulationAIPromptId': 'string',
'locale': 'string',
'associationConfigurations': [
{
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE',
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'tagCondition': {
'key': 'string',
'value': 'string'
},
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
]
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
}
},
]
},
'orchestrationAIAgentConfiguration': {
'orchestrationAIPromptId': 'string',
'orchestrationAIGuardrailId': 'string',
'toolConfigurations': [
{
'toolName': 'string',
'toolType': 'MODEL_CONTEXT_PROTOCOL'|'RETURN_TO_CONTROL'|'CONSTANT',
'title': 'string',
'toolId': 'string',
'description': 'string',
'instruction': {
'instruction': 'string',
'examples': [
'string',
]
},
'overrideInputValues': [
{
'jsonPath': 'string',
'value': {
'constant': {
'type': 'STRING'|'NUMBER'|'JSON_STRING',
'value': 'string'
}
}
},
],
'outputFilters': [
{
'jsonPath': 'string',
'outputConfiguration': {
'outputVariableNameOverride': 'string',
'sessionDataNamespace': 'string'
}
},
],
'inputSchema': {...}|[...]|123|123.4|'string'|True|None,
'outputSchema': {...}|[...]|123|123.4|'string'|True|None,
'annotations': {
'title': 'string',
'destructiveHint': True|False
},
'userInteractionConfiguration': {
'isUserConfirmationRequired': True|False
}
},
],
'multiAgentConfigurations': [
{
'delegateAgentConfiguration': {
'agentTarget': {
'aiAgentId': 'string',
'applicationId': 'string'
},
'instruction': {
'instruction': 'string',
'examples': [
'string',
]
}
},
'handoffAgentConfiguration': {
'agentTarget': {
'aiAgentId': 'string',
'applicationId': 'string'
},
'instruction': {
'instruction': 'string',
'examples': [
'string',
]
},
'audioStreamingEnabled': True|False,
'immediateHandoff': True|False
}
},
],
'connectInstanceArn': 'string',
'locale': 'string',
'inputSchemas': [
{...}|[...]|123|123.4|'string'|True|None,
],
'outputSchemas': [
{...}|[...]|123|123.4|'string'|True|None,
]
},
'noteTakingAIAgentConfiguration': {
'noteTakingAIPromptId': 'string',
'noteTakingAIGuardrailId': 'string',
'locale': 'string'
},
'caseSummarizationAIAgentConfiguration': {
'caseSummarizationAIPromptId': 'string',
'caseSummarizationAIGuardrailId': 'string',
'locale': 'string'
}
},
visibilityStatus='SAVED'|'PUBLISHED',
tags={
'string': 'string'
},
description='string'
)
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..
This field is autopopulated if not provided.
string
[REQUIRED]
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
string
[REQUIRED]
The name of the AI Agent.
string
[REQUIRED]
The type of the AI Agent.
dict
[REQUIRED]
The configuration of the AI Agent.
manualSearchAIAgentConfiguration (dict) --
The configuration for AI Agents of type MANUAL_SEARCH.
answerGenerationAIPromptId (string) --
The AI Prompt identifier for the Answer Generation prompt used by the MANUAL_SEARCH AI Agent.
answerGenerationAIGuardrailId (string) --
The AI Guardrail identifier for the Answer Generation guardrail used by the MANUAL_SEARCH AI Agent.
associationConfigurations (list) --
The association configurations for overriding behavior on this AI Agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
associationConfigurationData (dict) --
The data of the configuration for an Amazon Q in Connect Assistant Association.
knowledgeBaseAssociationConfigurationData (dict) --
The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
contentTagFilter (dict) --
An object that can be used to specify Tag conditions.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) -- [REQUIRED]
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) -- [REQUIRED]
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
orConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
A list of conditions which would be applied together with an OR condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) -- [REQUIRED]
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) -- [REQUIRED]
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
maxResults (integer) --
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) --
The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text
locale (string) --
The locale to which specifies the language and region settings that determine the response language for QueryAssistant.
answerRecommendationAIAgentConfiguration (dict) --
The configuration for AI Agents of type ANSWER_RECOMMENDATION.
intentLabelingGenerationAIPromptId (string) --
The AI Prompt identifier for the Intent Labeling prompt used by the ANSWER_RECOMMENDATION AI Agent.
queryReformulationAIPromptId (string) --
The AI Prompt identifier for the Query Reformulation prompt used by the ANSWER_RECOMMENDATION AI Agent.
answerGenerationAIPromptId (string) --
The AI Prompt identifier for the Answer Generation prompt used by the ANSWER_RECOMMENDATION AI Agent.
answerGenerationAIGuardrailId (string) --
The AI Guardrail identifier for the Answer Generation Guardrail used by the ANSWER_RECOMMENDATION AI Agent.
associationConfigurations (list) --
The association configurations for overriding behavior on this AI Agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
associationConfigurationData (dict) --
The data of the configuration for an Amazon Q in Connect Assistant Association.
knowledgeBaseAssociationConfigurationData (dict) --
The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
contentTagFilter (dict) --
An object that can be used to specify Tag conditions.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) -- [REQUIRED]
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) -- [REQUIRED]
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
orConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
A list of conditions which would be applied together with an OR condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) -- [REQUIRED]
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) -- [REQUIRED]
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
maxResults (integer) --
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) --
The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text
locale (string) --
The locale to which specifies the language and region settings that determine the response language for QueryAssistant.
suggestedMessages (list) --
The suggested messages configuration for the Answer Recommendation AI Agent.
(string) --
selfServiceAIAgentConfiguration (dict) --
The configuration for AI Agents of type SELF_SERVICE.
selfServicePreProcessingAIPromptId (string) --
The AI Prompt identifier for the Self Service Pre-Processing prompt used by the SELF_SERVICE AI Agent
selfServiceAnswerGenerationAIPromptId (string) --
The AI Prompt identifier for the Self Service Answer Generation prompt used by the SELF_SERVICE AI Agent
selfServiceAIGuardrailId (string) --
The AI Guardrail identifier used by the SELF_SERVICE AI Agent.
associationConfigurations (list) --
The association configurations for overriding behavior on this AI Agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
associationConfigurationData (dict) --
The data of the configuration for an Amazon Q in Connect Assistant Association.
knowledgeBaseAssociationConfigurationData (dict) --
The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
contentTagFilter (dict) --
An object that can be used to specify Tag conditions.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) -- [REQUIRED]
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) -- [REQUIRED]
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
orConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
A list of conditions which would be applied together with an OR condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) -- [REQUIRED]
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) -- [REQUIRED]
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
maxResults (integer) --
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) --
The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text
emailResponseAIAgentConfiguration (dict) --
Configuration for the EMAIL_RESPONSE AI agent that generates professional email responses using knowledge base content.
emailResponseAIPromptId (string) --
The ID of the System AI prompt used for generating professional email responses based on knowledge base content.
emailQueryReformulationAIPromptId (string) --
The ID of the System AI prompt used for reformulating email queries to optimize knowledge base search for response generation.
locale (string) --
The locale setting for language-specific email response generation (for example, en_US, es_ES).
associationConfigurations (list) --
Configuration settings for knowledge base associations used by the email response agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
associationConfigurationData (dict) --
The data of the configuration for an Amazon Q in Connect Assistant Association.
knowledgeBaseAssociationConfigurationData (dict) --
The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
contentTagFilter (dict) --
An object that can be used to specify Tag conditions.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) -- [REQUIRED]
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) -- [REQUIRED]
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
orConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
A list of conditions which would be applied together with an OR condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) -- [REQUIRED]
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) -- [REQUIRED]
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
maxResults (integer) --
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) --
The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text
emailOverviewAIAgentConfiguration (dict) --
Configuration for the EMAIL_OVERVIEW AI agent that generates structured overview of email conversations.
emailOverviewAIPromptId (string) --
The ID of the System AI prompt used for generating structured email conversation summaries.
locale (string) --
The locale setting for language-specific email overview processing (for example, en_US, es_ES).
emailGenerativeAnswerAIAgentConfiguration (dict) --
Configuration for the EMAIL_GENERATIVE_ANSWER AI agent that provides comprehensive knowledge-based answers for customer queries.
emailGenerativeAnswerAIPromptId (string) --
The ID of the System AI prompt used for generating comprehensive knowledge-based answers from email queries.
emailQueryReformulationAIPromptId (string) --
The ID of the System AI prompt used for reformulating email queries to optimize knowledge base search results.
locale (string) --
The locale setting for language-specific email processing and response generation (for example, en_US, es_ES).
associationConfigurations (list) --
Configuration settings for knowledge base associations used by the email generative answer agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
associationConfigurationData (dict) --
The data of the configuration for an Amazon Q in Connect Assistant Association.
knowledgeBaseAssociationConfigurationData (dict) --
The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
contentTagFilter (dict) --
An object that can be used to specify Tag conditions.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) -- [REQUIRED]
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) -- [REQUIRED]
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
orConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
A list of conditions which would be applied together with an OR condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) -- [REQUIRED]
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) -- [REQUIRED]
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
maxResults (integer) --
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) --
The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text
orchestrationAIAgentConfiguration (dict) --
The configuration for AI Agents of type ORCHESTRATION.
orchestrationAIPromptId (string) --
The AI Prompt identifier used by the Orchestration AI Agent.
orchestrationAIGuardrailId (string) --
The AI Guardrail identifier used by the Orchestration AI Agent.
toolConfigurations (list) --
The tool configurations used by the Orchestration AI Agent.
(dict) --
Configuration settings for a tool used by AI Agents.
toolName (string) -- [REQUIRED]
The name of the tool.
toolType (string) -- [REQUIRED]
The type of the tool.
title (string) --
The title of the tool configuration.
toolId (string) --
The identifier of the tool, for example toolName from Model Context Provider server.
description (string) --
The description of the tool configuration.
instruction (dict) --
Instructions for using the tool.
instruction (string) --
The instruction text for the tool.
examples (list) --
Examples for using the tool.
(string) --
overrideInputValues (list) --
Override input values for the tool configuration.
(dict) --
An input value override for tools.
jsonPath (string) -- [REQUIRED]
The JSON path for the input value override.
value (dict) -- [REQUIRED]
The override input value.
constant (dict) --
Constant input value configuration for tool override.
type (string) -- [REQUIRED]
Override tool input value with constant values
value (string) -- [REQUIRED]
The constant input override value.
outputFilters (list) --
Output filters applies to the tool result.
(dict) --
Filter configuration for tool output.
jsonPath (string) -- [REQUIRED]
The JSON path for filtering tool output.
outputConfiguration (dict) --
The output configuration for the filter.
outputVariableNameOverride (string) --
Override the tool output results to different variable name.
sessionDataNamespace (string) --
The session data namespace for tool output.
inputSchema (:ref:`document<document>`) --
The input schema for the tool configuration.
outputSchema (:ref:`document<document>`) --
The output schema for the tool configuration.
annotations (dict) --
Annotations for the tool configuration.
title (string) --
The title of the annotation.
destructiveHint (boolean) --
A hint indicating that the annotation contains potentially destructive content.
userInteractionConfiguration (dict) --
Configuration for user interaction with the tool.
isUserConfirmationRequired (boolean) --
Indicates whether user confirmation is required for the interaction.
multiAgentConfigurations (list) --
The collaborator agents that the Orchestration AI Agent can work with. Each entry defines another agent that the orchestrator either delegates to or hands the conversation off to.
(dict) --
A union that configures a single collaborator agent for an Orchestration AI Agent, as either a delegate or a handoff.
delegateAgentConfiguration (dict) --
Configures the collaborator agent as a delegate that the Orchestration AI Agent invokes while retaining control of the conversation.
agentTarget (dict) -- [REQUIRED]
The collaborator agent to delegate to.
aiAgentId (string) --
The identifier of an Amazon Connect AI Agent to use as the collaborator agent.
applicationId (string) --
The identifier of a third-party agent to use as the collaborator agent.
instruction (dict) --
The instruction that tells the Orchestration AI Agent when and how to delegate to this collaborator agent.
instruction (string) --
The natural-language instruction that tells the Orchestration AI Agent when and how to engage the collaborator agent.
examples (list) --
Example interactions that illustrate when the Orchestration AI Agent should engage the collaborator agent.
(string) --
handoffAgentConfiguration (dict) --
Configures the collaborator agent as a handoff target that the Orchestration AI Agent transfers control of the conversation to.
agentTarget (dict) -- [REQUIRED]
The collaborator agent to hand off to.
aiAgentId (string) --
The identifier of an Amazon Connect AI Agent to use as the collaborator agent.
applicationId (string) --
The identifier of a third-party agent to use as the collaborator agent.
instruction (dict) --
The instruction that tells the Orchestration AI Agent when and how to hand off to this collaborator agent.
instruction (string) --
The natural-language instruction that tells the Orchestration AI Agent when and how to engage the collaborator agent.
examples (list) --
Example interactions that illustrate when the Orchestration AI Agent should engage the collaborator agent.
(string) --
audioStreamingEnabled (boolean) --
Specifies whether the caller's audio is streamed directly to the collaborator agent and the collaborator's audio response is played back during the handoff. This applies only to voice handoffs.
immediateHandoff (boolean) --
Specifies whether the conversation is handed off to this collaborator agent immediately on the first turn, without any orchestration reasoning. At most one handoff in an AI Agent's configuration can set this to true.
connectInstanceArn (string) --
The Amazon Resource Name (ARN) of the Amazon Connect instance used by the Orchestration AI Agent.
locale (string) --
The locale setting for the Orchestration AI Agent.
inputSchemas (list) --
The JSON schemas that define the structure of the structured data input accepted by the Orchestration AI Agent. The data in a DATA message sent to the agent is validated against these schemas. You can specify at most one schema.
(:ref:`document<document>`) --
outputSchemas (list) --
The JSON schemas that define the structure of the structured output generated by the Orchestration AI Agent. You can specify at most one schema.
(:ref:`document<document>`) --
noteTakingAIAgentConfiguration (dict) --
The configuration for AI Agents of type NOTE_TAKING.
noteTakingAIPromptId (string) --
The AI Prompt identifier used by the Note Taking AI Agent.
noteTakingAIGuardrailId (string) --
The AI Guardrail identifier used by the Note Taking AI Agent.
locale (string) --
The locale setting for language-specific case summarization generation (for example, en_US, es_ES).
caseSummarizationAIAgentConfiguration (dict) --
The configuration for AI Agents of type CASE_SUMMARIZATION.
caseSummarizationAIPromptId (string) --
The AI Prompt identifier used by the Case Summarization AI Agent.
caseSummarizationAIGuardrailId (string) --
The AI Guardrail identifier used by the Case Summarization AI Agent.
locale (string) --
The locale setting for the Case Summarization AI Agent.
string
[REQUIRED]
The visibility status of the AI Agent.
dict
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
string
The description of the AI Agent.
dict
Response Syntax
{
'aiAgent': {
'assistantId': 'string',
'assistantArn': 'string',
'aiAgentId': 'string',
'aiAgentArn': 'string',
'name': 'string',
'type': 'MANUAL_SEARCH'|'ANSWER_RECOMMENDATION'|'SELF_SERVICE'|'EMAIL_RESPONSE'|'EMAIL_OVERVIEW'|'EMAIL_GENERATIVE_ANSWER'|'ORCHESTRATION'|'NOTE_TAKING'|'CASE_SUMMARIZATION',
'configuration': {
'manualSearchAIAgentConfiguration': {
'answerGenerationAIPromptId': 'string',
'answerGenerationAIGuardrailId': 'string',
'associationConfigurations': [
{
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE',
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'tagCondition': {
'key': 'string',
'value': 'string'
},
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
]
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
}
},
],
'locale': 'string'
},
'answerRecommendationAIAgentConfiguration': {
'intentLabelingGenerationAIPromptId': 'string',
'queryReformulationAIPromptId': 'string',
'answerGenerationAIPromptId': 'string',
'answerGenerationAIGuardrailId': 'string',
'associationConfigurations': [
{
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE',
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'tagCondition': {
'key': 'string',
'value': 'string'
},
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
]
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
}
},
],
'locale': 'string',
'suggestedMessages': [
'string',
]
},
'selfServiceAIAgentConfiguration': {
'selfServicePreProcessingAIPromptId': 'string',
'selfServiceAnswerGenerationAIPromptId': 'string',
'selfServiceAIGuardrailId': 'string',
'associationConfigurations': [
{
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE',
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'tagCondition': {
'key': 'string',
'value': 'string'
},
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
]
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
}
},
]
},
'emailResponseAIAgentConfiguration': {
'emailResponseAIPromptId': 'string',
'emailQueryReformulationAIPromptId': 'string',
'locale': 'string',
'associationConfigurations': [
{
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE',
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'tagCondition': {
'key': 'string',
'value': 'string'
},
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
]
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
}
},
]
},
'emailOverviewAIAgentConfiguration': {
'emailOverviewAIPromptId': 'string',
'locale': 'string'
},
'emailGenerativeAnswerAIAgentConfiguration': {
'emailGenerativeAnswerAIPromptId': 'string',
'emailQueryReformulationAIPromptId': 'string',
'locale': 'string',
'associationConfigurations': [
{
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE',
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'tagCondition': {
'key': 'string',
'value': 'string'
},
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
]
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
}
},
]
},
'orchestrationAIAgentConfiguration': {
'orchestrationAIPromptId': 'string',
'orchestrationAIGuardrailId': 'string',
'toolConfigurations': [
{
'toolName': 'string',
'toolType': 'MODEL_CONTEXT_PROTOCOL'|'RETURN_TO_CONTROL'|'CONSTANT',
'title': 'string',
'toolId': 'string',
'description': 'string',
'instruction': {
'instruction': 'string',
'examples': [
'string',
]
},
'overrideInputValues': [
{
'jsonPath': 'string',
'value': {
'constant': {
'type': 'STRING'|'NUMBER'|'JSON_STRING',
'value': 'string'
}
}
},
],
'outputFilters': [
{
'jsonPath': 'string',
'outputConfiguration': {
'outputVariableNameOverride': 'string',
'sessionDataNamespace': 'string'
}
},
],
'inputSchema': {...}|[...]|123|123.4|'string'|True|None,
'outputSchema': {...}|[...]|123|123.4|'string'|True|None,
'annotations': {
'title': 'string',
'destructiveHint': True|False
},
'userInteractionConfiguration': {
'isUserConfirmationRequired': True|False
}
},
],
'multiAgentConfigurations': [
{
'delegateAgentConfiguration': {
'agentTarget': {
'aiAgentId': 'string',
'applicationId': 'string'
},
'instruction': {
'instruction': 'string',
'examples': [
'string',
]
}
},
'handoffAgentConfiguration': {
'agentTarget': {
'aiAgentId': 'string',
'applicationId': 'string'
},
'instruction': {
'instruction': 'string',
'examples': [
'string',
]
},
'audioStreamingEnabled': True|False,
'immediateHandoff': True|False
}
},
],
'connectInstanceArn': 'string',
'locale': 'string',
'inputSchemas': [
{...}|[...]|123|123.4|'string'|True|None,
],
'outputSchemas': [
{...}|[...]|123|123.4|'string'|True|None,
]
},
'noteTakingAIAgentConfiguration': {
'noteTakingAIPromptId': 'string',
'noteTakingAIGuardrailId': 'string',
'locale': 'string'
},
'caseSummarizationAIAgentConfiguration': {
'caseSummarizationAIPromptId': 'string',
'caseSummarizationAIGuardrailId': 'string',
'locale': 'string'
}
},
'modifiedTime': datetime(2015, 1, 1),
'description': 'string',
'visibilityStatus': 'SAVED'|'PUBLISHED',
'tags': {
'string': 'string'
},
'origin': 'SYSTEM'|'CUSTOMER',
'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'
}
}
Response Structure
(dict) --
aiAgent (dict) --
The data of the created AI Agent.
assistantId (string) --
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
assistantArn (string) --
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
aiAgentId (string) --
The identifier of the AI Agent.
aiAgentArn (string) --
The Amazon Resource Name (ARN) of the AI agent.
name (string) --
The name of the AI Agent.
type (string) --
The type of the AI Agent.
configuration (dict) --
Configuration for the AI Agent.
manualSearchAIAgentConfiguration (dict) --
The configuration for AI Agents of type MANUAL_SEARCH.
answerGenerationAIPromptId (string) --
The AI Prompt identifier for the Answer Generation prompt used by the MANUAL_SEARCH AI Agent.
answerGenerationAIGuardrailId (string) --
The AI Guardrail identifier for the Answer Generation guardrail used by the MANUAL_SEARCH AI Agent.
associationConfigurations (list) --
The association configurations for overriding behavior on this AI Agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
associationConfigurationData (dict) --
The data of the configuration for an Amazon Q in Connect Assistant Association.
knowledgeBaseAssociationConfigurationData (dict) --
The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
contentTagFilter (dict) --
An object that can be used to specify Tag conditions.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
orConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
A list of conditions which would be applied together with an OR condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
maxResults (integer) --
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) --
The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text
locale (string) --
The locale to which specifies the language and region settings that determine the response language for QueryAssistant.
answerRecommendationAIAgentConfiguration (dict) --
The configuration for AI Agents of type ANSWER_RECOMMENDATION.
intentLabelingGenerationAIPromptId (string) --
The AI Prompt identifier for the Intent Labeling prompt used by the ANSWER_RECOMMENDATION AI Agent.
queryReformulationAIPromptId (string) --
The AI Prompt identifier for the Query Reformulation prompt used by the ANSWER_RECOMMENDATION AI Agent.
answerGenerationAIPromptId (string) --
The AI Prompt identifier for the Answer Generation prompt used by the ANSWER_RECOMMENDATION AI Agent.
answerGenerationAIGuardrailId (string) --
The AI Guardrail identifier for the Answer Generation Guardrail used by the ANSWER_RECOMMENDATION AI Agent.
associationConfigurations (list) --
The association configurations for overriding behavior on this AI Agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
associationConfigurationData (dict) --
The data of the configuration for an Amazon Q in Connect Assistant Association.
knowledgeBaseAssociationConfigurationData (dict) --
The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
contentTagFilter (dict) --
An object that can be used to specify Tag conditions.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
orConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
A list of conditions which would be applied together with an OR condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
maxResults (integer) --
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) --
The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text
locale (string) --
The locale to which specifies the language and region settings that determine the response language for QueryAssistant.
suggestedMessages (list) --
The suggested messages configuration for the Answer Recommendation AI Agent.
(string) --
selfServiceAIAgentConfiguration (dict) --
The configuration for AI Agents of type SELF_SERVICE.
selfServicePreProcessingAIPromptId (string) --
The AI Prompt identifier for the Self Service Pre-Processing prompt used by the SELF_SERVICE AI Agent
selfServiceAnswerGenerationAIPromptId (string) --
The AI Prompt identifier for the Self Service Answer Generation prompt used by the SELF_SERVICE AI Agent
selfServiceAIGuardrailId (string) --
The AI Guardrail identifier used by the SELF_SERVICE AI Agent.
associationConfigurations (list) --
The association configurations for overriding behavior on this AI Agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
associationConfigurationData (dict) --
The data of the configuration for an Amazon Q in Connect Assistant Association.
knowledgeBaseAssociationConfigurationData (dict) --
The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
contentTagFilter (dict) --
An object that can be used to specify Tag conditions.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
orConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
A list of conditions which would be applied together with an OR condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
maxResults (integer) --
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) --
The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text
emailResponseAIAgentConfiguration (dict) --
Configuration for the EMAIL_RESPONSE AI agent that generates professional email responses using knowledge base content.
emailResponseAIPromptId (string) --
The ID of the System AI prompt used for generating professional email responses based on knowledge base content.
emailQueryReformulationAIPromptId (string) --
The ID of the System AI prompt used for reformulating email queries to optimize knowledge base search for response generation.
locale (string) --
The locale setting for language-specific email response generation (for example, en_US, es_ES).
associationConfigurations (list) --
Configuration settings for knowledge base associations used by the email response agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
associationConfigurationData (dict) --
The data of the configuration for an Amazon Q in Connect Assistant Association.
knowledgeBaseAssociationConfigurationData (dict) --
The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
contentTagFilter (dict) --
An object that can be used to specify Tag conditions.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
orConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
A list of conditions which would be applied together with an OR condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
maxResults (integer) --
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) --
The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text
emailOverviewAIAgentConfiguration (dict) --
Configuration for the EMAIL_OVERVIEW AI agent that generates structured overview of email conversations.
emailOverviewAIPromptId (string) --
The ID of the System AI prompt used for generating structured email conversation summaries.
locale (string) --
The locale setting for language-specific email overview processing (for example, en_US, es_ES).
emailGenerativeAnswerAIAgentConfiguration (dict) --
Configuration for the EMAIL_GENERATIVE_ANSWER AI agent that provides comprehensive knowledge-based answers for customer queries.
emailGenerativeAnswerAIPromptId (string) --
The ID of the System AI prompt used for generating comprehensive knowledge-based answers from email queries.
emailQueryReformulationAIPromptId (string) --
The ID of the System AI prompt used for reformulating email queries to optimize knowledge base search results.
locale (string) --
The locale setting for language-specific email processing and response generation (for example, en_US, es_ES).
associationConfigurations (list) --
Configuration settings for knowledge base associations used by the email generative answer agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
associationConfigurationData (dict) --
The data of the configuration for an Amazon Q in Connect Assistant Association.
knowledgeBaseAssociationConfigurationData (dict) --
The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
contentTagFilter (dict) --
An object that can be used to specify Tag conditions.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
orConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
A list of conditions which would be applied together with an OR condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
maxResults (integer) --
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) --
The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text
orchestrationAIAgentConfiguration (dict) --
The configuration for AI Agents of type ORCHESTRATION.
orchestrationAIPromptId (string) --
The AI Prompt identifier used by the Orchestration AI Agent.
orchestrationAIGuardrailId (string) --
The AI Guardrail identifier used by the Orchestration AI Agent.
toolConfigurations (list) --
The tool configurations used by the Orchestration AI Agent.
(dict) --
Configuration settings for a tool used by AI Agents.
toolName (string) --
The name of the tool.
toolType (string) --
The type of the tool.
title (string) --
The title of the tool configuration.
toolId (string) --
The identifier of the tool, for example toolName from Model Context Provider server.
description (string) --
The description of the tool configuration.
instruction (dict) --
Instructions for using the tool.
instruction (string) --
The instruction text for the tool.
examples (list) --
Examples for using the tool.
(string) --
overrideInputValues (list) --
Override input values for the tool configuration.
(dict) --
An input value override for tools.
jsonPath (string) --
The JSON path for the input value override.
value (dict) --
The override input value.
constant (dict) --
Constant input value configuration for tool override.
type (string) --
Override tool input value with constant values
value (string) --
The constant input override value.
outputFilters (list) --
Output filters applies to the tool result.
(dict) --
Filter configuration for tool output.
jsonPath (string) --
The JSON path for filtering tool output.
outputConfiguration (dict) --
The output configuration for the filter.
outputVariableNameOverride (string) --
Override the tool output results to different variable name.
sessionDataNamespace (string) --
The session data namespace for tool output.
inputSchema (:ref:`document<document>`) --
The input schema for the tool configuration.
outputSchema (:ref:`document<document>`) --
The output schema for the tool configuration.
annotations (dict) --
Annotations for the tool configuration.
title (string) --
The title of the annotation.
destructiveHint (boolean) --
A hint indicating that the annotation contains potentially destructive content.
userInteractionConfiguration (dict) --
Configuration for user interaction with the tool.
isUserConfirmationRequired (boolean) --
Indicates whether user confirmation is required for the interaction.
multiAgentConfigurations (list) --
The collaborator agents that the Orchestration AI Agent can work with. Each entry defines another agent that the orchestrator either delegates to or hands the conversation off to.
(dict) --
A union that configures a single collaborator agent for an Orchestration AI Agent, as either a delegate or a handoff.
delegateAgentConfiguration (dict) --
Configures the collaborator agent as a delegate that the Orchestration AI Agent invokes while retaining control of the conversation.
agentTarget (dict) --
The collaborator agent to delegate to.
aiAgentId (string) --
The identifier of an Amazon Connect AI Agent to use as the collaborator agent.
applicationId (string) --
The identifier of a third-party agent to use as the collaborator agent.
instruction (dict) --
The instruction that tells the Orchestration AI Agent when and how to delegate to this collaborator agent.
instruction (string) --
The natural-language instruction that tells the Orchestration AI Agent when and how to engage the collaborator agent.
examples (list) --
Example interactions that illustrate when the Orchestration AI Agent should engage the collaborator agent.
(string) --
handoffAgentConfiguration (dict) --
Configures the collaborator agent as a handoff target that the Orchestration AI Agent transfers control of the conversation to.
agentTarget (dict) --
The collaborator agent to hand off to.
aiAgentId (string) --
The identifier of an Amazon Connect AI Agent to use as the collaborator agent.
applicationId (string) --
The identifier of a third-party agent to use as the collaborator agent.
instruction (dict) --
The instruction that tells the Orchestration AI Agent when and how to hand off to this collaborator agent.
instruction (string) --
The natural-language instruction that tells the Orchestration AI Agent when and how to engage the collaborator agent.
examples (list) --
Example interactions that illustrate when the Orchestration AI Agent should engage the collaborator agent.
(string) --
audioStreamingEnabled (boolean) --
Specifies whether the caller's audio is streamed directly to the collaborator agent and the collaborator's audio response is played back during the handoff. This applies only to voice handoffs.
immediateHandoff (boolean) --
Specifies whether the conversation is handed off to this collaborator agent immediately on the first turn, without any orchestration reasoning. At most one handoff in an AI Agent's configuration can set this to true.
connectInstanceArn (string) --
The Amazon Resource Name (ARN) of the Amazon Connect instance used by the Orchestration AI Agent.
locale (string) --
The locale setting for the Orchestration AI Agent.
inputSchemas (list) --
The JSON schemas that define the structure of the structured data input accepted by the Orchestration AI Agent. The data in a DATA message sent to the agent is validated against these schemas. You can specify at most one schema.
(:ref:`document<document>`) --
outputSchemas (list) --
The JSON schemas that define the structure of the structured output generated by the Orchestration AI Agent. You can specify at most one schema.
(:ref:`document<document>`) --
noteTakingAIAgentConfiguration (dict) --
The configuration for AI Agents of type NOTE_TAKING.
noteTakingAIPromptId (string) --
The AI Prompt identifier used by the Note Taking AI Agent.
noteTakingAIGuardrailId (string) --
The AI Guardrail identifier used by the Note Taking AI Agent.
locale (string) --
The locale setting for language-specific case summarization generation (for example, en_US, es_ES).
caseSummarizationAIAgentConfiguration (dict) --
The configuration for AI Agents of type CASE_SUMMARIZATION.
caseSummarizationAIPromptId (string) --
The AI Prompt identifier used by the Case Summarization AI Agent.
caseSummarizationAIGuardrailId (string) --
The AI Guardrail identifier used by the Case Summarization AI Agent.
locale (string) --
The locale setting for the Case Summarization AI Agent.
modifiedTime (datetime) --
The time the AI Agent was last modified.
description (string) --
The description of the AI Agent.
visibilityStatus (string) --
The visibility status of the AI Agent.
tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
origin (string) --
Specifies the origin of the AI Agent. SYSTEM for a default AI Agent created by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent creation APIs.
status (string) --
The status of the AI Agent.
{'aiAgent': {'configuration': {'orchestrationAIAgentConfiguration': {'inputSchemas': [{}],
'multiAgentConfigurations': [{'delegateAgentConfiguration': {'agentTarget': {'aiAgentId': 'string',
'applicationId': 'string'},
'instruction': {'examples': ['string'],
'instruction': 'string'}},
'handoffAgentConfiguration': {'agentTarget': {'aiAgentId': 'string',
'applicationId': 'string'},
'audioStreamingEnabled': 'boolean',
'immediateHandoff': 'boolean',
'instruction': {'examples': ['string'],
'instruction': 'string'}}}],
'outputSchemas': [{}]}}}}
Creates and Amazon Q in Connect AI Agent version.
See also: AWS API Documentation
Request Syntax
client.create_ai_agent_version(
assistantId='string',
aiAgentId='string',
modifiedTime=datetime(2015, 1, 1),
clientToken='string'
)
string
[REQUIRED]
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
string
[REQUIRED]
The identifier of the Amazon Q in Connect AI Agent.
datetime
The modification time of the AI Agent should be tracked for version creation. This field should be specified to avoid version creation when simultaneous update to the underlying AI Agent are possible. The value should be the modifiedTime returned from the request to create or update an AI Agent so that version creation can fail if an update to the AI Agent post the specified modification time has been made.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..
This field is autopopulated if not provided.
dict
Response Syntax
{
'aiAgent': {
'assistantId': 'string',
'assistantArn': 'string',
'aiAgentId': 'string',
'aiAgentArn': 'string',
'name': 'string',
'type': 'MANUAL_SEARCH'|'ANSWER_RECOMMENDATION'|'SELF_SERVICE'|'EMAIL_RESPONSE'|'EMAIL_OVERVIEW'|'EMAIL_GENERATIVE_ANSWER'|'ORCHESTRATION'|'NOTE_TAKING'|'CASE_SUMMARIZATION',
'configuration': {
'manualSearchAIAgentConfiguration': {
'answerGenerationAIPromptId': 'string',
'answerGenerationAIGuardrailId': 'string',
'associationConfigurations': [
{
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE',
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'tagCondition': {
'key': 'string',
'value': 'string'
},
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
]
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
}
},
],
'locale': 'string'
},
'answerRecommendationAIAgentConfiguration': {
'intentLabelingGenerationAIPromptId': 'string',
'queryReformulationAIPromptId': 'string',
'answerGenerationAIPromptId': 'string',
'answerGenerationAIGuardrailId': 'string',
'associationConfigurations': [
{
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE',
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'tagCondition': {
'key': 'string',
'value': 'string'
},
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
]
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
}
},
],
'locale': 'string',
'suggestedMessages': [
'string',
]
},
'selfServiceAIAgentConfiguration': {
'selfServicePreProcessingAIPromptId': 'string',
'selfServiceAnswerGenerationAIPromptId': 'string',
'selfServiceAIGuardrailId': 'string',
'associationConfigurations': [
{
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE',
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'tagCondition': {
'key': 'string',
'value': 'string'
},
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
]
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
}
},
]
},
'emailResponseAIAgentConfiguration': {
'emailResponseAIPromptId': 'string',
'emailQueryReformulationAIPromptId': 'string',
'locale': 'string',
'associationConfigurations': [
{
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE',
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'tagCondition': {
'key': 'string',
'value': 'string'
},
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
]
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
}
},
]
},
'emailOverviewAIAgentConfiguration': {
'emailOverviewAIPromptId': 'string',
'locale': 'string'
},
'emailGenerativeAnswerAIAgentConfiguration': {
'emailGenerativeAnswerAIPromptId': 'string',
'emailQueryReformulationAIPromptId': 'string',
'locale': 'string',
'associationConfigurations': [
{
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE',
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'tagCondition': {
'key': 'string',
'value': 'string'
},
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
]
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
}
},
]
},
'orchestrationAIAgentConfiguration': {
'orchestrationAIPromptId': 'string',
'orchestrationAIGuardrailId': 'string',
'toolConfigurations': [
{
'toolName': 'string',
'toolType': 'MODEL_CONTEXT_PROTOCOL'|'RETURN_TO_CONTROL'|'CONSTANT',
'title': 'string',
'toolId': 'string',
'description': 'string',
'instruction': {
'instruction': 'string',
'examples': [
'string',
]
},
'overrideInputValues': [
{
'jsonPath': 'string',
'value': {
'constant': {
'type': 'STRING'|'NUMBER'|'JSON_STRING',
'value': 'string'
}
}
},
],
'outputFilters': [
{
'jsonPath': 'string',
'outputConfiguration': {
'outputVariableNameOverride': 'string',
'sessionDataNamespace': 'string'
}
},
],
'inputSchema': {...}|[...]|123|123.4|'string'|True|None,
'outputSchema': {...}|[...]|123|123.4|'string'|True|None,
'annotations': {
'title': 'string',
'destructiveHint': True|False
},
'userInteractionConfiguration': {
'isUserConfirmationRequired': True|False
}
},
],
'multiAgentConfigurations': [
{
'delegateAgentConfiguration': {
'agentTarget': {
'aiAgentId': 'string',
'applicationId': 'string'
},
'instruction': {
'instruction': 'string',
'examples': [
'string',
]
}
},
'handoffAgentConfiguration': {
'agentTarget': {
'aiAgentId': 'string',
'applicationId': 'string'
},
'instruction': {
'instruction': 'string',
'examples': [
'string',
]
},
'audioStreamingEnabled': True|False,
'immediateHandoff': True|False
}
},
],
'connectInstanceArn': 'string',
'locale': 'string',
'inputSchemas': [
{...}|[...]|123|123.4|'string'|True|None,
],
'outputSchemas': [
{...}|[...]|123|123.4|'string'|True|None,
]
},
'noteTakingAIAgentConfiguration': {
'noteTakingAIPromptId': 'string',
'noteTakingAIGuardrailId': 'string',
'locale': 'string'
},
'caseSummarizationAIAgentConfiguration': {
'caseSummarizationAIPromptId': 'string',
'caseSummarizationAIGuardrailId': 'string',
'locale': 'string'
}
},
'modifiedTime': datetime(2015, 1, 1),
'description': 'string',
'visibilityStatus': 'SAVED'|'PUBLISHED',
'tags': {
'string': 'string'
},
'origin': 'SYSTEM'|'CUSTOMER',
'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'
},
'versionNumber': 123
}
Response Structure
(dict) --
aiAgent (dict) --
The data of the AI Agent version.
assistantId (string) --
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
assistantArn (string) --
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
aiAgentId (string) --
The identifier of the AI Agent.
aiAgentArn (string) --
The Amazon Resource Name (ARN) of the AI agent.
name (string) --
The name of the AI Agent.
type (string) --
The type of the AI Agent.
configuration (dict) --
Configuration for the AI Agent.
manualSearchAIAgentConfiguration (dict) --
The configuration for AI Agents of type MANUAL_SEARCH.
answerGenerationAIPromptId (string) --
The AI Prompt identifier for the Answer Generation prompt used by the MANUAL_SEARCH AI Agent.
answerGenerationAIGuardrailId (string) --
The AI Guardrail identifier for the Answer Generation guardrail used by the MANUAL_SEARCH AI Agent.
associationConfigurations (list) --
The association configurations for overriding behavior on this AI Agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
associationConfigurationData (dict) --
The data of the configuration for an Amazon Q in Connect Assistant Association.
knowledgeBaseAssociationConfigurationData (dict) --
The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
contentTagFilter (dict) --
An object that can be used to specify Tag conditions.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
orConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
A list of conditions which would be applied together with an OR condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
maxResults (integer) --
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) --
The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text
locale (string) --
The locale to which specifies the language and region settings that determine the response language for QueryAssistant.
answerRecommendationAIAgentConfiguration (dict) --
The configuration for AI Agents of type ANSWER_RECOMMENDATION.
intentLabelingGenerationAIPromptId (string) --
The AI Prompt identifier for the Intent Labeling prompt used by the ANSWER_RECOMMENDATION AI Agent.
queryReformulationAIPromptId (string) --
The AI Prompt identifier for the Query Reformulation prompt used by the ANSWER_RECOMMENDATION AI Agent.
answerGenerationAIPromptId (string) --
The AI Prompt identifier for the Answer Generation prompt used by the ANSWER_RECOMMENDATION AI Agent.
answerGenerationAIGuardrailId (string) --
The AI Guardrail identifier for the Answer Generation Guardrail used by the ANSWER_RECOMMENDATION AI Agent.
associationConfigurations (list) --
The association configurations for overriding behavior on this AI Agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
associationConfigurationData (dict) --
The data of the configuration for an Amazon Q in Connect Assistant Association.
knowledgeBaseAssociationConfigurationData (dict) --
The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
contentTagFilter (dict) --
An object that can be used to specify Tag conditions.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
orConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
A list of conditions which would be applied together with an OR condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
maxResults (integer) --
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) --
The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text
locale (string) --
The locale to which specifies the language and region settings that determine the response language for QueryAssistant.
suggestedMessages (list) --
The suggested messages configuration for the Answer Recommendation AI Agent.
(string) --
selfServiceAIAgentConfiguration (dict) --
The configuration for AI Agents of type SELF_SERVICE.
selfServicePreProcessingAIPromptId (string) --
The AI Prompt identifier for the Self Service Pre-Processing prompt used by the SELF_SERVICE AI Agent
selfServiceAnswerGenerationAIPromptId (string) --
The AI Prompt identifier for the Self Service Answer Generation prompt used by the SELF_SERVICE AI Agent
selfServiceAIGuardrailId (string) --
The AI Guardrail identifier used by the SELF_SERVICE AI Agent.
associationConfigurations (list) --
The association configurations for overriding behavior on this AI Agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
associationConfigurationData (dict) --
The data of the configuration for an Amazon Q in Connect Assistant Association.
knowledgeBaseAssociationConfigurationData (dict) --
The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
contentTagFilter (dict) --
An object that can be used to specify Tag conditions.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
orConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
A list of conditions which would be applied together with an OR condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
maxResults (integer) --
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) --
The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text
emailResponseAIAgentConfiguration (dict) --
Configuration for the EMAIL_RESPONSE AI agent that generates professional email responses using knowledge base content.
emailResponseAIPromptId (string) --
The ID of the System AI prompt used for generating professional email responses based on knowledge base content.
emailQueryReformulationAIPromptId (string) --
The ID of the System AI prompt used for reformulating email queries to optimize knowledge base search for response generation.
locale (string) --
The locale setting for language-specific email response generation (for example, en_US, es_ES).
associationConfigurations (list) --
Configuration settings for knowledge base associations used by the email response agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
associationConfigurationData (dict) --
The data of the configuration for an Amazon Q in Connect Assistant Association.
knowledgeBaseAssociationConfigurationData (dict) --
The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
contentTagFilter (dict) --
An object that can be used to specify Tag conditions.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
orConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
A list of conditions which would be applied together with an OR condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
maxResults (integer) --
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) --
The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text
emailOverviewAIAgentConfiguration (dict) --
Configuration for the EMAIL_OVERVIEW AI agent that generates structured overview of email conversations.
emailOverviewAIPromptId (string) --
The ID of the System AI prompt used for generating structured email conversation summaries.
locale (string) --
The locale setting for language-specific email overview processing (for example, en_US, es_ES).
emailGenerativeAnswerAIAgentConfiguration (dict) --
Configuration for the EMAIL_GENERATIVE_ANSWER AI agent that provides comprehensive knowledge-based answers for customer queries.
emailGenerativeAnswerAIPromptId (string) --
The ID of the System AI prompt used for generating comprehensive knowledge-based answers from email queries.
emailQueryReformulationAIPromptId (string) --
The ID of the System AI prompt used for reformulating email queries to optimize knowledge base search results.
locale (string) --
The locale setting for language-specific email processing and response generation (for example, en_US, es_ES).
associationConfigurations (list) --
Configuration settings for knowledge base associations used by the email generative answer agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
associationConfigurationData (dict) --
The data of the configuration for an Amazon Q in Connect Assistant Association.
knowledgeBaseAssociationConfigurationData (dict) --
The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
contentTagFilter (dict) --
An object that can be used to specify Tag conditions.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
orConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
A list of conditions which would be applied together with an OR condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
maxResults (integer) --
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) --
The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text
orchestrationAIAgentConfiguration (dict) --
The configuration for AI Agents of type ORCHESTRATION.
orchestrationAIPromptId (string) --
The AI Prompt identifier used by the Orchestration AI Agent.
orchestrationAIGuardrailId (string) --
The AI Guardrail identifier used by the Orchestration AI Agent.
toolConfigurations (list) --
The tool configurations used by the Orchestration AI Agent.
(dict) --
Configuration settings for a tool used by AI Agents.
toolName (string) --
The name of the tool.
toolType (string) --
The type of the tool.
title (string) --
The title of the tool configuration.
toolId (string) --
The identifier of the tool, for example toolName from Model Context Provider server.
description (string) --
The description of the tool configuration.
instruction (dict) --
Instructions for using the tool.
instruction (string) --
The instruction text for the tool.
examples (list) --
Examples for using the tool.
(string) --
overrideInputValues (list) --
Override input values for the tool configuration.
(dict) --
An input value override for tools.
jsonPath (string) --
The JSON path for the input value override.
value (dict) --
The override input value.
constant (dict) --
Constant input value configuration for tool override.
type (string) --
Override tool input value with constant values
value (string) --
The constant input override value.
outputFilters (list) --
Output filters applies to the tool result.
(dict) --
Filter configuration for tool output.
jsonPath (string) --
The JSON path for filtering tool output.
outputConfiguration (dict) --
The output configuration for the filter.
outputVariableNameOverride (string) --
Override the tool output results to different variable name.
sessionDataNamespace (string) --
The session data namespace for tool output.
inputSchema (:ref:`document<document>`) --
The input schema for the tool configuration.
outputSchema (:ref:`document<document>`) --
The output schema for the tool configuration.
annotations (dict) --
Annotations for the tool configuration.
title (string) --
The title of the annotation.
destructiveHint (boolean) --
A hint indicating that the annotation contains potentially destructive content.
userInteractionConfiguration (dict) --
Configuration for user interaction with the tool.
isUserConfirmationRequired (boolean) --
Indicates whether user confirmation is required for the interaction.
multiAgentConfigurations (list) --
The collaborator agents that the Orchestration AI Agent can work with. Each entry defines another agent that the orchestrator either delegates to or hands the conversation off to.
(dict) --
A union that configures a single collaborator agent for an Orchestration AI Agent, as either a delegate or a handoff.
delegateAgentConfiguration (dict) --
Configures the collaborator agent as a delegate that the Orchestration AI Agent invokes while retaining control of the conversation.
agentTarget (dict) --
The collaborator agent to delegate to.
aiAgentId (string) --
The identifier of an Amazon Connect AI Agent to use as the collaborator agent.
applicationId (string) --
The identifier of a third-party agent to use as the collaborator agent.
instruction (dict) --
The instruction that tells the Orchestration AI Agent when and how to delegate to this collaborator agent.
instruction (string) --
The natural-language instruction that tells the Orchestration AI Agent when and how to engage the collaborator agent.
examples (list) --
Example interactions that illustrate when the Orchestration AI Agent should engage the collaborator agent.
(string) --
handoffAgentConfiguration (dict) --
Configures the collaborator agent as a handoff target that the Orchestration AI Agent transfers control of the conversation to.
agentTarget (dict) --
The collaborator agent to hand off to.
aiAgentId (string) --
The identifier of an Amazon Connect AI Agent to use as the collaborator agent.
applicationId (string) --
The identifier of a third-party agent to use as the collaborator agent.
instruction (dict) --
The instruction that tells the Orchestration AI Agent when and how to hand off to this collaborator agent.
instruction (string) --
The natural-language instruction that tells the Orchestration AI Agent when and how to engage the collaborator agent.
examples (list) --
Example interactions that illustrate when the Orchestration AI Agent should engage the collaborator agent.
(string) --
audioStreamingEnabled (boolean) --
Specifies whether the caller's audio is streamed directly to the collaborator agent and the collaborator's audio response is played back during the handoff. This applies only to voice handoffs.
immediateHandoff (boolean) --
Specifies whether the conversation is handed off to this collaborator agent immediately on the first turn, without any orchestration reasoning. At most one handoff in an AI Agent's configuration can set this to true.
connectInstanceArn (string) --
The Amazon Resource Name (ARN) of the Amazon Connect instance used by the Orchestration AI Agent.
locale (string) --
The locale setting for the Orchestration AI Agent.
inputSchemas (list) --
The JSON schemas that define the structure of the structured data input accepted by the Orchestration AI Agent. The data in a DATA message sent to the agent is validated against these schemas. You can specify at most one schema.
(:ref:`document<document>`) --
outputSchemas (list) --
The JSON schemas that define the structure of the structured output generated by the Orchestration AI Agent. You can specify at most one schema.
(:ref:`document<document>`) --
noteTakingAIAgentConfiguration (dict) --
The configuration for AI Agents of type NOTE_TAKING.
noteTakingAIPromptId (string) --
The AI Prompt identifier used by the Note Taking AI Agent.
noteTakingAIGuardrailId (string) --
The AI Guardrail identifier used by the Note Taking AI Agent.
locale (string) --
The locale setting for language-specific case summarization generation (for example, en_US, es_ES).
caseSummarizationAIAgentConfiguration (dict) --
The configuration for AI Agents of type CASE_SUMMARIZATION.
caseSummarizationAIPromptId (string) --
The AI Prompt identifier used by the Case Summarization AI Agent.
caseSummarizationAIGuardrailId (string) --
The AI Guardrail identifier used by the Case Summarization AI Agent.
locale (string) --
The locale setting for the Case Summarization AI Agent.
modifiedTime (datetime) --
The time the AI Agent was last modified.
description (string) --
The description of the AI Agent.
visibilityStatus (string) --
The visibility status of the AI Agent.
tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
origin (string) --
Specifies the origin of the AI Agent. SYSTEM for a default AI Agent created by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent creation APIs.
status (string) --
The status of the AI Agent.
versionNumber (integer) --
The version number of the AI Agent version.
{'aiAgent': {'configuration': {'orchestrationAIAgentConfiguration': {'inputSchemas': [{}],
'multiAgentConfigurations': [{'delegateAgentConfiguration': {'agentTarget': {'aiAgentId': 'string',
'applicationId': 'string'},
'instruction': {'examples': ['string'],
'instruction': 'string'}},
'handoffAgentConfiguration': {'agentTarget': {'aiAgentId': 'string',
'applicationId': 'string'},
'audioStreamingEnabled': 'boolean',
'immediateHandoff': 'boolean',
'instruction': {'examples': ['string'],
'instruction': 'string'}}}],
'outputSchemas': [{}]}}}}
Gets an Amazon Q in Connect AI Agent.
See also: AWS API Documentation
Request Syntax
client.get_ai_agent(
assistantId='string',
aiAgentId='string'
)
string
[REQUIRED]
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
string
[REQUIRED]
The identifier of the Amazon Q in Connect AI Agent (with or without a version qualifier). Can be either the ID or the ARN. URLs cannot contain the ARN.
dict
Response Syntax
{
'aiAgent': {
'assistantId': 'string',
'assistantArn': 'string',
'aiAgentId': 'string',
'aiAgentArn': 'string',
'name': 'string',
'type': 'MANUAL_SEARCH'|'ANSWER_RECOMMENDATION'|'SELF_SERVICE'|'EMAIL_RESPONSE'|'EMAIL_OVERVIEW'|'EMAIL_GENERATIVE_ANSWER'|'ORCHESTRATION'|'NOTE_TAKING'|'CASE_SUMMARIZATION',
'configuration': {
'manualSearchAIAgentConfiguration': {
'answerGenerationAIPromptId': 'string',
'answerGenerationAIGuardrailId': 'string',
'associationConfigurations': [
{
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE',
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'tagCondition': {
'key': 'string',
'value': 'string'
},
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
]
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
}
},
],
'locale': 'string'
},
'answerRecommendationAIAgentConfiguration': {
'intentLabelingGenerationAIPromptId': 'string',
'queryReformulationAIPromptId': 'string',
'answerGenerationAIPromptId': 'string',
'answerGenerationAIGuardrailId': 'string',
'associationConfigurations': [
{
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE',
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'tagCondition': {
'key': 'string',
'value': 'string'
},
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
]
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
}
},
],
'locale': 'string',
'suggestedMessages': [
'string',
]
},
'selfServiceAIAgentConfiguration': {
'selfServicePreProcessingAIPromptId': 'string',
'selfServiceAnswerGenerationAIPromptId': 'string',
'selfServiceAIGuardrailId': 'string',
'associationConfigurations': [
{
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE',
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'tagCondition': {
'key': 'string',
'value': 'string'
},
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
]
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
}
},
]
},
'emailResponseAIAgentConfiguration': {
'emailResponseAIPromptId': 'string',
'emailQueryReformulationAIPromptId': 'string',
'locale': 'string',
'associationConfigurations': [
{
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE',
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'tagCondition': {
'key': 'string',
'value': 'string'
},
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
]
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
}
},
]
},
'emailOverviewAIAgentConfiguration': {
'emailOverviewAIPromptId': 'string',
'locale': 'string'
},
'emailGenerativeAnswerAIAgentConfiguration': {
'emailGenerativeAnswerAIPromptId': 'string',
'emailQueryReformulationAIPromptId': 'string',
'locale': 'string',
'associationConfigurations': [
{
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE',
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'tagCondition': {
'key': 'string',
'value': 'string'
},
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
]
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
}
},
]
},
'orchestrationAIAgentConfiguration': {
'orchestrationAIPromptId': 'string',
'orchestrationAIGuardrailId': 'string',
'toolConfigurations': [
{
'toolName': 'string',
'toolType': 'MODEL_CONTEXT_PROTOCOL'|'RETURN_TO_CONTROL'|'CONSTANT',
'title': 'string',
'toolId': 'string',
'description': 'string',
'instruction': {
'instruction': 'string',
'examples': [
'string',
]
},
'overrideInputValues': [
{
'jsonPath': 'string',
'value': {
'constant': {
'type': 'STRING'|'NUMBER'|'JSON_STRING',
'value': 'string'
}
}
},
],
'outputFilters': [
{
'jsonPath': 'string',
'outputConfiguration': {
'outputVariableNameOverride': 'string',
'sessionDataNamespace': 'string'
}
},
],
'inputSchema': {...}|[...]|123|123.4|'string'|True|None,
'outputSchema': {...}|[...]|123|123.4|'string'|True|None,
'annotations': {
'title': 'string',
'destructiveHint': True|False
},
'userInteractionConfiguration': {
'isUserConfirmationRequired': True|False
}
},
],
'multiAgentConfigurations': [
{
'delegateAgentConfiguration': {
'agentTarget': {
'aiAgentId': 'string',
'applicationId': 'string'
},
'instruction': {
'instruction': 'string',
'examples': [
'string',
]
}
},
'handoffAgentConfiguration': {
'agentTarget': {
'aiAgentId': 'string',
'applicationId': 'string'
},
'instruction': {
'instruction': 'string',
'examples': [
'string',
]
},
'audioStreamingEnabled': True|False,
'immediateHandoff': True|False
}
},
],
'connectInstanceArn': 'string',
'locale': 'string',
'inputSchemas': [
{...}|[...]|123|123.4|'string'|True|None,
],
'outputSchemas': [
{...}|[...]|123|123.4|'string'|True|None,
]
},
'noteTakingAIAgentConfiguration': {
'noteTakingAIPromptId': 'string',
'noteTakingAIGuardrailId': 'string',
'locale': 'string'
},
'caseSummarizationAIAgentConfiguration': {
'caseSummarizationAIPromptId': 'string',
'caseSummarizationAIGuardrailId': 'string',
'locale': 'string'
}
},
'modifiedTime': datetime(2015, 1, 1),
'description': 'string',
'visibilityStatus': 'SAVED'|'PUBLISHED',
'tags': {
'string': 'string'
},
'origin': 'SYSTEM'|'CUSTOMER',
'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'
},
'versionNumber': 123
}
Response Structure
(dict) --
aiAgent (dict) --
The data of the AI Agent.
assistantId (string) --
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
assistantArn (string) --
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
aiAgentId (string) --
The identifier of the AI Agent.
aiAgentArn (string) --
The Amazon Resource Name (ARN) of the AI agent.
name (string) --
The name of the AI Agent.
type (string) --
The type of the AI Agent.
configuration (dict) --
Configuration for the AI Agent.
manualSearchAIAgentConfiguration (dict) --
The configuration for AI Agents of type MANUAL_SEARCH.
answerGenerationAIPromptId (string) --
The AI Prompt identifier for the Answer Generation prompt used by the MANUAL_SEARCH AI Agent.
answerGenerationAIGuardrailId (string) --
The AI Guardrail identifier for the Answer Generation guardrail used by the MANUAL_SEARCH AI Agent.
associationConfigurations (list) --
The association configurations for overriding behavior on this AI Agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
associationConfigurationData (dict) --
The data of the configuration for an Amazon Q in Connect Assistant Association.
knowledgeBaseAssociationConfigurationData (dict) --
The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
contentTagFilter (dict) --
An object that can be used to specify Tag conditions.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
orConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
A list of conditions which would be applied together with an OR condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
maxResults (integer) --
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) --
The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text
locale (string) --
The locale to which specifies the language and region settings that determine the response language for QueryAssistant.
answerRecommendationAIAgentConfiguration (dict) --
The configuration for AI Agents of type ANSWER_RECOMMENDATION.
intentLabelingGenerationAIPromptId (string) --
The AI Prompt identifier for the Intent Labeling prompt used by the ANSWER_RECOMMENDATION AI Agent.
queryReformulationAIPromptId (string) --
The AI Prompt identifier for the Query Reformulation prompt used by the ANSWER_RECOMMENDATION AI Agent.
answerGenerationAIPromptId (string) --
The AI Prompt identifier for the Answer Generation prompt used by the ANSWER_RECOMMENDATION AI Agent.
answerGenerationAIGuardrailId (string) --
The AI Guardrail identifier for the Answer Generation Guardrail used by the ANSWER_RECOMMENDATION AI Agent.
associationConfigurations (list) --
The association configurations for overriding behavior on this AI Agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
associationConfigurationData (dict) --
The data of the configuration for an Amazon Q in Connect Assistant Association.
knowledgeBaseAssociationConfigurationData (dict) --
The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
contentTagFilter (dict) --
An object that can be used to specify Tag conditions.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
orConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
A list of conditions which would be applied together with an OR condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
maxResults (integer) --
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) --
The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text
locale (string) --
The locale to which specifies the language and region settings that determine the response language for QueryAssistant.
suggestedMessages (list) --
The suggested messages configuration for the Answer Recommendation AI Agent.
(string) --
selfServiceAIAgentConfiguration (dict) --
The configuration for AI Agents of type SELF_SERVICE.
selfServicePreProcessingAIPromptId (string) --
The AI Prompt identifier for the Self Service Pre-Processing prompt used by the SELF_SERVICE AI Agent
selfServiceAnswerGenerationAIPromptId (string) --
The AI Prompt identifier for the Self Service Answer Generation prompt used by the SELF_SERVICE AI Agent
selfServiceAIGuardrailId (string) --
The AI Guardrail identifier used by the SELF_SERVICE AI Agent.
associationConfigurations (list) --
The association configurations for overriding behavior on this AI Agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
associationConfigurationData (dict) --
The data of the configuration for an Amazon Q in Connect Assistant Association.
knowledgeBaseAssociationConfigurationData (dict) --
The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
contentTagFilter (dict) --
An object that can be used to specify Tag conditions.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
orConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
A list of conditions which would be applied together with an OR condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
maxResults (integer) --
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) --
The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text
emailResponseAIAgentConfiguration (dict) --
Configuration for the EMAIL_RESPONSE AI agent that generates professional email responses using knowledge base content.
emailResponseAIPromptId (string) --
The ID of the System AI prompt used for generating professional email responses based on knowledge base content.
emailQueryReformulationAIPromptId (string) --
The ID of the System AI prompt used for reformulating email queries to optimize knowledge base search for response generation.
locale (string) --
The locale setting for language-specific email response generation (for example, en_US, es_ES).
associationConfigurations (list) --
Configuration settings for knowledge base associations used by the email response agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
associationConfigurationData (dict) --
The data of the configuration for an Amazon Q in Connect Assistant Association.
knowledgeBaseAssociationConfigurationData (dict) --
The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
contentTagFilter (dict) --
An object that can be used to specify Tag conditions.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
orConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
A list of conditions which would be applied together with an OR condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
maxResults (integer) --
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) --
The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text
emailOverviewAIAgentConfiguration (dict) --
Configuration for the EMAIL_OVERVIEW AI agent that generates structured overview of email conversations.
emailOverviewAIPromptId (string) --
The ID of the System AI prompt used for generating structured email conversation summaries.
locale (string) --
The locale setting for language-specific email overview processing (for example, en_US, es_ES).
emailGenerativeAnswerAIAgentConfiguration (dict) --
Configuration for the EMAIL_GENERATIVE_ANSWER AI agent that provides comprehensive knowledge-based answers for customer queries.
emailGenerativeAnswerAIPromptId (string) --
The ID of the System AI prompt used for generating comprehensive knowledge-based answers from email queries.
emailQueryReformulationAIPromptId (string) --
The ID of the System AI prompt used for reformulating email queries to optimize knowledge base search results.
locale (string) --
The locale setting for language-specific email processing and response generation (for example, en_US, es_ES).
associationConfigurations (list) --
Configuration settings for knowledge base associations used by the email generative answer agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
associationConfigurationData (dict) --
The data of the configuration for an Amazon Q in Connect Assistant Association.
knowledgeBaseAssociationConfigurationData (dict) --
The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
contentTagFilter (dict) --
An object that can be used to specify Tag conditions.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
orConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
A list of conditions which would be applied together with an OR condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
maxResults (integer) --
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) --
The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text
orchestrationAIAgentConfiguration (dict) --
The configuration for AI Agents of type ORCHESTRATION.
orchestrationAIPromptId (string) --
The AI Prompt identifier used by the Orchestration AI Agent.
orchestrationAIGuardrailId (string) --
The AI Guardrail identifier used by the Orchestration AI Agent.
toolConfigurations (list) --
The tool configurations used by the Orchestration AI Agent.
(dict) --
Configuration settings for a tool used by AI Agents.
toolName (string) --
The name of the tool.
toolType (string) --
The type of the tool.
title (string) --
The title of the tool configuration.
toolId (string) --
The identifier of the tool, for example toolName from Model Context Provider server.
description (string) --
The description of the tool configuration.
instruction (dict) --
Instructions for using the tool.
instruction (string) --
The instruction text for the tool.
examples (list) --
Examples for using the tool.
(string) --
overrideInputValues (list) --
Override input values for the tool configuration.
(dict) --
An input value override for tools.
jsonPath (string) --
The JSON path for the input value override.
value (dict) --
The override input value.
constant (dict) --
Constant input value configuration for tool override.
type (string) --
Override tool input value with constant values
value (string) --
The constant input override value.
outputFilters (list) --
Output filters applies to the tool result.
(dict) --
Filter configuration for tool output.
jsonPath (string) --
The JSON path for filtering tool output.
outputConfiguration (dict) --
The output configuration for the filter.
outputVariableNameOverride (string) --
Override the tool output results to different variable name.
sessionDataNamespace (string) --
The session data namespace for tool output.
inputSchema (:ref:`document<document>`) --
The input schema for the tool configuration.
outputSchema (:ref:`document<document>`) --
The output schema for the tool configuration.
annotations (dict) --
Annotations for the tool configuration.
title (string) --
The title of the annotation.
destructiveHint (boolean) --
A hint indicating that the annotation contains potentially destructive content.
userInteractionConfiguration (dict) --
Configuration for user interaction with the tool.
isUserConfirmationRequired (boolean) --
Indicates whether user confirmation is required for the interaction.
multiAgentConfigurations (list) --
The collaborator agents that the Orchestration AI Agent can work with. Each entry defines another agent that the orchestrator either delegates to or hands the conversation off to.
(dict) --
A union that configures a single collaborator agent for an Orchestration AI Agent, as either a delegate or a handoff.
delegateAgentConfiguration (dict) --
Configures the collaborator agent as a delegate that the Orchestration AI Agent invokes while retaining control of the conversation.
agentTarget (dict) --
The collaborator agent to delegate to.
aiAgentId (string) --
The identifier of an Amazon Connect AI Agent to use as the collaborator agent.
applicationId (string) --
The identifier of a third-party agent to use as the collaborator agent.
instruction (dict) --
The instruction that tells the Orchestration AI Agent when and how to delegate to this collaborator agent.
instruction (string) --
The natural-language instruction that tells the Orchestration AI Agent when and how to engage the collaborator agent.
examples (list) --
Example interactions that illustrate when the Orchestration AI Agent should engage the collaborator agent.
(string) --
handoffAgentConfiguration (dict) --
Configures the collaborator agent as a handoff target that the Orchestration AI Agent transfers control of the conversation to.
agentTarget (dict) --
The collaborator agent to hand off to.
aiAgentId (string) --
The identifier of an Amazon Connect AI Agent to use as the collaborator agent.
applicationId (string) --
The identifier of a third-party agent to use as the collaborator agent.
instruction (dict) --
The instruction that tells the Orchestration AI Agent when and how to hand off to this collaborator agent.
instruction (string) --
The natural-language instruction that tells the Orchestration AI Agent when and how to engage the collaborator agent.
examples (list) --
Example interactions that illustrate when the Orchestration AI Agent should engage the collaborator agent.
(string) --
audioStreamingEnabled (boolean) --
Specifies whether the caller's audio is streamed directly to the collaborator agent and the collaborator's audio response is played back during the handoff. This applies only to voice handoffs.
immediateHandoff (boolean) --
Specifies whether the conversation is handed off to this collaborator agent immediately on the first turn, without any orchestration reasoning. At most one handoff in an AI Agent's configuration can set this to true.
connectInstanceArn (string) --
The Amazon Resource Name (ARN) of the Amazon Connect instance used by the Orchestration AI Agent.
locale (string) --
The locale setting for the Orchestration AI Agent.
inputSchemas (list) --
The JSON schemas that define the structure of the structured data input accepted by the Orchestration AI Agent. The data in a DATA message sent to the agent is validated against these schemas. You can specify at most one schema.
(:ref:`document<document>`) --
outputSchemas (list) --
The JSON schemas that define the structure of the structured output generated by the Orchestration AI Agent. You can specify at most one schema.
(:ref:`document<document>`) --
noteTakingAIAgentConfiguration (dict) --
The configuration for AI Agents of type NOTE_TAKING.
noteTakingAIPromptId (string) --
The AI Prompt identifier used by the Note Taking AI Agent.
noteTakingAIGuardrailId (string) --
The AI Guardrail identifier used by the Note Taking AI Agent.
locale (string) --
The locale setting for language-specific case summarization generation (for example, en_US, es_ES).
caseSummarizationAIAgentConfiguration (dict) --
The configuration for AI Agents of type CASE_SUMMARIZATION.
caseSummarizationAIPromptId (string) --
The AI Prompt identifier used by the Case Summarization AI Agent.
caseSummarizationAIGuardrailId (string) --
The AI Guardrail identifier used by the Case Summarization AI Agent.
locale (string) --
The locale setting for the Case Summarization AI Agent.
modifiedTime (datetime) --
The time the AI Agent was last modified.
description (string) --
The description of the AI Agent.
visibilityStatus (string) --
The visibility status of the AI Agent.
tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
origin (string) --
Specifies the origin of the AI Agent. SYSTEM for a default AI Agent created by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent creation APIs.
status (string) --
The status of the AI Agent.
versionNumber (integer) --
The version number of the AI Agent version (returned if an AI Agent version was specified via use of a qualifier for the aiAgentId on the request).
{'response': {'value': {'data': {}}}, 'type': {'DATA'}}
Retrieves next message on an Amazon Q in Connect session.
See also: AWS API Documentation
Request Syntax
client.get_next_message(
assistantId='string',
sessionId='string',
nextMessageToken='string'
)
string
[REQUIRED]
The identifier of the Amazon Q in Connect assistant.
string
[REQUIRED]
The identifier of the Amazon Q in Connect session.
string
[REQUIRED]
The token for the next message. Use the value returned in the SendMessage or previous response in the next request to retrieve the next message.
dict
Response Syntax
{
'type': 'TEXT'|'TOOL_USE_RESULT'|'DATA',
'response': {
'value': {
'text': {
'value': 'string',
'citations': [
{
'contentId': 'string',
'title': 'string',
'knowledgeBaseId': 'string',
'citationSpan': {
'beginOffsetInclusive': 123,
'endOffsetExclusive': 123
},
'sourceURL': 'string',
'referenceType': 'WEB_CRAWLER'|'KNOWLEDGE_BASE'|'BEDROCK_KB_S3'|'BEDROCK_KB_WEB'|'BEDROCK_KB_CONFLUENCE'|'BEDROCK_KB_SALESFORCE'|'BEDROCK_KB_SHAREPOINT'|'BEDROCK_KB_KENDRA'|'BEDROCK_KB_CUSTOM_DOCUMENT'|'BEDROCK_KB_SQL'
},
],
'aiGuardrailAssessment': {
'blocked': True|False
}
},
'toolUseResult': {
'toolUseId': 'string',
'toolName': 'string',
'toolResult': {...}|[...]|123|123.4|'string'|True|None,
'inputSchema': {...}|[...]|123|123.4|'string'|True|None
},
'data': {...}|[...]|123|123.4|'string'|True|None
},
'messageId': 'string',
'participant': 'CUSTOMER'|'AGENT'|'BOT',
'timestamp': datetime(2015, 1, 1)
},
'requestMessageId': 'string',
'conversationState': {
'status': 'CLOSED'|'READY'|'PROCESSING',
'reason': 'SUCCESS'|'FAILED'|'REJECTED'
},
'nextMessageToken': 'string',
'conversationSessionData': [
{
'key': 'string',
'value': {
'stringValue': 'string'
}
},
],
'chunkedResponseTerminated': True|False
}
Response Structure
(dict) --
type (string) --
The type of message response.
response (dict) --
The message response to the requested message.
value (dict) --
The value of a message data.
text (dict) --
The message data in text type.
value (string) --
The value of the message data in text type.
citations (list) --
The citations associated with the text message.
(dict) --
A citation that references source content.
contentId (string) --
The identifier of the content being cited.
title (string) --
The title of the cited content.
knowledgeBaseId (string) --
The identifier of the knowledge base containing the cited content.
citationSpan (dict) --
Contains information about where the text with a citation begins and ends in the generated output.
beginOffsetInclusive (integer) --
Where the text with a citation starts in the generated output.
endOffsetExclusive (integer) --
Where the text with a citation ends in the generated output.
sourceURL (string) --
The source URL for the citation.
referenceType (string) --
A type to define the KB origin of a cited content
aiGuardrailAssessment (dict) --
The AI Guardrail assessment for the text message.
blocked (boolean) --
Indicates whether the AI Guardrail blocked the content.
toolUseResult (dict) --
The result of tool usage in the message.
toolUseId (string) --
The identifier of the tool use instance.
toolName (string) --
The name of the tool that was used.
toolResult (:ref:`document<document>`) --
The result of the tool usage.
inputSchema (:ref:`document<document>`) --
The input schema for the tool use result.
data (:ref:`document<document>`) --
The message data as a structured JSON document. This is the payload for a message of type DATA, and must be a JSON object at the root level.
messageId (string) --
The identifier of a message.
participant (string) --
The participant of a message.
timestamp (datetime) --
The timestamp of a message.
requestMessageId (string) --
The identifier of the submitted message.
conversationState (dict) --
The state of current conversation.
status (string) --
The status of the conversation state.
reason (string) --
The reason of the conversation state.
nextMessageToken (string) --
The token for the next message.
conversationSessionData (list) --
The conversation data stored on an Amazon Q in Connect Session.
(dict) --
The list of key-value pairs that are stored on the session.
key (string) --
The key of the data stored on the session.
value (dict) --
The value of the data stored on the session.
stringValue (string) --
The string value of the data stored on the session.
chunkedResponseTerminated (boolean) --
Indicates whether the chunked response has been terminated.
{'aiAgentVersionSummaries': {'aiAgentSummary': {'configuration': {'orchestrationAIAgentConfiguration': {'inputSchemas': [{}],
'multiAgentConfigurations': [{'delegateAgentConfiguration': {'agentTarget': {'aiAgentId': 'string',
'applicationId': 'string'},
'instruction': {'examples': ['string'],
'instruction': 'string'}},
'handoffAgentConfiguration': {'agentTarget': {'aiAgentId': 'string',
'applicationId': 'string'},
'audioStreamingEnabled': 'boolean',
'immediateHandoff': 'boolean',
'instruction': {'examples': ['string'],
'instruction': 'string'}}}],
'outputSchemas': [{}]}}}}}
List AI Agent versions.
See also: AWS API Documentation
Request Syntax
client.list_ai_agent_versions(
assistantId='string',
aiAgentId='string',
nextToken='string',
maxResults=123,
origin='SYSTEM'|'CUSTOMER'
)
string
[REQUIRED]
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
string
[REQUIRED]
The identifier of the Amazon Q in Connect AI Agent for which versions are to be listed.
string
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
integer
The maximum number of results to return per page.
string
The origin of the AI Agent versions to be listed. SYSTEM for a default AI Agent created by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent creation APIs.
dict
Response Syntax
{
'aiAgentVersionSummaries': [
{
'aiAgentSummary': {
'name': 'string',
'assistantId': 'string',
'assistantArn': 'string',
'aiAgentId': 'string',
'type': 'MANUAL_SEARCH'|'ANSWER_RECOMMENDATION'|'SELF_SERVICE'|'EMAIL_RESPONSE'|'EMAIL_OVERVIEW'|'EMAIL_GENERATIVE_ANSWER'|'ORCHESTRATION'|'NOTE_TAKING'|'CASE_SUMMARIZATION',
'aiAgentArn': 'string',
'modifiedTime': datetime(2015, 1, 1),
'visibilityStatus': 'SAVED'|'PUBLISHED',
'configuration': {
'manualSearchAIAgentConfiguration': {
'answerGenerationAIPromptId': 'string',
'answerGenerationAIGuardrailId': 'string',
'associationConfigurations': [
{
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE',
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'tagCondition': {
'key': 'string',
'value': 'string'
},
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
]
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
}
},
],
'locale': 'string'
},
'answerRecommendationAIAgentConfiguration': {
'intentLabelingGenerationAIPromptId': 'string',
'queryReformulationAIPromptId': 'string',
'answerGenerationAIPromptId': 'string',
'answerGenerationAIGuardrailId': 'string',
'associationConfigurations': [
{
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE',
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'tagCondition': {
'key': 'string',
'value': 'string'
},
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
]
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
}
},
],
'locale': 'string',
'suggestedMessages': [
'string',
]
},
'selfServiceAIAgentConfiguration': {
'selfServicePreProcessingAIPromptId': 'string',
'selfServiceAnswerGenerationAIPromptId': 'string',
'selfServiceAIGuardrailId': 'string',
'associationConfigurations': [
{
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE',
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'tagCondition': {
'key': 'string',
'value': 'string'
},
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
]
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
}
},
]
},
'emailResponseAIAgentConfiguration': {
'emailResponseAIPromptId': 'string',
'emailQueryReformulationAIPromptId': 'string',
'locale': 'string',
'associationConfigurations': [
{
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE',
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'tagCondition': {
'key': 'string',
'value': 'string'
},
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
]
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
}
},
]
},
'emailOverviewAIAgentConfiguration': {
'emailOverviewAIPromptId': 'string',
'locale': 'string'
},
'emailGenerativeAnswerAIAgentConfiguration': {
'emailGenerativeAnswerAIPromptId': 'string',
'emailQueryReformulationAIPromptId': 'string',
'locale': 'string',
'associationConfigurations': [
{
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE',
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'tagCondition': {
'key': 'string',
'value': 'string'
},
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
]
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
}
},
]
},
'orchestrationAIAgentConfiguration': {
'orchestrationAIPromptId': 'string',
'orchestrationAIGuardrailId': 'string',
'toolConfigurations': [
{
'toolName': 'string',
'toolType': 'MODEL_CONTEXT_PROTOCOL'|'RETURN_TO_CONTROL'|'CONSTANT',
'title': 'string',
'toolId': 'string',
'description': 'string',
'instruction': {
'instruction': 'string',
'examples': [
'string',
]
},
'overrideInputValues': [
{
'jsonPath': 'string',
'value': {
'constant': {
'type': 'STRING'|'NUMBER'|'JSON_STRING',
'value': 'string'
}
}
},
],
'outputFilters': [
{
'jsonPath': 'string',
'outputConfiguration': {
'outputVariableNameOverride': 'string',
'sessionDataNamespace': 'string'
}
},
],
'inputSchema': {...}|[...]|123|123.4|'string'|True|None,
'outputSchema': {...}|[...]|123|123.4|'string'|True|None,
'annotations': {
'title': 'string',
'destructiveHint': True|False
},
'userInteractionConfiguration': {
'isUserConfirmationRequired': True|False
}
},
],
'multiAgentConfigurations': [
{
'delegateAgentConfiguration': {
'agentTarget': {
'aiAgentId': 'string',
'applicationId': 'string'
},
'instruction': {
'instruction': 'string',
'examples': [
'string',
]
}
},
'handoffAgentConfiguration': {
'agentTarget': {
'aiAgentId': 'string',
'applicationId': 'string'
},
'instruction': {
'instruction': 'string',
'examples': [
'string',
]
},
'audioStreamingEnabled': True|False,
'immediateHandoff': True|False
}
},
],
'connectInstanceArn': 'string',
'locale': 'string',
'inputSchemas': [
{...}|[...]|123|123.4|'string'|True|None,
],
'outputSchemas': [
{...}|[...]|123|123.4|'string'|True|None,
]
},
'noteTakingAIAgentConfiguration': {
'noteTakingAIPromptId': 'string',
'noteTakingAIGuardrailId': 'string',
'locale': 'string'
},
'caseSummarizationAIAgentConfiguration': {
'caseSummarizationAIPromptId': 'string',
'caseSummarizationAIGuardrailId': 'string',
'locale': 'string'
}
},
'origin': 'SYSTEM'|'CUSTOMER',
'description': 'string',
'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED',
'tags': {
'string': 'string'
}
},
'versionNumber': 123
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
aiAgentVersionSummaries (list) --
The summaries of AI Agent versions.
(dict) --
The summary of the AI Agent version.
aiAgentSummary (dict) --
The data for the summary of the AI Agent version.
name (string) --
The name of the AI Agent.
assistantId (string) --
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
assistantArn (string) --
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
aiAgentId (string) --
The identifier of the AI Agent.
type (string) --
The type of the AI Agent.
aiAgentArn (string) --
The Amazon Resource Name (ARN) of the AI agent.
modifiedTime (datetime) --
The time the AI Agent was last modified.
visibilityStatus (string) --
The visibility status of the AI Agent.
configuration (dict) --
The configuration for the AI Agent.
manualSearchAIAgentConfiguration (dict) --
The configuration for AI Agents of type MANUAL_SEARCH.
answerGenerationAIPromptId (string) --
The AI Prompt identifier for the Answer Generation prompt used by the MANUAL_SEARCH AI Agent.
answerGenerationAIGuardrailId (string) --
The AI Guardrail identifier for the Answer Generation guardrail used by the MANUAL_SEARCH AI Agent.
associationConfigurations (list) --
The association configurations for overriding behavior on this AI Agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
associationConfigurationData (dict) --
The data of the configuration for an Amazon Q in Connect Assistant Association.
knowledgeBaseAssociationConfigurationData (dict) --
The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
contentTagFilter (dict) --
An object that can be used to specify Tag conditions.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
orConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
A list of conditions which would be applied together with an OR condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
maxResults (integer) --
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) --
The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text
locale (string) --
The locale to which specifies the language and region settings that determine the response language for QueryAssistant.
answerRecommendationAIAgentConfiguration (dict) --
The configuration for AI Agents of type ANSWER_RECOMMENDATION.
intentLabelingGenerationAIPromptId (string) --
The AI Prompt identifier for the Intent Labeling prompt used by the ANSWER_RECOMMENDATION AI Agent.
queryReformulationAIPromptId (string) --
The AI Prompt identifier for the Query Reformulation prompt used by the ANSWER_RECOMMENDATION AI Agent.
answerGenerationAIPromptId (string) --
The AI Prompt identifier for the Answer Generation prompt used by the ANSWER_RECOMMENDATION AI Agent.
answerGenerationAIGuardrailId (string) --
The AI Guardrail identifier for the Answer Generation Guardrail used by the ANSWER_RECOMMENDATION AI Agent.
associationConfigurations (list) --
The association configurations for overriding behavior on this AI Agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
associationConfigurationData (dict) --
The data of the configuration for an Amazon Q in Connect Assistant Association.
knowledgeBaseAssociationConfigurationData (dict) --
The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
contentTagFilter (dict) --
An object that can be used to specify Tag conditions.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
orConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
A list of conditions which would be applied together with an OR condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
maxResults (integer) --
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) --
The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text
locale (string) --
The locale to which specifies the language and region settings that determine the response language for QueryAssistant.
suggestedMessages (list) --
The suggested messages configuration for the Answer Recommendation AI Agent.
(string) --
selfServiceAIAgentConfiguration (dict) --
The configuration for AI Agents of type SELF_SERVICE.
selfServicePreProcessingAIPromptId (string) --
The AI Prompt identifier for the Self Service Pre-Processing prompt used by the SELF_SERVICE AI Agent
selfServiceAnswerGenerationAIPromptId (string) --
The AI Prompt identifier for the Self Service Answer Generation prompt used by the SELF_SERVICE AI Agent
selfServiceAIGuardrailId (string) --
The AI Guardrail identifier used by the SELF_SERVICE AI Agent.
associationConfigurations (list) --
The association configurations for overriding behavior on this AI Agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
associationConfigurationData (dict) --
The data of the configuration for an Amazon Q in Connect Assistant Association.
knowledgeBaseAssociationConfigurationData (dict) --
The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
contentTagFilter (dict) --
An object that can be used to specify Tag conditions.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
orConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
A list of conditions which would be applied together with an OR condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
maxResults (integer) --
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) --
The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text
emailResponseAIAgentConfiguration (dict) --
Configuration for the EMAIL_RESPONSE AI agent that generates professional email responses using knowledge base content.
emailResponseAIPromptId (string) --
The ID of the System AI prompt used for generating professional email responses based on knowledge base content.
emailQueryReformulationAIPromptId (string) --
The ID of the System AI prompt used for reformulating email queries to optimize knowledge base search for response generation.
locale (string) --
The locale setting for language-specific email response generation (for example, en_US, es_ES).
associationConfigurations (list) --
Configuration settings for knowledge base associations used by the email response agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
associationConfigurationData (dict) --
The data of the configuration for an Amazon Q in Connect Assistant Association.
knowledgeBaseAssociationConfigurationData (dict) --
The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
contentTagFilter (dict) --
An object that can be used to specify Tag conditions.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
orConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
A list of conditions which would be applied together with an OR condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
maxResults (integer) --
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) --
The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text
emailOverviewAIAgentConfiguration (dict) --
Configuration for the EMAIL_OVERVIEW AI agent that generates structured overview of email conversations.
emailOverviewAIPromptId (string) --
The ID of the System AI prompt used for generating structured email conversation summaries.
locale (string) --
The locale setting for language-specific email overview processing (for example, en_US, es_ES).
emailGenerativeAnswerAIAgentConfiguration (dict) --
Configuration for the EMAIL_GENERATIVE_ANSWER AI agent that provides comprehensive knowledge-based answers for customer queries.
emailGenerativeAnswerAIPromptId (string) --
The ID of the System AI prompt used for generating comprehensive knowledge-based answers from email queries.
emailQueryReformulationAIPromptId (string) --
The ID of the System AI prompt used for reformulating email queries to optimize knowledge base search results.
locale (string) --
The locale setting for language-specific email processing and response generation (for example, en_US, es_ES).
associationConfigurations (list) --
Configuration settings for knowledge base associations used by the email generative answer agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
associationConfigurationData (dict) --
The data of the configuration for an Amazon Q in Connect Assistant Association.
knowledgeBaseAssociationConfigurationData (dict) --
The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
contentTagFilter (dict) --
An object that can be used to specify Tag conditions.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
orConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
A list of conditions which would be applied together with an OR condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
maxResults (integer) --
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) --
The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text
orchestrationAIAgentConfiguration (dict) --
The configuration for AI Agents of type ORCHESTRATION.
orchestrationAIPromptId (string) --
The AI Prompt identifier used by the Orchestration AI Agent.
orchestrationAIGuardrailId (string) --
The AI Guardrail identifier used by the Orchestration AI Agent.
toolConfigurations (list) --
The tool configurations used by the Orchestration AI Agent.
(dict) --
Configuration settings for a tool used by AI Agents.
toolName (string) --
The name of the tool.
toolType (string) --
The type of the tool.
title (string) --
The title of the tool configuration.
toolId (string) --
The identifier of the tool, for example toolName from Model Context Provider server.
description (string) --
The description of the tool configuration.
instruction (dict) --
Instructions for using the tool.
instruction (string) --
The instruction text for the tool.
examples (list) --
Examples for using the tool.
(string) --
overrideInputValues (list) --
Override input values for the tool configuration.
(dict) --
An input value override for tools.
jsonPath (string) --
The JSON path for the input value override.
value (dict) --
The override input value.
constant (dict) --
Constant input value configuration for tool override.
type (string) --
Override tool input value with constant values
value (string) --
The constant input override value.
outputFilters (list) --
Output filters applies to the tool result.
(dict) --
Filter configuration for tool output.
jsonPath (string) --
The JSON path for filtering tool output.
outputConfiguration (dict) --
The output configuration for the filter.
outputVariableNameOverride (string) --
Override the tool output results to different variable name.
sessionDataNamespace (string) --
The session data namespace for tool output.
inputSchema (:ref:`document<document>`) --
The input schema for the tool configuration.
outputSchema (:ref:`document<document>`) --
The output schema for the tool configuration.
annotations (dict) --
Annotations for the tool configuration.
title (string) --
The title of the annotation.
destructiveHint (boolean) --
A hint indicating that the annotation contains potentially destructive content.
userInteractionConfiguration (dict) --
Configuration for user interaction with the tool.
isUserConfirmationRequired (boolean) --
Indicates whether user confirmation is required for the interaction.
multiAgentConfigurations (list) --
The collaborator agents that the Orchestration AI Agent can work with. Each entry defines another agent that the orchestrator either delegates to or hands the conversation off to.
(dict) --
A union that configures a single collaborator agent for an Orchestration AI Agent, as either a delegate or a handoff.
delegateAgentConfiguration (dict) --
Configures the collaborator agent as a delegate that the Orchestration AI Agent invokes while retaining control of the conversation.
agentTarget (dict) --
The collaborator agent to delegate to.
aiAgentId (string) --
The identifier of an Amazon Connect AI Agent to use as the collaborator agent.
applicationId (string) --
The identifier of a third-party agent to use as the collaborator agent.
instruction (dict) --
The instruction that tells the Orchestration AI Agent when and how to delegate to this collaborator agent.
instruction (string) --
The natural-language instruction that tells the Orchestration AI Agent when and how to engage the collaborator agent.
examples (list) --
Example interactions that illustrate when the Orchestration AI Agent should engage the collaborator agent.
(string) --
handoffAgentConfiguration (dict) --
Configures the collaborator agent as a handoff target that the Orchestration AI Agent transfers control of the conversation to.
agentTarget (dict) --
The collaborator agent to hand off to.
aiAgentId (string) --
The identifier of an Amazon Connect AI Agent to use as the collaborator agent.
applicationId (string) --
The identifier of a third-party agent to use as the collaborator agent.
instruction (dict) --
The instruction that tells the Orchestration AI Agent when and how to hand off to this collaborator agent.
instruction (string) --
The natural-language instruction that tells the Orchestration AI Agent when and how to engage the collaborator agent.
examples (list) --
Example interactions that illustrate when the Orchestration AI Agent should engage the collaborator agent.
(string) --
audioStreamingEnabled (boolean) --
Specifies whether the caller's audio is streamed directly to the collaborator agent and the collaborator's audio response is played back during the handoff. This applies only to voice handoffs.
immediateHandoff (boolean) --
Specifies whether the conversation is handed off to this collaborator agent immediately on the first turn, without any orchestration reasoning. At most one handoff in an AI Agent's configuration can set this to true.
connectInstanceArn (string) --
The Amazon Resource Name (ARN) of the Amazon Connect instance used by the Orchestration AI Agent.
locale (string) --
The locale setting for the Orchestration AI Agent.
inputSchemas (list) --
The JSON schemas that define the structure of the structured data input accepted by the Orchestration AI Agent. The data in a DATA message sent to the agent is validated against these schemas. You can specify at most one schema.
(:ref:`document<document>`) --
outputSchemas (list) --
The JSON schemas that define the structure of the structured output generated by the Orchestration AI Agent. You can specify at most one schema.
(:ref:`document<document>`) --
noteTakingAIAgentConfiguration (dict) --
The configuration for AI Agents of type NOTE_TAKING.
noteTakingAIPromptId (string) --
The AI Prompt identifier used by the Note Taking AI Agent.
noteTakingAIGuardrailId (string) --
The AI Guardrail identifier used by the Note Taking AI Agent.
locale (string) --
The locale setting for language-specific case summarization generation (for example, en_US, es_ES).
caseSummarizationAIAgentConfiguration (dict) --
The configuration for AI Agents of type CASE_SUMMARIZATION.
caseSummarizationAIPromptId (string) --
The AI Prompt identifier used by the Case Summarization AI Agent.
caseSummarizationAIGuardrailId (string) --
The AI Guardrail identifier used by the Case Summarization AI Agent.
locale (string) --
The locale setting for the Case Summarization AI Agent.
origin (string) --
The origin of the AI Agent. SYSTEM for a default AI Agent created by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent creation APIs.
description (string) --
The description of the AI Agent.
status (string) --
The status of the AI Agent.
tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
versionNumber (integer) --
The version number for this AI Agent version.
nextToken (string) --
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
{'aiAgentSummaries': {'configuration': {'orchestrationAIAgentConfiguration': {'inputSchemas': [{}],
'multiAgentConfigurations': [{'delegateAgentConfiguration': {'agentTarget': {'aiAgentId': 'string',
'applicationId': 'string'},
'instruction': {'examples': ['string'],
'instruction': 'string'}},
'handoffAgentConfiguration': {'agentTarget': {'aiAgentId': 'string',
'applicationId': 'string'},
'audioStreamingEnabled': 'boolean',
'immediateHandoff': 'boolean',
'instruction': {'examples': ['string'],
'instruction': 'string'}}}],
'outputSchemas': [{}]}}}}
Lists AI Agents.
See also: AWS API Documentation
Request Syntax
client.list_ai_agents(
assistantId='string',
nextToken='string',
maxResults=123,
origin='SYSTEM'|'CUSTOMER'
)
string
[REQUIRED]
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
string
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
integer
The maximum number of results to return per page.
string
The origin of the AI Agents to be listed. SYSTEM for a default AI Agent created by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent creation APIs.
dict
Response Syntax
{
'aiAgentSummaries': [
{
'name': 'string',
'assistantId': 'string',
'assistantArn': 'string',
'aiAgentId': 'string',
'type': 'MANUAL_SEARCH'|'ANSWER_RECOMMENDATION'|'SELF_SERVICE'|'EMAIL_RESPONSE'|'EMAIL_OVERVIEW'|'EMAIL_GENERATIVE_ANSWER'|'ORCHESTRATION'|'NOTE_TAKING'|'CASE_SUMMARIZATION',
'aiAgentArn': 'string',
'modifiedTime': datetime(2015, 1, 1),
'visibilityStatus': 'SAVED'|'PUBLISHED',
'configuration': {
'manualSearchAIAgentConfiguration': {
'answerGenerationAIPromptId': 'string',
'answerGenerationAIGuardrailId': 'string',
'associationConfigurations': [
{
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE',
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'tagCondition': {
'key': 'string',
'value': 'string'
},
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
]
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
}
},
],
'locale': 'string'
},
'answerRecommendationAIAgentConfiguration': {
'intentLabelingGenerationAIPromptId': 'string',
'queryReformulationAIPromptId': 'string',
'answerGenerationAIPromptId': 'string',
'answerGenerationAIGuardrailId': 'string',
'associationConfigurations': [
{
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE',
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'tagCondition': {
'key': 'string',
'value': 'string'
},
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
]
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
}
},
],
'locale': 'string',
'suggestedMessages': [
'string',
]
},
'selfServiceAIAgentConfiguration': {
'selfServicePreProcessingAIPromptId': 'string',
'selfServiceAnswerGenerationAIPromptId': 'string',
'selfServiceAIGuardrailId': 'string',
'associationConfigurations': [
{
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE',
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'tagCondition': {
'key': 'string',
'value': 'string'
},
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
]
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
}
},
]
},
'emailResponseAIAgentConfiguration': {
'emailResponseAIPromptId': 'string',
'emailQueryReformulationAIPromptId': 'string',
'locale': 'string',
'associationConfigurations': [
{
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE',
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'tagCondition': {
'key': 'string',
'value': 'string'
},
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
]
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
}
},
]
},
'emailOverviewAIAgentConfiguration': {
'emailOverviewAIPromptId': 'string',
'locale': 'string'
},
'emailGenerativeAnswerAIAgentConfiguration': {
'emailGenerativeAnswerAIPromptId': 'string',
'emailQueryReformulationAIPromptId': 'string',
'locale': 'string',
'associationConfigurations': [
{
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE',
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'tagCondition': {
'key': 'string',
'value': 'string'
},
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
]
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
}
},
]
},
'orchestrationAIAgentConfiguration': {
'orchestrationAIPromptId': 'string',
'orchestrationAIGuardrailId': 'string',
'toolConfigurations': [
{
'toolName': 'string',
'toolType': 'MODEL_CONTEXT_PROTOCOL'|'RETURN_TO_CONTROL'|'CONSTANT',
'title': 'string',
'toolId': 'string',
'description': 'string',
'instruction': {
'instruction': 'string',
'examples': [
'string',
]
},
'overrideInputValues': [
{
'jsonPath': 'string',
'value': {
'constant': {
'type': 'STRING'|'NUMBER'|'JSON_STRING',
'value': 'string'
}
}
},
],
'outputFilters': [
{
'jsonPath': 'string',
'outputConfiguration': {
'outputVariableNameOverride': 'string',
'sessionDataNamespace': 'string'
}
},
],
'inputSchema': {...}|[...]|123|123.4|'string'|True|None,
'outputSchema': {...}|[...]|123|123.4|'string'|True|None,
'annotations': {
'title': 'string',
'destructiveHint': True|False
},
'userInteractionConfiguration': {
'isUserConfirmationRequired': True|False
}
},
],
'multiAgentConfigurations': [
{
'delegateAgentConfiguration': {
'agentTarget': {
'aiAgentId': 'string',
'applicationId': 'string'
},
'instruction': {
'instruction': 'string',
'examples': [
'string',
]
}
},
'handoffAgentConfiguration': {
'agentTarget': {
'aiAgentId': 'string',
'applicationId': 'string'
},
'instruction': {
'instruction': 'string',
'examples': [
'string',
]
},
'audioStreamingEnabled': True|False,
'immediateHandoff': True|False
}
},
],
'connectInstanceArn': 'string',
'locale': 'string',
'inputSchemas': [
{...}|[...]|123|123.4|'string'|True|None,
],
'outputSchemas': [
{...}|[...]|123|123.4|'string'|True|None,
]
},
'noteTakingAIAgentConfiguration': {
'noteTakingAIPromptId': 'string',
'noteTakingAIGuardrailId': 'string',
'locale': 'string'
},
'caseSummarizationAIAgentConfiguration': {
'caseSummarizationAIPromptId': 'string',
'caseSummarizationAIGuardrailId': 'string',
'locale': 'string'
}
},
'origin': 'SYSTEM'|'CUSTOMER',
'description': 'string',
'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED',
'tags': {
'string': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
aiAgentSummaries (list) --
The summaries of AI Agents.
(dict) --
The summary of the AI Agent.
name (string) --
The name of the AI Agent.
assistantId (string) --
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
assistantArn (string) --
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
aiAgentId (string) --
The identifier of the AI Agent.
type (string) --
The type of the AI Agent.
aiAgentArn (string) --
The Amazon Resource Name (ARN) of the AI agent.
modifiedTime (datetime) --
The time the AI Agent was last modified.
visibilityStatus (string) --
The visibility status of the AI Agent.
configuration (dict) --
The configuration for the AI Agent.
manualSearchAIAgentConfiguration (dict) --
The configuration for AI Agents of type MANUAL_SEARCH.
answerGenerationAIPromptId (string) --
The AI Prompt identifier for the Answer Generation prompt used by the MANUAL_SEARCH AI Agent.
answerGenerationAIGuardrailId (string) --
The AI Guardrail identifier for the Answer Generation guardrail used by the MANUAL_SEARCH AI Agent.
associationConfigurations (list) --
The association configurations for overriding behavior on this AI Agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
associationConfigurationData (dict) --
The data of the configuration for an Amazon Q in Connect Assistant Association.
knowledgeBaseAssociationConfigurationData (dict) --
The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
contentTagFilter (dict) --
An object that can be used to specify Tag conditions.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
orConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
A list of conditions which would be applied together with an OR condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
maxResults (integer) --
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) --
The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text
locale (string) --
The locale to which specifies the language and region settings that determine the response language for QueryAssistant.
answerRecommendationAIAgentConfiguration (dict) --
The configuration for AI Agents of type ANSWER_RECOMMENDATION.
intentLabelingGenerationAIPromptId (string) --
The AI Prompt identifier for the Intent Labeling prompt used by the ANSWER_RECOMMENDATION AI Agent.
queryReformulationAIPromptId (string) --
The AI Prompt identifier for the Query Reformulation prompt used by the ANSWER_RECOMMENDATION AI Agent.
answerGenerationAIPromptId (string) --
The AI Prompt identifier for the Answer Generation prompt used by the ANSWER_RECOMMENDATION AI Agent.
answerGenerationAIGuardrailId (string) --
The AI Guardrail identifier for the Answer Generation Guardrail used by the ANSWER_RECOMMENDATION AI Agent.
associationConfigurations (list) --
The association configurations for overriding behavior on this AI Agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
associationConfigurationData (dict) --
The data of the configuration for an Amazon Q in Connect Assistant Association.
knowledgeBaseAssociationConfigurationData (dict) --
The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
contentTagFilter (dict) --
An object that can be used to specify Tag conditions.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
orConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
A list of conditions which would be applied together with an OR condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
maxResults (integer) --
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) --
The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text
locale (string) --
The locale to which specifies the language and region settings that determine the response language for QueryAssistant.
suggestedMessages (list) --
The suggested messages configuration for the Answer Recommendation AI Agent.
(string) --
selfServiceAIAgentConfiguration (dict) --
The configuration for AI Agents of type SELF_SERVICE.
selfServicePreProcessingAIPromptId (string) --
The AI Prompt identifier for the Self Service Pre-Processing prompt used by the SELF_SERVICE AI Agent
selfServiceAnswerGenerationAIPromptId (string) --
The AI Prompt identifier for the Self Service Answer Generation prompt used by the SELF_SERVICE AI Agent
selfServiceAIGuardrailId (string) --
The AI Guardrail identifier used by the SELF_SERVICE AI Agent.
associationConfigurations (list) --
The association configurations for overriding behavior on this AI Agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
associationConfigurationData (dict) --
The data of the configuration for an Amazon Q in Connect Assistant Association.
knowledgeBaseAssociationConfigurationData (dict) --
The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
contentTagFilter (dict) --
An object that can be used to specify Tag conditions.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
orConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
A list of conditions which would be applied together with an OR condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
maxResults (integer) --
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) --
The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text
emailResponseAIAgentConfiguration (dict) --
Configuration for the EMAIL_RESPONSE AI agent that generates professional email responses using knowledge base content.
emailResponseAIPromptId (string) --
The ID of the System AI prompt used for generating professional email responses based on knowledge base content.
emailQueryReformulationAIPromptId (string) --
The ID of the System AI prompt used for reformulating email queries to optimize knowledge base search for response generation.
locale (string) --
The locale setting for language-specific email response generation (for example, en_US, es_ES).
associationConfigurations (list) --
Configuration settings for knowledge base associations used by the email response agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
associationConfigurationData (dict) --
The data of the configuration for an Amazon Q in Connect Assistant Association.
knowledgeBaseAssociationConfigurationData (dict) --
The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
contentTagFilter (dict) --
An object that can be used to specify Tag conditions.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
orConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
A list of conditions which would be applied together with an OR condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
maxResults (integer) --
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) --
The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text
emailOverviewAIAgentConfiguration (dict) --
Configuration for the EMAIL_OVERVIEW AI agent that generates structured overview of email conversations.
emailOverviewAIPromptId (string) --
The ID of the System AI prompt used for generating structured email conversation summaries.
locale (string) --
The locale setting for language-specific email overview processing (for example, en_US, es_ES).
emailGenerativeAnswerAIAgentConfiguration (dict) --
Configuration for the EMAIL_GENERATIVE_ANSWER AI agent that provides comprehensive knowledge-based answers for customer queries.
emailGenerativeAnswerAIPromptId (string) --
The ID of the System AI prompt used for generating comprehensive knowledge-based answers from email queries.
emailQueryReformulationAIPromptId (string) --
The ID of the System AI prompt used for reformulating email queries to optimize knowledge base search results.
locale (string) --
The locale setting for language-specific email processing and response generation (for example, en_US, es_ES).
associationConfigurations (list) --
Configuration settings for knowledge base associations used by the email generative answer agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
associationConfigurationData (dict) --
The data of the configuration for an Amazon Q in Connect Assistant Association.
knowledgeBaseAssociationConfigurationData (dict) --
The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
contentTagFilter (dict) --
An object that can be used to specify Tag conditions.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
orConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
A list of conditions which would be applied together with an OR condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
maxResults (integer) --
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) --
The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text
orchestrationAIAgentConfiguration (dict) --
The configuration for AI Agents of type ORCHESTRATION.
orchestrationAIPromptId (string) --
The AI Prompt identifier used by the Orchestration AI Agent.
orchestrationAIGuardrailId (string) --
The AI Guardrail identifier used by the Orchestration AI Agent.
toolConfigurations (list) --
The tool configurations used by the Orchestration AI Agent.
(dict) --
Configuration settings for a tool used by AI Agents.
toolName (string) --
The name of the tool.
toolType (string) --
The type of the tool.
title (string) --
The title of the tool configuration.
toolId (string) --
The identifier of the tool, for example toolName from Model Context Provider server.
description (string) --
The description of the tool configuration.
instruction (dict) --
Instructions for using the tool.
instruction (string) --
The instruction text for the tool.
examples (list) --
Examples for using the tool.
(string) --
overrideInputValues (list) --
Override input values for the tool configuration.
(dict) --
An input value override for tools.
jsonPath (string) --
The JSON path for the input value override.
value (dict) --
The override input value.
constant (dict) --
Constant input value configuration for tool override.
type (string) --
Override tool input value with constant values
value (string) --
The constant input override value.
outputFilters (list) --
Output filters applies to the tool result.
(dict) --
Filter configuration for tool output.
jsonPath (string) --
The JSON path for filtering tool output.
outputConfiguration (dict) --
The output configuration for the filter.
outputVariableNameOverride (string) --
Override the tool output results to different variable name.
sessionDataNamespace (string) --
The session data namespace for tool output.
inputSchema (:ref:`document<document>`) --
The input schema for the tool configuration.
outputSchema (:ref:`document<document>`) --
The output schema for the tool configuration.
annotations (dict) --
Annotations for the tool configuration.
title (string) --
The title of the annotation.
destructiveHint (boolean) --
A hint indicating that the annotation contains potentially destructive content.
userInteractionConfiguration (dict) --
Configuration for user interaction with the tool.
isUserConfirmationRequired (boolean) --
Indicates whether user confirmation is required for the interaction.
multiAgentConfigurations (list) --
The collaborator agents that the Orchestration AI Agent can work with. Each entry defines another agent that the orchestrator either delegates to or hands the conversation off to.
(dict) --
A union that configures a single collaborator agent for an Orchestration AI Agent, as either a delegate or a handoff.
delegateAgentConfiguration (dict) --
Configures the collaborator agent as a delegate that the Orchestration AI Agent invokes while retaining control of the conversation.
agentTarget (dict) --
The collaborator agent to delegate to.
aiAgentId (string) --
The identifier of an Amazon Connect AI Agent to use as the collaborator agent.
applicationId (string) --
The identifier of a third-party agent to use as the collaborator agent.
instruction (dict) --
The instruction that tells the Orchestration AI Agent when and how to delegate to this collaborator agent.
instruction (string) --
The natural-language instruction that tells the Orchestration AI Agent when and how to engage the collaborator agent.
examples (list) --
Example interactions that illustrate when the Orchestration AI Agent should engage the collaborator agent.
(string) --
handoffAgentConfiguration (dict) --
Configures the collaborator agent as a handoff target that the Orchestration AI Agent transfers control of the conversation to.
agentTarget (dict) --
The collaborator agent to hand off to.
aiAgentId (string) --
The identifier of an Amazon Connect AI Agent to use as the collaborator agent.
applicationId (string) --
The identifier of a third-party agent to use as the collaborator agent.
instruction (dict) --
The instruction that tells the Orchestration AI Agent when and how to hand off to this collaborator agent.
instruction (string) --
The natural-language instruction that tells the Orchestration AI Agent when and how to engage the collaborator agent.
examples (list) --
Example interactions that illustrate when the Orchestration AI Agent should engage the collaborator agent.
(string) --
audioStreamingEnabled (boolean) --
Specifies whether the caller's audio is streamed directly to the collaborator agent and the collaborator's audio response is played back during the handoff. This applies only to voice handoffs.
immediateHandoff (boolean) --
Specifies whether the conversation is handed off to this collaborator agent immediately on the first turn, without any orchestration reasoning. At most one handoff in an AI Agent's configuration can set this to true.
connectInstanceArn (string) --
The Amazon Resource Name (ARN) of the Amazon Connect instance used by the Orchestration AI Agent.
locale (string) --
The locale setting for the Orchestration AI Agent.
inputSchemas (list) --
The JSON schemas that define the structure of the structured data input accepted by the Orchestration AI Agent. The data in a DATA message sent to the agent is validated against these schemas. You can specify at most one schema.
(:ref:`document<document>`) --
outputSchemas (list) --
The JSON schemas that define the structure of the structured output generated by the Orchestration AI Agent. You can specify at most one schema.
(:ref:`document<document>`) --
noteTakingAIAgentConfiguration (dict) --
The configuration for AI Agents of type NOTE_TAKING.
noteTakingAIPromptId (string) --
The AI Prompt identifier used by the Note Taking AI Agent.
noteTakingAIGuardrailId (string) --
The AI Guardrail identifier used by the Note Taking AI Agent.
locale (string) --
The locale setting for language-specific case summarization generation (for example, en_US, es_ES).
caseSummarizationAIAgentConfiguration (dict) --
The configuration for AI Agents of type CASE_SUMMARIZATION.
caseSummarizationAIPromptId (string) --
The AI Prompt identifier used by the Case Summarization AI Agent.
caseSummarizationAIGuardrailId (string) --
The AI Guardrail identifier used by the Case Summarization AI Agent.
locale (string) --
The locale setting for the Case Summarization AI Agent.
origin (string) --
The origin of the AI Agent. SYSTEM for a default AI Agent created by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent creation APIs.
description (string) --
The description of the AI Agent.
status (string) --
The status of the AI Agent.
tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
nextToken (string) --
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
{'messages': {'value': {'data': {}}}}
Lists messages on an Amazon Q in Connect session.
See also: AWS API Documentation
Request Syntax
client.list_messages(
assistantId='string',
sessionId='string',
nextToken='string',
maxResults=123,
filter='ALL'|'TEXT_ONLY'
)
string
[REQUIRED]
The identifier of the Amazon Q in Connect assistant.
string
[REQUIRED]
The identifier of the Amazon Q in Connect session.
string
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
integer
The maximum number of results to return per page.
string
The filter criteria for listing messages.
dict
Response Syntax
{
'messages': [
{
'value': {
'text': {
'value': 'string',
'citations': [
{
'contentId': 'string',
'title': 'string',
'knowledgeBaseId': 'string',
'citationSpan': {
'beginOffsetInclusive': 123,
'endOffsetExclusive': 123
},
'sourceURL': 'string',
'referenceType': 'WEB_CRAWLER'|'KNOWLEDGE_BASE'|'BEDROCK_KB_S3'|'BEDROCK_KB_WEB'|'BEDROCK_KB_CONFLUENCE'|'BEDROCK_KB_SALESFORCE'|'BEDROCK_KB_SHAREPOINT'|'BEDROCK_KB_KENDRA'|'BEDROCK_KB_CUSTOM_DOCUMENT'|'BEDROCK_KB_SQL'
},
],
'aiGuardrailAssessment': {
'blocked': True|False
}
},
'toolUseResult': {
'toolUseId': 'string',
'toolName': 'string',
'toolResult': {...}|[...]|123|123.4|'string'|True|None,
'inputSchema': {...}|[...]|123|123.4|'string'|True|None
},
'data': {...}|[...]|123|123.4|'string'|True|None
},
'messageId': 'string',
'participant': 'CUSTOMER'|'AGENT'|'BOT',
'timestamp': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
messages (list) --
The message information.
(dict) --
The message output.
value (dict) --
The value of a message data.
text (dict) --
The message data in text type.
value (string) --
The value of the message data in text type.
citations (list) --
The citations associated with the text message.
(dict) --
A citation that references source content.
contentId (string) --
The identifier of the content being cited.
title (string) --
The title of the cited content.
knowledgeBaseId (string) --
The identifier of the knowledge base containing the cited content.
citationSpan (dict) --
Contains information about where the text with a citation begins and ends in the generated output.
beginOffsetInclusive (integer) --
Where the text with a citation starts in the generated output.
endOffsetExclusive (integer) --
Where the text with a citation ends in the generated output.
sourceURL (string) --
The source URL for the citation.
referenceType (string) --
A type to define the KB origin of a cited content
aiGuardrailAssessment (dict) --
The AI Guardrail assessment for the text message.
blocked (boolean) --
Indicates whether the AI Guardrail blocked the content.
toolUseResult (dict) --
The result of tool usage in the message.
toolUseId (string) --
The identifier of the tool use instance.
toolName (string) --
The name of the tool that was used.
toolResult (:ref:`document<document>`) --
The result of the tool usage.
inputSchema (:ref:`document<document>`) --
The input schema for the tool use result.
data (:ref:`document<document>`) --
The message data as a structured JSON document. This is the payload for a message of type DATA, and must be a JSON object at the root level.
messageId (string) --
The identifier of a message.
participant (string) --
The participant of a message.
timestamp (datetime) --
The timestamp of a message.
nextToken (string) --
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
{'spans': {'attributes': {'interactionMode': 'DELEGATE | HANDOFF',
'returnReason': 'COMPLETE | COMPLETE_WITH_ERROR | '
'ESCALATE | OUT_OF_DOMAIN',
'targetAgentId': 'string'}}}
Retrieves AI agent execution traces for a session, providing granular visibility into agent orchestration flows, LLM interactions, and tool invocations.
See also: AWS API Documentation
Request Syntax
client.list_spans(
assistantId='string',
sessionId='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
UUID or ARN of the Connect AI Assistant resource
string
[REQUIRED]
UUID or ARN of the Connect AI Session resource
string
Pagination token for retrieving the next page of results
integer
Maximum number of spans to return per page
dict
Response Syntax
{
'spans': [
{
'spanId': 'string',
'assistantId': 'string',
'sessionId': 'string',
'parentSpanId': 'string',
'spanName': 'string',
'spanType': 'CLIENT'|'SERVER'|'INTERNAL',
'startTimestamp': datetime(2015, 1, 1),
'endTimestamp': datetime(2015, 1, 1),
'status': 'OK'|'ERROR'|'TIMEOUT',
'statusDescription': 'string',
'requestId': 'string',
'originRequestId': 'string',
'attributes': {
'operationName': 'string',
'providerName': 'string',
'errorType': 'string',
'agentId': 'string',
'instanceArn': 'string',
'contactId': 'string',
'initialContactId': 'string',
'sessionName': 'string',
'aiAgentArn': 'string',
'aiAgentType': 'MANUAL_SEARCH'|'ANSWER_RECOMMENDATION'|'SELF_SERVICE'|'EMAIL_RESPONSE'|'EMAIL_OVERVIEW'|'EMAIL_GENERATIVE_ANSWER'|'ORCHESTRATION'|'NOTE_TAKING'|'CASE_SUMMARIZATION',
'aiAgentName': 'string',
'aiAgentId': 'string',
'aiAgentVersion': 123,
'aiAgentInvoker': 'string',
'aiAgentOrchestratorUseCase': 'string',
'interactionMode': 'DELEGATE'|'HANDOFF',
'targetAgentId': 'string',
'returnReason': 'COMPLETE'|'COMPLETE_WITH_ERROR'|'ESCALATE'|'OUT_OF_DOMAIN',
'requestModel': 'string',
'requestMaxTokens': 123,
'temperature': ...,
'topP': ...,
'responseModel': 'string',
'responseFinishReasons': [
'string',
],
'usageInputTokens': 123,
'usageOutputTokens': 123,
'usageTotalTokens': 123,
'cacheReadInputTokens': 123,
'cacheWriteInputTokens': 123,
'inputMessages': [
{
'messageId': 'string',
'participant': 'CUSTOMER'|'AGENT'|'BOT',
'timestamp': datetime(2015, 1, 1),
'values': [
{
'text': {
'value': 'string',
'citations': [
{
'contentId': 'string',
'title': 'string',
'knowledgeBaseId': 'string',
'knowledgeBaseArn': 'string'
},
],
'aiGuardrailAssessment': {
'blocked': True|False
}
},
'toolUse': {
'toolUseId': 'string',
'name': 'string',
'arguments': {...}|[...]|123|123.4|'string'|True|None
},
'toolResult': {
'toolUseId': 'string',
'values': {'... recursive ...'},
'error': 'string'
},
'reasoning': {
'value': 'string'
}
},
]
},
],
'outputMessages': [
{
'messageId': 'string',
'participant': 'CUSTOMER'|'AGENT'|'BOT',
'timestamp': datetime(2015, 1, 1),
'values': [
{
'text': {
'value': 'string',
'citations': [
{
'contentId': 'string',
'title': 'string',
'knowledgeBaseId': 'string',
'knowledgeBaseArn': 'string'
},
],
'aiGuardrailAssessment': {
'blocked': True|False
}
},
'toolUse': {
'toolUseId': 'string',
'name': 'string',
'arguments': {...}|[...]|123|123.4|'string'|True|None
},
'toolResult': {
'toolUseId': 'string',
'values': {'... recursive ...'},
'error': 'string'
},
'reasoning': {
'value': 'string'
}
},
]
},
],
'systemInstructions': [
{
'text': {
'value': 'string',
'citations': [
{
'contentId': 'string',
'title': 'string',
'knowledgeBaseId': 'string',
'knowledgeBaseArn': 'string'
},
],
'aiGuardrailAssessment': {
'blocked': True|False
}
},
'toolUse': {
'toolUseId': 'string',
'name': 'string',
'arguments': {...}|[...]|123|123.4|'string'|True|None
},
'toolResult': {
'toolUseId': 'string',
'values': {'... recursive ...'},
'error': 'string'
},
'reasoning': {
'value': 'string'
}
},
],
'promptArn': 'string',
'promptId': 'string',
'promptType': 'ANSWER_GENERATION'|'INTENT_LABELING_GENERATION'|'QUERY_REFORMULATION'|'SELF_SERVICE_PRE_PROCESSING'|'SELF_SERVICE_ANSWER_GENERATION'|'EMAIL_RESPONSE'|'EMAIL_OVERVIEW'|'EMAIL_GENERATIVE_ANSWER'|'EMAIL_QUERY_REFORMULATION'|'ORCHESTRATION'|'NOTE_TAKING'|'CASE_SUMMARIZATION',
'promptName': 'string',
'promptVersion': 123,
'timeToFirstTokenMs': 123,
'guardrailAssessments': [
{
'guardrailId': 'string',
'guardrailName': 'string',
'source': 'INPUT'|'OUTPUT',
'action': 'NONE'|'BLOCKED'|'MASKED',
'policies': [
{
'policyType': 'CONTENT_FILTER'|'TOPIC'|'WORD'|'SENSITIVE_INFORMATION_PII'|'SENSITIVE_INFORMATION_REGEX'|'CONTEXTUAL_GROUNDING',
'action': 'NONE'|'BLOCKED'|'MASKED',
'details': 'string'
},
]
},
]
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
spans (list) --
Array of span objects for the session
(dict) --
A span represents a unit of work during AI agent execution, capturing timing, status, and contextual attributes.
spanId (string) --
Unique span identifier
assistantId (string) --
UUID of the Connect AI Assistant resource
sessionId (string) --
UUID of the Connect AI Session resource
parentSpanId (string) --
Parent span identifier for hierarchy. Null for root spans.
spanName (string) --
Service-defined operation name
spanType (string) --
Operation relationship type
startTimestamp (datetime) --
Operation start time in milliseconds since epoch
endTimestamp (datetime) --
Operation end time in milliseconds since epoch
status (string) --
Span completion status
statusDescription (string) --
Human-readable error description when status is ERROR or TIMEOUT
requestId (string) --
The service request ID that initiated the operation
originRequestId (string) --
The origin request identifier for end-to-end tracing.
attributes (dict) --
Span-specific contextual attributes
operationName (string) --
Action being performed
providerName (string) --
Model provider identifier (e.g., aws.bedrock)
errorType (string) --
Error classification if span failed (e.g., throttle, timeout)
agentId (string) --
Amazon Connect agent ID
instanceArn (string) --
Amazon Connect instance ARN
contactId (string) --
Amazon Connect contact identifier
initialContactId (string) --
Amazon Connect contact identifier
sessionName (string) --
Session name
aiAgentArn (string) --
AI agent ARN
aiAgentType (string) --
AI agent type
aiAgentName (string) --
AI agent name
aiAgentId (string) --
AI agent identifier
aiAgentVersion (integer) --
AI agent version number
aiAgentInvoker (string) --
Entity that invoked the AI agent
aiAgentOrchestratorUseCase (string) --
AI agent orchestrator use case
interactionMode (string) --
How the orchestrator engaged the collaborator agent. Present on spans that invoke a collaborator agent.
targetAgentId (string) --
Identifier of the collaborator agent being invoked. For first-party collaborators this is the Amazon Connect AI agent ID; for third-party collaborators this is the external application ID.
returnReason (string) --
Reason a sub-agent returned control to the calling agent. Present on return_to_agent spans.
requestModel (string) --
LLM model ID for request (e.g., anthropic.claude-3-sonnet)
requestMaxTokens (integer) --
Maximum tokens configured for generation
temperature (float) --
Sampling temperature for generation
topP (float) --
Top-p sampling parameter for generation
responseModel (string) --
Actual model used for response (usually matches requestModel)
responseFinishReasons (list) --
Generation termination reasons (e.g., stop, max_tokens)
(string) --
usageInputTokens (integer) --
Number of input tokens in prompt
usageOutputTokens (integer) --
Number of output tokens in response
usageTotalTokens (integer) --
Total tokens consumed (input + output)
cacheReadInputTokens (integer) --
Number of input tokens that were retrieved from cache
cacheWriteInputTokens (integer) --
Number of input tokens that were written to cache in this request
inputMessages (list) --
Input message collection sent to LLM
(dict) --
A message in the conversation history with participant role and content values
messageId (string) --
Unique message identifier
participant (string) --
Message source role
timestamp (datetime) --
Message timestamp
values (list) --
Message content values (text, tool use, tool result, reasoning)
(dict) --
Message content value - can be text, tool invocation, tool result, or reasoning
text (dict) --
Text message content
value (string) --
String content of the message text
citations (list) --
The citations associated with the span text.
(dict) --
A citation that spans a specific range of text.
contentId (string) --
The identifier of the content being cited in the span.
title (string) --
The title of the content being cited in the span.
knowledgeBaseId (string) --
The identifier of the knowledge base containing the cited content.
knowledgeBaseArn (string) --
The Amazon Resource Name (ARN) of the knowledge base containing the cited content.
aiGuardrailAssessment (dict) --
The AI Guardrail assessment for the span text.
blocked (boolean) --
Indicates whether the AI Guardrail blocked the content.
toolUse (dict) --
Tool invocation message content
toolUseId (string) --
Unique ID for this tool invocation
name (string) --
The tool name
arguments (:ref:`document<document>`) --
The tool input arguments
toolResult (dict) --
Tool result message content
toolUseId (string) --
Relates this result back to the tool invocation
values (list) --
The tool results
error (string) --
The tool invocation error if failed
reasoning (dict) --
Model reasoning and it's internal decision making process
value (string) --
The reasoning text content
outputMessages (list) --
Output message collection received from LLM
(dict) --
A message in the conversation history with participant role and content values
messageId (string) --
Unique message identifier
participant (string) --
Message source role
timestamp (datetime) --
Message timestamp
values (list) --
Message content values (text, tool use, tool result, reasoning)
(dict) --
Message content value - can be text, tool invocation, tool result, or reasoning
text (dict) --
Text message content
value (string) --
String content of the message text
citations (list) --
The citations associated with the span text.
(dict) --
A citation that spans a specific range of text.
contentId (string) --
The identifier of the content being cited in the span.
title (string) --
The title of the content being cited in the span.
knowledgeBaseId (string) --
The identifier of the knowledge base containing the cited content.
knowledgeBaseArn (string) --
The Amazon Resource Name (ARN) of the knowledge base containing the cited content.
aiGuardrailAssessment (dict) --
The AI Guardrail assessment for the span text.
blocked (boolean) --
Indicates whether the AI Guardrail blocked the content.
toolUse (dict) --
Tool invocation message content
toolUseId (string) --
Unique ID for this tool invocation
name (string) --
The tool name
arguments (:ref:`document<document>`) --
The tool input arguments
toolResult (dict) --
Tool result message content
toolUseId (string) --
Relates this result back to the tool invocation
values (list) --
The tool results
error (string) --
The tool invocation error if failed
reasoning (dict) --
Model reasoning and it's internal decision making process
value (string) --
The reasoning text content
systemInstructions (list) --
System prompt instructions
(dict) --
Message content value - can be text, tool invocation, tool result, or reasoning
text (dict) --
Text message content
value (string) --
String content of the message text
citations (list) --
The citations associated with the span text.
(dict) --
A citation that spans a specific range of text.
contentId (string) --
The identifier of the content being cited in the span.
title (string) --
The title of the content being cited in the span.
knowledgeBaseId (string) --
The identifier of the knowledge base containing the cited content.
knowledgeBaseArn (string) --
The Amazon Resource Name (ARN) of the knowledge base containing the cited content.
aiGuardrailAssessment (dict) --
The AI Guardrail assessment for the span text.
blocked (boolean) --
Indicates whether the AI Guardrail blocked the content.
toolUse (dict) --
Tool invocation message content
toolUseId (string) --
Unique ID for this tool invocation
name (string) --
The tool name
arguments (:ref:`document<document>`) --
The tool input arguments
toolResult (dict) --
Tool result message content
toolUseId (string) --
Relates this result back to the tool invocation
values (list) --
The tool results
error (string) --
The tool invocation error if failed
reasoning (dict) --
Model reasoning and it's internal decision making process
value (string) --
The reasoning text content
promptArn (string) --
AI prompt ARN
promptId (string) --
AI prompt identifier
promptType (string) --
AI prompt type
promptName (string) --
AI prompt name
promptVersion (integer) --
AI prompt version number
timeToFirstTokenMs (integer) --
Time to first token in milliseconds, measured from when Amazon Bedrock was invoked to when the first token was returned
guardrailAssessments (list) --
Guardrail assessments for the inference span. Absent on other span types and when no AI Guardrail is attached to the AI Agent.
(dict) --
Result of a single guardrail assessment, covering either the input (customer/user message) or the output (LLM response) of a Bedrock Converse call.
guardrailId (string) --
Unique AI Guardrail identifier.
guardrailName (string) --
Customer-defined display name of the AI Guardrail resource.
source (string) --
Content source the guardrail was evaluated against.
action (string) --
Outcome of the guardrail assessment.
policies (list) --
Per-policy assessment results. Absent or empty when action is NONE.
(dict) --
Per-policy guardrail assessment result. Captures which policy triggered, its outcome, and a policy-specific detail string.
policyType (string) --
The type of guardrail policy that was evaluated.
action (string) --
Outcome of this specific policy.
details (string) --
Policy-specific detail.
nextToken (string) --
Pagination token for retrieving additional results
{'message': {'value': {'data': {}}}, 'type': {'DATA'}}
Submits a message to the Amazon Q in Connect session.
See also: AWS API Documentation
Request Syntax
client.send_message(
assistantId='string',
sessionId='string',
type='TEXT'|'TOOL_USE_RESULT'|'DATA',
message={
'value': {
'text': {
'value': 'string',
'citations': [
{
'contentId': 'string',
'title': 'string',
'knowledgeBaseId': 'string',
'citationSpan': {
'beginOffsetInclusive': 123,
'endOffsetExclusive': 123
},
'sourceURL': 'string',
'referenceType': 'WEB_CRAWLER'|'KNOWLEDGE_BASE'|'BEDROCK_KB_S3'|'BEDROCK_KB_WEB'|'BEDROCK_KB_CONFLUENCE'|'BEDROCK_KB_SALESFORCE'|'BEDROCK_KB_SHAREPOINT'|'BEDROCK_KB_KENDRA'|'BEDROCK_KB_CUSTOM_DOCUMENT'|'BEDROCK_KB_SQL'
},
],
'aiGuardrailAssessment': {
'blocked': True|False
}
},
'toolUseResult': {
'toolUseId': 'string',
'toolName': 'string',
'toolResult': {...}|[...]|123|123.4|'string'|True|None,
'inputSchema': {...}|[...]|123|123.4|'string'|True|None
},
'data': {...}|[...]|123|123.4|'string'|True|None
}
},
aiAgentId='string',
conversationContext={
'selfServiceConversationHistory': [
{
'turnNumber': 123,
'inputTranscript': 'string',
'botResponse': 'string',
'timestamp': datetime(2015, 1, 1)
},
]
},
configuration={
'generateFillerMessage': True|False,
'generateChunkedMessage': True|False
},
clientToken='string',
orchestratorUseCase='string',
metadata={
'string': 'string'
},
originRequestId='string'
)
string
[REQUIRED]
The identifier of the Amazon Q in Connect assistant.
string
[REQUIRED]
The identifier of the Amazon Q in Connect session.
string
[REQUIRED]
The message type.
dict
[REQUIRED]
The message data to submit to the Amazon Q in Connect session.
value (dict) -- [REQUIRED]
The message input value.
text (dict) --
The message data in text type.
value (string) --
The value of the message data in text type.
citations (list) --
The citations associated with the text message.
(dict) --
A citation that references source content.
contentId (string) --
The identifier of the content being cited.
title (string) --
The title of the cited content.
knowledgeBaseId (string) --
The identifier of the knowledge base containing the cited content.
citationSpan (dict) -- [REQUIRED]
Contains information about where the text with a citation begins and ends in the generated output.
beginOffsetInclusive (integer) --
Where the text with a citation starts in the generated output.
endOffsetExclusive (integer) --
Where the text with a citation ends in the generated output.
sourceURL (string) --
The source URL for the citation.
referenceType (string) -- [REQUIRED]
A type to define the KB origin of a cited content
aiGuardrailAssessment (dict) --
The AI Guardrail assessment for the text message.
blocked (boolean) -- [REQUIRED]
Indicates whether the AI Guardrail blocked the content.
toolUseResult (dict) --
The result of tool usage in the message.
toolUseId (string) -- [REQUIRED]
The identifier of the tool use instance.
toolName (string) -- [REQUIRED]
The name of the tool that was used.
toolResult (:ref:`document<document>`) -- [REQUIRED]
The result of the tool usage.
inputSchema (:ref:`document<document>`) --
The input schema for the tool use result.
data (:ref:`document<document>`) --
The message data as a structured JSON document. This is the payload for a message of type DATA, and must be a JSON object at the root level.
string
The identifier of the AI Agent to use for processing the message.
dict
The conversation context before the Amazon Q in Connect session.
selfServiceConversationHistory (list) -- [REQUIRED]
The self service conversation history before the Amazon Q in Connect session.
(dict) --
The conversation history data to included in conversation context data before the Amazon Q in Connect session.
turnNumber (integer) --
The number of turn of the conversation history data.
inputTranscript (string) --
The input transcript of the conversation history data.
botResponse (string) --
The bot response of the conversation history data.
timestamp (datetime) --
The timestamp of the conversation history entry.
dict
The configuration of the SendMessage request.
generateFillerMessage (boolean) --
Generates a filler response when tool selection is QUESTION.
generateChunkedMessage (boolean) --
Configuration for generating chunked messages.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field.For more information about idempotency, see Making retries safe with idempotent APIs.
This field is autopopulated if not provided.
string
The orchestrator use case for message processing.
dict
Additional metadata for the message.
(string) --
(string) --
string
Request identifier from the origin system, used for end-to-end tracing across spans.
dict
Response Syntax
{
'requestMessageId': 'string',
'configuration': {
'generateFillerMessage': True|False,
'generateChunkedMessage': True|False
},
'nextMessageToken': 'string'
}
Response Structure
(dict) --
requestMessageId (string) --
The identifier of the submitted message.
configuration (dict) --
The configuration of the SendMessage request.
generateFillerMessage (boolean) --
Generates a filler response when tool selection is QUESTION.
generateChunkedMessage (boolean) --
Configuration for generating chunked messages.
nextMessageToken (string) --
The token for the next message, used by GetNextMessage.
{'configuration': {'orchestrationAIAgentConfiguration': {'inputSchemas': [{}],
'multiAgentConfigurations': [{'delegateAgentConfiguration': {'agentTarget': {'aiAgentId': 'string',
'applicationId': 'string'},
'instruction': {'examples': ['string'],
'instruction': 'string'}},
'handoffAgentConfiguration': {'agentTarget': {'aiAgentId': 'string',
'applicationId': 'string'},
'audioStreamingEnabled': 'boolean',
'immediateHandoff': 'boolean',
'instruction': {'examples': ['string'],
'instruction': 'string'}}}],
'outputSchemas': [{}]}}}
Response {'aiAgent': {'configuration': {'orchestrationAIAgentConfiguration': {'inputSchemas': [{}],
'multiAgentConfigurations': [{'delegateAgentConfiguration': {'agentTarget': {'aiAgentId': 'string',
'applicationId': 'string'},
'instruction': {'examples': ['string'],
'instruction': 'string'}},
'handoffAgentConfiguration': {'agentTarget': {'aiAgentId': 'string',
'applicationId': 'string'},
'audioStreamingEnabled': 'boolean',
'immediateHandoff': 'boolean',
'instruction': {'examples': ['string'],
'instruction': 'string'}}}],
'outputSchemas': [{}]}}}}
Updates an AI Agent.
See also: AWS API Documentation
Request Syntax
client.update_ai_agent(
clientToken='string',
assistantId='string',
aiAgentId='string',
visibilityStatus='SAVED'|'PUBLISHED',
configuration={
'manualSearchAIAgentConfiguration': {
'answerGenerationAIPromptId': 'string',
'answerGenerationAIGuardrailId': 'string',
'associationConfigurations': [
{
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE',
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'tagCondition': {
'key': 'string',
'value': 'string'
},
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
]
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
}
},
],
'locale': 'string'
},
'answerRecommendationAIAgentConfiguration': {
'intentLabelingGenerationAIPromptId': 'string',
'queryReformulationAIPromptId': 'string',
'answerGenerationAIPromptId': 'string',
'answerGenerationAIGuardrailId': 'string',
'associationConfigurations': [
{
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE',
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'tagCondition': {
'key': 'string',
'value': 'string'
},
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
]
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
}
},
],
'locale': 'string',
'suggestedMessages': [
'string',
]
},
'selfServiceAIAgentConfiguration': {
'selfServicePreProcessingAIPromptId': 'string',
'selfServiceAnswerGenerationAIPromptId': 'string',
'selfServiceAIGuardrailId': 'string',
'associationConfigurations': [
{
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE',
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'tagCondition': {
'key': 'string',
'value': 'string'
},
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
]
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
}
},
]
},
'emailResponseAIAgentConfiguration': {
'emailResponseAIPromptId': 'string',
'emailQueryReformulationAIPromptId': 'string',
'locale': 'string',
'associationConfigurations': [
{
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE',
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'tagCondition': {
'key': 'string',
'value': 'string'
},
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
]
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
}
},
]
},
'emailOverviewAIAgentConfiguration': {
'emailOverviewAIPromptId': 'string',
'locale': 'string'
},
'emailGenerativeAnswerAIAgentConfiguration': {
'emailGenerativeAnswerAIPromptId': 'string',
'emailQueryReformulationAIPromptId': 'string',
'locale': 'string',
'associationConfigurations': [
{
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE',
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'tagCondition': {
'key': 'string',
'value': 'string'
},
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
]
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
}
},
]
},
'orchestrationAIAgentConfiguration': {
'orchestrationAIPromptId': 'string',
'orchestrationAIGuardrailId': 'string',
'toolConfigurations': [
{
'toolName': 'string',
'toolType': 'MODEL_CONTEXT_PROTOCOL'|'RETURN_TO_CONTROL'|'CONSTANT',
'title': 'string',
'toolId': 'string',
'description': 'string',
'instruction': {
'instruction': 'string',
'examples': [
'string',
]
},
'overrideInputValues': [
{
'jsonPath': 'string',
'value': {
'constant': {
'type': 'STRING'|'NUMBER'|'JSON_STRING',
'value': 'string'
}
}
},
],
'outputFilters': [
{
'jsonPath': 'string',
'outputConfiguration': {
'outputVariableNameOverride': 'string',
'sessionDataNamespace': 'string'
}
},
],
'inputSchema': {...}|[...]|123|123.4|'string'|True|None,
'outputSchema': {...}|[...]|123|123.4|'string'|True|None,
'annotations': {
'title': 'string',
'destructiveHint': True|False
},
'userInteractionConfiguration': {
'isUserConfirmationRequired': True|False
}
},
],
'multiAgentConfigurations': [
{
'delegateAgentConfiguration': {
'agentTarget': {
'aiAgentId': 'string',
'applicationId': 'string'
},
'instruction': {
'instruction': 'string',
'examples': [
'string',
]
}
},
'handoffAgentConfiguration': {
'agentTarget': {
'aiAgentId': 'string',
'applicationId': 'string'
},
'instruction': {
'instruction': 'string',
'examples': [
'string',
]
},
'audioStreamingEnabled': True|False,
'immediateHandoff': True|False
}
},
],
'connectInstanceArn': 'string',
'locale': 'string',
'inputSchemas': [
{...}|[...]|123|123.4|'string'|True|None,
],
'outputSchemas': [
{...}|[...]|123|123.4|'string'|True|None,
]
},
'noteTakingAIAgentConfiguration': {
'noteTakingAIPromptId': 'string',
'noteTakingAIGuardrailId': 'string',
'locale': 'string'
},
'caseSummarizationAIAgentConfiguration': {
'caseSummarizationAIPromptId': 'string',
'caseSummarizationAIGuardrailId': 'string',
'locale': 'string'
}
},
description='string'
)
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..
This field is autopopulated if not provided.
string
[REQUIRED]
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
string
[REQUIRED]
The identifier of the Amazon Q in Connect AI Agent.
string
[REQUIRED]
The visbility status of the Amazon Q in Connect AI Agent.
dict
The configuration of the Amazon Q in Connect AI Agent.
manualSearchAIAgentConfiguration (dict) --
The configuration for AI Agents of type MANUAL_SEARCH.
answerGenerationAIPromptId (string) --
The AI Prompt identifier for the Answer Generation prompt used by the MANUAL_SEARCH AI Agent.
answerGenerationAIGuardrailId (string) --
The AI Guardrail identifier for the Answer Generation guardrail used by the MANUAL_SEARCH AI Agent.
associationConfigurations (list) --
The association configurations for overriding behavior on this AI Agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
associationConfigurationData (dict) --
The data of the configuration for an Amazon Q in Connect Assistant Association.
knowledgeBaseAssociationConfigurationData (dict) --
The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
contentTagFilter (dict) --
An object that can be used to specify Tag conditions.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) -- [REQUIRED]
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) -- [REQUIRED]
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
orConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
A list of conditions which would be applied together with an OR condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) -- [REQUIRED]
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) -- [REQUIRED]
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
maxResults (integer) --
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) --
The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text
locale (string) --
The locale to which specifies the language and region settings that determine the response language for QueryAssistant.
answerRecommendationAIAgentConfiguration (dict) --
The configuration for AI Agents of type ANSWER_RECOMMENDATION.
intentLabelingGenerationAIPromptId (string) --
The AI Prompt identifier for the Intent Labeling prompt used by the ANSWER_RECOMMENDATION AI Agent.
queryReformulationAIPromptId (string) --
The AI Prompt identifier for the Query Reformulation prompt used by the ANSWER_RECOMMENDATION AI Agent.
answerGenerationAIPromptId (string) --
The AI Prompt identifier for the Answer Generation prompt used by the ANSWER_RECOMMENDATION AI Agent.
answerGenerationAIGuardrailId (string) --
The AI Guardrail identifier for the Answer Generation Guardrail used by the ANSWER_RECOMMENDATION AI Agent.
associationConfigurations (list) --
The association configurations for overriding behavior on this AI Agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
associationConfigurationData (dict) --
The data of the configuration for an Amazon Q in Connect Assistant Association.
knowledgeBaseAssociationConfigurationData (dict) --
The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
contentTagFilter (dict) --
An object that can be used to specify Tag conditions.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) -- [REQUIRED]
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) -- [REQUIRED]
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
orConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
A list of conditions which would be applied together with an OR condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) -- [REQUIRED]
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) -- [REQUIRED]
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
maxResults (integer) --
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) --
The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text
locale (string) --
The locale to which specifies the language and region settings that determine the response language for QueryAssistant.
suggestedMessages (list) --
The suggested messages configuration for the Answer Recommendation AI Agent.
(string) --
selfServiceAIAgentConfiguration (dict) --
The configuration for AI Agents of type SELF_SERVICE.
selfServicePreProcessingAIPromptId (string) --
The AI Prompt identifier for the Self Service Pre-Processing prompt used by the SELF_SERVICE AI Agent
selfServiceAnswerGenerationAIPromptId (string) --
The AI Prompt identifier for the Self Service Answer Generation prompt used by the SELF_SERVICE AI Agent
selfServiceAIGuardrailId (string) --
The AI Guardrail identifier used by the SELF_SERVICE AI Agent.
associationConfigurations (list) --
The association configurations for overriding behavior on this AI Agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
associationConfigurationData (dict) --
The data of the configuration for an Amazon Q in Connect Assistant Association.
knowledgeBaseAssociationConfigurationData (dict) --
The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
contentTagFilter (dict) --
An object that can be used to specify Tag conditions.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) -- [REQUIRED]
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) -- [REQUIRED]
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
orConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
A list of conditions which would be applied together with an OR condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) -- [REQUIRED]
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) -- [REQUIRED]
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
maxResults (integer) --
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) --
The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text
emailResponseAIAgentConfiguration (dict) --
Configuration for the EMAIL_RESPONSE AI agent that generates professional email responses using knowledge base content.
emailResponseAIPromptId (string) --
The ID of the System AI prompt used for generating professional email responses based on knowledge base content.
emailQueryReformulationAIPromptId (string) --
The ID of the System AI prompt used for reformulating email queries to optimize knowledge base search for response generation.
locale (string) --
The locale setting for language-specific email response generation (for example, en_US, es_ES).
associationConfigurations (list) --
Configuration settings for knowledge base associations used by the email response agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
associationConfigurationData (dict) --
The data of the configuration for an Amazon Q in Connect Assistant Association.
knowledgeBaseAssociationConfigurationData (dict) --
The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
contentTagFilter (dict) --
An object that can be used to specify Tag conditions.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) -- [REQUIRED]
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) -- [REQUIRED]
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
orConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
A list of conditions which would be applied together with an OR condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) -- [REQUIRED]
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) -- [REQUIRED]
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
maxResults (integer) --
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) --
The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text
emailOverviewAIAgentConfiguration (dict) --
Configuration for the EMAIL_OVERVIEW AI agent that generates structured overview of email conversations.
emailOverviewAIPromptId (string) --
The ID of the System AI prompt used for generating structured email conversation summaries.
locale (string) --
The locale setting for language-specific email overview processing (for example, en_US, es_ES).
emailGenerativeAnswerAIAgentConfiguration (dict) --
Configuration for the EMAIL_GENERATIVE_ANSWER AI agent that provides comprehensive knowledge-based answers for customer queries.
emailGenerativeAnswerAIPromptId (string) --
The ID of the System AI prompt used for generating comprehensive knowledge-based answers from email queries.
emailQueryReformulationAIPromptId (string) --
The ID of the System AI prompt used for reformulating email queries to optimize knowledge base search results.
locale (string) --
The locale setting for language-specific email processing and response generation (for example, en_US, es_ES).
associationConfigurations (list) --
Configuration settings for knowledge base associations used by the email generative answer agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
associationConfigurationData (dict) --
The data of the configuration for an Amazon Q in Connect Assistant Association.
knowledgeBaseAssociationConfigurationData (dict) --
The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
contentTagFilter (dict) --
An object that can be used to specify Tag conditions.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) -- [REQUIRED]
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) -- [REQUIRED]
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
orConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
A list of conditions which would be applied together with an OR condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) -- [REQUIRED]
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) -- [REQUIRED]
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
maxResults (integer) --
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) --
The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text
orchestrationAIAgentConfiguration (dict) --
The configuration for AI Agents of type ORCHESTRATION.
orchestrationAIPromptId (string) --
The AI Prompt identifier used by the Orchestration AI Agent.
orchestrationAIGuardrailId (string) --
The AI Guardrail identifier used by the Orchestration AI Agent.
toolConfigurations (list) --
The tool configurations used by the Orchestration AI Agent.
(dict) --
Configuration settings for a tool used by AI Agents.
toolName (string) -- [REQUIRED]
The name of the tool.
toolType (string) -- [REQUIRED]
The type of the tool.
title (string) --
The title of the tool configuration.
toolId (string) --
The identifier of the tool, for example toolName from Model Context Provider server.
description (string) --
The description of the tool configuration.
instruction (dict) --
Instructions for using the tool.
instruction (string) --
The instruction text for the tool.
examples (list) --
Examples for using the tool.
(string) --
overrideInputValues (list) --
Override input values for the tool configuration.
(dict) --
An input value override for tools.
jsonPath (string) -- [REQUIRED]
The JSON path for the input value override.
value (dict) -- [REQUIRED]
The override input value.
constant (dict) --
Constant input value configuration for tool override.
type (string) -- [REQUIRED]
Override tool input value with constant values
value (string) -- [REQUIRED]
The constant input override value.
outputFilters (list) --
Output filters applies to the tool result.
(dict) --
Filter configuration for tool output.
jsonPath (string) -- [REQUIRED]
The JSON path for filtering tool output.
outputConfiguration (dict) --
The output configuration for the filter.
outputVariableNameOverride (string) --
Override the tool output results to different variable name.
sessionDataNamespace (string) --
The session data namespace for tool output.
inputSchema (:ref:`document<document>`) --
The input schema for the tool configuration.
outputSchema (:ref:`document<document>`) --
The output schema for the tool configuration.
annotations (dict) --
Annotations for the tool configuration.
title (string) --
The title of the annotation.
destructiveHint (boolean) --
A hint indicating that the annotation contains potentially destructive content.
userInteractionConfiguration (dict) --
Configuration for user interaction with the tool.
isUserConfirmationRequired (boolean) --
Indicates whether user confirmation is required for the interaction.
multiAgentConfigurations (list) --
The collaborator agents that the Orchestration AI Agent can work with. Each entry defines another agent that the orchestrator either delegates to or hands the conversation off to.
(dict) --
A union that configures a single collaborator agent for an Orchestration AI Agent, as either a delegate or a handoff.
delegateAgentConfiguration (dict) --
Configures the collaborator agent as a delegate that the Orchestration AI Agent invokes while retaining control of the conversation.
agentTarget (dict) -- [REQUIRED]
The collaborator agent to delegate to.
aiAgentId (string) --
The identifier of an Amazon Connect AI Agent to use as the collaborator agent.
applicationId (string) --
The identifier of a third-party agent to use as the collaborator agent.
instruction (dict) --
The instruction that tells the Orchestration AI Agent when and how to delegate to this collaborator agent.
instruction (string) --
The natural-language instruction that tells the Orchestration AI Agent when and how to engage the collaborator agent.
examples (list) --
Example interactions that illustrate when the Orchestration AI Agent should engage the collaborator agent.
(string) --
handoffAgentConfiguration (dict) --
Configures the collaborator agent as a handoff target that the Orchestration AI Agent transfers control of the conversation to.
agentTarget (dict) -- [REQUIRED]
The collaborator agent to hand off to.
aiAgentId (string) --
The identifier of an Amazon Connect AI Agent to use as the collaborator agent.
applicationId (string) --
The identifier of a third-party agent to use as the collaborator agent.
instruction (dict) --
The instruction that tells the Orchestration AI Agent when and how to hand off to this collaborator agent.
instruction (string) --
The natural-language instruction that tells the Orchestration AI Agent when and how to engage the collaborator agent.
examples (list) --
Example interactions that illustrate when the Orchestration AI Agent should engage the collaborator agent.
(string) --
audioStreamingEnabled (boolean) --
Specifies whether the caller's audio is streamed directly to the collaborator agent and the collaborator's audio response is played back during the handoff. This applies only to voice handoffs.
immediateHandoff (boolean) --
Specifies whether the conversation is handed off to this collaborator agent immediately on the first turn, without any orchestration reasoning. At most one handoff in an AI Agent's configuration can set this to true.
connectInstanceArn (string) --
The Amazon Resource Name (ARN) of the Amazon Connect instance used by the Orchestration AI Agent.
locale (string) --
The locale setting for the Orchestration AI Agent.
inputSchemas (list) --
The JSON schemas that define the structure of the structured data input accepted by the Orchestration AI Agent. The data in a DATA message sent to the agent is validated against these schemas. You can specify at most one schema.
(:ref:`document<document>`) --
outputSchemas (list) --
The JSON schemas that define the structure of the structured output generated by the Orchestration AI Agent. You can specify at most one schema.
(:ref:`document<document>`) --
noteTakingAIAgentConfiguration (dict) --
The configuration for AI Agents of type NOTE_TAKING.
noteTakingAIPromptId (string) --
The AI Prompt identifier used by the Note Taking AI Agent.
noteTakingAIGuardrailId (string) --
The AI Guardrail identifier used by the Note Taking AI Agent.
locale (string) --
The locale setting for language-specific case summarization generation (for example, en_US, es_ES).
caseSummarizationAIAgentConfiguration (dict) --
The configuration for AI Agents of type CASE_SUMMARIZATION.
caseSummarizationAIPromptId (string) --
The AI Prompt identifier used by the Case Summarization AI Agent.
caseSummarizationAIGuardrailId (string) --
The AI Guardrail identifier used by the Case Summarization AI Agent.
locale (string) --
The locale setting for the Case Summarization AI Agent.
string
The description of the Amazon Q in Connect AI Agent.
dict
Response Syntax
{
'aiAgent': {
'assistantId': 'string',
'assistantArn': 'string',
'aiAgentId': 'string',
'aiAgentArn': 'string',
'name': 'string',
'type': 'MANUAL_SEARCH'|'ANSWER_RECOMMENDATION'|'SELF_SERVICE'|'EMAIL_RESPONSE'|'EMAIL_OVERVIEW'|'EMAIL_GENERATIVE_ANSWER'|'ORCHESTRATION'|'NOTE_TAKING'|'CASE_SUMMARIZATION',
'configuration': {
'manualSearchAIAgentConfiguration': {
'answerGenerationAIPromptId': 'string',
'answerGenerationAIGuardrailId': 'string',
'associationConfigurations': [
{
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE',
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'tagCondition': {
'key': 'string',
'value': 'string'
},
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
]
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
}
},
],
'locale': 'string'
},
'answerRecommendationAIAgentConfiguration': {
'intentLabelingGenerationAIPromptId': 'string',
'queryReformulationAIPromptId': 'string',
'answerGenerationAIPromptId': 'string',
'answerGenerationAIGuardrailId': 'string',
'associationConfigurations': [
{
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE',
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'tagCondition': {
'key': 'string',
'value': 'string'
},
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
]
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
}
},
],
'locale': 'string',
'suggestedMessages': [
'string',
]
},
'selfServiceAIAgentConfiguration': {
'selfServicePreProcessingAIPromptId': 'string',
'selfServiceAnswerGenerationAIPromptId': 'string',
'selfServiceAIGuardrailId': 'string',
'associationConfigurations': [
{
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE',
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'tagCondition': {
'key': 'string',
'value': 'string'
},
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
]
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
}
},
]
},
'emailResponseAIAgentConfiguration': {
'emailResponseAIPromptId': 'string',
'emailQueryReformulationAIPromptId': 'string',
'locale': 'string',
'associationConfigurations': [
{
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE',
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'tagCondition': {
'key': 'string',
'value': 'string'
},
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
]
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
}
},
]
},
'emailOverviewAIAgentConfiguration': {
'emailOverviewAIPromptId': 'string',
'locale': 'string'
},
'emailGenerativeAnswerAIAgentConfiguration': {
'emailGenerativeAnswerAIPromptId': 'string',
'emailQueryReformulationAIPromptId': 'string',
'locale': 'string',
'associationConfigurations': [
{
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE',
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'tagCondition': {
'key': 'string',
'value': 'string'
},
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
]
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
}
},
]
},
'orchestrationAIAgentConfiguration': {
'orchestrationAIPromptId': 'string',
'orchestrationAIGuardrailId': 'string',
'toolConfigurations': [
{
'toolName': 'string',
'toolType': 'MODEL_CONTEXT_PROTOCOL'|'RETURN_TO_CONTROL'|'CONSTANT',
'title': 'string',
'toolId': 'string',
'description': 'string',
'instruction': {
'instruction': 'string',
'examples': [
'string',
]
},
'overrideInputValues': [
{
'jsonPath': 'string',
'value': {
'constant': {
'type': 'STRING'|'NUMBER'|'JSON_STRING',
'value': 'string'
}
}
},
],
'outputFilters': [
{
'jsonPath': 'string',
'outputConfiguration': {
'outputVariableNameOverride': 'string',
'sessionDataNamespace': 'string'
}
},
],
'inputSchema': {...}|[...]|123|123.4|'string'|True|None,
'outputSchema': {...}|[...]|123|123.4|'string'|True|None,
'annotations': {
'title': 'string',
'destructiveHint': True|False
},
'userInteractionConfiguration': {
'isUserConfirmationRequired': True|False
}
},
],
'multiAgentConfigurations': [
{
'delegateAgentConfiguration': {
'agentTarget': {
'aiAgentId': 'string',
'applicationId': 'string'
},
'instruction': {
'instruction': 'string',
'examples': [
'string',
]
}
},
'handoffAgentConfiguration': {
'agentTarget': {
'aiAgentId': 'string',
'applicationId': 'string'
},
'instruction': {
'instruction': 'string',
'examples': [
'string',
]
},
'audioStreamingEnabled': True|False,
'immediateHandoff': True|False
}
},
],
'connectInstanceArn': 'string',
'locale': 'string',
'inputSchemas': [
{...}|[...]|123|123.4|'string'|True|None,
],
'outputSchemas': [
{...}|[...]|123|123.4|'string'|True|None,
]
},
'noteTakingAIAgentConfiguration': {
'noteTakingAIPromptId': 'string',
'noteTakingAIGuardrailId': 'string',
'locale': 'string'
},
'caseSummarizationAIAgentConfiguration': {
'caseSummarizationAIPromptId': 'string',
'caseSummarizationAIGuardrailId': 'string',
'locale': 'string'
}
},
'modifiedTime': datetime(2015, 1, 1),
'description': 'string',
'visibilityStatus': 'SAVED'|'PUBLISHED',
'tags': {
'string': 'string'
},
'origin': 'SYSTEM'|'CUSTOMER',
'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'
}
}
Response Structure
(dict) --
aiAgent (dict) --
The data of the updated Amazon Q in Connect AI Agent.
assistantId (string) --
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
assistantArn (string) --
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
aiAgentId (string) --
The identifier of the AI Agent.
aiAgentArn (string) --
The Amazon Resource Name (ARN) of the AI agent.
name (string) --
The name of the AI Agent.
type (string) --
The type of the AI Agent.
configuration (dict) --
Configuration for the AI Agent.
manualSearchAIAgentConfiguration (dict) --
The configuration for AI Agents of type MANUAL_SEARCH.
answerGenerationAIPromptId (string) --
The AI Prompt identifier for the Answer Generation prompt used by the MANUAL_SEARCH AI Agent.
answerGenerationAIGuardrailId (string) --
The AI Guardrail identifier for the Answer Generation guardrail used by the MANUAL_SEARCH AI Agent.
associationConfigurations (list) --
The association configurations for overriding behavior on this AI Agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
associationConfigurationData (dict) --
The data of the configuration for an Amazon Q in Connect Assistant Association.
knowledgeBaseAssociationConfigurationData (dict) --
The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
contentTagFilter (dict) --
An object that can be used to specify Tag conditions.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
orConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
A list of conditions which would be applied together with an OR condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
maxResults (integer) --
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) --
The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text
locale (string) --
The locale to which specifies the language and region settings that determine the response language for QueryAssistant.
answerRecommendationAIAgentConfiguration (dict) --
The configuration for AI Agents of type ANSWER_RECOMMENDATION.
intentLabelingGenerationAIPromptId (string) --
The AI Prompt identifier for the Intent Labeling prompt used by the ANSWER_RECOMMENDATION AI Agent.
queryReformulationAIPromptId (string) --
The AI Prompt identifier for the Query Reformulation prompt used by the ANSWER_RECOMMENDATION AI Agent.
answerGenerationAIPromptId (string) --
The AI Prompt identifier for the Answer Generation prompt used by the ANSWER_RECOMMENDATION AI Agent.
answerGenerationAIGuardrailId (string) --
The AI Guardrail identifier for the Answer Generation Guardrail used by the ANSWER_RECOMMENDATION AI Agent.
associationConfigurations (list) --
The association configurations for overriding behavior on this AI Agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
associationConfigurationData (dict) --
The data of the configuration for an Amazon Q in Connect Assistant Association.
knowledgeBaseAssociationConfigurationData (dict) --
The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
contentTagFilter (dict) --
An object that can be used to specify Tag conditions.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
orConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
A list of conditions which would be applied together with an OR condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
maxResults (integer) --
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) --
The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text
locale (string) --
The locale to which specifies the language and region settings that determine the response language for QueryAssistant.
suggestedMessages (list) --
The suggested messages configuration for the Answer Recommendation AI Agent.
(string) --
selfServiceAIAgentConfiguration (dict) --
The configuration for AI Agents of type SELF_SERVICE.
selfServicePreProcessingAIPromptId (string) --
The AI Prompt identifier for the Self Service Pre-Processing prompt used by the SELF_SERVICE AI Agent
selfServiceAnswerGenerationAIPromptId (string) --
The AI Prompt identifier for the Self Service Answer Generation prompt used by the SELF_SERVICE AI Agent
selfServiceAIGuardrailId (string) --
The AI Guardrail identifier used by the SELF_SERVICE AI Agent.
associationConfigurations (list) --
The association configurations for overriding behavior on this AI Agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
associationConfigurationData (dict) --
The data of the configuration for an Amazon Q in Connect Assistant Association.
knowledgeBaseAssociationConfigurationData (dict) --
The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
contentTagFilter (dict) --
An object that can be used to specify Tag conditions.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
orConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
A list of conditions which would be applied together with an OR condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
maxResults (integer) --
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) --
The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text
emailResponseAIAgentConfiguration (dict) --
Configuration for the EMAIL_RESPONSE AI agent that generates professional email responses using knowledge base content.
emailResponseAIPromptId (string) --
The ID of the System AI prompt used for generating professional email responses based on knowledge base content.
emailQueryReformulationAIPromptId (string) --
The ID of the System AI prompt used for reformulating email queries to optimize knowledge base search for response generation.
locale (string) --
The locale setting for language-specific email response generation (for example, en_US, es_ES).
associationConfigurations (list) --
Configuration settings for knowledge base associations used by the email response agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
associationConfigurationData (dict) --
The data of the configuration for an Amazon Q in Connect Assistant Association.
knowledgeBaseAssociationConfigurationData (dict) --
The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
contentTagFilter (dict) --
An object that can be used to specify Tag conditions.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
orConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
A list of conditions which would be applied together with an OR condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
maxResults (integer) --
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) --
The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text
emailOverviewAIAgentConfiguration (dict) --
Configuration for the EMAIL_OVERVIEW AI agent that generates structured overview of email conversations.
emailOverviewAIPromptId (string) --
The ID of the System AI prompt used for generating structured email conversation summaries.
locale (string) --
The locale setting for language-specific email overview processing (for example, en_US, es_ES).
emailGenerativeAnswerAIAgentConfiguration (dict) --
Configuration for the EMAIL_GENERATIVE_ANSWER AI agent that provides comprehensive knowledge-based answers for customer queries.
emailGenerativeAnswerAIPromptId (string) --
The ID of the System AI prompt used for generating comprehensive knowledge-based answers from email queries.
emailQueryReformulationAIPromptId (string) --
The ID of the System AI prompt used for reformulating email queries to optimize knowledge base search results.
locale (string) --
The locale setting for language-specific email processing and response generation (for example, en_US, es_ES).
associationConfigurations (list) --
Configuration settings for knowledge base associations used by the email generative answer agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
associationConfigurationData (dict) --
The data of the configuration for an Amazon Q in Connect Assistant Association.
knowledgeBaseAssociationConfigurationData (dict) --
The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
contentTagFilter (dict) --
An object that can be used to specify Tag conditions.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
orConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
A list of conditions which would be applied together with an OR condition.
andConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
tagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
key (string) --
The tag key in the tag condition.
value (string) --
The tag value in the tag condition.
maxResults (integer) --
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) --
The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text
orchestrationAIAgentConfiguration (dict) --
The configuration for AI Agents of type ORCHESTRATION.
orchestrationAIPromptId (string) --
The AI Prompt identifier used by the Orchestration AI Agent.
orchestrationAIGuardrailId (string) --
The AI Guardrail identifier used by the Orchestration AI Agent.
toolConfigurations (list) --
The tool configurations used by the Orchestration AI Agent.
(dict) --
Configuration settings for a tool used by AI Agents.
toolName (string) --
The name of the tool.
toolType (string) --
The type of the tool.
title (string) --
The title of the tool configuration.
toolId (string) --
The identifier of the tool, for example toolName from Model Context Provider server.
description (string) --
The description of the tool configuration.
instruction (dict) --
Instructions for using the tool.
instruction (string) --
The instruction text for the tool.
examples (list) --
Examples for using the tool.
(string) --
overrideInputValues (list) --
Override input values for the tool configuration.
(dict) --
An input value override for tools.
jsonPath (string) --
The JSON path for the input value override.
value (dict) --
The override input value.
constant (dict) --
Constant input value configuration for tool override.
type (string) --
Override tool input value with constant values
value (string) --
The constant input override value.
outputFilters (list) --
Output filters applies to the tool result.
(dict) --
Filter configuration for tool output.
jsonPath (string) --
The JSON path for filtering tool output.
outputConfiguration (dict) --
The output configuration for the filter.
outputVariableNameOverride (string) --
Override the tool output results to different variable name.
sessionDataNamespace (string) --
The session data namespace for tool output.
inputSchema (:ref:`document<document>`) --
The input schema for the tool configuration.
outputSchema (:ref:`document<document>`) --
The output schema for the tool configuration.
annotations (dict) --
Annotations for the tool configuration.
title (string) --
The title of the annotation.
destructiveHint (boolean) --
A hint indicating that the annotation contains potentially destructive content.
userInteractionConfiguration (dict) --
Configuration for user interaction with the tool.
isUserConfirmationRequired (boolean) --
Indicates whether user confirmation is required for the interaction.
multiAgentConfigurations (list) --
The collaborator agents that the Orchestration AI Agent can work with. Each entry defines another agent that the orchestrator either delegates to or hands the conversation off to.
(dict) --
A union that configures a single collaborator agent for an Orchestration AI Agent, as either a delegate or a handoff.
delegateAgentConfiguration (dict) --
Configures the collaborator agent as a delegate that the Orchestration AI Agent invokes while retaining control of the conversation.
agentTarget (dict) --
The collaborator agent to delegate to.
aiAgentId (string) --
The identifier of an Amazon Connect AI Agent to use as the collaborator agent.
applicationId (string) --
The identifier of a third-party agent to use as the collaborator agent.
instruction (dict) --
The instruction that tells the Orchestration AI Agent when and how to delegate to this collaborator agent.
instruction (string) --
The natural-language instruction that tells the Orchestration AI Agent when and how to engage the collaborator agent.
examples (list) --
Example interactions that illustrate when the Orchestration AI Agent should engage the collaborator agent.
(string) --
handoffAgentConfiguration (dict) --
Configures the collaborator agent as a handoff target that the Orchestration AI Agent transfers control of the conversation to.
agentTarget (dict) --
The collaborator agent to hand off to.
aiAgentId (string) --
The identifier of an Amazon Connect AI Agent to use as the collaborator agent.
applicationId (string) --
The identifier of a third-party agent to use as the collaborator agent.
instruction (dict) --
The instruction that tells the Orchestration AI Agent when and how to hand off to this collaborator agent.
instruction (string) --
The natural-language instruction that tells the Orchestration AI Agent when and how to engage the collaborator agent.
examples (list) --
Example interactions that illustrate when the Orchestration AI Agent should engage the collaborator agent.
(string) --
audioStreamingEnabled (boolean) --
Specifies whether the caller's audio is streamed directly to the collaborator agent and the collaborator's audio response is played back during the handoff. This applies only to voice handoffs.
immediateHandoff (boolean) --
Specifies whether the conversation is handed off to this collaborator agent immediately on the first turn, without any orchestration reasoning. At most one handoff in an AI Agent's configuration can set this to true.
connectInstanceArn (string) --
The Amazon Resource Name (ARN) of the Amazon Connect instance used by the Orchestration AI Agent.
locale (string) --
The locale setting for the Orchestration AI Agent.
inputSchemas (list) --
The JSON schemas that define the structure of the structured data input accepted by the Orchestration AI Agent. The data in a DATA message sent to the agent is validated against these schemas. You can specify at most one schema.
(:ref:`document<document>`) --
outputSchemas (list) --
The JSON schemas that define the structure of the structured output generated by the Orchestration AI Agent. You can specify at most one schema.
(:ref:`document<document>`) --
noteTakingAIAgentConfiguration (dict) --
The configuration for AI Agents of type NOTE_TAKING.
noteTakingAIPromptId (string) --
The AI Prompt identifier used by the Note Taking AI Agent.
noteTakingAIGuardrailId (string) --
The AI Guardrail identifier used by the Note Taking AI Agent.
locale (string) --
The locale setting for language-specific case summarization generation (for example, en_US, es_ES).
caseSummarizationAIAgentConfiguration (dict) --
The configuration for AI Agents of type CASE_SUMMARIZATION.
caseSummarizationAIPromptId (string) --
The AI Prompt identifier used by the Case Summarization AI Agent.
caseSummarizationAIGuardrailId (string) --
The AI Guardrail identifier used by the Case Summarization AI Agent.
locale (string) --
The locale setting for the Case Summarization AI Agent.
modifiedTime (datetime) --
The time the AI Agent was last modified.
description (string) --
The description of the AI Agent.
visibilityStatus (string) --
The visibility status of the AI Agent.
tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
origin (string) --
Specifies the origin of the AI Agent. SYSTEM for a default AI Agent created by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent creation APIs.
status (string) --
The status of the AI Agent.