QConnect / Client / create_ai_agent
create_ai_agent¶
- QConnect.Client.create_ai_agent(**kwargs)¶
Creates an Amazon Q in Connect AI Agent.
See also: AWS API Documentation
Request Syntax
response = client.create_ai_agent( clientToken='string', assistantId='string', name='string', type='MANUAL_SEARCH'|'ANSWER_RECOMMENDATION'|'SELF_SERVICE', configuration={ 'manualSearchAIAgentConfiguration': { 'answerGenerationAIPromptId': 'string', 'answerGenerationAIGuardrailId': 'string', 'associationConfigurations': [ { 'associationId': 'string', 'associationType': 'KNOWLEDGE_BASE', 'associationConfigurationData': { 'knowledgeBaseAssociationConfigurationData': { 'contentTagFilter': { 'tagCondition': { 'key': 'string', 'value': 'string' }, 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'orConditions': [ { 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'tagCondition': { 'key': 'string', 'value': 'string' } }, ] }, 'maxResults': 123, 'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC' } } }, ], 'locale': 'string' }, 'answerRecommendationAIAgentConfiguration': { 'intentLabelingGenerationAIPromptId': 'string', 'queryReformulationAIPromptId': 'string', 'answerGenerationAIPromptId': 'string', 'answerGenerationAIGuardrailId': 'string', 'associationConfigurations': [ { 'associationId': 'string', 'associationType': 'KNOWLEDGE_BASE', 'associationConfigurationData': { 'knowledgeBaseAssociationConfigurationData': { 'contentTagFilter': { 'tagCondition': { 'key': 'string', 'value': 'string' }, 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'orConditions': [ { 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'tagCondition': { 'key': 'string', 'value': 'string' } }, ] }, 'maxResults': 123, 'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC' } } }, ], 'locale': 'string' }, 'selfServiceAIAgentConfiguration': { 'selfServicePreProcessingAIPromptId': 'string', 'selfServiceAnswerGenerationAIPromptId': 'string', 'selfServiceAIGuardrailId': 'string', 'associationConfigurations': [ { 'associationId': 'string', 'associationType': 'KNOWLEDGE_BASE', 'associationConfigurationData': { 'knowledgeBaseAssociationConfigurationData': { 'contentTagFilter': { 'tagCondition': { 'key': 'string', 'value': 'string' }, 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'orConditions': [ { 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'tagCondition': { 'key': 'string', 'value': 'string' } }, ] }, 'maxResults': 123, 'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC' } } }, ] } }, visibilityStatus='SAVED'|'PUBLISHED', tags={ 'string': 'string' }, description='string' )
- Parameters:
clientToken (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.
assistantId (string) –
[REQUIRED]
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
name (string) –
[REQUIRED]
The name of the AI Agent.
type (string) –
[REQUIRED]
The type of the AI Agent.
configuration (dict) –
[REQUIRED]
The configuration of the AI Agent.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:
manualSearchAIAgentConfiguration
,answerRecommendationAIAgentConfiguration
,selfServiceAIAgentConfiguration
.manualSearchAIAgentConfiguration (dict) –
The configuration for AI Agents of type
MANUAL_SEARCH
.answerGenerationAIPromptId (string) –
The AI Prompt identifier for the Answer Generation prompt used by the MANUAL_SEARCH AI Agent.
answerGenerationAIGuardrailId (string) –
The AI Guardrail identifier for the Answer Generation guardrail used by the MANUAL_SEARCH AI Agent.
associationConfigurations (list) –
The association configurations for overriding behavior on this AI Agent.
(dict) –
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) –
The identifier of the association for this Association Configuration.
associationType (string) –
The type of the association for this Association Configuration.
associationConfigurationData (dict) –
The data of the configuration for an Amazon Q in Connect Assistant Association.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:
knowledgeBaseAssociationConfigurationData
.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.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:
tagCondition
,andConditions
,orConditions
.tagCondition (dict) –
A leaf node condition which can be used to specify a tag condition.
key (string) – [REQUIRED]
The tag key in the tag condition.
value (string) –
The tag value in the tag condition.
andConditions (list) –
A list of conditions which would be applied together with an
AND
condition.(dict) –
A leaf node condition which can be used to specify a tag condition.
key (string) – [REQUIRED]
The tag key in the tag condition.
value (string) –
The tag value in the tag condition.
orConditions (list) –
A list of conditions which would be applied together with an
OR
condition.(dict) –
A list of conditions which would be applied together with an
OR
condition.Note
This is a Tagged Union structure. Only one of the following top level keys can be set:
andConditions
,tagCondition
.andConditions (list) –
A list of conditions which would be applied together with an
AND
condition.(dict) –
A leaf node condition which can be used to specify a tag condition.
key (string) – [REQUIRED]
The tag key in the tag condition.
value (string) –
The tag value in the tag condition.
tagCondition (dict) –
A leaf node condition which can be used to specify a tag condition.
key (string) – [REQUIRED]
The tag key in the tag condition.
value (string) –
The tag value in the tag condition.
maxResults (integer) –
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) –
The search type to be used against the Knowledge Base for this request. The values can be
SEMANTIC
which uses vector embeddings orHYBRID
which use vector embeddings and raw text
locale (string) –
The locale to which specifies the language and region settings that determine the response language for QueryAssistant.
answerRecommendationAIAgentConfiguration (dict) –
The configuration for AI Agents of type
ANSWER_RECOMMENDATION
.intentLabelingGenerationAIPromptId (string) –
The AI Prompt identifier for the Intent Labeling prompt used by the
ANSWER_RECOMMENDATION
AI Agent.queryReformulationAIPromptId (string) –
The AI Prompt identifier for the Query Reformulation prompt used by the
ANSWER_RECOMMENDATION
AI Agent.answerGenerationAIPromptId (string) –
The AI Prompt identifier for the Answer Generation prompt used by the
ANSWER_RECOMMENDATION
AI Agent.answerGenerationAIGuardrailId (string) –
The AI Guardrail identifier for the Answer Generation Guardrail used by the
ANSWER_RECOMMENDATION
AI Agent.associationConfigurations (list) –
The association configurations for overriding behavior on this AI Agent.
(dict) –
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) –
The identifier of the association for this Association Configuration.
associationType (string) –
The type of the association for this Association Configuration.
associationConfigurationData (dict) –
The data of the configuration for an Amazon Q in Connect Assistant Association.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:
knowledgeBaseAssociationConfigurationData
.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.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:
tagCondition
,andConditions
,orConditions
.tagCondition (dict) –
A leaf node condition which can be used to specify a tag condition.
key (string) – [REQUIRED]
The tag key in the tag condition.
value (string) –
The tag value in the tag condition.
andConditions (list) –
A list of conditions which would be applied together with an
AND
condition.(dict) –
A leaf node condition which can be used to specify a tag condition.
key (string) – [REQUIRED]
The tag key in the tag condition.
value (string) –
The tag value in the tag condition.
orConditions (list) –
A list of conditions which would be applied together with an
OR
condition.(dict) –
A list of conditions which would be applied together with an
OR
condition.Note
This is a Tagged Union structure. Only one of the following top level keys can be set:
andConditions
,tagCondition
.andConditions (list) –
A list of conditions which would be applied together with an
AND
condition.(dict) –
A leaf node condition which can be used to specify a tag condition.
key (string) – [REQUIRED]
The tag key in the tag condition.
value (string) –
The tag value in the tag condition.
tagCondition (dict) –
A leaf node condition which can be used to specify a tag condition.
key (string) – [REQUIRED]
The tag key in the tag condition.
value (string) –
The tag value in the tag condition.
maxResults (integer) –
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) –
The search type to be used against the Knowledge Base for this request. The values can be
SEMANTIC
which uses vector embeddings orHYBRID
which use vector embeddings and raw text
locale (string) –
The locale to which specifies the language and region settings that determine the response language for QueryAssistant.
Note
Changing this locale to anything other than
en_US
,en_GB
, oren_AU
will turn off recommendations triggered by contact transcripts for agent assistance, as this feature is not supported in multiple languages.
selfServiceAIAgentConfiguration (dict) –
The configuration for AI Agents of type SELF_SERVICE.
selfServicePreProcessingAIPromptId (string) –
The AI Prompt identifier for the Self Service Pre-Processing prompt used by the SELF_SERVICE AI Agent
selfServiceAnswerGenerationAIPromptId (string) –
The AI Prompt identifier for the Self Service Answer Generation prompt used by the SELF_SERVICE AI Agent
selfServiceAIGuardrailId (string) –
The AI Guardrail identifier used by the SELF_SERVICE AI Agent.
associationConfigurations (list) –
The association configurations for overriding behavior on this AI Agent.
(dict) –
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) –
The identifier of the association for this Association Configuration.
associationType (string) –
The type of the association for this Association Configuration.
associationConfigurationData (dict) –
The data of the configuration for an Amazon Q in Connect Assistant Association.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:
knowledgeBaseAssociationConfigurationData
.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.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:
tagCondition
,andConditions
,orConditions
.tagCondition (dict) –
A leaf node condition which can be used to specify a tag condition.
key (string) – [REQUIRED]
The tag key in the tag condition.
value (string) –
The tag value in the tag condition.
andConditions (list) –
A list of conditions which would be applied together with an
AND
condition.(dict) –
A leaf node condition which can be used to specify a tag condition.
key (string) – [REQUIRED]
The tag key in the tag condition.
value (string) –
The tag value in the tag condition.
orConditions (list) –
A list of conditions which would be applied together with an
OR
condition.(dict) –
A list of conditions which would be applied together with an
OR
condition.Note
This is a Tagged Union structure. Only one of the following top level keys can be set:
andConditions
,tagCondition
.andConditions (list) –
A list of conditions which would be applied together with an
AND
condition.(dict) –
A leaf node condition which can be used to specify a tag condition.
key (string) – [REQUIRED]
The tag key in the tag condition.
value (string) –
The tag value in the tag condition.
tagCondition (dict) –
A leaf node condition which can be used to specify a tag condition.
key (string) – [REQUIRED]
The tag key in the tag condition.
value (string) –
The tag value in the tag condition.
maxResults (integer) –
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) –
The search type to be used against the Knowledge Base for this request. The values can be
SEMANTIC
which uses vector embeddings orHYBRID
which use vector embeddings and raw text
visibilityStatus (string) –
[REQUIRED]
The visibility status of the AI Agent.
tags (dict) –
The tags used to organize, track, or control access for this resource.
(string) –
(string) –
description (string) – The description of the AI Agent.
- Return type:
dict
- Returns:
Response Syntax
{ 'aiAgent': { 'assistantId': 'string', 'assistantArn': 'string', 'aiAgentId': 'string', 'aiAgentArn': 'string', 'name': 'string', 'type': 'MANUAL_SEARCH'|'ANSWER_RECOMMENDATION'|'SELF_SERVICE', 'configuration': { 'manualSearchAIAgentConfiguration': { 'answerGenerationAIPromptId': 'string', 'answerGenerationAIGuardrailId': 'string', 'associationConfigurations': [ { 'associationId': 'string', 'associationType': 'KNOWLEDGE_BASE', 'associationConfigurationData': { 'knowledgeBaseAssociationConfigurationData': { 'contentTagFilter': { 'tagCondition': { 'key': 'string', 'value': 'string' }, 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'orConditions': [ { 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'tagCondition': { 'key': 'string', 'value': 'string' } }, ] }, 'maxResults': 123, 'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC' } } }, ], 'locale': 'string' }, 'answerRecommendationAIAgentConfiguration': { 'intentLabelingGenerationAIPromptId': 'string', 'queryReformulationAIPromptId': 'string', 'answerGenerationAIPromptId': 'string', 'answerGenerationAIGuardrailId': 'string', 'associationConfigurations': [ { 'associationId': 'string', 'associationType': 'KNOWLEDGE_BASE', 'associationConfigurationData': { 'knowledgeBaseAssociationConfigurationData': { 'contentTagFilter': { 'tagCondition': { 'key': 'string', 'value': 'string' }, 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'orConditions': [ { 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'tagCondition': { 'key': 'string', 'value': 'string' } }, ] }, 'maxResults': 123, 'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC' } } }, ], 'locale': 'string' }, 'selfServiceAIAgentConfiguration': { 'selfServicePreProcessingAIPromptId': 'string', 'selfServiceAnswerGenerationAIPromptId': 'string', 'selfServiceAIGuardrailId': 'string', 'associationConfigurations': [ { 'associationId': 'string', 'associationType': 'KNOWLEDGE_BASE', 'associationConfigurationData': { 'knowledgeBaseAssociationConfigurationData': { 'contentTagFilter': { 'tagCondition': { 'key': 'string', 'value': 'string' }, 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'orConditions': [ { 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'tagCondition': { 'key': 'string', 'value': 'string' } }, ] }, 'maxResults': 123, 'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC' } } }, ] } }, 'modifiedTime': datetime(2015, 1, 1), 'description': 'string', 'visibilityStatus': 'SAVED'|'PUBLISHED', 'tags': { 'string': 'string' }, 'origin': 'SYSTEM'|'CUSTOMER', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED' } }
Response Structure
(dict) –
aiAgent (dict) –
The data of the created AI Agent.
assistantId (string) –
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
assistantArn (string) –
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
aiAgentId (string) –
The identifier of the AI Agent.
aiAgentArn (string) –
The Amazon Resource Name (ARN) of the AI agent.
name (string) –
The name of the AI Agent.
type (string) –
The type of the AI Agent.
configuration (dict) –
Configuration for the AI Agent.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set:
manualSearchAIAgentConfiguration
,answerRecommendationAIAgentConfiguration
,selfServiceAIAgentConfiguration
. If a client receives an unknown member it will setSDK_UNKNOWN_MEMBER
as the top level key, which maps to the name or tag of the unknown member. The structure ofSDK_UNKNOWN_MEMBER
is as follows:'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
manualSearchAIAgentConfiguration (dict) –
The configuration for AI Agents of type
MANUAL_SEARCH
.answerGenerationAIPromptId (string) –
The AI Prompt identifier for the Answer Generation prompt used by the MANUAL_SEARCH AI Agent.
answerGenerationAIGuardrailId (string) –
The AI Guardrail identifier for the Answer Generation guardrail used by the MANUAL_SEARCH AI Agent.
associationConfigurations (list) –
The association configurations for overriding behavior on this AI Agent.
(dict) –
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) –
The identifier of the association for this Association Configuration.
associationType (string) –
The type of the association for this Association Configuration.
associationConfigurationData (dict) –
The data of the configuration for an Amazon Q in Connect Assistant Association.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set:
knowledgeBaseAssociationConfigurationData
. If a client receives an unknown member it will setSDK_UNKNOWN_MEMBER
as the top level key, which maps to the name or tag of the unknown member. The structure ofSDK_UNKNOWN_MEMBER
is as follows:'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
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.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set:
tagCondition
,andConditions
,orConditions
. If a client receives an unknown member it will setSDK_UNKNOWN_MEMBER
as the top level key, which maps to the name or tag of the unknown member. The structure ofSDK_UNKNOWN_MEMBER
is as follows:'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
tagCondition (dict) –
A leaf node condition which can be used to specify a tag condition.
key (string) –
The tag key in the tag condition.
value (string) –
The tag value in the tag condition.
andConditions (list) –
A list of conditions which would be applied together with an
AND
condition.(dict) –
A leaf node condition which can be used to specify a tag condition.
key (string) –
The tag key in the tag condition.
value (string) –
The tag value in the tag condition.
orConditions (list) –
A list of conditions which would be applied together with an
OR
condition.(dict) –
A list of conditions which would be applied together with an
OR
condition.Note
This is a Tagged Union structure. Only one of the following top level keys will be set:
andConditions
,tagCondition
. If a client receives an unknown member it will setSDK_UNKNOWN_MEMBER
as the top level key, which maps to the name or tag of the unknown member. The structure ofSDK_UNKNOWN_MEMBER
is as follows:'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
andConditions (list) –
A list of conditions which would be applied together with an
AND
condition.(dict) –
A leaf node condition which can be used to specify a tag condition.
key (string) –
The tag key in the tag condition.
value (string) –
The tag value in the tag condition.
tagCondition (dict) –
A leaf node condition which can be used to specify a tag condition.
key (string) –
The tag key in the tag condition.
value (string) –
The tag value in the tag condition.
maxResults (integer) –
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) –
The search type to be used against the Knowledge Base for this request. The values can be
SEMANTIC
which uses vector embeddings orHYBRID
which use vector embeddings and raw text
locale (string) –
The locale to which specifies the language and region settings that determine the response language for QueryAssistant.
answerRecommendationAIAgentConfiguration (dict) –
The configuration for AI Agents of type
ANSWER_RECOMMENDATION
.intentLabelingGenerationAIPromptId (string) –
The AI Prompt identifier for the Intent Labeling prompt used by the
ANSWER_RECOMMENDATION
AI Agent.queryReformulationAIPromptId (string) –
The AI Prompt identifier for the Query Reformulation prompt used by the
ANSWER_RECOMMENDATION
AI Agent.answerGenerationAIPromptId (string) –
The AI Prompt identifier for the Answer Generation prompt used by the
ANSWER_RECOMMENDATION
AI Agent.answerGenerationAIGuardrailId (string) –
The AI Guardrail identifier for the Answer Generation Guardrail used by the
ANSWER_RECOMMENDATION
AI Agent.associationConfigurations (list) –
The association configurations for overriding behavior on this AI Agent.
(dict) –
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) –
The identifier of the association for this Association Configuration.
associationType (string) –
The type of the association for this Association Configuration.
associationConfigurationData (dict) –
The data of the configuration for an Amazon Q in Connect Assistant Association.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set:
knowledgeBaseAssociationConfigurationData
. If a client receives an unknown member it will setSDK_UNKNOWN_MEMBER
as the top level key, which maps to the name or tag of the unknown member. The structure ofSDK_UNKNOWN_MEMBER
is as follows:'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
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.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set:
tagCondition
,andConditions
,orConditions
. If a client receives an unknown member it will setSDK_UNKNOWN_MEMBER
as the top level key, which maps to the name or tag of the unknown member. The structure ofSDK_UNKNOWN_MEMBER
is as follows:'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
tagCondition (dict) –
A leaf node condition which can be used to specify a tag condition.
key (string) –
The tag key in the tag condition.
value (string) –
The tag value in the tag condition.
andConditions (list) –
A list of conditions which would be applied together with an
AND
condition.(dict) –
A leaf node condition which can be used to specify a tag condition.
key (string) –
The tag key in the tag condition.
value (string) –
The tag value in the tag condition.
orConditions (list) –
A list of conditions which would be applied together with an
OR
condition.(dict) –
A list of conditions which would be applied together with an
OR
condition.Note
This is a Tagged Union structure. Only one of the following top level keys will be set:
andConditions
,tagCondition
. If a client receives an unknown member it will setSDK_UNKNOWN_MEMBER
as the top level key, which maps to the name or tag of the unknown member. The structure ofSDK_UNKNOWN_MEMBER
is as follows:'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
andConditions (list) –
A list of conditions which would be applied together with an
AND
condition.(dict) –
A leaf node condition which can be used to specify a tag condition.
key (string) –
The tag key in the tag condition.
value (string) –
The tag value in the tag condition.
tagCondition (dict) –
A leaf node condition which can be used to specify a tag condition.
key (string) –
The tag key in the tag condition.
value (string) –
The tag value in the tag condition.
maxResults (integer) –
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) –
The search type to be used against the Knowledge Base for this request. The values can be
SEMANTIC
which uses vector embeddings orHYBRID
which use vector embeddings and raw text
locale (string) –
The locale to which specifies the language and region settings that determine the response language for QueryAssistant.
Note
Changing this locale to anything other than
en_US
,en_GB
, oren_AU
will turn off recommendations triggered by contact transcripts for agent assistance, as this feature is not supported in multiple languages.
selfServiceAIAgentConfiguration (dict) –
The configuration for AI Agents of type SELF_SERVICE.
selfServicePreProcessingAIPromptId (string) –
The AI Prompt identifier for the Self Service Pre-Processing prompt used by the SELF_SERVICE AI Agent
selfServiceAnswerGenerationAIPromptId (string) –
The AI Prompt identifier for the Self Service Answer Generation prompt used by the SELF_SERVICE AI Agent
selfServiceAIGuardrailId (string) –
The AI Guardrail identifier used by the SELF_SERVICE AI Agent.
associationConfigurations (list) –
The association configurations for overriding behavior on this AI Agent.
(dict) –
The configuration for an Amazon Q in Connect Assistant Association.
associationId (string) –
The identifier of the association for this Association Configuration.
associationType (string) –
The type of the association for this Association Configuration.
associationConfigurationData (dict) –
The data of the configuration for an Amazon Q in Connect Assistant Association.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set:
knowledgeBaseAssociationConfigurationData
. If a client receives an unknown member it will setSDK_UNKNOWN_MEMBER
as the top level key, which maps to the name or tag of the unknown member. The structure ofSDK_UNKNOWN_MEMBER
is as follows:'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
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.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set:
tagCondition
,andConditions
,orConditions
. If a client receives an unknown member it will setSDK_UNKNOWN_MEMBER
as the top level key, which maps to the name or tag of the unknown member. The structure ofSDK_UNKNOWN_MEMBER
is as follows:'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
tagCondition (dict) –
A leaf node condition which can be used to specify a tag condition.
key (string) –
The tag key in the tag condition.
value (string) –
The tag value in the tag condition.
andConditions (list) –
A list of conditions which would be applied together with an
AND
condition.(dict) –
A leaf node condition which can be used to specify a tag condition.
key (string) –
The tag key in the tag condition.
value (string) –
The tag value in the tag condition.
orConditions (list) –
A list of conditions which would be applied together with an
OR
condition.(dict) –
A list of conditions which would be applied together with an
OR
condition.Note
This is a Tagged Union structure. Only one of the following top level keys will be set:
andConditions
,tagCondition
. If a client receives an unknown member it will setSDK_UNKNOWN_MEMBER
as the top level key, which maps to the name or tag of the unknown member. The structure ofSDK_UNKNOWN_MEMBER
is as follows:'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
andConditions (list) –
A list of conditions which would be applied together with an
AND
condition.(dict) –
A leaf node condition which can be used to specify a tag condition.
key (string) –
The tag key in the tag condition.
value (string) –
The tag value in the tag condition.
tagCondition (dict) –
A leaf node condition which can be used to specify a tag condition.
key (string) –
The tag key in the tag condition.
value (string) –
The tag value in the tag condition.
maxResults (integer) –
The maximum number of results to return per page.
overrideKnowledgeBaseSearchType (string) –
The search type to be used against the Knowledge Base for this request. The values can be
SEMANTIC
which uses vector embeddings orHYBRID
which use vector embeddings and raw text
modifiedTime (datetime) –
The time the AI Agent was last modified.
description (string) –
The description of the AI Agent.
visibilityStatus (string) –
The visibility status of the AI Agent.
tags (dict) –
The tags used to organize, track, or control access for this resource.
(string) –
(string) –
origin (string) –
Specifies the origin of the AI Agent.
SYSTEM
for a default AI Agent created by Q in Connect orCUSTOMER
for an AI Agent created by calling AI Agent creation APIs.status (string) –
The status of the AI Agent.
Exceptions