2024/12/19 - Amazon Q Connect - 6 updated api methods
Changes Amazon Q in Connect enables agents to ask Q for assistance in multiple languages and Q will provide answers and recommended step-by-step guides in those languages. Qs default language is English (United States) and you can switch this by setting the locale configuration on the AI Agent.
{'configuration': {'answerRecommendationAIAgentConfiguration': {'locale': 'string'},
'manualSearchAIAgentConfiguration': {'locale': 'string'}}}
Response {'aiAgent': {'configuration': {'answerRecommendationAIAgentConfiguration': {'locale': 'string'},
'manualSearchAIAgentConfiguration': {'locale': 'string'}}}}
Creates an Amazon Q in Connect AI Agent.
See also: AWS API Documentation
Request Syntax
client.create_ai_agent(
assistantId='string',
clientToken='string',
configuration={
'answerRecommendationAIAgentConfiguration': {
'answerGenerationAIGuardrailId': 'string',
'answerGenerationAIPromptId': 'string',
'associationConfigurations': [
{
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
},
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE'
},
],
'intentLabelingGenerationAIPromptId': 'string',
'locale': 'string',
'queryReformulationAIPromptId': 'string'
},
'manualSearchAIAgentConfiguration': {
'answerGenerationAIGuardrailId': 'string',
'answerGenerationAIPromptId': 'string',
'associationConfigurations': [
{
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
},
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE'
},
],
'locale': 'string'
},
'selfServiceAIAgentConfiguration': {
'associationConfigurations': [
{
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
},
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE'
},
],
'selfServiceAIGuardrailId': 'string',
'selfServiceAnswerGenerationAIPromptId': 'string',
'selfServicePreProcessingAIPromptId': 'string'
}
},
description='string',
name='string',
tags={
'string': 'string'
},
type='MANUAL_SEARCH'|'ANSWER_RECOMMENDATION'|'SELF_SERVICE',
visibilityStatus='SAVED'|'PUBLISHED'
)
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
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
[REQUIRED]
The configuration of the AI Agent.
answerRecommendationAIAgentConfiguration (dict) --
The configuration for AI Agents of type ANSWER_RECOMMENDATION.
answerGenerationAIGuardrailId (string) --
The AI Guardrail identifier for the Answer Generation Guardrail 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.
associationConfigurations (list) --
The association configurations for overriding behavior on this AI Agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
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.
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.
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
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
intentLabelingGenerationAIPromptId (string) --
The AI Prompt identifier for the Intent Labeling prompt used by the ANSWER_RECOMMENDATION AI Agent.
locale (string) --
The locale to which specifies the language and region settings that determine the response language for QueryAssistant.
queryReformulationAIPromptId (string) --
The AI Prompt identifier for the Query Reformulation prompt used by the ANSWER_RECOMMENDATION AI Agent.
manualSearchAIAgentConfiguration (dict) --
The configuration for AI Agents of type MANUAL_SEARCH.
answerGenerationAIGuardrailId (string) --
The AI Guardrail identifier for the Answer Generation guardrail used by the MANUAL_SEARCH AI Agent.
answerGenerationAIPromptId (string) --
The AI Prompt identifier for the Answer Generation prompt 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.
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.
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.
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
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
locale (string) --
The locale to which specifies the language and region settings that determine the response language for QueryAssistant.
selfServiceAIAgentConfiguration (dict) --
The configuration for AI Agents of type SELF_SERVICE.
associationConfigurations (list) --
The association configurations for overriding behavior on this AI Agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
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.
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.
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
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
selfServiceAIGuardrailId (string) --
The AI Guardrail identifier 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
selfServicePreProcessingAIPromptId (string) --
The AI Prompt identifier for the Self Service Pre-Processing prompt used by the SELF_SERVICE AI Agent
string
The description of the AI Agent.
string
[REQUIRED]
The name of the AI Agent.
dict
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
string
[REQUIRED]
The type of the AI Agent.
string
[REQUIRED]
The visibility status of the AI Agent.
dict
Response Syntax
{
'aiAgent': {
'aiAgentArn': 'string',
'aiAgentId': 'string',
'assistantArn': 'string',
'assistantId': 'string',
'configuration': {
'answerRecommendationAIAgentConfiguration': {
'answerGenerationAIGuardrailId': 'string',
'answerGenerationAIPromptId': 'string',
'associationConfigurations': [
{
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
},
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE'
},
],
'intentLabelingGenerationAIPromptId': 'string',
'locale': 'string',
'queryReformulationAIPromptId': 'string'
},
'manualSearchAIAgentConfiguration': {
'answerGenerationAIGuardrailId': 'string',
'answerGenerationAIPromptId': 'string',
'associationConfigurations': [
{
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
},
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE'
},
],
'locale': 'string'
},
'selfServiceAIAgentConfiguration': {
'associationConfigurations': [
{
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
},
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE'
},
],
'selfServiceAIGuardrailId': 'string',
'selfServiceAnswerGenerationAIPromptId': 'string',
'selfServicePreProcessingAIPromptId': 'string'
}
},
'description': 'string',
'modifiedTime': datetime(2015, 1, 1),
'name': 'string',
'origin': 'SYSTEM'|'CUSTOMER',
'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED',
'tags': {
'string': 'string'
},
'type': 'MANUAL_SEARCH'|'ANSWER_RECOMMENDATION'|'SELF_SERVICE',
'visibilityStatus': 'SAVED'|'PUBLISHED'
}
}
Response Structure
(dict) --
aiAgent (dict) --
The data of the created AI Agent.
aiAgentArn (string) --
The Amazon Resource Name (ARN) of the AI agent.
aiAgentId (string) --
The identifier of the AI Agent.
assistantArn (string) --
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
assistantId (string) --
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
configuration (dict) --
Configuration for the AI Agent.
answerRecommendationAIAgentConfiguration (dict) --
The configuration for AI Agents of type ANSWER_RECOMMENDATION.
answerGenerationAIGuardrailId (string) --
The AI Guardrail identifier for the Answer Generation Guardrail 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.
associationConfigurations (list) --
The association configurations for overriding behavior on this AI Agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
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.
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.
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
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
intentLabelingGenerationAIPromptId (string) --
The AI Prompt identifier for the Intent Labeling prompt used by the ANSWER_RECOMMENDATION AI Agent.
locale (string) --
The locale to which specifies the language and region settings that determine the response language for QueryAssistant.
queryReformulationAIPromptId (string) --
The AI Prompt identifier for the Query Reformulation prompt used by the ANSWER_RECOMMENDATION AI Agent.
manualSearchAIAgentConfiguration (dict) --
The configuration for AI Agents of type MANUAL_SEARCH.
answerGenerationAIGuardrailId (string) --
The AI Guardrail identifier for the Answer Generation guardrail used by the MANUAL_SEARCH AI Agent.
answerGenerationAIPromptId (string) --
The AI Prompt identifier for the Answer Generation prompt 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.
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.
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.
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
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
locale (string) --
The locale to which specifies the language and region settings that determine the response language for QueryAssistant.
selfServiceAIAgentConfiguration (dict) --
The configuration for AI Agents of type SELF_SERVICE.
associationConfigurations (list) --
The association configurations for overriding behavior on this AI Agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
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.
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.
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
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
selfServiceAIGuardrailId (string) --
The AI Guardrail identifier 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
selfServicePreProcessingAIPromptId (string) --
The AI Prompt identifier for the Self Service Pre-Processing prompt used by the SELF_SERVICE AI Agent
description (string) --
The description of the AI Agent.
modifiedTime (datetime) --
The time the AI Agent was last modified.
name (string) --
The name of the AI Agent.
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.
tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
type (string) --
The type of the AI Agent.
visibilityStatus (string) --
The visibility status of the AI Agent.
{'aiAgent': {'configuration': {'answerRecommendationAIAgentConfiguration': {'locale': 'string'},
'manualSearchAIAgentConfiguration': {'locale': 'string'}}}}
Creates and Amazon Q in Connect AI Agent version.
See also: AWS API Documentation
Request Syntax
client.create_ai_agent_version(
aiAgentId='string',
assistantId='string',
clientToken='string',
modifiedTime=datetime(2015, 1, 1)
)
string
[REQUIRED]
The identifier of the Amazon Q in Connect AI Agent.
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
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.
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.
dict
Response Syntax
{
'aiAgent': {
'aiAgentArn': 'string',
'aiAgentId': 'string',
'assistantArn': 'string',
'assistantId': 'string',
'configuration': {
'answerRecommendationAIAgentConfiguration': {
'answerGenerationAIGuardrailId': 'string',
'answerGenerationAIPromptId': 'string',
'associationConfigurations': [
{
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
},
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE'
},
],
'intentLabelingGenerationAIPromptId': 'string',
'locale': 'string',
'queryReformulationAIPromptId': 'string'
},
'manualSearchAIAgentConfiguration': {
'answerGenerationAIGuardrailId': 'string',
'answerGenerationAIPromptId': 'string',
'associationConfigurations': [
{
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
},
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE'
},
],
'locale': 'string'
},
'selfServiceAIAgentConfiguration': {
'associationConfigurations': [
{
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
},
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE'
},
],
'selfServiceAIGuardrailId': 'string',
'selfServiceAnswerGenerationAIPromptId': 'string',
'selfServicePreProcessingAIPromptId': 'string'
}
},
'description': 'string',
'modifiedTime': datetime(2015, 1, 1),
'name': 'string',
'origin': 'SYSTEM'|'CUSTOMER',
'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED',
'tags': {
'string': 'string'
},
'type': 'MANUAL_SEARCH'|'ANSWER_RECOMMENDATION'|'SELF_SERVICE',
'visibilityStatus': 'SAVED'|'PUBLISHED'
},
'versionNumber': 123
}
Response Structure
(dict) --
aiAgent (dict) --
The data of the AI Agent version.
aiAgentArn (string) --
The Amazon Resource Name (ARN) of the AI agent.
aiAgentId (string) --
The identifier of the AI Agent.
assistantArn (string) --
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
assistantId (string) --
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
configuration (dict) --
Configuration for the AI Agent.
answerRecommendationAIAgentConfiguration (dict) --
The configuration for AI Agents of type ANSWER_RECOMMENDATION.
answerGenerationAIGuardrailId (string) --
The AI Guardrail identifier for the Answer Generation Guardrail 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.
associationConfigurations (list) --
The association configurations for overriding behavior on this AI Agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
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.
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.
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
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
intentLabelingGenerationAIPromptId (string) --
The AI Prompt identifier for the Intent Labeling prompt used by the ANSWER_RECOMMENDATION AI Agent.
locale (string) --
The locale to which specifies the language and region settings that determine the response language for QueryAssistant.
queryReformulationAIPromptId (string) --
The AI Prompt identifier for the Query Reformulation prompt used by the ANSWER_RECOMMENDATION AI Agent.
manualSearchAIAgentConfiguration (dict) --
The configuration for AI Agents of type MANUAL_SEARCH.
answerGenerationAIGuardrailId (string) --
The AI Guardrail identifier for the Answer Generation guardrail used by the MANUAL_SEARCH AI Agent.
answerGenerationAIPromptId (string) --
The AI Prompt identifier for the Answer Generation prompt 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.
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.
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.
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
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
locale (string) --
The locale to which specifies the language and region settings that determine the response language for QueryAssistant.
selfServiceAIAgentConfiguration (dict) --
The configuration for AI Agents of type SELF_SERVICE.
associationConfigurations (list) --
The association configurations for overriding behavior on this AI Agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
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.
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.
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
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
selfServiceAIGuardrailId (string) --
The AI Guardrail identifier 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
selfServicePreProcessingAIPromptId (string) --
The AI Prompt identifier for the Self Service Pre-Processing prompt used by the SELF_SERVICE AI Agent
description (string) --
The description of the AI Agent.
modifiedTime (datetime) --
The time the AI Agent was last modified.
name (string) --
The name of the AI Agent.
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.
tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
type (string) --
The type of the AI Agent.
visibilityStatus (string) --
The visibility status of the AI Agent.
versionNumber (integer) --
The version number of the AI Agent version.
{'aiAgent': {'configuration': {'answerRecommendationAIAgentConfiguration': {'locale': 'string'},
'manualSearchAIAgentConfiguration': {'locale': 'string'}}}}
Gets an Amazon Q in Connect AI Agent.
See also: AWS API Documentation
Request Syntax
client.get_ai_agent(
aiAgentId='string',
assistantId='string'
)
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.
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
{
'aiAgent': {
'aiAgentArn': 'string',
'aiAgentId': 'string',
'assistantArn': 'string',
'assistantId': 'string',
'configuration': {
'answerRecommendationAIAgentConfiguration': {
'answerGenerationAIGuardrailId': 'string',
'answerGenerationAIPromptId': 'string',
'associationConfigurations': [
{
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
},
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE'
},
],
'intentLabelingGenerationAIPromptId': 'string',
'locale': 'string',
'queryReformulationAIPromptId': 'string'
},
'manualSearchAIAgentConfiguration': {
'answerGenerationAIGuardrailId': 'string',
'answerGenerationAIPromptId': 'string',
'associationConfigurations': [
{
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
},
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE'
},
],
'locale': 'string'
},
'selfServiceAIAgentConfiguration': {
'associationConfigurations': [
{
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
},
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE'
},
],
'selfServiceAIGuardrailId': 'string',
'selfServiceAnswerGenerationAIPromptId': 'string',
'selfServicePreProcessingAIPromptId': 'string'
}
},
'description': 'string',
'modifiedTime': datetime(2015, 1, 1),
'name': 'string',
'origin': 'SYSTEM'|'CUSTOMER',
'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED',
'tags': {
'string': 'string'
},
'type': 'MANUAL_SEARCH'|'ANSWER_RECOMMENDATION'|'SELF_SERVICE',
'visibilityStatus': 'SAVED'|'PUBLISHED'
},
'versionNumber': 123
}
Response Structure
(dict) --
aiAgent (dict) --
The data of the AI Agent.
aiAgentArn (string) --
The Amazon Resource Name (ARN) of the AI agent.
aiAgentId (string) --
The identifier of the AI Agent.
assistantArn (string) --
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
assistantId (string) --
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
configuration (dict) --
Configuration for the AI Agent.
answerRecommendationAIAgentConfiguration (dict) --
The configuration for AI Agents of type ANSWER_RECOMMENDATION.
answerGenerationAIGuardrailId (string) --
The AI Guardrail identifier for the Answer Generation Guardrail 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.
associationConfigurations (list) --
The association configurations for overriding behavior on this AI Agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
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.
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.
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
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
intentLabelingGenerationAIPromptId (string) --
The AI Prompt identifier for the Intent Labeling prompt used by the ANSWER_RECOMMENDATION AI Agent.
locale (string) --
The locale to which specifies the language and region settings that determine the response language for QueryAssistant.
queryReformulationAIPromptId (string) --
The AI Prompt identifier for the Query Reformulation prompt used by the ANSWER_RECOMMENDATION AI Agent.
manualSearchAIAgentConfiguration (dict) --
The configuration for AI Agents of type MANUAL_SEARCH.
answerGenerationAIGuardrailId (string) --
The AI Guardrail identifier for the Answer Generation guardrail used by the MANUAL_SEARCH AI Agent.
answerGenerationAIPromptId (string) --
The AI Prompt identifier for the Answer Generation prompt 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.
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.
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.
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
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
locale (string) --
The locale to which specifies the language and region settings that determine the response language for QueryAssistant.
selfServiceAIAgentConfiguration (dict) --
The configuration for AI Agents of type SELF_SERVICE.
associationConfigurations (list) --
The association configurations for overriding behavior on this AI Agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
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.
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.
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
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
selfServiceAIGuardrailId (string) --
The AI Guardrail identifier 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
selfServicePreProcessingAIPromptId (string) --
The AI Prompt identifier for the Self Service Pre-Processing prompt used by the SELF_SERVICE AI Agent
description (string) --
The description of the AI Agent.
modifiedTime (datetime) --
The time the AI Agent was last modified.
name (string) --
The name of the AI Agent.
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.
tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
type (string) --
The type of the AI Agent.
visibilityStatus (string) --
The visibility 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).
{'aiAgentVersionSummaries': {'aiAgentSummary': {'configuration': {'answerRecommendationAIAgentConfiguration': {'locale': 'string'},
'manualSearchAIAgentConfiguration': {'locale': 'string'}}}}}
List AI Agent versions.
See also: AWS API Documentation
Request Syntax
client.list_ai_agent_versions(
aiAgentId='string',
assistantId='string',
maxResults=123,
nextToken='string',
origin='SYSTEM'|'CUSTOMER'
)
string
[REQUIRED]
The identifier of the Amazon Q in Connect AI Agent for which versions are to be listed.
string
[REQUIRED]
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
integer
The maximum number of results to return per page.
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.
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': {
'aiAgentArn': 'string',
'aiAgentId': 'string',
'assistantArn': 'string',
'assistantId': 'string',
'configuration': {
'answerRecommendationAIAgentConfiguration': {
'answerGenerationAIGuardrailId': 'string',
'answerGenerationAIPromptId': 'string',
'associationConfigurations': [
{
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
},
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE'
},
],
'intentLabelingGenerationAIPromptId': 'string',
'locale': 'string',
'queryReformulationAIPromptId': 'string'
},
'manualSearchAIAgentConfiguration': {
'answerGenerationAIGuardrailId': 'string',
'answerGenerationAIPromptId': 'string',
'associationConfigurations': [
{
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
},
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE'
},
],
'locale': 'string'
},
'selfServiceAIAgentConfiguration': {
'associationConfigurations': [
{
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
},
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE'
},
],
'selfServiceAIGuardrailId': 'string',
'selfServiceAnswerGenerationAIPromptId': 'string',
'selfServicePreProcessingAIPromptId': 'string'
}
},
'description': 'string',
'modifiedTime': datetime(2015, 1, 1),
'name': 'string',
'origin': 'SYSTEM'|'CUSTOMER',
'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED',
'tags': {
'string': 'string'
},
'type': 'MANUAL_SEARCH'|'ANSWER_RECOMMENDATION'|'SELF_SERVICE',
'visibilityStatus': 'SAVED'|'PUBLISHED'
},
'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.
aiAgentArn (string) --
The Amazon Resource Name (ARN) of the AI agent.
aiAgentId (string) --
The identifier of the AI Agent.
assistantArn (string) --
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
assistantId (string) --
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
configuration (dict) --
The configuration for the AI Agent.
answerRecommendationAIAgentConfiguration (dict) --
The configuration for AI Agents of type ANSWER_RECOMMENDATION.
answerGenerationAIGuardrailId (string) --
The AI Guardrail identifier for the Answer Generation Guardrail 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.
associationConfigurations (list) --
The association configurations for overriding behavior on this AI Agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
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.
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.
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
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
intentLabelingGenerationAIPromptId (string) --
The AI Prompt identifier for the Intent Labeling prompt used by the ANSWER_RECOMMENDATION AI Agent.
locale (string) --
The locale to which specifies the language and region settings that determine the response language for QueryAssistant.
queryReformulationAIPromptId (string) --
The AI Prompt identifier for the Query Reformulation prompt used by the ANSWER_RECOMMENDATION AI Agent.
manualSearchAIAgentConfiguration (dict) --
The configuration for AI Agents of type MANUAL_SEARCH.
answerGenerationAIGuardrailId (string) --
The AI Guardrail identifier for the Answer Generation guardrail used by the MANUAL_SEARCH AI Agent.
answerGenerationAIPromptId (string) --
The AI Prompt identifier for the Answer Generation prompt 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.
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.
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.
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
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
locale (string) --
The locale to which specifies the language and region settings that determine the response language for QueryAssistant.
selfServiceAIAgentConfiguration (dict) --
The configuration for AI Agents of type SELF_SERVICE.
associationConfigurations (list) --
The association configurations for overriding behavior on this AI Agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
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.
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.
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
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
selfServiceAIGuardrailId (string) --
The AI Guardrail identifier 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
selfServicePreProcessingAIPromptId (string) --
The AI Prompt identifier for the Self Service Pre-Processing prompt used by the SELF_SERVICE AI Agent
description (string) --
The description of the AI Agent.
modifiedTime (datetime) --
The time the AI Agent was last modified.
name (string) --
The name of the 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.
status (string) --
The status of the AI Agent.
tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
type (string) --
The type of the AI Agent.
visibilityStatus (string) --
The visibility status of the AI Agent.
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': {'locale': 'string'},
'manualSearchAIAgentConfiguration': {'locale': 'string'}}}}
Lists AI Agents.
See also: AWS API Documentation
Request Syntax
client.list_ai_agents(
assistantId='string',
maxResults=123,
nextToken='string',
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.
integer
The maximum number of results to return per page.
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.
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': [
{
'aiAgentArn': 'string',
'aiAgentId': 'string',
'assistantArn': 'string',
'assistantId': 'string',
'configuration': {
'answerRecommendationAIAgentConfiguration': {
'answerGenerationAIGuardrailId': 'string',
'answerGenerationAIPromptId': 'string',
'associationConfigurations': [
{
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
},
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE'
},
],
'intentLabelingGenerationAIPromptId': 'string',
'locale': 'string',
'queryReformulationAIPromptId': 'string'
},
'manualSearchAIAgentConfiguration': {
'answerGenerationAIGuardrailId': 'string',
'answerGenerationAIPromptId': 'string',
'associationConfigurations': [
{
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
},
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE'
},
],
'locale': 'string'
},
'selfServiceAIAgentConfiguration': {
'associationConfigurations': [
{
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
},
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE'
},
],
'selfServiceAIGuardrailId': 'string',
'selfServiceAnswerGenerationAIPromptId': 'string',
'selfServicePreProcessingAIPromptId': 'string'
}
},
'description': 'string',
'modifiedTime': datetime(2015, 1, 1),
'name': 'string',
'origin': 'SYSTEM'|'CUSTOMER',
'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED',
'tags': {
'string': 'string'
},
'type': 'MANUAL_SEARCH'|'ANSWER_RECOMMENDATION'|'SELF_SERVICE',
'visibilityStatus': 'SAVED'|'PUBLISHED'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
aiAgentSummaries (list) --
The summaries of AI Agents.
(dict) --
The summary of the AI Agent.
aiAgentArn (string) --
The Amazon Resource Name (ARN) of the AI agent.
aiAgentId (string) --
The identifier of the AI Agent.
assistantArn (string) --
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
assistantId (string) --
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
configuration (dict) --
The configuration for the AI Agent.
answerRecommendationAIAgentConfiguration (dict) --
The configuration for AI Agents of type ANSWER_RECOMMENDATION.
answerGenerationAIGuardrailId (string) --
The AI Guardrail identifier for the Answer Generation Guardrail 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.
associationConfigurations (list) --
The association configurations for overriding behavior on this AI Agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
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.
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.
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
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
intentLabelingGenerationAIPromptId (string) --
The AI Prompt identifier for the Intent Labeling prompt used by the ANSWER_RECOMMENDATION AI Agent.
locale (string) --
The locale to which specifies the language and region settings that determine the response language for QueryAssistant.
queryReformulationAIPromptId (string) --
The AI Prompt identifier for the Query Reformulation prompt used by the ANSWER_RECOMMENDATION AI Agent.
manualSearchAIAgentConfiguration (dict) --
The configuration for AI Agents of type MANUAL_SEARCH.
answerGenerationAIGuardrailId (string) --
The AI Guardrail identifier for the Answer Generation guardrail used by the MANUAL_SEARCH AI Agent.
answerGenerationAIPromptId (string) --
The AI Prompt identifier for the Answer Generation prompt 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.
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.
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.
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
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
locale (string) --
The locale to which specifies the language and region settings that determine the response language for QueryAssistant.
selfServiceAIAgentConfiguration (dict) --
The configuration for AI Agents of type SELF_SERVICE.
associationConfigurations (list) --
The association configurations for overriding behavior on this AI Agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
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.
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.
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
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
selfServiceAIGuardrailId (string) --
The AI Guardrail identifier 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
selfServicePreProcessingAIPromptId (string) --
The AI Prompt identifier for the Self Service Pre-Processing prompt used by the SELF_SERVICE AI Agent
description (string) --
The description of the AI Agent.
modifiedTime (datetime) --
The time the AI Agent was last modified.
name (string) --
The name of the 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.
status (string) --
The status of the AI Agent.
tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
type (string) --
The type of the AI Agent.
visibilityStatus (string) --
The visibility status of the AI Agent.
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.
{'configuration': {'answerRecommendationAIAgentConfiguration': {'locale': 'string'},
'manualSearchAIAgentConfiguration': {'locale': 'string'}}}
Response {'aiAgent': {'configuration': {'answerRecommendationAIAgentConfiguration': {'locale': 'string'},
'manualSearchAIAgentConfiguration': {'locale': 'string'}}}}
Updates an AI Agent.
See also: AWS API Documentation
Request Syntax
client.update_ai_agent(
aiAgentId='string',
assistantId='string',
clientToken='string',
configuration={
'answerRecommendationAIAgentConfiguration': {
'answerGenerationAIGuardrailId': 'string',
'answerGenerationAIPromptId': 'string',
'associationConfigurations': [
{
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
},
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE'
},
],
'intentLabelingGenerationAIPromptId': 'string',
'locale': 'string',
'queryReformulationAIPromptId': 'string'
},
'manualSearchAIAgentConfiguration': {
'answerGenerationAIGuardrailId': 'string',
'answerGenerationAIPromptId': 'string',
'associationConfigurations': [
{
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
},
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE'
},
],
'locale': 'string'
},
'selfServiceAIAgentConfiguration': {
'associationConfigurations': [
{
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
},
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE'
},
],
'selfServiceAIGuardrailId': 'string',
'selfServiceAnswerGenerationAIPromptId': 'string',
'selfServicePreProcessingAIPromptId': 'string'
}
},
description='string',
visibilityStatus='SAVED'|'PUBLISHED'
)
string
[REQUIRED]
The identifier of the Amazon Q in Connect AI Agent.
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
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 configuration of the Amazon Q in Connect AI Agent.
answerRecommendationAIAgentConfiguration (dict) --
The configuration for AI Agents of type ANSWER_RECOMMENDATION.
answerGenerationAIGuardrailId (string) --
The AI Guardrail identifier for the Answer Generation Guardrail 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.
associationConfigurations (list) --
The association configurations for overriding behavior on this AI Agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
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.
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.
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
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
intentLabelingGenerationAIPromptId (string) --
The AI Prompt identifier for the Intent Labeling prompt used by the ANSWER_RECOMMENDATION AI Agent.
locale (string) --
The locale to which specifies the language and region settings that determine the response language for QueryAssistant.
queryReformulationAIPromptId (string) --
The AI Prompt identifier for the Query Reformulation prompt used by the ANSWER_RECOMMENDATION AI Agent.
manualSearchAIAgentConfiguration (dict) --
The configuration for AI Agents of type MANUAL_SEARCH.
answerGenerationAIGuardrailId (string) --
The AI Guardrail identifier for the Answer Generation guardrail used by the MANUAL_SEARCH AI Agent.
answerGenerationAIPromptId (string) --
The AI Prompt identifier for the Answer Generation prompt 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.
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.
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.
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
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
locale (string) --
The locale to which specifies the language and region settings that determine the response language for QueryAssistant.
selfServiceAIAgentConfiguration (dict) --
The configuration for AI Agents of type SELF_SERVICE.
associationConfigurations (list) --
The association configurations for overriding behavior on this AI Agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
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.
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.
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
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
selfServiceAIGuardrailId (string) --
The AI Guardrail identifier 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
selfServicePreProcessingAIPromptId (string) --
The AI Prompt identifier for the Self Service Pre-Processing prompt used by the SELF_SERVICE AI Agent
string
The description of the Amazon Q in Connect AI Agent.
string
[REQUIRED]
The visbility status of the Amazon Q in Connect AI Agent.
dict
Response Syntax
{
'aiAgent': {
'aiAgentArn': 'string',
'aiAgentId': 'string',
'assistantArn': 'string',
'assistantId': 'string',
'configuration': {
'answerRecommendationAIAgentConfiguration': {
'answerGenerationAIGuardrailId': 'string',
'answerGenerationAIPromptId': 'string',
'associationConfigurations': [
{
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
},
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE'
},
],
'intentLabelingGenerationAIPromptId': 'string',
'locale': 'string',
'queryReformulationAIPromptId': 'string'
},
'manualSearchAIAgentConfiguration': {
'answerGenerationAIGuardrailId': 'string',
'answerGenerationAIPromptId': 'string',
'associationConfigurations': [
{
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
},
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE'
},
],
'locale': 'string'
},
'selfServiceAIAgentConfiguration': {
'associationConfigurations': [
{
'associationConfigurationData': {
'knowledgeBaseAssociationConfigurationData': {
'contentTagFilter': {
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'orConditions': [
{
'andConditions': [
{
'key': 'string',
'value': 'string'
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
],
'tagCondition': {
'key': 'string',
'value': 'string'
}
},
'maxResults': 123,
'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
}
},
'associationId': 'string',
'associationType': 'KNOWLEDGE_BASE'
},
],
'selfServiceAIGuardrailId': 'string',
'selfServiceAnswerGenerationAIPromptId': 'string',
'selfServicePreProcessingAIPromptId': 'string'
}
},
'description': 'string',
'modifiedTime': datetime(2015, 1, 1),
'name': 'string',
'origin': 'SYSTEM'|'CUSTOMER',
'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED',
'tags': {
'string': 'string'
},
'type': 'MANUAL_SEARCH'|'ANSWER_RECOMMENDATION'|'SELF_SERVICE',
'visibilityStatus': 'SAVED'|'PUBLISHED'
}
}
Response Structure
(dict) --
aiAgent (dict) --
The data of the updated Amazon Q in Connect AI Agent.
aiAgentArn (string) --
The Amazon Resource Name (ARN) of the AI agent.
aiAgentId (string) --
The identifier of the AI Agent.
assistantArn (string) --
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
assistantId (string) --
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
configuration (dict) --
Configuration for the AI Agent.
answerRecommendationAIAgentConfiguration (dict) --
The configuration for AI Agents of type ANSWER_RECOMMENDATION.
answerGenerationAIGuardrailId (string) --
The AI Guardrail identifier for the Answer Generation Guardrail 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.
associationConfigurations (list) --
The association configurations for overriding behavior on this AI Agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
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.
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.
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
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
intentLabelingGenerationAIPromptId (string) --
The AI Prompt identifier for the Intent Labeling prompt used by the ANSWER_RECOMMENDATION AI Agent.
locale (string) --
The locale to which specifies the language and region settings that determine the response language for QueryAssistant.
queryReformulationAIPromptId (string) --
The AI Prompt identifier for the Query Reformulation prompt used by the ANSWER_RECOMMENDATION AI Agent.
manualSearchAIAgentConfiguration (dict) --
The configuration for AI Agents of type MANUAL_SEARCH.
answerGenerationAIGuardrailId (string) --
The AI Guardrail identifier for the Answer Generation guardrail used by the MANUAL_SEARCH AI Agent.
answerGenerationAIPromptId (string) --
The AI Prompt identifier for the Answer Generation prompt 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.
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.
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.
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
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
locale (string) --
The locale to which specifies the language and region settings that determine the response language for QueryAssistant.
selfServiceAIAgentConfiguration (dict) --
The configuration for AI Agents of type SELF_SERVICE.
associationConfigurations (list) --
The association configurations for overriding behavior on this AI Agent.
(dict) --
The configuration for an Amazon Q in Connect Assistant Association.
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.
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.
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
associationId (string) --
The identifier of the association for this Association Configuration.
associationType (string) --
The type of the association for this Association Configuration.
selfServiceAIGuardrailId (string) --
The AI Guardrail identifier 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
selfServicePreProcessingAIPromptId (string) --
The AI Prompt identifier for the Self Service Pre-Processing prompt used by the SELF_SERVICE AI Agent
description (string) --
The description of the AI Agent.
modifiedTime (datetime) --
The time the AI Agent was last modified.
name (string) --
The name of the AI Agent.
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.
tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
type (string) --
The type of the AI Agent.
visibilityStatus (string) --
The visibility status of the AI Agent.