2025/12/01 - Amazon Q Connect - 2 new28 updated api methods
Changes New AIAgent types: Orchestration for ModelContextProtocol tool integration, CaseSummary for Amazon Connect Case summaries, NoteTaker for Agent Assistance notes. Added ListSpans and Retrieve APIs. Enhanced Q in Connect AssistantAssociationType to support Bring Your Own Bedrock Knowledge Bases.
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',
'requestId': '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',
'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'
}
},
]
},
],
'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'
}
},
]
},
],
'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'
}
},
],
'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
}
},
],
'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
requestId (string) --
The service request ID that initiated the operation
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
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)
(dict) --
Message content value - can be text, tool invocation, or tool result
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
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)
(dict) --
Message content value - can be text, tool invocation, or tool result
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
systemInstructions (list) --
System prompt instructions
(dict) --
Message content value - can be text, tool invocation, or tool result
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
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
nextToken (string) --
Pagination token for retrieving additional results
Retrieves content from knowledge sources based on a query.
See also: AWS API Documentation
Request Syntax
client.retrieve(
assistantId='string',
retrievalConfiguration={
'knowledgeSource': {
'assistantAssociationIds': [
'string',
]
},
'filter': {
'andAll': [
{'... recursive ...'},
],
'equals': {
'key': 'string',
'value': {...}|[...]|123|123.4|'string'|True|None
},
'greaterThan': {
'key': 'string',
'value': {...}|[...]|123|123.4|'string'|True|None
},
'greaterThanOrEquals': {
'key': 'string',
'value': {...}|[...]|123|123.4|'string'|True|None
},
'in': {
'key': 'string',
'value': {...}|[...]|123|123.4|'string'|True|None
},
'lessThan': {
'key': 'string',
'value': {...}|[...]|123|123.4|'string'|True|None
},
'lessThanOrEquals': {
'key': 'string',
'value': {...}|[...]|123|123.4|'string'|True|None
},
'listContains': {
'key': 'string',
'value': {...}|[...]|123|123.4|'string'|True|None
},
'notEquals': {
'key': 'string',
'value': {...}|[...]|123|123.4|'string'|True|None
},
'notIn': {
'key': 'string',
'value': {...}|[...]|123|123.4|'string'|True|None
},
'orAll': [
{'... recursive ...'},
],
'startsWith': {
'key': 'string',
'value': {...}|[...]|123|123.4|'string'|True|None
},
'stringContains': {
'key': 'string',
'value': {...}|[...]|123|123.4|'string'|True|None
}
},
'numberOfResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
},
retrievalQuery='string'
)
string
[REQUIRED]
The identifier of the Amazon Q in Connect assistant for content retrieval.
dict
[REQUIRED]
The configuration for the content retrieval operation.
knowledgeSource (dict) -- [REQUIRED]
The knowledge source configuration for content retrieval.
assistantAssociationIds (list) --
The list of assistant association identifiers for the knowledge source.
(string) --
filter (dict) --
The filter configuration for content retrieval.
andAll (list) --
Filter configuration that requires all conditions to be met.
(dict) --
Configuration for filtering content during retrieval operations.
equals (dict) --
Filter configuration for exact equality matching.
key (string) -- [REQUIRED]
The key of the filter attribute.
value (:ref:`document<document>`) -- [REQUIRED]
The value of the filter attribute.
greaterThan (dict) --
Filter configuration for greater than comparison.
key (string) -- [REQUIRED]
The key of the filter attribute.
value (:ref:`document<document>`) -- [REQUIRED]
The value of the filter attribute.
greaterThanOrEquals (dict) --
Filter configuration for greater than or equal comparison.
key (string) -- [REQUIRED]
The key of the filter attribute.
value (:ref:`document<document>`) -- [REQUIRED]
The value of the filter attribute.
in (dict) --
Filter configuration for membership in a set of values.
key (string) -- [REQUIRED]
The key of the filter attribute.
value (:ref:`document<document>`) -- [REQUIRED]
The value of the filter attribute.
lessThan (dict) --
Filter configuration for less than comparison.
key (string) -- [REQUIRED]
The key of the filter attribute.
value (:ref:`document<document>`) -- [REQUIRED]
The value of the filter attribute.
lessThanOrEquals (dict) --
Filter configuration for less than or equal comparison.
key (string) -- [REQUIRED]
The key of the filter attribute.
value (:ref:`document<document>`) -- [REQUIRED]
The value of the filter attribute.
listContains (dict) --
Filter configuration for checking if a list contains a value.
key (string) -- [REQUIRED]
The key of the filter attribute.
value (:ref:`document<document>`) -- [REQUIRED]
The value of the filter attribute.
notEquals (dict) --
Filter configuration for inequality matching.
key (string) -- [REQUIRED]
The key of the filter attribute.
value (:ref:`document<document>`) -- [REQUIRED]
The value of the filter attribute.
notIn (dict) --
Filter configuration for exclusion from a set of values.
key (string) -- [REQUIRED]
The key of the filter attribute.
value (:ref:`document<document>`) -- [REQUIRED]
The value of the filter attribute.
orAll (list) --
Filter configuration where any condition can be met.
(dict) --
Configuration for filtering content during retrieval operations.
startsWith (dict) --
Filter configuration for prefix matching.
key (string) -- [REQUIRED]
The key of the filter attribute.
value (:ref:`document<document>`) -- [REQUIRED]
The value of the filter attribute.
stringContains (dict) --
Filter configuration for substring matching.
key (string) -- [REQUIRED]
The key of the filter attribute.
value (:ref:`document<document>`) -- [REQUIRED]
The value of the filter attribute.
numberOfResults (integer) --
The number of results to retrieve.
overrideKnowledgeBaseSearchType (string) --
Override setting for the knowledge base search type during retrieval.
string
[REQUIRED]
The query for content retrieval.
dict
Response Syntax
{
'results': [
{
'associationId': 'string',
'sourceId': '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',
'contentText': 'string'
},
]
}
Response Structure
(dict) --
results (list) --
The results of the content retrieval operation.
(dict) --
A single result from a content retrieval operation.
associationId (string) --
The identifier of the assistant association for the retrieved result.
sourceId (string) --
The URL, URI, or ID of the retrieved content when available, or a UUID when unavailable.
referenceType (string) --
A type to define the KB origin of a retrieved content.
contentText (string) --
The text content of the retrieved result.
{'configuration': {'answerRecommendationAIAgentConfiguration': {'suggestedMessages': ['string']},
'caseSummarizationAIAgentConfiguration': {'caseSummarizationAIGuardrailId': 'string',
'caseSummarizationAIPromptId': 'string',
'locale': 'string'},
'noteTakingAIAgentConfiguration': {'locale': 'string',
'noteTakingAIGuardrailId': 'string',
'noteTakingAIPromptId': 'string'},
'orchestrationAIAgentConfiguration': {'connectInstanceArn': 'string',
'locale': 'string',
'orchestrationAIGuardrailId': 'string',
'orchestrationAIPromptId': 'string',
'toolConfigurations': [{'annotations': {'destructiveHint': 'boolean',
'title': 'string'},
'description': 'string',
'inputSchema': {},
'instruction': {'examples': ['string'],
'instruction': 'string'},
'outputFilters': [{'jsonPath': 'string',
'outputConfiguration': {'outputVariableNameOverride': 'string',
'sessionDataNamespace': 'string'}}],
'outputSchema': {},
'overrideInputValues': [{'jsonPath': 'string',
'value': {'constant': {'type': 'STRING '
'| '
'NUMBER '
'| '
'JSON_STRING',
'value': 'string'}}}],
'title': 'string',
'toolId': 'string',
'toolName': 'string',
'toolType': 'MODEL_CONTEXT_PROTOCOL '
'| '
'RETURN_TO_CONTROL '
'| '
'CONSTANT',
'userInteractionConfiguration': {'isUserConfirmationRequired': 'boolean'}}]}},
'type': {'CASE_SUMMARIZATION', 'ORCHESTRATION', 'NOTE_TAKING'}}
Response {'aiAgent': {'configuration': {'answerRecommendationAIAgentConfiguration': {'suggestedMessages': ['string']},
'caseSummarizationAIAgentConfiguration': {'caseSummarizationAIGuardrailId': 'string',
'caseSummarizationAIPromptId': 'string',
'locale': 'string'},
'noteTakingAIAgentConfiguration': {'locale': 'string',
'noteTakingAIGuardrailId': 'string',
'noteTakingAIPromptId': 'string'},
'orchestrationAIAgentConfiguration': {'connectInstanceArn': 'string',
'locale': 'string',
'orchestrationAIGuardrailId': 'string',
'orchestrationAIPromptId': 'string',
'toolConfigurations': [{'annotations': {'destructiveHint': 'boolean',
'title': 'string'},
'description': 'string',
'inputSchema': {},
'instruction': {'examples': ['string'],
'instruction': 'string'},
'outputFilters': [{'jsonPath': 'string',
'outputConfiguration': {'outputVariableNameOverride': 'string',
'sessionDataNamespace': 'string'}}],
'outputSchema': {},
'overrideInputValues': [{'jsonPath': 'string',
'value': {'constant': {'type': 'STRING '
'| '
'NUMBER '
'| '
'JSON_STRING',
'value': 'string'}}}],
'title': 'string',
'toolId': 'string',
'toolName': 'string',
'toolType': 'MODEL_CONTEXT_PROTOCOL '
'| '
'RETURN_TO_CONTROL '
'| '
'CONSTANT',
'userInteractionConfiguration': {'isUserConfirmationRequired': 'boolean'}}]}},
'type': {'CASE_SUMMARIZATION', 'ORCHESTRATION', 'NOTE_TAKING'}}}
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
}
},
],
'connectInstanceArn': 'string',
'locale': 'string'
},
'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) -- [REQUIRED]
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.
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.
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
}
},
],
'connectInstanceArn': 'string',
'locale': 'string'
},
'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.
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.
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': {'answerRecommendationAIAgentConfiguration': {'suggestedMessages': ['string']},
'caseSummarizationAIAgentConfiguration': {'caseSummarizationAIGuardrailId': 'string',
'caseSummarizationAIPromptId': 'string',
'locale': 'string'},
'noteTakingAIAgentConfiguration': {'locale': 'string',
'noteTakingAIGuardrailId': 'string',
'noteTakingAIPromptId': 'string'},
'orchestrationAIAgentConfiguration': {'connectInstanceArn': 'string',
'locale': 'string',
'orchestrationAIGuardrailId': 'string',
'orchestrationAIPromptId': 'string',
'toolConfigurations': [{'annotations': {'destructiveHint': 'boolean',
'title': 'string'},
'description': 'string',
'inputSchema': {},
'instruction': {'examples': ['string'],
'instruction': 'string'},
'outputFilters': [{'jsonPath': 'string',
'outputConfiguration': {'outputVariableNameOverride': 'string',
'sessionDataNamespace': 'string'}}],
'outputSchema': {},
'overrideInputValues': [{'jsonPath': 'string',
'value': {'constant': {'type': 'STRING '
'| '
'NUMBER '
'| '
'JSON_STRING',
'value': 'string'}}}],
'title': 'string',
'toolId': 'string',
'toolName': 'string',
'toolType': 'MODEL_CONTEXT_PROTOCOL '
'| '
'RETURN_TO_CONTROL '
'| '
'CONSTANT',
'userInteractionConfiguration': {'isUserConfirmationRequired': 'boolean'}}]}},
'type': {'CASE_SUMMARIZATION', 'ORCHESTRATION', 'NOTE_TAKING'}}}
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
}
},
],
'connectInstanceArn': 'string',
'locale': 'string'
},
'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.
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.
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.
{'inferenceConfiguration': {'textAIPromptInferenceConfiguration': {'maxTokensToSample': 'integer',
'temperature': 'float',
'topK': 'integer',
'topP': 'float'}},
'type': {'CASE_SUMMARIZATION', 'ORCHESTRATION', 'NOTE_TAKING'}}
Response {'aiPrompt': {'inferenceConfiguration': {'textAIPromptInferenceConfiguration': {'maxTokensToSample': 'integer',
'temperature': 'float',
'topK': 'integer',
'topP': 'float'}},
'type': {'CASE_SUMMARIZATION', 'ORCHESTRATION', 'NOTE_TAKING'}}}
Creates an Amazon Q in Connect AI Prompt.
See also: AWS API Documentation
Request Syntax
client.create_ai_prompt(
clientToken='string',
assistantId='string',
name='string',
type='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',
templateConfiguration={
'textFullAIPromptEditTemplateConfiguration': {
'text': 'string'
}
},
visibilityStatus='SAVED'|'PUBLISHED',
templateType='TEXT',
modelId='string',
apiFormat='ANTHROPIC_CLAUDE_MESSAGES'|'ANTHROPIC_CLAUDE_TEXT_COMPLETIONS'|'MESSAGES'|'TEXT_COMPLETIONS',
tags={
'string': 'string'
},
description='string',
inferenceConfiguration={
'textAIPromptInferenceConfiguration': {
'temperature': ...,
'topP': ...,
'topK': 123,
'maxTokensToSample': 123
}
}
)
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 Prompt.
string
[REQUIRED]
The type of this AI Prompt.
dict
[REQUIRED]
The configuration of the prompt template for this AI Prompt.
textFullAIPromptEditTemplateConfiguration (dict) --
The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt.
text (string) -- [REQUIRED]
The YAML text for the AI Prompt template.
string
[REQUIRED]
The visibility status of the AI Prompt.
string
[REQUIRED]
The type of the prompt template for this AI Prompt.
string
[REQUIRED]
The identifier of the model used for this AI Prompt.
string
[REQUIRED]
The API Format of the AI Prompt.
Recommended values: MESSAGES | TEXT_COMPLETIONS
dict
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
string
The description of the AI Prompt.
dict
The inference configuration for the AI Prompt being created.
textAIPromptInferenceConfiguration (dict) --
The inference configuration for text-based AI Prompts.
temperature (float) --
The temperature setting for controlling randomness in the generated response.
topP (float) --
The top-P sampling parameter for nucleus sampling.
topK (integer) --
The top-K sampling parameter for token selection.
maxTokensToSample (integer) --
The maximum number of tokens to generate in the response.
dict
Response Syntax
{
'aiPrompt': {
'assistantId': 'string',
'assistantArn': 'string',
'aiPromptId': 'string',
'aiPromptArn': 'string',
'name': 'string',
'type': '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',
'templateType': 'TEXT',
'modelId': 'string',
'apiFormat': 'ANTHROPIC_CLAUDE_MESSAGES'|'ANTHROPIC_CLAUDE_TEXT_COMPLETIONS'|'MESSAGES'|'TEXT_COMPLETIONS',
'templateConfiguration': {
'textFullAIPromptEditTemplateConfiguration': {
'text': 'string'
}
},
'inferenceConfiguration': {
'textAIPromptInferenceConfiguration': {
'temperature': ...,
'topP': ...,
'topK': 123,
'maxTokensToSample': 123
}
},
'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) --
aiPrompt (dict) --
The data of the AI Prompt.
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.
aiPromptId (string) --
The identifier of the Amazon Q in Connect AI prompt.
aiPromptArn (string) --
The Amazon Resource Name (ARN) of the AI Prompt.
name (string) --
The name of the AI Prompt
type (string) --
The type of this AI Prompt.
templateType (string) --
The type of the prompt template for this AI Prompt.
modelId (string) --
The identifier of the model used for this AI Prompt. The following model Ids are supported:
anthropic.claude-3-haiku--v1:0
apac.amazon.nova-lite-v1:0
apac.amazon.nova-micro-v1:0
apac.amazon.nova-pro-v1:0
apac.anthropic.claude-3-5-sonnet--v2:0
apac.anthropic.claude-3-haiku-20240307-v1:0
eu.amazon.nova-lite-v1:0
eu.amazon.nova-micro-v1:0
eu.amazon.nova-pro-v1:0
eu.anthropic.claude-3-7-sonnet-20250219-v1:0
eu.anthropic.claude-3-haiku-20240307-v1:0
us.amazon.nova-lite-v1:0
us.amazon.nova-micro-v1:0
us.amazon.nova-pro-v1:0
us.anthropic.claude-3-5-haiku-20241022-v1:0
us.anthropic.claude-3-7-sonnet-20250219-v1:0
us.anthropic.claude-3-haiku-20240307-v1:0
apiFormat (string) --
The API format used for this AI Prompt.
templateConfiguration (dict) --
The configuration of the prompt template for this AI Prompt.
textFullAIPromptEditTemplateConfiguration (dict) --
The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt.
text (string) --
The YAML text for the AI Prompt template.
inferenceConfiguration (dict) --
The configuration for inference parameters when using the AI Prompt.
textAIPromptInferenceConfiguration (dict) --
The inference configuration for text-based AI Prompts.
temperature (float) --
The temperature setting for controlling randomness in the generated response.
topP (float) --
The top-P sampling parameter for nucleus sampling.
topK (integer) --
The top-K sampling parameter for token selection.
maxTokensToSample (integer) --
The maximum number of tokens to generate in the response.
modifiedTime (datetime) --
The time the AI Prompt was last modified.
description (string) --
The description of the AI Prompt.
visibilityStatus (string) --
The visibility status of the AI Prompt.
tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
origin (string) --
The origin of the AI Prompt. SYSTEM for a default AI Prompt created by Q in Connect or CUSTOMER for an AI Prompt created by calling AI Prompt creation APIs.
status (string) --
The status of the AI Prompt.
{'aiPrompt': {'inferenceConfiguration': {'textAIPromptInferenceConfiguration': {'maxTokensToSample': 'integer',
'temperature': 'float',
'topK': 'integer',
'topP': 'float'}},
'type': {'CASE_SUMMARIZATION', 'ORCHESTRATION', 'NOTE_TAKING'}}}
Creates an Amazon Q in Connect AI Prompt version.
See also: AWS API Documentation
Request Syntax
client.create_ai_prompt_version(
assistantId='string',
aiPromptId='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 prompt.
datetime
The time the AI Prompt was last modified.
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
{
'aiPrompt': {
'assistantId': 'string',
'assistantArn': 'string',
'aiPromptId': 'string',
'aiPromptArn': 'string',
'name': 'string',
'type': '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',
'templateType': 'TEXT',
'modelId': 'string',
'apiFormat': 'ANTHROPIC_CLAUDE_MESSAGES'|'ANTHROPIC_CLAUDE_TEXT_COMPLETIONS'|'MESSAGES'|'TEXT_COMPLETIONS',
'templateConfiguration': {
'textFullAIPromptEditTemplateConfiguration': {
'text': 'string'
}
},
'inferenceConfiguration': {
'textAIPromptInferenceConfiguration': {
'temperature': ...,
'topP': ...,
'topK': 123,
'maxTokensToSample': 123
}
},
'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) --
aiPrompt (dict) --
The data of the AI Prompt 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.
aiPromptId (string) --
The identifier of the Amazon Q in Connect AI prompt.
aiPromptArn (string) --
The Amazon Resource Name (ARN) of the AI Prompt.
name (string) --
The name of the AI Prompt
type (string) --
The type of this AI Prompt.
templateType (string) --
The type of the prompt template for this AI Prompt.
modelId (string) --
The identifier of the model used for this AI Prompt. The following model Ids are supported:
anthropic.claude-3-haiku--v1:0
apac.amazon.nova-lite-v1:0
apac.amazon.nova-micro-v1:0
apac.amazon.nova-pro-v1:0
apac.anthropic.claude-3-5-sonnet--v2:0
apac.anthropic.claude-3-haiku-20240307-v1:0
eu.amazon.nova-lite-v1:0
eu.amazon.nova-micro-v1:0
eu.amazon.nova-pro-v1:0
eu.anthropic.claude-3-7-sonnet-20250219-v1:0
eu.anthropic.claude-3-haiku-20240307-v1:0
us.amazon.nova-lite-v1:0
us.amazon.nova-micro-v1:0
us.amazon.nova-pro-v1:0
us.anthropic.claude-3-5-haiku-20241022-v1:0
us.anthropic.claude-3-7-sonnet-20250219-v1:0
us.anthropic.claude-3-haiku-20240307-v1:0
apiFormat (string) --
The API format used for this AI Prompt.
templateConfiguration (dict) --
The configuration of the prompt template for this AI Prompt.
textFullAIPromptEditTemplateConfiguration (dict) --
The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt.
text (string) --
The YAML text for the AI Prompt template.
inferenceConfiguration (dict) --
The configuration for inference parameters when using the AI Prompt.
textAIPromptInferenceConfiguration (dict) --
The inference configuration for text-based AI Prompts.
temperature (float) --
The temperature setting for controlling randomness in the generated response.
topP (float) --
The top-P sampling parameter for nucleus sampling.
topK (integer) --
The top-K sampling parameter for token selection.
maxTokensToSample (integer) --
The maximum number of tokens to generate in the response.
modifiedTime (datetime) --
The time the AI Prompt was last modified.
description (string) --
The description of the AI Prompt.
visibilityStatus (string) --
The visibility status of the AI Prompt.
tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
origin (string) --
The origin of the AI Prompt. SYSTEM for a default AI Prompt created by Q in Connect or CUSTOMER for an AI Prompt created by calling AI Prompt creation APIs.
status (string) --
The status of the AI Prompt.
versionNumber (integer) --
The version number of the AI Prompt version.
{'assistant': {'orchestratorConfigurationList': [{'aiAgentId': 'string',
'orchestratorUseCase': 'string'}]}}
Creates an Amazon Q in Connect assistant.
See also: AWS API Documentation
Request Syntax
client.create_assistant(
clientToken='string',
name='string',
type='AGENT',
description='string',
tags={
'string': 'string'
},
serverSideEncryptionConfiguration={
'kmsKeyId': '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 name of the assistant.
string
[REQUIRED]
The type of assistant.
string
The description of the assistant.
dict
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
dict
The configuration information for the customer managed key used for encryption.
The customer managed key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey permissions to the connect.amazonaws.com service principal.
For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.
kmsKeyId (string) --
The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. For information about valid ID values, see Key identifiers (KeyId).
dict
Response Syntax
{
'assistant': {
'assistantId': 'string',
'assistantArn': 'string',
'name': 'string',
'type': 'AGENT',
'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED',
'description': 'string',
'tags': {
'string': 'string'
},
'serverSideEncryptionConfiguration': {
'kmsKeyId': 'string'
},
'integrationConfiguration': {
'topicIntegrationArn': 'string'
},
'capabilityConfiguration': {
'type': 'V1'|'V2'
},
'aiAgentConfiguration': {
'string': {
'aiAgentId': 'string'
}
},
'orchestratorConfigurationList': [
{
'aiAgentId': 'string',
'orchestratorUseCase': 'string'
},
]
}
}
Response Structure
(dict) --
assistant (dict) --
Information about the assistant.
assistantId (string) --
The identifier of the Amazon Q in Connect assistant.
assistantArn (string) --
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
name (string) --
The name.
type (string) --
The type of assistant.
status (string) --
The status of the assistant.
description (string) --
The description.
tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
serverSideEncryptionConfiguration (dict) --
The configuration information for the customer managed key used for encryption.
This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey permissions to the connect.amazonaws.com service principal.
For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.
kmsKeyId (string) --
The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. For information about valid ID values, see Key identifiers (KeyId).
integrationConfiguration (dict) --
The configuration information for the Amazon Q in Connect assistant integration.
topicIntegrationArn (string) --
The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.
capabilityConfiguration (dict) --
The configuration information for the Amazon Q in Connect assistant capability.
type (string) --
The type of Amazon Q in Connect assistant capability.
aiAgentConfiguration (dict) --
The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that is set on the Amazon Q in Connect Assistant.
(string) --
(dict) --
A type that specifies the AI Agent ID configuration data when mapping an AI Agents to be used for an AI Agent type on a session or assistant.
aiAgentId (string) --
The ID of the AI Agent to be configured.
orchestratorConfigurationList (list) --
The list of orchestrator configurations for the assistant.
(dict) --
An entry in the orchestrator configuration list.
aiAgentId (string) --
The identifier of the AI Agent in the orchestrator configuration.
orchestratorUseCase (string) --
The use case for the orchestrator configuration. (for example Connect.SelfService, Connect.AgentAssistance)
{'association': {'externalBedrockKnowledgeBaseConfig': {'accessRoleArn': 'string',
'bedrockKnowledgeBaseArn': 'string'}},
'associationType': {'EXTERNAL_BEDROCK_KNOWLEDGE_BASE'}}
Response {'assistantAssociation': {'associationData': {'externalBedrockKnowledgeBaseConfig': {'accessRoleArn': 'string',
'bedrockKnowledgeBaseArn': 'string'}},
'associationType': {'EXTERNAL_BEDROCK_KNOWLEDGE_BASE'}}}
Creates an association between an Amazon Q in Connect assistant and another resource. Currently, the only supported association is with a knowledge base. An assistant can have only a single association.
See also: AWS API Documentation
Request Syntax
client.create_assistant_association(
assistantId='string',
associationType='KNOWLEDGE_BASE'|'EXTERNAL_BEDROCK_KNOWLEDGE_BASE',
association={
'knowledgeBaseId': 'string',
'externalBedrockKnowledgeBaseConfig': {
'bedrockKnowledgeBaseArn': 'string',
'accessRoleArn': 'string'
}
},
clientToken='string',
tags={
'string': '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 type of association.
dict
[REQUIRED]
The identifier of the associated resource.
knowledgeBaseId (string) --
The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.
externalBedrockKnowledgeBaseConfig (dict) --
The configuration for an external Bedrock knowledge base association.
bedrockKnowledgeBaseArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the external Bedrock knowledge base.
accessRoleArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the IAM role used to access the external Bedrock knowledge base.
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
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
dict
Response Syntax
{
'assistantAssociation': {
'assistantAssociationId': 'string',
'assistantAssociationArn': 'string',
'assistantId': 'string',
'assistantArn': 'string',
'associationType': 'KNOWLEDGE_BASE'|'EXTERNAL_BEDROCK_KNOWLEDGE_BASE',
'associationData': {
'knowledgeBaseAssociation': {
'knowledgeBaseId': 'string',
'knowledgeBaseArn': 'string'
},
'externalBedrockKnowledgeBaseConfig': {
'bedrockKnowledgeBaseArn': 'string',
'accessRoleArn': 'string'
}
},
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
assistantAssociation (dict) --
The assistant association.
assistantAssociationId (string) --
The identifier of the assistant association.
assistantAssociationArn (string) --
The Amazon Resource Name (ARN) of the assistant association.
assistantId (string) --
The identifier of the Amazon Q in Connect assistant.
assistantArn (string) --
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
associationType (string) --
The type of association.
associationData (dict) --
A union type that currently has a single argument, the knowledge base ID.
knowledgeBaseAssociation (dict) --
The knowledge base where output data is sent.
knowledgeBaseId (string) --
The identifier of the knowledge base.
knowledgeBaseArn (string) --
The Amazon Resource Name (ARN) of the knowledge base.
externalBedrockKnowledgeBaseConfig (dict) --
The configuration for an external Bedrock knowledge base association in the output data.
bedrockKnowledgeBaseArn (string) --
The Amazon Resource Name (ARN) of the external Bedrock knowledge base.
accessRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role used to access the external Bedrock knowledge base.
tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
{'orchestratorConfigurationList': [{'aiAgentId': 'string',
'orchestratorUseCase': 'string'}],
'removeOrchestratorConfigurationList': 'boolean'}
Response {'session': {'orchestratorConfigurationList': [{'aiAgentId': 'string',
'orchestratorUseCase': 'string'}]}}
Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.
See also: AWS API Documentation
Request Syntax
client.create_session(
clientToken='string',
assistantId='string',
name='string',
description='string',
tags={
'string': 'string'
},
tagFilter={
'tagCondition': {
'key': 'string',
'value': 'string'
},
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
]
},
aiAgentConfiguration={
'string': {
'aiAgentId': 'string'
}
},
contactArn='string',
orchestratorConfigurationList=[
{
'aiAgentId': 'string',
'orchestratorUseCase': 'string'
},
],
removeOrchestratorConfigurationList=True|False
)
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 session.
string
The description.
dict
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
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.
dict
The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session.
(string) --
(dict) --
A type that specifies the AI Agent ID configuration data when mapping an AI Agents to be used for an AI Agent type on a session or assistant.
aiAgentId (string) -- [REQUIRED]
The ID of the AI Agent to be configured.
string
The Amazon Resource Name (ARN) of the email contact in Amazon Connect. Used to retrieve email content and establish session context for AI-powered email assistance.
list
The list of orchestrator configurations for the session being created.
(dict) --
An entry in the orchestrator configuration list.
aiAgentId (string) --
The identifier of the AI Agent in the orchestrator configuration.
orchestratorUseCase (string) -- [REQUIRED]
The use case for the orchestrator configuration. (for example Connect.SelfService, Connect.AgentAssistance)
boolean
The list of orchestrator configurations to remove from the session.
dict
Response Syntax
{
'session': {
'sessionArn': 'string',
'sessionId': 'string',
'name': 'string',
'description': 'string',
'tags': {
'string': 'string'
},
'integrationConfiguration': {
'topicIntegrationArn': 'string'
},
'tagFilter': {
'tagCondition': {
'key': 'string',
'value': 'string'
},
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
]
},
'aiAgentConfiguration': {
'string': {
'aiAgentId': 'string'
}
},
'origin': 'SYSTEM'|'CUSTOMER',
'orchestratorConfigurationList': [
{
'aiAgentId': 'string',
'orchestratorUseCase': 'string'
},
]
}
}
Response Structure
(dict) --
session (dict) --
The session.
sessionArn (string) --
The Amazon Resource Name (ARN) of the session.
sessionId (string) --
The identifier of the session.
name (string) --
The name of the session.
description (string) --
The description of the session.
tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
integrationConfiguration (dict) --
The configuration information for the session integration.
topicIntegrationArn (string) --
The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.
tagFilter (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.
aiAgentConfiguration (dict) --
The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session.
(string) --
(dict) --
A type that specifies the AI Agent ID configuration data when mapping an AI Agents to be used for an AI Agent type on a session or assistant.
aiAgentId (string) --
The ID of the AI Agent to be configured.
origin (string) --
The origin of the Session to be listed. SYSTEM for a default Session created by Amazon Q in Connect or CUSTOMER for a Session created by calling CreateSession API.
orchestratorConfigurationList (list) --
The list of orchestrator configurations for the session.
(dict) --
An entry in the orchestrator configuration list.
aiAgentId (string) --
The identifier of the AI Agent in the orchestrator configuration.
orchestratorUseCase (string) --
The use case for the orchestrator configuration. (for example Connect.SelfService, Connect.AgentAssistance)
{'aiAgent': {'configuration': {'answerRecommendationAIAgentConfiguration': {'suggestedMessages': ['string']},
'caseSummarizationAIAgentConfiguration': {'caseSummarizationAIGuardrailId': 'string',
'caseSummarizationAIPromptId': 'string',
'locale': 'string'},
'noteTakingAIAgentConfiguration': {'locale': 'string',
'noteTakingAIGuardrailId': 'string',
'noteTakingAIPromptId': 'string'},
'orchestrationAIAgentConfiguration': {'connectInstanceArn': 'string',
'locale': 'string',
'orchestrationAIGuardrailId': 'string',
'orchestrationAIPromptId': 'string',
'toolConfigurations': [{'annotations': {'destructiveHint': 'boolean',
'title': 'string'},
'description': 'string',
'inputSchema': {},
'instruction': {'examples': ['string'],
'instruction': 'string'},
'outputFilters': [{'jsonPath': 'string',
'outputConfiguration': {'outputVariableNameOverride': 'string',
'sessionDataNamespace': 'string'}}],
'outputSchema': {},
'overrideInputValues': [{'jsonPath': 'string',
'value': {'constant': {'type': 'STRING '
'| '
'NUMBER '
'| '
'JSON_STRING',
'value': 'string'}}}],
'title': 'string',
'toolId': 'string',
'toolName': 'string',
'toolType': 'MODEL_CONTEXT_PROTOCOL '
'| '
'RETURN_TO_CONTROL '
'| '
'CONSTANT',
'userInteractionConfiguration': {'isUserConfirmationRequired': 'boolean'}}]}},
'type': {'CASE_SUMMARIZATION', 'ORCHESTRATION', 'NOTE_TAKING'}}}
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
}
},
],
'connectInstanceArn': 'string',
'locale': 'string'
},
'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.
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.
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).
{'aiPrompt': {'inferenceConfiguration': {'textAIPromptInferenceConfiguration': {'maxTokensToSample': 'integer',
'temperature': 'float',
'topK': 'integer',
'topP': 'float'}},
'type': {'CASE_SUMMARIZATION', 'ORCHESTRATION', 'NOTE_TAKING'}}}
Gets and Amazon Q in Connect AI Prompt.
See also: AWS API Documentation
Request Syntax
client.get_ai_prompt(
assistantId='string',
aiPromptId='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 prompt.
dict
Response Syntax
{
'aiPrompt': {
'assistantId': 'string',
'assistantArn': 'string',
'aiPromptId': 'string',
'aiPromptArn': 'string',
'name': 'string',
'type': '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',
'templateType': 'TEXT',
'modelId': 'string',
'apiFormat': 'ANTHROPIC_CLAUDE_MESSAGES'|'ANTHROPIC_CLAUDE_TEXT_COMPLETIONS'|'MESSAGES'|'TEXT_COMPLETIONS',
'templateConfiguration': {
'textFullAIPromptEditTemplateConfiguration': {
'text': 'string'
}
},
'inferenceConfiguration': {
'textAIPromptInferenceConfiguration': {
'temperature': ...,
'topP': ...,
'topK': 123,
'maxTokensToSample': 123
}
},
'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) --
aiPrompt (dict) --
The data of the AI Prompt.
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.
aiPromptId (string) --
The identifier of the Amazon Q in Connect AI prompt.
aiPromptArn (string) --
The Amazon Resource Name (ARN) of the AI Prompt.
name (string) --
The name of the AI Prompt
type (string) --
The type of this AI Prompt.
templateType (string) --
The type of the prompt template for this AI Prompt.
modelId (string) --
The identifier of the model used for this AI Prompt. The following model Ids are supported:
anthropic.claude-3-haiku--v1:0
apac.amazon.nova-lite-v1:0
apac.amazon.nova-micro-v1:0
apac.amazon.nova-pro-v1:0
apac.anthropic.claude-3-5-sonnet--v2:0
apac.anthropic.claude-3-haiku-20240307-v1:0
eu.amazon.nova-lite-v1:0
eu.amazon.nova-micro-v1:0
eu.amazon.nova-pro-v1:0
eu.anthropic.claude-3-7-sonnet-20250219-v1:0
eu.anthropic.claude-3-haiku-20240307-v1:0
us.amazon.nova-lite-v1:0
us.amazon.nova-micro-v1:0
us.amazon.nova-pro-v1:0
us.anthropic.claude-3-5-haiku-20241022-v1:0
us.anthropic.claude-3-7-sonnet-20250219-v1:0
us.anthropic.claude-3-haiku-20240307-v1:0
apiFormat (string) --
The API format used for this AI Prompt.
templateConfiguration (dict) --
The configuration of the prompt template for this AI Prompt.
textFullAIPromptEditTemplateConfiguration (dict) --
The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt.
text (string) --
The YAML text for the AI Prompt template.
inferenceConfiguration (dict) --
The configuration for inference parameters when using the AI Prompt.
textAIPromptInferenceConfiguration (dict) --
The inference configuration for text-based AI Prompts.
temperature (float) --
The temperature setting for controlling randomness in the generated response.
topP (float) --
The top-P sampling parameter for nucleus sampling.
topK (integer) --
The top-K sampling parameter for token selection.
maxTokensToSample (integer) --
The maximum number of tokens to generate in the response.
modifiedTime (datetime) --
The time the AI Prompt was last modified.
description (string) --
The description of the AI Prompt.
visibilityStatus (string) --
The visibility status of the AI Prompt.
tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
origin (string) --
The origin of the AI Prompt. SYSTEM for a default AI Prompt created by Q in Connect or CUSTOMER for an AI Prompt created by calling AI Prompt creation APIs.
status (string) --
The status of the AI Prompt.
versionNumber (integer) --
The version number of the AI Prompt version (returned if an AI Prompt version was specified via use of a qualifier for the aiPromptId on the request).
{'assistant': {'orchestratorConfigurationList': [{'aiAgentId': 'string',
'orchestratorUseCase': 'string'}]}}
Retrieves information about an assistant.
See also: AWS API Documentation
Request Syntax
client.get_assistant(
assistantId='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.
dict
Response Syntax
{
'assistant': {
'assistantId': 'string',
'assistantArn': 'string',
'name': 'string',
'type': 'AGENT',
'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED',
'description': 'string',
'tags': {
'string': 'string'
},
'serverSideEncryptionConfiguration': {
'kmsKeyId': 'string'
},
'integrationConfiguration': {
'topicIntegrationArn': 'string'
},
'capabilityConfiguration': {
'type': 'V1'|'V2'
},
'aiAgentConfiguration': {
'string': {
'aiAgentId': 'string'
}
},
'orchestratorConfigurationList': [
{
'aiAgentId': 'string',
'orchestratorUseCase': 'string'
},
]
}
}
Response Structure
(dict) --
assistant (dict) --
Information about the assistant.
assistantId (string) --
The identifier of the Amazon Q in Connect assistant.
assistantArn (string) --
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
name (string) --
The name.
type (string) --
The type of assistant.
status (string) --
The status of the assistant.
description (string) --
The description.
tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
serverSideEncryptionConfiguration (dict) --
The configuration information for the customer managed key used for encryption.
This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey permissions to the connect.amazonaws.com service principal.
For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.
kmsKeyId (string) --
The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. For information about valid ID values, see Key identifiers (KeyId).
integrationConfiguration (dict) --
The configuration information for the Amazon Q in Connect assistant integration.
topicIntegrationArn (string) --
The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.
capabilityConfiguration (dict) --
The configuration information for the Amazon Q in Connect assistant capability.
type (string) --
The type of Amazon Q in Connect assistant capability.
aiAgentConfiguration (dict) --
The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that is set on the Amazon Q in Connect Assistant.
(string) --
(dict) --
A type that specifies the AI Agent ID configuration data when mapping an AI Agents to be used for an AI Agent type on a session or assistant.
aiAgentId (string) --
The ID of the AI Agent to be configured.
orchestratorConfigurationList (list) --
The list of orchestrator configurations for the assistant.
(dict) --
An entry in the orchestrator configuration list.
aiAgentId (string) --
The identifier of the AI Agent in the orchestrator configuration.
orchestratorUseCase (string) --
The use case for the orchestrator configuration. (for example Connect.SelfService, Connect.AgentAssistance)
{'assistantAssociation': {'associationData': {'externalBedrockKnowledgeBaseConfig': {'accessRoleArn': 'string',
'bedrockKnowledgeBaseArn': 'string'}},
'associationType': {'EXTERNAL_BEDROCK_KNOWLEDGE_BASE'}}}
Retrieves information about an assistant association.
See also: AWS API Documentation
Request Syntax
client.get_assistant_association(
assistantAssociationId='string',
assistantId='string'
)
string
[REQUIRED]
The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.
string
[REQUIRED]
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
dict
Response Syntax
{
'assistantAssociation': {
'assistantAssociationId': 'string',
'assistantAssociationArn': 'string',
'assistantId': 'string',
'assistantArn': 'string',
'associationType': 'KNOWLEDGE_BASE'|'EXTERNAL_BEDROCK_KNOWLEDGE_BASE',
'associationData': {
'knowledgeBaseAssociation': {
'knowledgeBaseId': 'string',
'knowledgeBaseArn': 'string'
},
'externalBedrockKnowledgeBaseConfig': {
'bedrockKnowledgeBaseArn': 'string',
'accessRoleArn': 'string'
}
},
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
assistantAssociation (dict) --
The assistant association.
assistantAssociationId (string) --
The identifier of the assistant association.
assistantAssociationArn (string) --
The Amazon Resource Name (ARN) of the assistant association.
assistantId (string) --
The identifier of the Amazon Q in Connect assistant.
assistantArn (string) --
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
associationType (string) --
The type of association.
associationData (dict) --
A union type that currently has a single argument, the knowledge base ID.
knowledgeBaseAssociation (dict) --
The knowledge base where output data is sent.
knowledgeBaseId (string) --
The identifier of the knowledge base.
knowledgeBaseArn (string) --
The Amazon Resource Name (ARN) of the knowledge base.
externalBedrockKnowledgeBaseConfig (dict) --
The configuration for an external Bedrock knowledge base association in the output data.
bedrockKnowledgeBaseArn (string) --
The Amazon Resource Name (ARN) of the external Bedrock knowledge base.
accessRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role used to access the external Bedrock knowledge base.
tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
{'chunkedResponseTerminated': 'boolean',
'response': {'value': {'text': {'aiGuardrailAssessment': {'blocked': 'boolean'},
'citations': [{'citationSpan': {'beginOffsetInclusive': 'integer',
'endOffsetExclusive': 'integer'},
'contentId': 'string',
'knowledgeBaseId': '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',
'sourceURL': 'string',
'title': 'string'}]},
'toolUseResult': {'inputSchema': {},
'toolName': 'string',
'toolResult': {},
'toolUseId': 'string'}}}}
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',
'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
}
},
'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.
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.
{'recommendationType': 'KNOWLEDGE_CONTENT | GENERATIVE_RESPONSE | '
'GENERATIVE_ANSWER | DETECTED_INTENT | '
'GENERATIVE_ANSWER_CHUNK | '
'BLOCKED_GENERATIVE_ANSWER_CHUNK | INTENT_ANSWER_CHUNK '
'| BLOCKED_INTENT_ANSWER_CHUNK | EMAIL_RESPONSE_CHUNK | '
'EMAIL_OVERVIEW_CHUNK | EMAIL_GENERATIVE_ANSWER_CHUNK | '
'CASE_SUMMARIZATION_CHUNK | '
'BLOCKED_CASE_SUMMARIZATION_CHUNK | SUGGESTED_MESSAGE | '
'NOTES_CHUNK | BLOCKED_NOTES_CHUNK'}
Response {'recommendations': {'data': {'details': {'caseSummarizationChunkData': {'completion': 'string',
'nextChunkToken': 'string'},
'intentDetectedData': {'relevanceLevel': 'HIGH '
'| '
'MEDIUM '
'| '
'LOW'},
'notesChunkData': {'completion': 'string',
'nextChunkToken': 'string'},
'notesData': {'completion': 'string'},
'suggestedMessageData': {'messageText': 'string'}},
'reference': {'contentReference': {'referenceType': {'BEDROCK_KB_CONFLUENCE',
'BEDROCK_KB_CUSTOM_DOCUMENT',
'BEDROCK_KB_KENDRA',
'BEDROCK_KB_S3',
'BEDROCK_KB_SALESFORCE',
'BEDROCK_KB_SHAREPOINT',
'BEDROCK_KB_SQL',
'BEDROCK_KB_WEB'}},
'suggestedMessageReference': {'aiAgentArn': 'string',
'aiAgentId': 'string'}}},
'document': {'contentReference': {'referenceType': {'BEDROCK_KB_CONFLUENCE',
'BEDROCK_KB_CUSTOM_DOCUMENT',
'BEDROCK_KB_KENDRA',
'BEDROCK_KB_S3',
'BEDROCK_KB_SALESFORCE',
'BEDROCK_KB_SHAREPOINT',
'BEDROCK_KB_SQL',
'BEDROCK_KB_WEB'}}},
'type': {'BLOCKED_CASE_SUMMARIZATION_CHUNK',
'BLOCKED_NOTES_CHUNK',
'CASE_SUMMARIZATION_CHUNK',
'NOTES_CHUNK',
'SUGGESTED_MESSAGE'}}}
Retrieves recommendations for the specified session. To avoid retrieving the same recommendations in subsequent calls, use NotifyRecommendationsReceived. This API supports long-polling behavior with the waitTimeSeconds parameter. Short poll is the default behavior and only returns recommendations already available. To perform a manual query against an assistant, use QueryAssistant.
See also: AWS API Documentation
Request Syntax
client.get_recommendations(
assistantId='string',
sessionId='string',
maxResults=123,
waitTimeSeconds=123,
nextChunkToken='string',
recommendationType='KNOWLEDGE_CONTENT'|'GENERATIVE_RESPONSE'|'GENERATIVE_ANSWER'|'DETECTED_INTENT'|'GENERATIVE_ANSWER_CHUNK'|'BLOCKED_GENERATIVE_ANSWER_CHUNK'|'INTENT_ANSWER_CHUNK'|'BLOCKED_INTENT_ANSWER_CHUNK'|'EMAIL_RESPONSE_CHUNK'|'EMAIL_OVERVIEW_CHUNK'|'EMAIL_GENERATIVE_ANSWER_CHUNK'|'CASE_SUMMARIZATION_CHUNK'|'BLOCKED_CASE_SUMMARIZATION_CHUNK'|'SUGGESTED_MESSAGE'|'NOTES_CHUNK'|'BLOCKED_NOTES_CHUNK'
)
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 session. Can be either the ID or the ARN. URLs cannot contain the ARN.
integer
The maximum number of results to return per page.
integer
The duration (in seconds) for which the call waits for a recommendation to be made available before returning. If a recommendation is available, the call returns sooner than WaitTimeSeconds. If no messages are available and the wait time expires, the call returns successfully with an empty list.
string
The token for the next set of chunks. Use the value returned in the previous response in the next request to retrieve the next set of chunks.
string
The type of recommendation being requested.
dict
Response Syntax
{
'recommendations': [
{
'recommendationId': 'string',
'document': {
'contentReference': {
'knowledgeBaseArn': 'string',
'knowledgeBaseId': 'string',
'contentArn': 'string',
'contentId': 'string',
'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'
},
'title': {
'text': 'string',
'highlights': [
{
'beginOffsetInclusive': 123,
'endOffsetExclusive': 123
},
]
},
'excerpt': {
'text': 'string',
'highlights': [
{
'beginOffsetInclusive': 123,
'endOffsetExclusive': 123
},
]
}
},
'relevanceScore': 123.0,
'relevanceLevel': 'HIGH'|'MEDIUM'|'LOW',
'type': 'KNOWLEDGE_CONTENT'|'GENERATIVE_RESPONSE'|'GENERATIVE_ANSWER'|'DETECTED_INTENT'|'GENERATIVE_ANSWER_CHUNK'|'BLOCKED_GENERATIVE_ANSWER_CHUNK'|'INTENT_ANSWER_CHUNK'|'BLOCKED_INTENT_ANSWER_CHUNK'|'EMAIL_RESPONSE_CHUNK'|'EMAIL_OVERVIEW_CHUNK'|'EMAIL_GENERATIVE_ANSWER_CHUNK'|'CASE_SUMMARIZATION_CHUNK'|'BLOCKED_CASE_SUMMARIZATION_CHUNK'|'SUGGESTED_MESSAGE'|'NOTES_CHUNK'|'BLOCKED_NOTES_CHUNK',
'data': {
'reference': {
'contentReference': {
'knowledgeBaseArn': 'string',
'knowledgeBaseId': 'string',
'contentArn': 'string',
'contentId': 'string',
'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'
},
'generativeReference': {
'modelId': 'string',
'generationId': 'string'
},
'suggestedMessageReference': {
'aiAgentId': 'string',
'aiAgentArn': 'string'
}
},
'details': {
'contentData': {
'textData': {
'title': {
'text': 'string',
'highlights': [
{
'beginOffsetInclusive': 123,
'endOffsetExclusive': 123
},
]
},
'excerpt': {
'text': 'string',
'highlights': [
{
'beginOffsetInclusive': 123,
'endOffsetExclusive': 123
},
]
}
},
'rankingData': {
'relevanceScore': 123.0,
'relevanceLevel': 'HIGH'|'MEDIUM'|'LOW'
}
},
'generativeData': {
'completion': 'string',
'references': [
{'... recursive ...'},
],
'rankingData': {
'relevanceScore': 123.0,
'relevanceLevel': 'HIGH'|'MEDIUM'|'LOW'
}
},
'intentDetectedData': {
'intent': 'string',
'intentId': 'string',
'relevanceLevel': 'HIGH'|'MEDIUM'|'LOW'
},
'sourceContentData': {
'id': 'string',
'type': 'KNOWLEDGE_CONTENT',
'textData': {
'title': {
'text': 'string',
'highlights': [
{
'beginOffsetInclusive': 123,
'endOffsetExclusive': 123
},
]
},
'excerpt': {
'text': 'string',
'highlights': [
{
'beginOffsetInclusive': 123,
'endOffsetExclusive': 123
},
]
}
},
'rankingData': {
'relevanceScore': 123.0,
'relevanceLevel': 'HIGH'|'MEDIUM'|'LOW'
},
'citationSpan': {
'beginOffsetInclusive': 123,
'endOffsetExclusive': 123
}
},
'generativeChunkData': {
'completion': 'string',
'references': [
{'... recursive ...'},
],
'nextChunkToken': 'string'
},
'emailResponseChunkData': {
'completion': 'string',
'nextChunkToken': 'string'
},
'emailOverviewChunkData': {
'completion': 'string',
'nextChunkToken': 'string'
},
'emailGenerativeAnswerChunkData': {
'completion': 'string',
'references': [
{'... recursive ...'},
],
'nextChunkToken': 'string'
},
'caseSummarizationChunkData': {
'completion': 'string',
'nextChunkToken': 'string'
},
'suggestedMessageData': {
'messageText': 'string'
},
'notesData': {
'completion': 'string'
},
'notesChunkData': {
'completion': 'string',
'nextChunkToken': 'string'
}
}
}
},
],
'triggers': [
{
'id': 'string',
'type': 'QUERY'|'GENERATIVE',
'source': 'ISSUE_DETECTION'|'RULE_EVALUATION'|'OTHER',
'data': {
'query': {
'text': 'string'
}
},
'recommendationIds': [
'string',
]
},
]
}
Response Structure
(dict) --
recommendations (list) --
The recommendations.
(dict) --
Information about the recommendation.
recommendationId (string) --
The identifier of the recommendation.
document (dict) --
The recommended document.
contentReference (dict) --
A reference to the content resource.
knowledgeBaseArn (string) --
The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseId (string) --
The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.
contentArn (string) --
The Amazon Resource Name (ARN) of the content.
contentId (string) --
The identifier of the content.
sourceURL (string) --
The web URL of the source content.
referenceType (string) --
The type of reference content.
title (dict) --
The title of the document.
text (string) --
Text in the document.
highlights (list) --
Highlights in the document text.
(dict) --
Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.
beginOffsetInclusive (integer) --
The offset for the start of the highlight.
endOffsetExclusive (integer) --
The offset for the end of the highlight.
excerpt (dict) --
The excerpt from the document.
text (string) --
Text in the document.
highlights (list) --
Highlights in the document text.
(dict) --
Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.
beginOffsetInclusive (integer) --
The offset for the start of the highlight.
endOffsetExclusive (integer) --
The offset for the end of the highlight.
relevanceScore (float) --
The relevance score of the recommendation.
relevanceLevel (string) --
The relevance level of the recommendation.
type (string) --
The type of recommendation.
data (dict) --
Summary of the recommended content.
reference (dict) --
Reference information about the content.
contentReference (dict) --
Reference information about the content.
knowledgeBaseArn (string) --
The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseId (string) --
The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.
contentArn (string) --
The Amazon Resource Name (ARN) of the content.
contentId (string) --
The identifier of the content.
sourceURL (string) --
The web URL of the source content.
referenceType (string) --
The type of reference content.
generativeReference (dict) --
Reference information about the generative content.
modelId (string) --
The identifier of the LLM model.
generationId (string) --
The identifier of the LLM model.
suggestedMessageReference (dict) --
Reference information for suggested messages.
aiAgentId (string) --
The identifier of the AI Agent that generated the suggested message.
aiAgentArn (string) --
The Amazon Resource Name (ARN) of the AI Agent that generated the suggested message.
details (dict) --
Details about the data.
contentData (dict) --
Details about the content data.
textData (dict) --
Details about the content text data.
title (dict) --
The text of the document.
text (string) --
Text in the document.
highlights (list) --
Highlights in the document text.
(dict) --
Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.
beginOffsetInclusive (integer) --
The offset for the start of the highlight.
endOffsetExclusive (integer) --
The offset for the end of the highlight.
excerpt (dict) --
The text of the document.
text (string) --
Text in the document.
highlights (list) --
Highlights in the document text.
(dict) --
Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.
beginOffsetInclusive (integer) --
The offset for the start of the highlight.
endOffsetExclusive (integer) --
The offset for the end of the highlight.
rankingData (dict) --
Details about the content ranking data.
relevanceScore (float) --
The relevance level of the recommendation.
relevanceLevel (string) --
The relevance score of the content.
generativeData (dict) --
Details about the generative data.
completion (string) --
The LLM response.
references (list) --
The references used to generative the LLM response.
(dict) --
Summary of the data.
rankingData (dict) --
Details about the generative content ranking data.
relevanceScore (float) --
The relevance level of the recommendation.
relevanceLevel (string) --
The relevance score of the content.
intentDetectedData (dict) --
Details about the intent data.
intent (string) --
The detected intent.
intentId (string) --
The identifier of the detected intent.
relevanceLevel (string) --
The relevance level of the detected intent.
sourceContentData (dict) --
Details about the content data.
id (string) --
The identifier of the source content.
type (string) --
The type of the source content.
textData (dict) --
Details about the source content text data.
title (dict) --
The text of the document.
text (string) --
Text in the document.
highlights (list) --
Highlights in the document text.
(dict) --
Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.
beginOffsetInclusive (integer) --
The offset for the start of the highlight.
endOffsetExclusive (integer) --
The offset for the end of the highlight.
excerpt (dict) --
The text of the document.
text (string) --
Text in the document.
highlights (list) --
Highlights in the document text.
(dict) --
Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.
beginOffsetInclusive (integer) --
The offset for the start of the highlight.
endOffsetExclusive (integer) --
The offset for the end of the highlight.
rankingData (dict) --
Details about the source content ranking data.
relevanceScore (float) --
The relevance level of the recommendation.
relevanceLevel (string) --
The relevance score of the 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.
generativeChunkData (dict) --
Details about the generative chunk data.
completion (string) --
A chunk of the LLM response.
references (list) --
The references used to generate the LLM response.
(dict) --
Summary of the data.
nextChunkToken (string) --
The token for the next set of chunks. Use the value returned in the previous response in the next request to retrieve the next set of chunks.
emailResponseChunkData (dict) --
Streaming chunk data for email response generation containing partial response content.
completion (string) --
The partial or complete professional email response text with appropriate greetings and closings.
nextChunkToken (string) --
Token for retrieving the next chunk of streaming response data, if available.
emailOverviewChunkData (dict) --
Streaming chunk data for email overview containing partial overview content.
completion (string) --
The partial or complete overview text content in structured HTML format with customer issues, resolutions, and next steps.
nextChunkToken (string) --
Token for retrieving the next chunk of streaming overview data, if available.
emailGenerativeAnswerChunkData (dict) --
Streaming chunk data for email generative answers containing partial knowledge-based response content.
completion (string) --
The partial or complete text content of the generative answer response.
references (list) --
Source references and citations from knowledge base articles used to generate the answer.
(dict) --
Summary of the data.
nextChunkToken (string) --
Token for retrieving the next chunk of streaming response data, if available.
caseSummarizationChunkData (dict) --
Details about case summarization chunk data.
completion (string) --
A chunk of the case summarization completion.
nextChunkToken (string) --
Token for retrieving the next chunk of streaming summarization data, if available.
suggestedMessageData (dict) --
Details about suggested message data.
messageText (string) --
The text content of the suggested message.
notesData (dict) --
Details about notes data.
completion (string) --
The completion data for notes.
notesChunkData (dict) --
Details about notes chunk data.
completion (string) --
A chunk of the notes completion.
nextChunkToken (string) --
The token for the next chunk of notes data.
triggers (list) --
The triggers corresponding to recommendations.
(dict) --
A recommendation trigger provides context on the event that produced the referenced recommendations. Recommendations are only referenced in recommendationIds by a single RecommendationTrigger.
id (string) --
The identifier of the recommendation trigger.
type (string) --
The type of recommendation trigger.
source (string) --
The source of the recommendation trigger.
ISSUE_DETECTION: The corresponding recommendations were triggered by a Contact Lens issue.
RULE_EVALUATION: The corresponding recommendations were triggered by a Contact Lens rule.
data (dict) --
A union type containing information related to the trigger.
query (dict) --
Data associated with the QUERY RecommendationTriggerType.
text (string) --
The text associated with the recommendation trigger.
recommendationIds (list) --
The identifiers of the recommendations.
(string) --
{'session': {'orchestratorConfigurationList': [{'aiAgentId': 'string',
'orchestratorUseCase': 'string'}]}}
Retrieves information for a specified session.
See also: AWS API Documentation
Request Syntax
client.get_session(
assistantId='string',
sessionId='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 session. Can be either the ID or the ARN. URLs cannot contain the ARN.
dict
Response Syntax
{
'session': {
'sessionArn': 'string',
'sessionId': 'string',
'name': 'string',
'description': 'string',
'tags': {
'string': 'string'
},
'integrationConfiguration': {
'topicIntegrationArn': 'string'
},
'tagFilter': {
'tagCondition': {
'key': 'string',
'value': 'string'
},
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
]
},
'aiAgentConfiguration': {
'string': {
'aiAgentId': 'string'
}
},
'origin': 'SYSTEM'|'CUSTOMER',
'orchestratorConfigurationList': [
{
'aiAgentId': 'string',
'orchestratorUseCase': 'string'
},
]
}
}
Response Structure
(dict) --
session (dict) --
The session.
sessionArn (string) --
The Amazon Resource Name (ARN) of the session.
sessionId (string) --
The identifier of the session.
name (string) --
The name of the session.
description (string) --
The description of the session.
tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
integrationConfiguration (dict) --
The configuration information for the session integration.
topicIntegrationArn (string) --
The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.
tagFilter (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.
aiAgentConfiguration (dict) --
The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session.
(string) --
(dict) --
A type that specifies the AI Agent ID configuration data when mapping an AI Agents to be used for an AI Agent type on a session or assistant.
aiAgentId (string) --
The ID of the AI Agent to be configured.
origin (string) --
The origin of the Session to be listed. SYSTEM for a default Session created by Amazon Q in Connect or CUSTOMER for a Session created by calling CreateSession API.
orchestratorConfigurationList (list) --
The list of orchestrator configurations for the session.
(dict) --
An entry in the orchestrator configuration list.
aiAgentId (string) --
The identifier of the AI Agent in the orchestrator configuration.
orchestratorUseCase (string) --
The use case for the orchestrator configuration. (for example Connect.SelfService, Connect.AgentAssistance)
{'aiAgentVersionSummaries': {'aiAgentSummary': {'configuration': {'answerRecommendationAIAgentConfiguration': {'suggestedMessages': ['string']},
'caseSummarizationAIAgentConfiguration': {'caseSummarizationAIGuardrailId': 'string',
'caseSummarizationAIPromptId': 'string',
'locale': 'string'},
'noteTakingAIAgentConfiguration': {'locale': 'string',
'noteTakingAIGuardrailId': 'string',
'noteTakingAIPromptId': 'string'},
'orchestrationAIAgentConfiguration': {'connectInstanceArn': 'string',
'locale': 'string',
'orchestrationAIGuardrailId': 'string',
'orchestrationAIPromptId': 'string',
'toolConfigurations': [{'annotations': {'destructiveHint': 'boolean',
'title': 'string'},
'description': 'string',
'inputSchema': {},
'instruction': {'examples': ['string'],
'instruction': 'string'},
'outputFilters': [{'jsonPath': 'string',
'outputConfiguration': {'outputVariableNameOverride': 'string',
'sessionDataNamespace': 'string'}}],
'outputSchema': {},
'overrideInputValues': [{'jsonPath': 'string',
'value': {'constant': {'type': 'STRING '
'| '
'NUMBER '
'| '
'JSON_STRING',
'value': 'string'}}}],
'title': 'string',
'toolId': 'string',
'toolName': 'string',
'toolType': 'MODEL_CONTEXT_PROTOCOL '
'| '
'RETURN_TO_CONTROL '
'| '
'CONSTANT',
'userInteractionConfiguration': {'isUserConfirmationRequired': 'boolean'}}]}},
'type': {'CASE_SUMMARIZATION',
'NOTE_TAKING',
'ORCHESTRATION'}}}}
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
}
},
],
'connectInstanceArn': 'string',
'locale': 'string'
},
'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.
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.
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': {'answerRecommendationAIAgentConfiguration': {'suggestedMessages': ['string']},
'caseSummarizationAIAgentConfiguration': {'caseSummarizationAIGuardrailId': 'string',
'caseSummarizationAIPromptId': 'string',
'locale': 'string'},
'noteTakingAIAgentConfiguration': {'locale': 'string',
'noteTakingAIGuardrailId': 'string',
'noteTakingAIPromptId': 'string'},
'orchestrationAIAgentConfiguration': {'connectInstanceArn': 'string',
'locale': 'string',
'orchestrationAIGuardrailId': 'string',
'orchestrationAIPromptId': 'string',
'toolConfigurations': [{'annotations': {'destructiveHint': 'boolean',
'title': 'string'},
'description': 'string',
'inputSchema': {},
'instruction': {'examples': ['string'],
'instruction': 'string'},
'outputFilters': [{'jsonPath': 'string',
'outputConfiguration': {'outputVariableNameOverride': 'string',
'sessionDataNamespace': 'string'}}],
'outputSchema': {},
'overrideInputValues': [{'jsonPath': 'string',
'value': {'constant': {'type': 'STRING '
'| '
'NUMBER '
'| '
'JSON_STRING',
'value': 'string'}}}],
'title': 'string',
'toolId': 'string',
'toolName': 'string',
'toolType': 'MODEL_CONTEXT_PROTOCOL '
'| '
'RETURN_TO_CONTROL '
'| '
'CONSTANT',
'userInteractionConfiguration': {'isUserConfirmationRequired': 'boolean'}}]}},
'type': {'CASE_SUMMARIZATION',
'NOTE_TAKING',
'ORCHESTRATION'}}}
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
}
},
],
'connectInstanceArn': 'string',
'locale': 'string'
},
'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.
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.
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.
{'aiPromptVersionSummaries': {'aiPromptSummary': {'type': {'CASE_SUMMARIZATION',
'NOTE_TAKING',
'ORCHESTRATION'}}}}
Lists AI Prompt versions.
See also: AWS API Documentation
Request Syntax
client.list_ai_prompt_versions(
assistantId='string',
aiPromptId='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 prompt 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 Prompt 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
{
'aiPromptVersionSummaries': [
{
'aiPromptSummary': {
'name': 'string',
'assistantId': 'string',
'assistantArn': 'string',
'aiPromptId': 'string',
'type': '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',
'aiPromptArn': 'string',
'modifiedTime': datetime(2015, 1, 1),
'templateType': 'TEXT',
'modelId': 'string',
'apiFormat': 'ANTHROPIC_CLAUDE_MESSAGES'|'ANTHROPIC_CLAUDE_TEXT_COMPLETIONS'|'MESSAGES'|'TEXT_COMPLETIONS',
'visibilityStatus': 'SAVED'|'PUBLISHED',
'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) --
aiPromptVersionSummaries (list) --
The summaries of the AI Prompt versions.
(dict) --
The summary of the AI Prompt version.
aiPromptSummary (dict) --
The date for the summary of the AI Prompt version.
name (string) --
The name of the AI Prompt.
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.
aiPromptId (string) --
The identifier of the Amazon Q in Connect AI prompt.
type (string) --
The type of this AI Prompt.
aiPromptArn (string) --
The Amazon Resource Name (ARN) of the AI Prompt.
modifiedTime (datetime) --
The time the AI Prompt was last modified.
templateType (string) --
The type of the prompt template for this AI Prompt.
modelId (string) --
The identifier of the model used for this AI Prompt. Model Ids supported are: anthropic.claude-3-haiku-20240307-v1:0.
apiFormat (string) --
The API format used for this AI Prompt.
visibilityStatus (string) --
The visibility status of the AI Prompt.
origin (string) --
The origin of the AI Prompt. SYSTEM for a default AI Prompt created by Q in Connect or CUSTOMER for an AI Prompt created by calling AI Prompt creation APIs.
description (string) --
The description of the AI Prompt.
status (string) --
The status of the AI Prompt.
tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
versionNumber (integer) --
The version number for this AI Prompt 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.
{'aiPromptSummaries': {'type': {'CASE_SUMMARIZATION',
'NOTE_TAKING',
'ORCHESTRATION'}}}
Lists the AI Prompts available on the Amazon Q in Connect assistant.
See also: AWS API Documentation
Request Syntax
client.list_ai_prompts(
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 Prompts 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
{
'aiPromptSummaries': [
{
'name': 'string',
'assistantId': 'string',
'assistantArn': 'string',
'aiPromptId': 'string',
'type': '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',
'aiPromptArn': 'string',
'modifiedTime': datetime(2015, 1, 1),
'templateType': 'TEXT',
'modelId': 'string',
'apiFormat': 'ANTHROPIC_CLAUDE_MESSAGES'|'ANTHROPIC_CLAUDE_TEXT_COMPLETIONS'|'MESSAGES'|'TEXT_COMPLETIONS',
'visibilityStatus': 'SAVED'|'PUBLISHED',
'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) --
aiPromptSummaries (list) --
The summaries of the AI Prompts.
(dict) --
The summary of the AI Prompt.
name (string) --
The name of the AI Prompt.
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.
aiPromptId (string) --
The identifier of the Amazon Q in Connect AI prompt.
type (string) --
The type of this AI Prompt.
aiPromptArn (string) --
The Amazon Resource Name (ARN) of the AI Prompt.
modifiedTime (datetime) --
The time the AI Prompt was last modified.
templateType (string) --
The type of the prompt template for this AI Prompt.
modelId (string) --
The identifier of the model used for this AI Prompt. Model Ids supported are: anthropic.claude-3-haiku-20240307-v1:0.
apiFormat (string) --
The API format used for this AI Prompt.
visibilityStatus (string) --
The visibility status of the AI Prompt.
origin (string) --
The origin of the AI Prompt. SYSTEM for a default AI Prompt created by Q in Connect or CUSTOMER for an AI Prompt created by calling AI Prompt creation APIs.
description (string) --
The description of the AI Prompt.
status (string) --
The status of the AI Prompt.
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.
{'assistantAssociationSummaries': {'associationData': {'externalBedrockKnowledgeBaseConfig': {'accessRoleArn': 'string',
'bedrockKnowledgeBaseArn': 'string'}},
'associationType': {'EXTERNAL_BEDROCK_KNOWLEDGE_BASE'}}}
Lists information about assistant associations.
See also: AWS API Documentation
Request Syntax
client.list_assistant_associations(
nextToken='string',
maxResults=123,
assistantId='string'
)
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
[REQUIRED]
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
dict
Response Syntax
{
'assistantAssociationSummaries': [
{
'assistantAssociationId': 'string',
'assistantAssociationArn': 'string',
'assistantId': 'string',
'assistantArn': 'string',
'associationType': 'KNOWLEDGE_BASE'|'EXTERNAL_BEDROCK_KNOWLEDGE_BASE',
'associationData': {
'knowledgeBaseAssociation': {
'knowledgeBaseId': 'string',
'knowledgeBaseArn': 'string'
},
'externalBedrockKnowledgeBaseConfig': {
'bedrockKnowledgeBaseArn': 'string',
'accessRoleArn': 'string'
}
},
'tags': {
'string': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
assistantAssociationSummaries (list) --
Summary information about assistant associations.
(dict) --
Summary information about the assistant association.
assistantAssociationId (string) --
The identifier of the assistant association.
assistantAssociationArn (string) --
The Amazon Resource Name (ARN) of the assistant association.
assistantId (string) --
The identifier of the Amazon Q in Connect assistant.
assistantArn (string) --
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
associationType (string) --
The type of association.
associationData (dict) --
The association data.
knowledgeBaseAssociation (dict) --
The knowledge base where output data is sent.
knowledgeBaseId (string) --
The identifier of the knowledge base.
knowledgeBaseArn (string) --
The Amazon Resource Name (ARN) of the knowledge base.
externalBedrockKnowledgeBaseConfig (dict) --
The configuration for an external Bedrock knowledge base association in the output data.
bedrockKnowledgeBaseArn (string) --
The Amazon Resource Name (ARN) of the external Bedrock knowledge base.
accessRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role used to access the external Bedrock knowledge base.
tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
nextToken (string) --
If there are additional results, this is the token for the next set of results.
{'assistantSummaries': {'orchestratorConfigurationList': [{'aiAgentId': 'string',
'orchestratorUseCase': 'string'}]}}
Lists information about assistants.
See also: AWS API Documentation
Request Syntax
client.list_assistants(
nextToken='string',
maxResults=123
)
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.
dict
Response Syntax
{
'assistantSummaries': [
{
'assistantId': 'string',
'assistantArn': 'string',
'name': 'string',
'type': 'AGENT',
'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED',
'description': 'string',
'tags': {
'string': 'string'
},
'serverSideEncryptionConfiguration': {
'kmsKeyId': 'string'
},
'integrationConfiguration': {
'topicIntegrationArn': 'string'
},
'capabilityConfiguration': {
'type': 'V1'|'V2'
},
'aiAgentConfiguration': {
'string': {
'aiAgentId': 'string'
}
},
'orchestratorConfigurationList': [
{
'aiAgentId': 'string',
'orchestratorUseCase': 'string'
},
]
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
assistantSummaries (list) --
Information about the assistants.
(dict) --
Summary information about the assistant.
assistantId (string) --
The identifier of the Amazon Q in Connect assistant.
assistantArn (string) --
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
name (string) --
The name of the assistant.
type (string) --
The type of the assistant.
status (string) --
The status of the assistant.
description (string) --
The description of the assistant.
tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
serverSideEncryptionConfiguration (dict) --
The configuration information for the customer managed key used for encryption.
This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey permissions to the connect.amazonaws.com service principal.
For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.
kmsKeyId (string) --
The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. For information about valid ID values, see Key identifiers (KeyId).
integrationConfiguration (dict) --
The configuration information for the Amazon Q in Connect assistant integration.
topicIntegrationArn (string) --
The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.
capabilityConfiguration (dict) --
The configuration information for the Amazon Q in Connect assistant capability.
type (string) --
The type of Amazon Q in Connect assistant capability.
aiAgentConfiguration (dict) --
The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that is set on the Amazon Q in Connect Assistant.
(string) --
(dict) --
A type that specifies the AI Agent ID configuration data when mapping an AI Agents to be used for an AI Agent type on a session or assistant.
aiAgentId (string) --
The ID of the AI Agent to be configured.
orchestratorConfigurationList (list) --
The list of orchestrator configurations for the assistant.
(dict) --
An entry in the orchestrator configuration list.
aiAgentId (string) --
The identifier of the AI Agent in the orchestrator configuration.
orchestratorUseCase (string) --
The use case for the orchestrator configuration. (for example Connect.SelfService, Connect.AgentAssistance)
nextToken (string) --
If there are additional results, this is the token for the next set of results.
{'filter': 'ALL | TEXT_ONLY'}
Response {'messages': {'value': {'text': {'aiGuardrailAssessment': {'blocked': 'boolean'},
'citations': [{'citationSpan': {'beginOffsetInclusive': 'integer',
'endOffsetExclusive': 'integer'},
'contentId': 'string',
'knowledgeBaseId': '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',
'sourceURL': 'string',
'title': 'string'}]},
'toolUseResult': {'inputSchema': {},
'toolName': 'string',
'toolResult': {},
'toolUseId': 'string'}}}}
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
}
},
'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.
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.
{'queryInputData': {'caseSummarizationInputData': {'caseArn': 'string'}}}
Response {'results': {'data': {'details': {'caseSummarizationChunkData': {'completion': 'string',
'nextChunkToken': 'string'},
'intentDetectedData': {'relevanceLevel': 'HIGH '
'| '
'MEDIUM '
'| '
'LOW'},
'notesChunkData': {'completion': 'string',
'nextChunkToken': 'string'},
'notesData': {'completion': 'string'},
'suggestedMessageData': {'messageText': 'string'}},
'reference': {'contentReference': {'referenceType': {'BEDROCK_KB_CONFLUENCE',
'BEDROCK_KB_CUSTOM_DOCUMENT',
'BEDROCK_KB_KENDRA',
'BEDROCK_KB_S3',
'BEDROCK_KB_SALESFORCE',
'BEDROCK_KB_SHAREPOINT',
'BEDROCK_KB_SQL',
'BEDROCK_KB_WEB'}},
'suggestedMessageReference': {'aiAgentArn': 'string',
'aiAgentId': 'string'}}},
'document': {'contentReference': {'referenceType': {'BEDROCK_KB_CONFLUENCE',
'BEDROCK_KB_CUSTOM_DOCUMENT',
'BEDROCK_KB_KENDRA',
'BEDROCK_KB_S3',
'BEDROCK_KB_SALESFORCE',
'BEDROCK_KB_SHAREPOINT',
'BEDROCK_KB_SQL',
'BEDROCK_KB_WEB'}}},
'type': {'BLOCKED_CASE_SUMMARIZATION_CHUNK',
'BLOCKED_NOTES_CHUNK',
'CASE_SUMMARIZATION_CHUNK',
'NOTES',
'NOTES_CHUNK'}}}
Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations.
See also: AWS API Documentation
Request Syntax
client.query_assistant(
assistantId='string',
queryText='string',
nextToken='string',
maxResults=123,
sessionId='string',
queryCondition=[
{
'single': {
'field': 'RESULT_TYPE',
'comparator': 'EQUALS',
'value': 'string'
}
},
],
queryInputData={
'queryTextInputData': {
'text': 'string'
},
'intentInputData': {
'intentId': 'string'
},
'caseSummarizationInputData': {
'caseArn': 'string'
}
},
overrideKnowledgeBaseSearchType='HYBRID'|'SEMANTIC'
)
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 text to search for.
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 identifier of the Amazon Q in Connect session. Can be either the ID or the ARN. URLs cannot contain the ARN.
list
Information about how to query content.
(dict) --
Information about how to query content.
single (dict) --
The condition for the query.
field (string) -- [REQUIRED]
The name of the field for query condition to query on.
comparator (string) -- [REQUIRED]
The comparison operator for query condition to query on.
value (string) -- [REQUIRED]
The value for the query condition to query on.
dict
Information about the query.
queryTextInputData (dict) --
Input information for the query.
text (string) -- [REQUIRED]
The text to search for.
intentInputData (dict) --
Input information for the intent.
intentId (string) -- [REQUIRED]
The identifier of the Amazon Q intent.
caseSummarizationInputData (dict) --
Input data for case summarization queries.
caseArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the case for summarization.
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.
dict
Response Syntax
{
'results': [
{
'resultId': 'string',
'document': {
'contentReference': {
'knowledgeBaseArn': 'string',
'knowledgeBaseId': 'string',
'contentArn': 'string',
'contentId': 'string',
'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'
},
'title': {
'text': 'string',
'highlights': [
{
'beginOffsetInclusive': 123,
'endOffsetExclusive': 123
},
]
},
'excerpt': {
'text': 'string',
'highlights': [
{
'beginOffsetInclusive': 123,
'endOffsetExclusive': 123
},
]
}
},
'relevanceScore': 123.0,
'data': {
'reference': {
'contentReference': {
'knowledgeBaseArn': 'string',
'knowledgeBaseId': 'string',
'contentArn': 'string',
'contentId': 'string',
'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'
},
'generativeReference': {
'modelId': 'string',
'generationId': 'string'
},
'suggestedMessageReference': {
'aiAgentId': 'string',
'aiAgentArn': 'string'
}
},
'details': {
'contentData': {
'textData': {
'title': {
'text': 'string',
'highlights': [
{
'beginOffsetInclusive': 123,
'endOffsetExclusive': 123
},
]
},
'excerpt': {
'text': 'string',
'highlights': [
{
'beginOffsetInclusive': 123,
'endOffsetExclusive': 123
},
]
}
},
'rankingData': {
'relevanceScore': 123.0,
'relevanceLevel': 'HIGH'|'MEDIUM'|'LOW'
}
},
'generativeData': {
'completion': 'string',
'references': [
{'... recursive ...'},
],
'rankingData': {
'relevanceScore': 123.0,
'relevanceLevel': 'HIGH'|'MEDIUM'|'LOW'
}
},
'intentDetectedData': {
'intent': 'string',
'intentId': 'string',
'relevanceLevel': 'HIGH'|'MEDIUM'|'LOW'
},
'sourceContentData': {
'id': 'string',
'type': 'KNOWLEDGE_CONTENT',
'textData': {
'title': {
'text': 'string',
'highlights': [
{
'beginOffsetInclusive': 123,
'endOffsetExclusive': 123
},
]
},
'excerpt': {
'text': 'string',
'highlights': [
{
'beginOffsetInclusive': 123,
'endOffsetExclusive': 123
},
]
}
},
'rankingData': {
'relevanceScore': 123.0,
'relevanceLevel': 'HIGH'|'MEDIUM'|'LOW'
},
'citationSpan': {
'beginOffsetInclusive': 123,
'endOffsetExclusive': 123
}
},
'generativeChunkData': {
'completion': 'string',
'references': [
{'... recursive ...'},
],
'nextChunkToken': 'string'
},
'emailResponseChunkData': {
'completion': 'string',
'nextChunkToken': 'string'
},
'emailOverviewChunkData': {
'completion': 'string',
'nextChunkToken': 'string'
},
'emailGenerativeAnswerChunkData': {
'completion': 'string',
'references': [
{'... recursive ...'},
],
'nextChunkToken': 'string'
},
'caseSummarizationChunkData': {
'completion': 'string',
'nextChunkToken': 'string'
},
'suggestedMessageData': {
'messageText': 'string'
},
'notesData': {
'completion': 'string'
},
'notesChunkData': {
'completion': 'string',
'nextChunkToken': 'string'
}
}
},
'type': 'KNOWLEDGE_CONTENT'|'INTENT_ANSWER'|'GENERATIVE_ANSWER'|'GENERATIVE_ANSWER_CHUNK'|'BLOCKED_GENERATIVE_ANSWER_CHUNK'|'INTENT_ANSWER_CHUNK'|'BLOCKED_INTENT_ANSWER_CHUNK'|'EMAIL_RESPONSE_CHUNK'|'EMAIL_OVERVIEW_CHUNK'|'EMAIL_GENERATIVE_ANSWER_CHUNK'|'CASE_SUMMARIZATION_CHUNK'|'BLOCKED_CASE_SUMMARIZATION_CHUNK'|'NOTES'|'NOTES_CHUNK'|'BLOCKED_NOTES_CHUNK'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
results (list) --
The results of the query.
(dict) --
Information about the result.
resultId (string) --
The identifier of the result data.
document (dict) --
The document.
contentReference (dict) --
A reference to the content resource.
knowledgeBaseArn (string) --
The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseId (string) --
The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.
contentArn (string) --
The Amazon Resource Name (ARN) of the content.
contentId (string) --
The identifier of the content.
sourceURL (string) --
The web URL of the source content.
referenceType (string) --
The type of reference content.
title (dict) --
The title of the document.
text (string) --
Text in the document.
highlights (list) --
Highlights in the document text.
(dict) --
Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.
beginOffsetInclusive (integer) --
The offset for the start of the highlight.
endOffsetExclusive (integer) --
The offset for the end of the highlight.
excerpt (dict) --
The excerpt from the document.
text (string) --
Text in the document.
highlights (list) --
Highlights in the document text.
(dict) --
Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.
beginOffsetInclusive (integer) --
The offset for the start of the highlight.
endOffsetExclusive (integer) --
The offset for the end of the highlight.
relevanceScore (float) --
The relevance score of the results.
data (dict) --
Summary of the recommended content.
reference (dict) --
Reference information about the content.
contentReference (dict) --
Reference information about the content.
knowledgeBaseArn (string) --
The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseId (string) --
The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.
contentArn (string) --
The Amazon Resource Name (ARN) of the content.
contentId (string) --
The identifier of the content.
sourceURL (string) --
The web URL of the source content.
referenceType (string) --
The type of reference content.
generativeReference (dict) --
Reference information about the generative content.
modelId (string) --
The identifier of the LLM model.
generationId (string) --
The identifier of the LLM model.
suggestedMessageReference (dict) --
Reference information for suggested messages.
aiAgentId (string) --
The identifier of the AI Agent that generated the suggested message.
aiAgentArn (string) --
The Amazon Resource Name (ARN) of the AI Agent that generated the suggested message.
details (dict) --
Details about the data.
contentData (dict) --
Details about the content data.
textData (dict) --
Details about the content text data.
title (dict) --
The text of the document.
text (string) --
Text in the document.
highlights (list) --
Highlights in the document text.
(dict) --
Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.
beginOffsetInclusive (integer) --
The offset for the start of the highlight.
endOffsetExclusive (integer) --
The offset for the end of the highlight.
excerpt (dict) --
The text of the document.
text (string) --
Text in the document.
highlights (list) --
Highlights in the document text.
(dict) --
Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.
beginOffsetInclusive (integer) --
The offset for the start of the highlight.
endOffsetExclusive (integer) --
The offset for the end of the highlight.
rankingData (dict) --
Details about the content ranking data.
relevanceScore (float) --
The relevance level of the recommendation.
relevanceLevel (string) --
The relevance score of the content.
generativeData (dict) --
Details about the generative data.
completion (string) --
The LLM response.
references (list) --
The references used to generative the LLM response.
(dict) --
Summary of the data.
rankingData (dict) --
Details about the generative content ranking data.
relevanceScore (float) --
The relevance level of the recommendation.
relevanceLevel (string) --
The relevance score of the content.
intentDetectedData (dict) --
Details about the intent data.
intent (string) --
The detected intent.
intentId (string) --
The identifier of the detected intent.
relevanceLevel (string) --
The relevance level of the detected intent.
sourceContentData (dict) --
Details about the content data.
id (string) --
The identifier of the source content.
type (string) --
The type of the source content.
textData (dict) --
Details about the source content text data.
title (dict) --
The text of the document.
text (string) --
Text in the document.
highlights (list) --
Highlights in the document text.
(dict) --
Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.
beginOffsetInclusive (integer) --
The offset for the start of the highlight.
endOffsetExclusive (integer) --
The offset for the end of the highlight.
excerpt (dict) --
The text of the document.
text (string) --
Text in the document.
highlights (list) --
Highlights in the document text.
(dict) --
Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.
beginOffsetInclusive (integer) --
The offset for the start of the highlight.
endOffsetExclusive (integer) --
The offset for the end of the highlight.
rankingData (dict) --
Details about the source content ranking data.
relevanceScore (float) --
The relevance level of the recommendation.
relevanceLevel (string) --
The relevance score of the 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.
generativeChunkData (dict) --
Details about the generative chunk data.
completion (string) --
A chunk of the LLM response.
references (list) --
The references used to generate the LLM response.
(dict) --
Summary of the data.
nextChunkToken (string) --
The token for the next set of chunks. Use the value returned in the previous response in the next request to retrieve the next set of chunks.
emailResponseChunkData (dict) --
Streaming chunk data for email response generation containing partial response content.
completion (string) --
The partial or complete professional email response text with appropriate greetings and closings.
nextChunkToken (string) --
Token for retrieving the next chunk of streaming response data, if available.
emailOverviewChunkData (dict) --
Streaming chunk data for email overview containing partial overview content.
completion (string) --
The partial or complete overview text content in structured HTML format with customer issues, resolutions, and next steps.
nextChunkToken (string) --
Token for retrieving the next chunk of streaming overview data, if available.
emailGenerativeAnswerChunkData (dict) --
Streaming chunk data for email generative answers containing partial knowledge-based response content.
completion (string) --
The partial or complete text content of the generative answer response.
references (list) --
Source references and citations from knowledge base articles used to generate the answer.
(dict) --
Summary of the data.
nextChunkToken (string) --
Token for retrieving the next chunk of streaming response data, if available.
caseSummarizationChunkData (dict) --
Details about case summarization chunk data.
completion (string) --
A chunk of the case summarization completion.
nextChunkToken (string) --
Token for retrieving the next chunk of streaming summarization data, if available.
suggestedMessageData (dict) --
Details about suggested message data.
messageText (string) --
The text content of the suggested message.
notesData (dict) --
Details about notes data.
completion (string) --
The completion data for notes.
notesChunkData (dict) --
Details about notes chunk data.
completion (string) --
A chunk of the notes completion.
nextChunkToken (string) --
The token for the next chunk of notes data.
type (string) --
The type of the query result.
nextToken (string) --
If there are additional results, this is the token for the next set of results.
{'aiAgentType': {'CASE_SUMMARIZATION', 'ORCHESTRATION', 'NOTE_TAKING'},
'orchestratorUseCase': 'string'}
Removes the AI Agent that is set for use by default on an Amazon Q in Connect Assistant.
See also: AWS API Documentation
Request Syntax
client.remove_assistant_ai_agent(
assistantId='string',
aiAgentType='MANUAL_SEARCH'|'ANSWER_RECOMMENDATION'|'SELF_SERVICE'|'EMAIL_RESPONSE'|'EMAIL_OVERVIEW'|'EMAIL_GENERATIVE_ANSWER'|'ORCHESTRATION'|'NOTE_TAKING'|'CASE_SUMMARIZATION',
orchestratorUseCase='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 type of the AI Agent being removed for use by default from the Amazon Q in Connect Assistant.
string
The orchestrator use case for the AI Agent being removed.
dict
Response Syntax
{}
Response Structure
(dict) --
{'aiAgentId': 'string',
'configuration': {'generateChunkedMessage': 'boolean'},
'conversationContext': {'selfServiceConversationHistory': {'timestamp': 'timestamp'}},
'message': {'value': {'text': {'aiGuardrailAssessment': {'blocked': 'boolean'},
'citations': [{'citationSpan': {'beginOffsetInclusive': 'integer',
'endOffsetExclusive': 'integer'},
'contentId': 'string',
'knowledgeBaseId': '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',
'sourceURL': 'string',
'title': 'string'}]},
'toolUseResult': {'inputSchema': {},
'toolName': 'string',
'toolResult': {},
'toolUseId': 'string'}}},
'metadata': {'string': 'string'},
'orchestratorUseCase': 'string'}
Response {'configuration': {'generateChunkedMessage': 'boolean'}}
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',
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
}
}
},
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'
}
)
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.
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) --
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': {'answerRecommendationAIAgentConfiguration': {'suggestedMessages': ['string']},
'caseSummarizationAIAgentConfiguration': {'caseSummarizationAIGuardrailId': 'string',
'caseSummarizationAIPromptId': 'string',
'locale': 'string'},
'noteTakingAIAgentConfiguration': {'locale': 'string',
'noteTakingAIGuardrailId': 'string',
'noteTakingAIPromptId': 'string'},
'orchestrationAIAgentConfiguration': {'connectInstanceArn': 'string',
'locale': 'string',
'orchestrationAIGuardrailId': 'string',
'orchestrationAIPromptId': 'string',
'toolConfigurations': [{'annotations': {'destructiveHint': 'boolean',
'title': 'string'},
'description': 'string',
'inputSchema': {},
'instruction': {'examples': ['string'],
'instruction': 'string'},
'outputFilters': [{'jsonPath': 'string',
'outputConfiguration': {'outputVariableNameOverride': 'string',
'sessionDataNamespace': 'string'}}],
'outputSchema': {},
'overrideInputValues': [{'jsonPath': 'string',
'value': {'constant': {'type': 'STRING '
'| '
'NUMBER '
'| '
'JSON_STRING',
'value': 'string'}}}],
'title': 'string',
'toolId': 'string',
'toolName': 'string',
'toolType': 'MODEL_CONTEXT_PROTOCOL '
'| '
'RETURN_TO_CONTROL '
'| '
'CONSTANT',
'userInteractionConfiguration': {'isUserConfirmationRequired': 'boolean'}}]}}}
Response {'aiAgent': {'configuration': {'answerRecommendationAIAgentConfiguration': {'suggestedMessages': ['string']},
'caseSummarizationAIAgentConfiguration': {'caseSummarizationAIGuardrailId': 'string',
'caseSummarizationAIPromptId': 'string',
'locale': 'string'},
'noteTakingAIAgentConfiguration': {'locale': 'string',
'noteTakingAIGuardrailId': 'string',
'noteTakingAIPromptId': 'string'},
'orchestrationAIAgentConfiguration': {'connectInstanceArn': 'string',
'locale': 'string',
'orchestrationAIGuardrailId': 'string',
'orchestrationAIPromptId': 'string',
'toolConfigurations': [{'annotations': {'destructiveHint': 'boolean',
'title': 'string'},
'description': 'string',
'inputSchema': {},
'instruction': {'examples': ['string'],
'instruction': 'string'},
'outputFilters': [{'jsonPath': 'string',
'outputConfiguration': {'outputVariableNameOverride': 'string',
'sessionDataNamespace': 'string'}}],
'outputSchema': {},
'overrideInputValues': [{'jsonPath': 'string',
'value': {'constant': {'type': 'STRING '
'| '
'NUMBER '
'| '
'JSON_STRING',
'value': 'string'}}}],
'title': 'string',
'toolId': 'string',
'toolName': 'string',
'toolType': 'MODEL_CONTEXT_PROTOCOL '
'| '
'RETURN_TO_CONTROL '
'| '
'CONSTANT',
'userInteractionConfiguration': {'isUserConfirmationRequired': 'boolean'}}]}},
'type': {'CASE_SUMMARIZATION', 'ORCHESTRATION', 'NOTE_TAKING'}}}
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
}
},
],
'connectInstanceArn': 'string',
'locale': 'string'
},
'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) -- [REQUIRED]
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.
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.
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
}
},
],
'connectInstanceArn': 'string',
'locale': 'string'
},
'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.
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.
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.
{'inferenceConfiguration': {'textAIPromptInferenceConfiguration': {'maxTokensToSample': 'integer',
'temperature': 'float',
'topK': 'integer',
'topP': 'float'}}}
Response {'aiPrompt': {'inferenceConfiguration': {'textAIPromptInferenceConfiguration': {'maxTokensToSample': 'integer',
'temperature': 'float',
'topK': 'integer',
'topP': 'float'}},
'type': {'CASE_SUMMARIZATION', 'ORCHESTRATION', 'NOTE_TAKING'}}}
Updates an AI Prompt.
See also: AWS API Documentation
Request Syntax
client.update_ai_prompt(
clientToken='string',
assistantId='string',
aiPromptId='string',
visibilityStatus='SAVED'|'PUBLISHED',
templateConfiguration={
'textFullAIPromptEditTemplateConfiguration': {
'text': 'string'
}
},
description='string',
modelId='string',
inferenceConfiguration={
'textAIPromptInferenceConfiguration': {
'temperature': ...,
'topP': ...,
'topK': 123,
'maxTokensToSample': 123
}
}
)
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 Prompt.
string
[REQUIRED]
The visibility status of the Amazon Q in Connect AI prompt.
dict
The configuration of the prompt template for this AI Prompt.
textFullAIPromptEditTemplateConfiguration (dict) --
The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt.
text (string) -- [REQUIRED]
The YAML text for the AI Prompt template.
string
The description of the Amazon Q in Connect AI Prompt.
string
The identifier of the model used for this AI Prompt.
dict
The updated inference configuration for the AI Prompt.
textAIPromptInferenceConfiguration (dict) --
The inference configuration for text-based AI Prompts.
temperature (float) --
The temperature setting for controlling randomness in the generated response.
topP (float) --
The top-P sampling parameter for nucleus sampling.
topK (integer) --
The top-K sampling parameter for token selection.
maxTokensToSample (integer) --
The maximum number of tokens to generate in the response.
dict
Response Syntax
{
'aiPrompt': {
'assistantId': 'string',
'assistantArn': 'string',
'aiPromptId': 'string',
'aiPromptArn': 'string',
'name': 'string',
'type': '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',
'templateType': 'TEXT',
'modelId': 'string',
'apiFormat': 'ANTHROPIC_CLAUDE_MESSAGES'|'ANTHROPIC_CLAUDE_TEXT_COMPLETIONS'|'MESSAGES'|'TEXT_COMPLETIONS',
'templateConfiguration': {
'textFullAIPromptEditTemplateConfiguration': {
'text': 'string'
}
},
'inferenceConfiguration': {
'textAIPromptInferenceConfiguration': {
'temperature': ...,
'topP': ...,
'topK': 123,
'maxTokensToSample': 123
}
},
'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) --
aiPrompt (dict) --
The data of the updated Amazon Q in Connect AI Prompt.
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.
aiPromptId (string) --
The identifier of the Amazon Q in Connect AI prompt.
aiPromptArn (string) --
The Amazon Resource Name (ARN) of the AI Prompt.
name (string) --
The name of the AI Prompt
type (string) --
The type of this AI Prompt.
templateType (string) --
The type of the prompt template for this AI Prompt.
modelId (string) --
The identifier of the model used for this AI Prompt. The following model Ids are supported:
anthropic.claude-3-haiku--v1:0
apac.amazon.nova-lite-v1:0
apac.amazon.nova-micro-v1:0
apac.amazon.nova-pro-v1:0
apac.anthropic.claude-3-5-sonnet--v2:0
apac.anthropic.claude-3-haiku-20240307-v1:0
eu.amazon.nova-lite-v1:0
eu.amazon.nova-micro-v1:0
eu.amazon.nova-pro-v1:0
eu.anthropic.claude-3-7-sonnet-20250219-v1:0
eu.anthropic.claude-3-haiku-20240307-v1:0
us.amazon.nova-lite-v1:0
us.amazon.nova-micro-v1:0
us.amazon.nova-pro-v1:0
us.anthropic.claude-3-5-haiku-20241022-v1:0
us.anthropic.claude-3-7-sonnet-20250219-v1:0
us.anthropic.claude-3-haiku-20240307-v1:0
apiFormat (string) --
The API format used for this AI Prompt.
templateConfiguration (dict) --
The configuration of the prompt template for this AI Prompt.
textFullAIPromptEditTemplateConfiguration (dict) --
The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt.
text (string) --
The YAML text for the AI Prompt template.
inferenceConfiguration (dict) --
The configuration for inference parameters when using the AI Prompt.
textAIPromptInferenceConfiguration (dict) --
The inference configuration for text-based AI Prompts.
temperature (float) --
The temperature setting for controlling randomness in the generated response.
topP (float) --
The top-P sampling parameter for nucleus sampling.
topK (integer) --
The top-K sampling parameter for token selection.
maxTokensToSample (integer) --
The maximum number of tokens to generate in the response.
modifiedTime (datetime) --
The time the AI Prompt was last modified.
description (string) --
The description of the AI Prompt.
visibilityStatus (string) --
The visibility status of the AI Prompt.
tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
origin (string) --
The origin of the AI Prompt. SYSTEM for a default AI Prompt created by Q in Connect or CUSTOMER for an AI Prompt created by calling AI Prompt creation APIs.
status (string) --
The status of the AI Prompt.
{'aiAgentType': {'CASE_SUMMARIZATION', 'ORCHESTRATION', 'NOTE_TAKING'},
'orchestratorConfigurationList': [{'aiAgentId': 'string',
'orchestratorUseCase': 'string'}]}
Response {'assistant': {'orchestratorConfigurationList': [{'aiAgentId': 'string',
'orchestratorUseCase': 'string'}]}}
Updates the AI Agent that is set for use by default on an Amazon Q in Connect Assistant.
See also: AWS API Documentation
Request Syntax
client.update_assistant_ai_agent(
assistantId='string',
aiAgentType='MANUAL_SEARCH'|'ANSWER_RECOMMENDATION'|'SELF_SERVICE'|'EMAIL_RESPONSE'|'EMAIL_OVERVIEW'|'EMAIL_GENERATIVE_ANSWER'|'ORCHESTRATION'|'NOTE_TAKING'|'CASE_SUMMARIZATION',
configuration={
'aiAgentId': 'string'
},
orchestratorConfigurationList=[
{
'aiAgentId': 'string',
'orchestratorUseCase': '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 type of the AI Agent being updated for use by default on the Amazon Q in Connect Assistant.
dict
[REQUIRED]
The configuration of the AI Agent being updated for use by default on the Amazon Q in Connect Assistant.
aiAgentId (string) -- [REQUIRED]
The ID of the AI Agent to be configured.
list
The updated list of orchestrator configurations for the assistant AI Agent.
(dict) --
An entry in the orchestrator configuration list.
aiAgentId (string) --
The identifier of the AI Agent in the orchestrator configuration.
orchestratorUseCase (string) -- [REQUIRED]
The use case for the orchestrator configuration. (for example Connect.SelfService, Connect.AgentAssistance)
dict
Response Syntax
{
'assistant': {
'assistantId': 'string',
'assistantArn': 'string',
'name': 'string',
'type': 'AGENT',
'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED',
'description': 'string',
'tags': {
'string': 'string'
},
'serverSideEncryptionConfiguration': {
'kmsKeyId': 'string'
},
'integrationConfiguration': {
'topicIntegrationArn': 'string'
},
'capabilityConfiguration': {
'type': 'V1'|'V2'
},
'aiAgentConfiguration': {
'string': {
'aiAgentId': 'string'
}
},
'orchestratorConfigurationList': [
{
'aiAgentId': 'string',
'orchestratorUseCase': 'string'
},
]
}
}
Response Structure
(dict) --
assistant (dict) --
The assistant data.
assistantId (string) --
The identifier of the Amazon Q in Connect assistant.
assistantArn (string) --
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
name (string) --
The name.
type (string) --
The type of assistant.
status (string) --
The status of the assistant.
description (string) --
The description.
tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
serverSideEncryptionConfiguration (dict) --
The configuration information for the customer managed key used for encryption.
This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey permissions to the connect.amazonaws.com service principal.
For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.
kmsKeyId (string) --
The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. For information about valid ID values, see Key identifiers (KeyId).
integrationConfiguration (dict) --
The configuration information for the Amazon Q in Connect assistant integration.
topicIntegrationArn (string) --
The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.
capabilityConfiguration (dict) --
The configuration information for the Amazon Q in Connect assistant capability.
type (string) --
The type of Amazon Q in Connect assistant capability.
aiAgentConfiguration (dict) --
The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that is set on the Amazon Q in Connect Assistant.
(string) --
(dict) --
A type that specifies the AI Agent ID configuration data when mapping an AI Agents to be used for an AI Agent type on a session or assistant.
aiAgentId (string) --
The ID of the AI Agent to be configured.
orchestratorConfigurationList (list) --
The list of orchestrator configurations for the assistant.
(dict) --
An entry in the orchestrator configuration list.
aiAgentId (string) --
The identifier of the AI Agent in the orchestrator configuration.
orchestratorUseCase (string) --
The use case for the orchestrator configuration. (for example Connect.SelfService, Connect.AgentAssistance)
{'orchestratorConfigurationList': [{'aiAgentId': 'string',
'orchestratorUseCase': 'string'}],
'removeOrchestratorConfigurationList': 'boolean'}
Response {'session': {'orchestratorConfigurationList': [{'aiAgentId': 'string',
'orchestratorUseCase': 'string'}]}}
Updates a session. A session is a contextual container used for generating recommendations. Amazon Connect updates the existing Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.
See also: AWS API Documentation
Request Syntax
client.update_session(
assistantId='string',
sessionId='string',
description='string',
tagFilter={
'tagCondition': {
'key': 'string',
'value': 'string'
},
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
]
},
aiAgentConfiguration={
'string': {
'aiAgentId': 'string'
}
},
orchestratorConfigurationList=[
{
'aiAgentId': 'string',
'orchestratorUseCase': 'string'
},
],
removeOrchestratorConfigurationList=True|False
)
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 session. Can be either the ID or the ARN. URLs cannot contain the ARN.
string
The description.
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.
dict
The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session.
(string) --
(dict) --
A type that specifies the AI Agent ID configuration data when mapping an AI Agents to be used for an AI Agent type on a session or assistant.
aiAgentId (string) -- [REQUIRED]
The ID of the AI Agent to be configured.
list
The updated list of orchestrator configurations for the session.
(dict) --
An entry in the orchestrator configuration list.
aiAgentId (string) --
The identifier of the AI Agent in the orchestrator configuration.
orchestratorUseCase (string) -- [REQUIRED]
The use case for the orchestrator configuration. (for example Connect.SelfService, Connect.AgentAssistance)
boolean
The list of orchestrator configurations to remove from the session.
dict
Response Syntax
{
'session': {
'sessionArn': 'string',
'sessionId': 'string',
'name': 'string',
'description': 'string',
'tags': {
'string': 'string'
},
'integrationConfiguration': {
'topicIntegrationArn': 'string'
},
'tagFilter': {
'tagCondition': {
'key': 'string',
'value': 'string'
},
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
]
},
'aiAgentConfiguration': {
'string': {
'aiAgentId': 'string'
}
},
'origin': 'SYSTEM'|'CUSTOMER',
'orchestratorConfigurationList': [
{
'aiAgentId': 'string',
'orchestratorUseCase': 'string'
},
]
}
}
Response Structure
(dict) --
session (dict) --
Information about the session.
sessionArn (string) --
The Amazon Resource Name (ARN) of the session.
sessionId (string) --
The identifier of the session.
name (string) --
The name of the session.
description (string) --
The description of the session.
tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
integrationConfiguration (dict) --
The configuration information for the session integration.
topicIntegrationArn (string) --
The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.
tagFilter (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.
aiAgentConfiguration (dict) --
The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session.
(string) --
(dict) --
A type that specifies the AI Agent ID configuration data when mapping an AI Agents to be used for an AI Agent type on a session or assistant.
aiAgentId (string) --
The ID of the AI Agent to be configured.
origin (string) --
The origin of the Session to be listed. SYSTEM for a default Session created by Amazon Q in Connect or CUSTOMER for a Session created by calling CreateSession API.
orchestratorConfigurationList (list) --
The list of orchestrator configurations for the session.
(dict) --
An entry in the orchestrator configuration list.
aiAgentId (string) --
The identifier of the AI Agent in the orchestrator configuration.
orchestratorUseCase (string) --
The use case for the orchestrator configuration. (for example Connect.SelfService, Connect.AgentAssistance)