2026/09/25 - Amazon Q Connect - 10 updated api methods
Changes Release shapes for the proactive agentic recommendations and the multi-knowledge base search features. Increases the maximum length of QuickResponseContent.
{'assistant': {'aiAgentConfiguration': {'enabled': 'boolean'}}}
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',
'enabled': True|False
}
},
'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.
enabled (boolean) --
Indicates whether the AI Agent configured for this AI Agent type is enabled. When this value is omitted or set to true, the configured AI Agent runs; when set to false, the AI Agent ID is retained but no AI Agent runs for the AI Agent type. Setting this value to false is currently supported only for the ANSWER_RECOMMENDATION AI Agent type; other requests to set it to false are rejected with a validation error.
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)
{'aiAgentConfiguration': {'enabled': 'boolean'}}
Response {'session': {'aiAgentConfiguration': {'enabled': 'boolean'}}}
Creates a session. A session is a contextual container used for generating recommendations. Connect Customer 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',
'enabled': True|False
}
},
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.
enabled (boolean) --
Indicates whether the AI Agent configured for this AI Agent type is enabled. When this value is omitted or set to true, the configured AI Agent runs; when set to false, the AI Agent ID is retained but no AI Agent runs for the AI Agent type. Setting this value to false is currently supported only for the ANSWER_RECOMMENDATION AI Agent type; other requests to set it to false are rejected with a validation error.
string
The Amazon Resource Name (ARN) of the email contact in Connect Customer. 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',
'enabled': True|False
}
},
'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.
enabled (boolean) --
Indicates whether the AI Agent configured for this AI Agent type is enabled. When this value is omitted or set to true, the configured AI Agent runs; when set to false, the AI Agent ID is retained but no AI Agent runs for the AI Agent type. Setting this value to false is currently supported only for the ANSWER_RECOMMENDATION AI Agent type; other requests to set it to false are rejected with a validation error.
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)
{'assistant': {'aiAgentConfiguration': {'enabled': 'boolean'}}}
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',
'enabled': True|False
}
},
'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.
enabled (boolean) --
Indicates whether the AI Agent configured for this AI Agent type is enabled. When this value is omitted or set to true, the configured AI Agent runs; when set to false, the AI Agent ID is retained but no AI Agent runs for the AI Agent type. Setting this value to false is currently supported only for the ANSWER_RECOMMENDATION AI Agent type; other requests to set it to false are rejected with a validation error.
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)
{'recommendationType': {'PROACTIVE_RECOMMENDATION'}}
Response {'recommendations': {'data': {'details': {'proactiveRecommendationData': {'nextMessageToken': 'string'}}},
'type': {'PROACTIVE_RECOMMENDATION'}}}
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'|'PROACTIVE_RECOMMENDATION'
)
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'|'PROACTIVE_RECOMMENDATION',
'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'
},
'proactiveRecommendationData': {
'nextMessageToken': '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.
proactiveRecommendationData (dict) --
Details about a proactive recommendation, including the token used to retrieve its chunked response with GetNextMessage.
nextMessageToken (string) --
The token used to retrieve the next message in the proactive recommendation. Pass this token in a GetNextMessage request to continue receiving the chunked proactive response. Each response returns the next token to use until the chunked response is complete.
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': {'aiAgentConfiguration': {'enabled': 'boolean'}}}
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',
'enabled': True|False
}
},
'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.
enabled (boolean) --
Indicates whether the AI Agent configured for this AI Agent type is enabled. When this value is omitted or set to true, the configured AI Agent runs; when set to false, the AI Agent ID is retained but no AI Agent runs for the AI Agent type. Setting this value to false is currently supported only for the ANSWER_RECOMMENDATION AI Agent type; other requests to set it to false are rejected with a validation error.
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)
{'assistantSummaries': {'aiAgentConfiguration': {'enabled': 'boolean'}}}
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',
'enabled': True|False
}
},
'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.
enabled (boolean) --
Indicates whether the AI Agent configured for this AI Agent type is enabled. When this value is omitted or set to true, the configured AI Agent runs; when set to false, the AI Agent ID is retained but no AI Agent runs for the AI Agent type. Setting this value to false is currently supported only for the ANSWER_RECOMMENDATION AI Agent type; other requests to set it to false are rejected with a validation error.
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.
{'results': {'data': {'details': {'proactiveRecommendationData': {'nextMessageToken': 'string'}}}}}
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'
},
'proactiveRecommendationData': {
'nextMessageToken': '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.
proactiveRecommendationData (dict) --
Details about a proactive recommendation, including the token used to retrieve its chunked response with GetNextMessage.
nextMessageToken (string) --
The token used to retrieve the next message in the proactive recommendation. Pass this token in a GetNextMessage request to continue receiving the chunked proactive response. Each response returns the next token to use until the chunked response is complete.
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.
{'errors': [{'associationId': 'string',
'code': 'ACCESS_DENIED | RESOURCE_NOT_FOUND | VALIDATION_ERROR | '
'THROTTLED | DEPENDENCY_FAILED | INTERNAL_SERVER_ERROR',
'message': 'string'}]}
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'
},
],
'errors': [
{
'associationId': 'string',
'code': 'ACCESS_DENIED'|'RESOURCE_NOT_FOUND'|'VALIDATION_ERROR'|'THROTTLED'|'DEPENDENCY_FAILED'|'INTERNAL_SERVER_ERROR',
'message': '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.
errors (list) --
The per-association errors returned when one or more knowledge base associations fail during a Retrieve operation that spans multiple assistant associations. The overall operation still succeeds and returns the results from the associations that were queried successfully. This list contains one entry for each association that failed, up to a maximum of five.
(dict) --
An error returned for a single assistant association whose knowledge base retrieval failed during a Retrieve operation. The overall operation still succeeds and returns the results from the associations that were queried successfully.
associationId (string) --
The identifier of the assistant association whose knowledge base retrieval failed.
code (string) --
The error code that categorizes the retrieval failure for the assistant association.
message (string) --
A human-readable description of the retrieval failure for the assistant association.
{'configuration': {'enabled': 'boolean'}}
Response {'assistant': {'aiAgentConfiguration': {'enabled': 'boolean'}}}
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',
'enabled': True|False
},
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.
enabled (boolean) --
Indicates whether the AI Agent configured for this AI Agent type is enabled. When this value is omitted or set to true, the configured AI Agent runs; when set to false, the AI Agent ID is retained but no AI Agent runs for the AI Agent type. Setting this value to false is currently supported only for the ANSWER_RECOMMENDATION AI Agent type; other requests to set it to false are rejected with a validation error.
string
The orchestrator use case for the AI Agent being added.
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',
'enabled': True|False
}
},
'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.
enabled (boolean) --
Indicates whether the AI Agent configured for this AI Agent type is enabled. When this value is omitted or set to true, the configured AI Agent runs; when set to false, the AI Agent ID is retained but no AI Agent runs for the AI Agent type. Setting this value to false is currently supported only for the ANSWER_RECOMMENDATION AI Agent type; other requests to set it to false are rejected with a validation error.
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)
{'aiAgentConfiguration': {'enabled': 'boolean'}}
Response {'session': {'aiAgentConfiguration': {'enabled': 'boolean'}}}
Updates a session. A session is a contextual container used for generating recommendations. Connect Customer 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',
'enabled': True|False
}
},
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.
enabled (boolean) --
Indicates whether the AI Agent configured for this AI Agent type is enabled. When this value is omitted or set to true, the configured AI Agent runs; when set to false, the AI Agent ID is retained but no AI Agent runs for the AI Agent type. Setting this value to false is currently supported only for the ANSWER_RECOMMENDATION AI Agent type; other requests to set it to false are rejected with a validation error.
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',
'enabled': True|False
}
},
'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.
enabled (boolean) --
Indicates whether the AI Agent configured for this AI Agent type is enabled. When this value is omitted or set to true, the configured AI Agent runs; when set to false, the AI Agent ID is retained but no AI Agent runs for the AI Agent type. Setting this value to false is currently supported only for the ANSWER_RECOMMENDATION AI Agent type; other requests to set it to false are rejected with a validation error.
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)