AWS API Changes

2024/10/07 - Amazon Q Connect - 19 new 12 updated api methods

Changes This release adds support for the following capabilities: Configuration of the Gen AI system via AIAgent and AIPrompts. Integration support for Bedrock Knowledge Base.

ListAIPromptVersions (new)

Link ¶

Lists AI Prompt versions.

See also: AWS API Documentation

Request Syntax

client.list_ai_prompt_versions(
    aiPromptId='string',
    assistantId='string',
    maxResults=123,
    nextToken='string',
    origin='SYSTEM'|'CUSTOMER'
)

type aiPromptId

string

param aiPromptId

[REQUIRED]

The identifier of the Amazon Q in Connect AI prompt for which versions are to be listed.

type assistantId

string

param assistantId

[REQUIRED]

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

type maxResults

integer

param maxResults

The maximum number of results to return per page.

type nextToken

string

param nextToken

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.

type origin

string

param origin

The origin of the AI Prompt versions to be listed. SYSTEM for a default AI Agent created by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent creation APIs.

rtype

dict

returns

Response Syntax

{
    'aiPromptVersionSummaries': [
        {
            'aiPromptSummary': {
                'aiPromptArn': 'string',
                'aiPromptId': 'string',
                'apiFormat': 'ANTHROPIC_CLAUDE_MESSAGES'|'ANTHROPIC_CLAUDE_TEXT_COMPLETIONS',
                'assistantArn': 'string',
                'assistantId': 'string',
                'description': 'string',
                'modelId': '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'
                },
                'templateType': 'TEXT',
                'type': 'ANSWER_GENERATION'|'INTENT_LABELING_GENERATION'|'QUERY_REFORMULATION',
                'visibilityStatus': 'SAVED'|'PUBLISHED'
            },
            'versionNumber': 123
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- aiPromptVersionSummaries (list) --
  
  The summaries of the AI Prompt versions.
  - (dict) --
    
    The summary of the AI Prompt version.
    - aiPromptSummary (dict) --
      
      The date for the summary of the AI Prompt version.
      - aiPromptArn (string) --
        
        The Amazon Resource Name (ARN) of the AI Prompt.
      - aiPromptId (string) --
        
        The identifier of the Amazon Q in Connect AI prompt.
      - apiFormat (string) --
        
        The API format used for this AI Prompt.
      - 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.
      - description (string) --
        
        The description of the AI Prompt.
      - modelId (string) --
        
        The identifier of the model used for this AI Prompt. Model Ids supported are: CLAUDE_3_HAIKU_20240307_V1 .
      - modifiedTime (datetime) --
        
        The time the AI Prompt was last modified.
      - name (string) --
        
        The name of the AI Prompt.
      - origin (string) --
        
        The origin of the AI Prompt. SYSTEM for a default AI Prompt created by Q in Connect or CUSTOMER for an AI Prompt created by calling AI Prompt creation APIs.
      - status (string) --
        
        The status of the AI Prompt.
      - tags (dict) --
        
        The tags used to organize, track, or control access for this resource.
        
        (string) --
        
        (string) --
      - templateType (string) --
        
        The type of the prompt template for this AI Prompt.
      - type (string) --
        
        The type of this AI Prompt.
      - visibilityStatus (string) --
        
        The visibility status of the AI Prompt.
    - versionNumber (integer) --
      
      The version number for this AI Prompt version.
- nextToken (string) --
  
  The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

DeleteAIAgent (new)

Link ¶

Deletes an Amazon Q in Connect AI Agent.

See also: AWS API Documentation

Request Syntax

client.delete_ai_agent(
    aiAgentId='string',
    assistantId='string'
)

type aiAgentId

string

param aiAgentId

[REQUIRED]

The identifier of the Amazon Q in Connect AI Agent. Can be either the ID or the ARN. URLs cannot contain the ARN.

type assistantId

string

param assistantId

[REQUIRED]

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

CreateAIPromptVersion (new)

Link ¶

Creates an Amazon Q in Connect AI Prompt version.

See also: AWS API Documentation

Request Syntax

client.create_ai_prompt_version(
    aiPromptId='string',
    assistantId='string',
    clientToken='string',
    modifiedTime=datetime(2015, 1, 1)
)

type aiPromptId

string

param aiPromptId

[REQUIRED]

The identifier of the Amazon Q in Connect AI prompt.

type assistantId

string

param assistantId

[REQUIRED]

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

type clientToken

string

param clientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

This field is autopopulated if not provided.

type modifiedTime

datetime

param modifiedTime

The time the AI Prompt was last modified.

rtype

dict

returns

Response Syntax

{
    'aiPrompt': {
        'aiPromptArn': 'string',
        'aiPromptId': 'string',
        'apiFormat': 'ANTHROPIC_CLAUDE_MESSAGES'|'ANTHROPIC_CLAUDE_TEXT_COMPLETIONS',
        'assistantArn': 'string',
        'assistantId': 'string',
        'description': 'string',
        'modelId': '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'
        },
        'templateConfiguration': {
            'textFullAIPromptEditTemplateConfiguration': {
                'text': 'string'
            }
        },
        'templateType': 'TEXT',
        'type': 'ANSWER_GENERATION'|'INTENT_LABELING_GENERATION'|'QUERY_REFORMULATION',
        'visibilityStatus': 'SAVED'|'PUBLISHED'
    },
    'versionNumber': 123
}

Response Structure

(dict) --
- aiPrompt (dict) --
  
  The data of the AI Prompt version.
  - aiPromptArn (string) --
    
    The Amazon Resource Name (ARN) of the AI Prompt.
  - aiPromptId (string) --
    
    The identifier of the Amazon Q in Connect AI prompt.
  - apiFormat (string) --
    
    The API format used for this AI Prompt.
  - 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.
  - description (string) --
    
    The description of the AI Prompt.
  - modelId (string) --
    
    The identifier of the model used for this AI Prompt. Model Ids supported are: CLAUDE_3_HAIKU_20240307_V1 .
  - modifiedTime (datetime) --
    
    The time the AI Prompt was last modified.
  - name (string) --
    
    The name of the AI Prompt
  - origin (string) --
    
    The origin of the AI Prompt. SYSTEM for a default AI Prompt created by Q in Connect or CUSTOMER for an AI Prompt created by calling AI Prompt creation APIs.
  - status (string) --
    
    The status of the AI Prompt.
  - tags (dict) --
    
    The tags used to organize, track, or control access for this resource.
    - (string) --
      - (string) --
  - templateConfiguration (dict) --
    
    The configuration of the prompt template for this AI Prompt.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: textFullAIPromptEditTemplateConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - textFullAIPromptEditTemplateConfiguration (dict) --
      
      The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt.
      - text (string) --
        
        The YAML text for the AI Prompt template.
  - templateType (string) --
    
    The type of the prompt template for this AI Prompt.
  - type (string) --
    
    The type of this AI Prompt.
  - visibilityStatus (string) --
    
    The visibility status of the AI Prompt.
- versionNumber (integer) --
  
  The version number of the AI Prompt version.

RemoveAssistantAIAgent (new)

Link ¶

Removes the AI Agent that is set for use by defafult on an Amazon Q in Connect Assistant.

See also: AWS API Documentation

Request Syntax

client.remove_assistant_ai_agent(
    aiAgentType='MANUAL_SEARCH'|'ANSWER_RECOMMENDATION',
    assistantId='string'
)

type aiAgentType

string

param aiAgentType

[REQUIRED]

The type of the AI Agent being removed for use by default from the Amazon Q in Connect Assistant.

type assistantId

string

param assistantId

[REQUIRED]

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

CreateAIAgent (new)

Link ¶

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': {
            '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',
            'queryReformulationAIPromptId': 'string'
        },
        'manualSearchAIAgentConfiguration': {
            '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'
                },
            ]
        }
    },
    description='string',
    name='string',
    tags={
        'string': 'string'
    },
    type='MANUAL_SEARCH'|'ANSWER_RECOMMENDATION',
    visibilityStatus='SAVED'|'PUBLISHED'
)

type assistantId

string

param assistantId

[REQUIRED]

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

type clientToken

string

param clientToken

This field is autopopulated if not provided.

type configuration

dict

param configuration

[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: answerRecommendationAIAgentConfiguration, manualSearchAIAgentConfiguration.

answerRecommendationAIAgentConfiguration (dict) --

The configuration for AI Agents of type ANSWER_RECOMMENDATION .
- 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.
      
      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: andConditions, orConditions, 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.
        
        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.
        
        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.
- 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 .
- 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.
      
      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: andConditions, orConditions, 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.
        
        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.
        
        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.

type description

string

param description

The description of the AI Agent.

type name

string

param name

[REQUIRED]

The name of the AI Agent.

type tags

dict

param tags

The tags used to organize, track, or control access for this resource.

(string) --
- (string) --

type type

string

param type

[REQUIRED]

The type of the AI Agent.

type visibilityStatus

string

param visibilityStatus

[REQUIRED]

The visibility status of the AI Agent.

rtype

dict

returns

Response Syntax

{
    'aiAgent': {
        'aiAgentArn': 'string',
        'aiAgentId': 'string',
        'assistantArn': 'string',
        'assistantId': 'string',
        'configuration': {
            'answerRecommendationAIAgentConfiguration': {
                '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',
                'queryReformulationAIPromptId': 'string'
            },
            'manualSearchAIAgentConfiguration': {
                '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'
                    },
                ]
            }
        },
        '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',
        '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.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: answerRecommendationAIAgentConfiguration, manualSearchAIAgentConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - answerRecommendationAIAgentConfiguration (dict) --
      
      The configuration for AI Agents of type ANSWER_RECOMMENDATION .
      - 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.
        
        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 set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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: andConditions, orConditions, tagCondition. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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.
        
        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 set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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.
        
        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.
      - 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 .
      - 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.
        
        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 set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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: andConditions, orConditions, tagCondition. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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.
        
        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 set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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.
        
        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.
  - 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.

DeleteAIAgentVersion (new)

Link ¶

Deletes an Amazon Q in Connect AI Agent Version.

See also: AWS API Documentation

Request Syntax

client.delete_ai_agent_version(
    aiAgentId='string',
    assistantId='string',
    versionNumber=123
)

type aiAgentId

string

param aiAgentId

[REQUIRED]

The identifier of the Amazon Q in Connect AI Agent. Can be either the ID or the ARN. URLs cannot contain the ARN.

type assistantId

string

param assistantId

[REQUIRED]

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

type versionNumber

integer

param versionNumber

[REQUIRED]

The version number of the AI Agent version.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

UpdateSessionData (new)

Link ¶

Updates the data stored on an Amazon Q in Connect Session.

See also: AWS API Documentation

Request Syntax

client.update_session_data(
    assistantId='string',
    data=[
        {
            'key': 'string',
            'value': {
                'stringValue': 'string'
            }
        },
    ],
    namespace='Custom',
    sessionId='string'
)

type assistantId

string

param assistantId

[REQUIRED]

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

type data

list

param data

[REQUIRED]

The data stored on the Amazon Q in Connect Session.

(dict) --

The list of key-value pairs that are stored on the session.
- key (string) -- [REQUIRED]
  
  The key of the data stored on the session.
- value (dict) -- [REQUIRED]
  
  The value of the data stored on the session.
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: stringValue.
  - stringValue (string) --
    
    The string value of the data stored on the session.

type namespace

string

param namespace

The namespace into which the session data is stored. Supported namespaces are: Custom

type sessionId

string

param sessionId

[REQUIRED]

The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.

rtype

dict

returns

Response Syntax

{
    'data': [
        {
            'key': 'string',
            'value': {
                'stringValue': 'string'
            }
        },
    ],
    'namespace': 'Custom',
    'sessionArn': 'string',
    'sessionId': 'string'
}

Response Structure

(dict) --
- data (list) --
  
  Data stored in the session.
  - (dict) --
    
    The list of key-value pairs that are stored on the session.
    - key (string) --
      
      The key of the data stored on the session.
    - value (dict) --
      
      The value of the data stored on the session.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: stringValue. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - stringValue (string) --
        
        The string value of the data stored on the session.
- namespace (string) --
  
  The namespace into which the session data is stored. Supported namespaces are: Custom
- sessionArn (string) --
  
  The Amazon Resource Name (ARN) of the session.
- sessionId (string) --
  
  The identifier of the session.

CreateAIAgentVersion (new)

Link ¶

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)
)

type aiAgentId

string

param aiAgentId

[REQUIRED]

The identifier of the Amazon Q in Connect AI Agent.

type assistantId

string

param assistantId

[REQUIRED]

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

type clientToken

string

param clientToken

This field is autopopulated if not provided.

type modifiedTime

datetime

param modifiedTime

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.

rtype

dict

returns

Response Syntax

{
    'aiAgent': {
        'aiAgentArn': 'string',
        'aiAgentId': 'string',
        'assistantArn': 'string',
        'assistantId': 'string',
        'configuration': {
            'answerRecommendationAIAgentConfiguration': {
                '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',
                'queryReformulationAIPromptId': 'string'
            },
            'manualSearchAIAgentConfiguration': {
                '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'
                    },
                ]
            }
        },
        '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',
        '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.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: answerRecommendationAIAgentConfiguration, manualSearchAIAgentConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - answerRecommendationAIAgentConfiguration (dict) --
      
      The configuration for AI Agents of type ANSWER_RECOMMENDATION .
      - 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.
        
        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 set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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: andConditions, orConditions, tagCondition. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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.
        
        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 set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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.
        
        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.
      - 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 .
      - 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.
        
        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 set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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: andConditions, orConditions, tagCondition. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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.
        
        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 set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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.
        
        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.
  - 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.

ListAIAgentVersions (new)

Link ¶

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'
)

type aiAgentId

string

param aiAgentId

[REQUIRED]

The identifier of the Amazon Q in Connect AI Agent for which versions are to be listed.

type assistantId

string

param assistantId

[REQUIRED]

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

type maxResults

integer

param maxResults

The maximum number of results to return per page.

type nextToken

string

param nextToken

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.

type origin

string

param origin

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.

rtype

dict

returns

Response Syntax

{
    'aiAgentVersionSummaries': [
        {
            'aiAgentSummary': {
                'aiAgentArn': 'string',
                'aiAgentId': 'string',
                'assistantArn': 'string',
                'assistantId': 'string',
                'configuration': {
                    'answerRecommendationAIAgentConfiguration': {
                        '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',
                        'queryReformulationAIPromptId': 'string'
                    },
                    'manualSearchAIAgentConfiguration': {
                        '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'
                            },
                        ]
                    }
                },
                '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',
                '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.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: answerRecommendationAIAgentConfiguration, manualSearchAIAgentConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        answerRecommendationAIAgentConfiguration (dict) --
        
        The configuration for AI Agents of type ANSWER_RECOMMENDATION .
        
        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.
        
        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 set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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: andConditions, orConditions, tagCondition. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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.
        
        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 set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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.
        
        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.
        
        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 .
        
        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.
        
        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 set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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: andConditions, orConditions, tagCondition. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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.
        
        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 set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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.
        
        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.
      - 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.

ListAIAgents (new)

Link ¶

Lists AI Agents.

See also: AWS API Documentation

Request Syntax

client.list_ai_agents(
    assistantId='string',
    maxResults=123,
    nextToken='string',
    origin='SYSTEM'|'CUSTOMER'
)

type assistantId

string

param assistantId

[REQUIRED]

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

type maxResults

integer

param maxResults

The maximum number of results to return per page.

type nextToken

string

param nextToken

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.

type origin

string

param origin

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.

rtype

dict

returns

Response Syntax

{
    'aiAgentSummaries': [
        {
            'aiAgentArn': 'string',
            'aiAgentId': 'string',
            'assistantArn': 'string',
            'assistantId': 'string',
            'configuration': {
                'answerRecommendationAIAgentConfiguration': {
                    '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',
                    'queryReformulationAIPromptId': 'string'
                },
                'manualSearchAIAgentConfiguration': {
                    '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'
                        },
                    ]
                }
            },
            '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',
            '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.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: answerRecommendationAIAgentConfiguration, manualSearchAIAgentConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - answerRecommendationAIAgentConfiguration (dict) --
        
        The configuration for AI Agents of type ANSWER_RECOMMENDATION .
        
        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.
        
        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 set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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: andConditions, orConditions, tagCondition. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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.
        
        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 set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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.
        
        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.
        
        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 .
        
        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.
        
        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 set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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: andConditions, orConditions, tagCondition. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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.
        
        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 set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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.
        
        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.
    - 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.

UpdateAIAgent (new)

Link ¶

Updates an AI Agent.

See also: AWS API Documentation

Request Syntax

client.update_ai_agent(
    aiAgentId='string',
    assistantId='string',
    clientToken='string',
    configuration={
        'answerRecommendationAIAgentConfiguration': {
            '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',
            'queryReformulationAIPromptId': 'string'
        },
        'manualSearchAIAgentConfiguration': {
            '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'
                },
            ]
        }
    },
    description='string',
    visibilityStatus='SAVED'|'PUBLISHED'
)

type aiAgentId

string

param aiAgentId

[REQUIRED]

The identifier of the Amazon Q in Connect AI Agent.

type assistantId

string

param assistantId

[REQUIRED]

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

type clientToken

string

param clientToken

This field is autopopulated if not provided.

type configuration

dict

param configuration

The configuration of the Amazon Q in Connect AI Agent.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: answerRecommendationAIAgentConfiguration, manualSearchAIAgentConfiguration.

answerRecommendationAIAgentConfiguration (dict) --

The configuration for AI Agents of type ANSWER_RECOMMENDATION .
- 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.
      
      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: andConditions, orConditions, 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.
        
        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.
        
        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.
- 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 .
- 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.
      
      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: andConditions, orConditions, 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.
        
        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.
        
        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.

type description

string

param description

The description of the Amazon Q in Connect AI Agent.

type visibilityStatus

string

param visibilityStatus

[REQUIRED]

The visbility status of the Amazon Q in Connect AI Agent.

rtype

dict

returns

Response Syntax

{
    'aiAgent': {
        'aiAgentArn': 'string',
        'aiAgentId': 'string',
        'assistantArn': 'string',
        'assistantId': 'string',
        'configuration': {
            'answerRecommendationAIAgentConfiguration': {
                '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',
                'queryReformulationAIPromptId': 'string'
            },
            'manualSearchAIAgentConfiguration': {
                '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'
                    },
                ]
            }
        },
        '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',
        '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.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: answerRecommendationAIAgentConfiguration, manualSearchAIAgentConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - answerRecommendationAIAgentConfiguration (dict) --
      
      The configuration for AI Agents of type ANSWER_RECOMMENDATION .
      - 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.
        
        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 set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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: andConditions, orConditions, tagCondition. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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.
        
        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 set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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.
        
        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.
      - 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 .
      - 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.
        
        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 set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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: andConditions, orConditions, tagCondition. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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.
        
        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 set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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.
        
        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.
  - 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.

GetAIPrompt (new)

Link ¶

Gets and Amazon Q in Connect AI Prompt.

See also: AWS API Documentation

Request Syntax

client.get_ai_prompt(
    aiPromptId='string',
    assistantId='string'
)

type aiPromptId

string

param aiPromptId

[REQUIRED]

The identifier of the Amazon Q in Connect AI prompt.

type assistantId

string

param assistantId

[REQUIRED]

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

rtype

dict

returns

Response Syntax

{
    'aiPrompt': {
        'aiPromptArn': 'string',
        'aiPromptId': 'string',
        'apiFormat': 'ANTHROPIC_CLAUDE_MESSAGES'|'ANTHROPIC_CLAUDE_TEXT_COMPLETIONS',
        'assistantArn': 'string',
        'assistantId': 'string',
        'description': 'string',
        'modelId': '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'
        },
        'templateConfiguration': {
            'textFullAIPromptEditTemplateConfiguration': {
                'text': 'string'
            }
        },
        'templateType': 'TEXT',
        'type': 'ANSWER_GENERATION'|'INTENT_LABELING_GENERATION'|'QUERY_REFORMULATION',
        'visibilityStatus': 'SAVED'|'PUBLISHED'
    },
    'versionNumber': 123
}

Response Structure

(dict) --
- aiPrompt (dict) --
  
  The data of the AI Prompt.
  - aiPromptArn (string) --
    
    The Amazon Resource Name (ARN) of the AI Prompt.
  - aiPromptId (string) --
    
    The identifier of the Amazon Q in Connect AI prompt.
  - apiFormat (string) --
    
    The API format used for this AI Prompt.
  - 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.
  - description (string) --
    
    The description of the AI Prompt.
  - modelId (string) --
    
    The identifier of the model used for this AI Prompt. Model Ids supported are: CLAUDE_3_HAIKU_20240307_V1 .
  - modifiedTime (datetime) --
    
    The time the AI Prompt was last modified.
  - name (string) --
    
    The name of the AI Prompt
  - origin (string) --
    
    The origin of the AI Prompt. SYSTEM for a default AI Prompt created by Q in Connect or CUSTOMER for an AI Prompt created by calling AI Prompt creation APIs.
  - status (string) --
    
    The status of the AI Prompt.
  - tags (dict) --
    
    The tags used to organize, track, or control access for this resource.
    - (string) --
      - (string) --
  - templateConfiguration (dict) --
    
    The configuration of the prompt template for this AI Prompt.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: textFullAIPromptEditTemplateConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - textFullAIPromptEditTemplateConfiguration (dict) --
      
      The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt.
      - text (string) --
        
        The YAML text for the AI Prompt template.
  - templateType (string) --
    
    The type of the prompt template for this AI Prompt.
  - type (string) --
    
    The type of this AI Prompt.
  - visibilityStatus (string) --
    
    The visibility status of the AI Prompt.
- versionNumber (integer) --
  
  The version number of the AI Prompt version (returned if an AI Prompt version was specified via use of a qualifier for the aiPromptId on the request).

ListAIPrompts (new)

Link ¶

Lists the AI Prompts available on the Amazon Q in Connect assistant.

See also: AWS API Documentation

Request Syntax

client.list_ai_prompts(
    assistantId='string',
    maxResults=123,
    nextToken='string',
    origin='SYSTEM'|'CUSTOMER'
)

type assistantId

string

param assistantId

[REQUIRED]

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

type maxResults

integer

param maxResults

The maximum number of results to return per page.

type nextToken

string

param nextToken

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.

type origin

string

param origin

The origin of the AI Prompts to be listed. SYSTEM for a default AI Agent created by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent creation APIs.

rtype

dict

returns

Response Syntax

{
    'aiPromptSummaries': [
        {
            'aiPromptArn': 'string',
            'aiPromptId': 'string',
            'apiFormat': 'ANTHROPIC_CLAUDE_MESSAGES'|'ANTHROPIC_CLAUDE_TEXT_COMPLETIONS',
            'assistantArn': 'string',
            'assistantId': 'string',
            'description': 'string',
            'modelId': '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'
            },
            'templateType': 'TEXT',
            'type': 'ANSWER_GENERATION'|'INTENT_LABELING_GENERATION'|'QUERY_REFORMULATION',
            'visibilityStatus': 'SAVED'|'PUBLISHED'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- aiPromptSummaries (list) --
  
  The summaries of the AI Prompts.
  - (dict) --
    
    The summary of the AI Prompt.
    - aiPromptArn (string) --
      
      The Amazon Resource Name (ARN) of the AI Prompt.
    - aiPromptId (string) --
      
      The identifier of the Amazon Q in Connect AI prompt.
    - apiFormat (string) --
      
      The API format used for this AI Prompt.
    - 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.
    - description (string) --
      
      The description of the AI Prompt.
    - modelId (string) --
      
      The identifier of the model used for this AI Prompt. Model Ids supported are: CLAUDE_3_HAIKU_20240307_V1 .
    - modifiedTime (datetime) --
      
      The time the AI Prompt was last modified.
    - name (string) --
      
      The name of the AI Prompt.
    - origin (string) --
      
      The origin of the AI Prompt. SYSTEM for a default AI Prompt created by Q in Connect or CUSTOMER for an AI Prompt created by calling AI Prompt creation APIs.
    - status (string) --
      
      The status of the AI Prompt.
    - tags (dict) --
      
      The tags used to organize, track, or control access for this resource.
      - (string) --
        
        (string) --
    - templateType (string) --
      
      The type of the prompt template for this AI Prompt.
    - type (string) --
      
      The type of this AI Prompt.
    - visibilityStatus (string) --
      
      The visibility status of the AI Prompt.
- 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.

UpdateAssistantAIAgent (new)

Link ¶

Updates the AI Agent that is set for use by defafult on an Amazon Q in Connect Assistant.

See also: AWS API Documentation

Request Syntax

client.update_assistant_ai_agent(
    aiAgentType='MANUAL_SEARCH'|'ANSWER_RECOMMENDATION',
    assistantId='string',
    configuration={
        'aiAgentId': 'string'
    }
)

type aiAgentType

string

param aiAgentType

[REQUIRED]

The type of the AI Agent being updated for use by default on the Amazon Q in Connect Assistant.

type assistantId

string

param assistantId

[REQUIRED]

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

type configuration

dict

param configuration

[REQUIRED]

The configuration of the AI Agent being updated for use by default on the Amazon Q in Connect Assistant.

aiAgentId (string) -- [REQUIRED]

The ID of the AI Agent to be configured.

rtype

dict

returns

Response Syntax

{
    'assistant': {
        'aiAgentConfiguration': {
            'string': {
                'aiAgentId': 'string'
            }
        },
        'assistantArn': 'string',
        'assistantId': 'string',
        'capabilityConfiguration': {
            'type': 'V1'|'V2'
        },
        'description': 'string',
        'integrationConfiguration': {
            'topicIntegrationArn': 'string'
        },
        'name': 'string',
        'serverSideEncryptionConfiguration': {
            'kmsKeyId': 'string'
        },
        'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED',
        'tags': {
            'string': 'string'
        },
        'type': 'AGENT'
    }
}

Response Structure

(dict) --
- assistant (dict) --
  
  The assistant data.
  - aiAgentConfiguration (dict) --
    
    The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that is set on the Amazon Q in Connect Assistant.
    - (string) --
      - (dict) --
        
        A type that specifies the AI Agent ID configuration data when mapping an AI Agents to be used for an AI Agent type on a session or assistant.
        
        aiAgentId (string) --
        
        The ID of the AI Agent to be configured.
  - 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.
  - capabilityConfiguration (dict) --
    
    The configuration information for the Amazon Q in Connect assistant capability.
    - type (string) --
      
      The type of Amazon Q in Connect assistant capability.
  - description (string) --
    
    The description.
  - integrationConfiguration (dict) --
    
    The configuration information for the Amazon Q in Connect assistant integration.
    - topicIntegrationArn (string) --
      
      The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.
  - name (string) --
    
    The name.
  - serverSideEncryptionConfiguration (dict) --
    
    The configuration information for the customer managed key used for encryption.
    
    This KMS key must have a policy that allows kms:CreateGrant , kms:DescribeKey , kms:Decrypt , and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow kms:Decrypt , kms:GenerateDataKey* , and kms:DescribeKey permissions to the connect.amazonaws.com service principal.
    
    For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.
    - kmsKeyId (string) --
      
      The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. For information about valid ID values, see Key identifiers (KeyId).
  - status (string) --
    
    The status of the assistant.
  - tags (dict) --
    
    The tags used to organize, track, or control access for this resource.
    - (string) --
      - (string) --
  - type (string) --
    
    The type of assistant.

CreateAIPrompt (new)

Link ¶

Creates an Amazon Q in Connect AI Prompt.

See also: AWS API Documentation

Request Syntax

client.create_ai_prompt(
    apiFormat='ANTHROPIC_CLAUDE_MESSAGES'|'ANTHROPIC_CLAUDE_TEXT_COMPLETIONS',
    assistantId='string',
    clientToken='string',
    description='string',
    modelId='string',
    name='string',
    tags={
        'string': 'string'
    },
    templateConfiguration={
        'textFullAIPromptEditTemplateConfiguration': {
            'text': 'string'
        }
    },
    templateType='TEXT',
    type='ANSWER_GENERATION'|'INTENT_LABELING_GENERATION'|'QUERY_REFORMULATION',
    visibilityStatus='SAVED'|'PUBLISHED'
)

type apiFormat

string

param apiFormat

[REQUIRED]

The API Format of the AI Prompt.

type assistantId

string

param assistantId

[REQUIRED]

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

type clientToken

string

param clientToken

This field is autopopulated if not provided.

type description

string

param description

The description of the AI Prompt.

type modelId

string

param modelId

[REQUIRED]

The identifier of the model used for this AI Prompt. Model Ids supported are: CLAUDE_3_HAIKU_20240307_V1

type name

string

param name

[REQUIRED]

The name of the AI Prompt.

type tags

dict

param tags

The tags used to organize, track, or control access for this resource.

(string) --
- (string) --

type templateConfiguration

dict

param templateConfiguration

[REQUIRED]

The configuration of the prompt template for this AI Prompt.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: textFullAIPromptEditTemplateConfiguration.

textFullAIPromptEditTemplateConfiguration (dict) --

The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt.
- text (string) -- [REQUIRED]
  
  The YAML text for the AI Prompt template.

type templateType

string

param templateType

[REQUIRED]

The type of the prompt template for this AI Prompt.

type type

string

param type

[REQUIRED]

The type of this AI Prompt.

type visibilityStatus

string

param visibilityStatus

[REQUIRED]

The visibility status of the AI Prompt.

rtype

dict

returns

Response Syntax

{
    'aiPrompt': {
        'aiPromptArn': 'string',
        'aiPromptId': 'string',
        'apiFormat': 'ANTHROPIC_CLAUDE_MESSAGES'|'ANTHROPIC_CLAUDE_TEXT_COMPLETIONS',
        'assistantArn': 'string',
        'assistantId': 'string',
        'description': 'string',
        'modelId': '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'
        },
        'templateConfiguration': {
            'textFullAIPromptEditTemplateConfiguration': {
                'text': 'string'
            }
        },
        'templateType': 'TEXT',
        'type': 'ANSWER_GENERATION'|'INTENT_LABELING_GENERATION'|'QUERY_REFORMULATION',
        'visibilityStatus': 'SAVED'|'PUBLISHED'
    }
}

Response Structure

(dict) --
- aiPrompt (dict) --
  
  The data of the AI Prompt.
  - aiPromptArn (string) --
    
    The Amazon Resource Name (ARN) of the AI Prompt.
  - aiPromptId (string) --
    
    The identifier of the Amazon Q in Connect AI prompt.
  - apiFormat (string) --
    
    The API format used for this AI Prompt.
  - 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.
  - description (string) --
    
    The description of the AI Prompt.
  - modelId (string) --
    
    The identifier of the model used for this AI Prompt. Model Ids supported are: CLAUDE_3_HAIKU_20240307_V1 .
  - modifiedTime (datetime) --
    
    The time the AI Prompt was last modified.
  - name (string) --
    
    The name of the AI Prompt
  - origin (string) --
    
    The origin of the AI Prompt. SYSTEM for a default AI Prompt created by Q in Connect or CUSTOMER for an AI Prompt created by calling AI Prompt creation APIs.
  - status (string) --
    
    The status of the AI Prompt.
  - tags (dict) --
    
    The tags used to organize, track, or control access for this resource.
    - (string) --
      - (string) --
  - templateConfiguration (dict) --
    
    The configuration of the prompt template for this AI Prompt.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: textFullAIPromptEditTemplateConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - textFullAIPromptEditTemplateConfiguration (dict) --
      
      The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt.
      - text (string) --
        
        The YAML text for the AI Prompt template.
  - templateType (string) --
    
    The type of the prompt template for this AI Prompt.
  - type (string) --
    
    The type of this AI Prompt.
  - visibilityStatus (string) --
    
    The visibility status of the AI Prompt.

DeleteAIPromptVersion (new)

Link ¶

Delete and Amazon Q in Connect AI Prompt version.

See also: AWS API Documentation

Request Syntax

client.delete_ai_prompt_version(
    aiPromptId='string',
    assistantId='string',
    versionNumber=123
)

type aiPromptId

string

param aiPromptId

[REQUIRED]

The identifier of the Amazon Q in Connect AI prompt.

type assistantId

string

param assistantId

[REQUIRED]

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

type versionNumber

integer

param versionNumber

[REQUIRED]

The version number of the AI Prompt version to be deleted.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

GetAIAgent (new)

Link ¶

Gets an Amazon Q in Connect AI Agent.

See also: AWS API Documentation

Request Syntax

client.get_ai_agent(
    aiAgentId='string',
    assistantId='string'
)

type aiAgentId

string

param aiAgentId

[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.

type assistantId

string

param assistantId

[REQUIRED]

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

rtype

dict

returns

Response Syntax

{
    'aiAgent': {
        'aiAgentArn': 'string',
        'aiAgentId': 'string',
        'assistantArn': 'string',
        'assistantId': 'string',
        'configuration': {
            'answerRecommendationAIAgentConfiguration': {
                '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',
                'queryReformulationAIPromptId': 'string'
            },
            'manualSearchAIAgentConfiguration': {
                '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'
                    },
                ]
            }
        },
        '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',
        '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.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: answerRecommendationAIAgentConfiguration, manualSearchAIAgentConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - answerRecommendationAIAgentConfiguration (dict) --
      
      The configuration for AI Agents of type ANSWER_RECOMMENDATION .
      - 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.
        
        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 set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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: andConditions, orConditions, tagCondition. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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.
        
        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 set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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.
        
        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.
      - 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 .
      - 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.
        
        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 set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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: andConditions, orConditions, tagCondition. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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.
        
        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 set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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.
        
        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.
  - 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).

DeleteAIPrompt (new)

Link ¶

Deletes an Amazon Q in Connect AI Prompt.

See also: AWS API Documentation

Request Syntax

client.delete_ai_prompt(
    aiPromptId='string',
    assistantId='string'
)

type aiPromptId

string

param aiPromptId

[REQUIRED]

The identifier of the Amazon Q in Connect AI prompt. Can be either the ID or the ARN. URLs cannot contain the ARN.

type assistantId

string

param assistantId

[REQUIRED]

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

UpdateAIPrompt (new)

Link ¶

Updates an AI Prompt.

See also: AWS API Documentation

Request Syntax

client.update_ai_prompt(
    aiPromptId='string',
    assistantId='string',
    clientToken='string',
    description='string',
    templateConfiguration={
        'textFullAIPromptEditTemplateConfiguration': {
            'text': 'string'
        }
    },
    visibilityStatus='SAVED'|'PUBLISHED'
)

type aiPromptId

string

param aiPromptId

[REQUIRED]

The identifier of the Amazon Q in Connect AI Prompt.

type assistantId

string

param assistantId

[REQUIRED]

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

type clientToken

string

param clientToken

This field is autopopulated if not provided.

type description

string

param description

The description of the Amazon Q in Connect AI Prompt.

type templateConfiguration

dict

param templateConfiguration

The configuration of the prompt template for this AI Prompt.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: textFullAIPromptEditTemplateConfiguration.

textFullAIPromptEditTemplateConfiguration (dict) --

The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt.
- text (string) -- [REQUIRED]
  
  The YAML text for the AI Prompt template.

type visibilityStatus

string

param visibilityStatus

[REQUIRED]

The visibility status of the Amazon Q in Connect AI prompt.

rtype

dict

returns

Response Syntax

{
    'aiPrompt': {
        'aiPromptArn': 'string',
        'aiPromptId': 'string',
        'apiFormat': 'ANTHROPIC_CLAUDE_MESSAGES'|'ANTHROPIC_CLAUDE_TEXT_COMPLETIONS',
        'assistantArn': 'string',
        'assistantId': 'string',
        'description': 'string',
        'modelId': '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'
        },
        'templateConfiguration': {
            'textFullAIPromptEditTemplateConfiguration': {
                'text': 'string'
            }
        },
        'templateType': 'TEXT',
        'type': 'ANSWER_GENERATION'|'INTENT_LABELING_GENERATION'|'QUERY_REFORMULATION',
        'visibilityStatus': 'SAVED'|'PUBLISHED'
    }
}

Response Structure

(dict) --
- aiPrompt (dict) --
  
  The data of the updated Amazon Q in Connect AI Prompt.
  - aiPromptArn (string) --
    
    The Amazon Resource Name (ARN) of the AI Prompt.
  - aiPromptId (string) --
    
    The identifier of the Amazon Q in Connect AI prompt.
  - apiFormat (string) --
    
    The API format used for this AI Prompt.
  - 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.
  - description (string) --
    
    The description of the AI Prompt.
  - modelId (string) --
    
    The identifier of the model used for this AI Prompt. Model Ids supported are: CLAUDE_3_HAIKU_20240307_V1 .
  - modifiedTime (datetime) --
    
    The time the AI Prompt was last modified.
  - name (string) --
    
    The name of the AI Prompt
  - origin (string) --
    
    The origin of the AI Prompt. SYSTEM for a default AI Prompt created by Q in Connect or CUSTOMER for an AI Prompt created by calling AI Prompt creation APIs.
  - status (string) --
    
    The status of the AI Prompt.
  - tags (dict) --
    
    The tags used to organize, track, or control access for this resource.
    - (string) --
      - (string) --
  - templateConfiguration (dict) --
    
    The configuration of the prompt template for this AI Prompt.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: textFullAIPromptEditTemplateConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - textFullAIPromptEditTemplateConfiguration (dict) --
      
      The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt.
      - text (string) --
        
        The YAML text for the AI Prompt template.
  - templateType (string) --
    
    The type of the prompt template for this AI Prompt.
  - type (string) --
    
    The type of this AI Prompt.
  - visibilityStatus (string) --
    
    The visibility status of the AI Prompt.

CreateAssistant (updated)

Link ¶
Changes (response)

{'assistant': {'aiAgentConfiguration': {'MANUAL_SEARCH | ANSWER_RECOMMENDATION': {'aiAgentId': 'string'}}}}

Creates an Amazon Q in Connect assistant.

See also: AWS API Documentation

Request Syntax

client.create_assistant(
    clientToken='string',
    description='string',
    name='string',
    serverSideEncryptionConfiguration={
        'kmsKeyId': 'string'
    },
    tags={
        'string': 'string'
    },
    type='AGENT'
)

type clientToken

string

param clientToken

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.

type description

string

param description

The description of the assistant.

type name

string

param name

[REQUIRED]

The name of the assistant.

type serverSideEncryptionConfiguration

dict

param serverSideEncryptionConfiguration

The configuration information for the customer managed key used for encryption.

The customer managed key must have a policy that allows kms:CreateGrant , kms:DescribeKey , kms:Decrypt , and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow kms:Decrypt , kms:GenerateDataKey* , and kms:DescribeKey permissions to the connect.amazonaws.com service principal.

For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.

kmsKeyId (string) --

The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. For information about valid ID values, see Key identifiers (KeyId).

type tags

dict

param tags

The tags used to organize, track, or control access for this resource.

(string) --
- (string) --

type type

string

param type

[REQUIRED]

The type of assistant.

rtype

dict

returns

Response Syntax

{
    'assistant': {
        'aiAgentConfiguration': {
            'string': {
                'aiAgentId': 'string'
            }
        },
        'assistantArn': 'string',
        'assistantId': 'string',
        'capabilityConfiguration': {
            'type': 'V1'|'V2'
        },
        'description': 'string',
        'integrationConfiguration': {
            'topicIntegrationArn': 'string'
        },
        'name': 'string',
        'serverSideEncryptionConfiguration': {
            'kmsKeyId': 'string'
        },
        'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED',
        'tags': {
            'string': 'string'
        },
        'type': 'AGENT'
    }
}

Response Structure

(dict) --
- assistant (dict) --
  
  Information about the assistant.
  - aiAgentConfiguration (dict) --
    
    The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that is set on the Amazon Q in Connect Assistant.
    - (string) --
      - (dict) --
        
        A type that specifies the AI Agent ID configuration data when mapping an AI Agents to be used for an AI Agent type on a session or assistant.
        
        aiAgentId (string) --
        
        The ID of the AI Agent to be configured.
  - 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.
  - capabilityConfiguration (dict) --
    
    The configuration information for the Amazon Q in Connect assistant capability.
    - type (string) --
      
      The type of Amazon Q in Connect assistant capability.
  - description (string) --
    
    The description.
  - integrationConfiguration (dict) --
    
    The configuration information for the Amazon Q in Connect assistant integration.
    - topicIntegrationArn (string) --
      
      The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.
  - name (string) --
    
    The name.
  - serverSideEncryptionConfiguration (dict) --
    
    The configuration information for the customer managed key used for encryption.
    
    This KMS key must have a policy that allows kms:CreateGrant , kms:DescribeKey , kms:Decrypt , and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow kms:Decrypt , kms:GenerateDataKey* , and kms:DescribeKey permissions to the connect.amazonaws.com service principal.
    
    For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.
    - kmsKeyId (string) --
      
      The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. For information about valid ID values, see Key identifiers (KeyId).
  - status (string) --
    
    The status of the assistant.
  - tags (dict) --
    
    The tags used to organize, track, or control access for this resource.
    - (string) --
      - (string) --
  - type (string) --
    
    The type of assistant.

CreateKnowledgeBase (updated)

Link ¶
Changes (request, response)
Request

{'knowledgeBaseType': {'MESSAGE_TEMPLATES', 'MANAGED'},
 'sourceConfiguration': {'managedSourceConfiguration': {'webCrawlerConfiguration': {'crawlerLimits': {'rateLimit': 'integer'},
                                                                                    'exclusionFilters': ['string'],
                                                                                    'inclusionFilters': ['string'],
                                                                                    'scope': 'HOST_ONLY '
                                                                                             '| '
                                                                                             'SUBDOMAINS',
                                                                                    'urlConfiguration': {'seedUrls': [{'url': 'string'}]}}}},
 'vectorIngestionConfiguration': {'chunkingConfiguration': {'chunkingStrategy': 'FIXED_SIZE '
                                                                                '| '
                                                                                'NONE '
                                                                                '| '
                                                                                'HIERARCHICAL '
                                                                                '| '
                                                                                'SEMANTIC',
                                                            'fixedSizeChunkingConfiguration': {'maxTokens': 'integer',
                                                                                               'overlapPercentage': 'integer'},
                                                            'hierarchicalChunkingConfiguration': {'levelConfigurations': [{'maxTokens': 'integer'}],
                                                                                                  'overlapTokens': 'integer'},
                                                            'semanticChunkingConfiguration': {'breakpointPercentileThreshold': 'integer',
                                                                                              'bufferSize': 'integer',
                                                                                              'maxTokens': 'integer'}},
                                  'parsingConfiguration': {'bedrockFoundationModelConfiguration': {'modelArn': 'string',
                                                                                                   'parsingPrompt': {'parsingPromptText': 'string'}},
                                                           'parsingStrategy': 'BEDROCK_FOUNDATION_MODEL'}}}

Response

{'knowledgeBase': {'ingestionFailureReasons': ['string'],
                   'ingestionStatus': 'SYNC_FAILED | SYNCING_IN_PROGRESS | '
                                      'SYNC_SUCCESS | CREATE_IN_PROGRESS',
                   'knowledgeBaseType': {'MESSAGE_TEMPLATES', 'MANAGED'},
                   'sourceConfiguration': {'managedSourceConfiguration': {'webCrawlerConfiguration': {'crawlerLimits': {'rateLimit': 'integer'},
                                                                                                      'exclusionFilters': ['string'],
                                                                                                      'inclusionFilters': ['string'],
                                                                                                      'scope': 'HOST_ONLY '
                                                                                                               '| '
                                                                                                               'SUBDOMAINS',
                                                                                                      'urlConfiguration': {'seedUrls': [{'url': 'string'}]}}}},
                   'vectorIngestionConfiguration': {'chunkingConfiguration': {'chunkingStrategy': 'FIXED_SIZE '
                                                                                                  '| '
                                                                                                  'NONE '
                                                                                                  '| '
                                                                                                  'HIERARCHICAL '
                                                                                                  '| '
                                                                                                  'SEMANTIC',
                                                                              'fixedSizeChunkingConfiguration': {'maxTokens': 'integer',
                                                                                                                 'overlapPercentage': 'integer'},
                                                                              'hierarchicalChunkingConfiguration': {'levelConfigurations': [{'maxTokens': 'integer'}],
                                                                                                                    'overlapTokens': 'integer'},
                                                                              'semanticChunkingConfiguration': {'breakpointPercentileThreshold': 'integer',
                                                                                                                'bufferSize': 'integer',
                                                                                                                'maxTokens': 'integer'}},
                                                    'parsingConfiguration': {'bedrockFoundationModelConfiguration': {'modelArn': 'string',
                                                                                                                     'parsingPrompt': {'parsingPromptText': 'string'}},
                                                                             'parsingStrategy': 'BEDROCK_FOUNDATION_MODEL'}}}}

Creates a knowledge base.

Note

When using this API, you cannot reuse Amazon AppIntegrations DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do, you'll get an InvalidRequestException error.

For example, you're programmatically managing your external knowledge base, and you want to add or remove one of the fields that is being ingested from Salesforce. Do the following:

Call DeleteKnowledgeBase.
Call DeleteDataIntegration.
Call CreateDataIntegration to recreate the DataIntegration or a create different one.
Call CreateKnowledgeBase.

See also: AWS API Documentation

Request Syntax

client.create_knowledge_base(
    clientToken='string',
    description='string',
    knowledgeBaseType='EXTERNAL'|'CUSTOM'|'QUICK_RESPONSES'|'MESSAGE_TEMPLATES'|'MANAGED',
    name='string',
    renderingConfiguration={
        'templateUri': 'string'
    },
    serverSideEncryptionConfiguration={
        'kmsKeyId': 'string'
    },
    sourceConfiguration={
        'appIntegrations': {
            'appIntegrationArn': 'string',
            'objectFields': [
                'string',
            ]
        },
        'managedSourceConfiguration': {
            'webCrawlerConfiguration': {
                'crawlerLimits': {
                    'rateLimit': 123
                },
                'exclusionFilters': [
                    'string',
                ],
                'inclusionFilters': [
                    'string',
                ],
                'scope': 'HOST_ONLY'|'SUBDOMAINS',
                'urlConfiguration': {
                    'seedUrls': [
                        {
                            'url': 'string'
                        },
                    ]
                }
            }
        }
    },
    tags={
        'string': 'string'
    },
    vectorIngestionConfiguration={
        'chunkingConfiguration': {
            'chunkingStrategy': 'FIXED_SIZE'|'NONE'|'HIERARCHICAL'|'SEMANTIC',
            'fixedSizeChunkingConfiguration': {
                'maxTokens': 123,
                'overlapPercentage': 123
            },
            'hierarchicalChunkingConfiguration': {
                'levelConfigurations': [
                    {
                        'maxTokens': 123
                    },
                ],
                'overlapTokens': 123
            },
            'semanticChunkingConfiguration': {
                'breakpointPercentileThreshold': 123,
                'bufferSize': 123,
                'maxTokens': 123
            }
        },
        'parsingConfiguration': {
            'bedrockFoundationModelConfiguration': {
                'modelArn': 'string',
                'parsingPrompt': {
                    'parsingPromptText': 'string'
                }
            },
            'parsingStrategy': 'BEDROCK_FOUNDATION_MODEL'
        }
    }
)

type clientToken

string

param clientToken

This field is autopopulated if not provided.

type description

string

param description

The description.

type knowledgeBaseType

string

param knowledgeBaseType

[REQUIRED]

The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.

type name

string

param name

[REQUIRED]

The name of the knowledge base.

type renderingConfiguration

dict

param renderingConfiguration

Information about how to render the content.

templateUri (string) --

A URI template containing exactly one variable in ${variableName} format. This can only be set for EXTERNAL knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following:
- Salesforce: Id , ArticleNumber , VersionNumber , Title , PublishStatus , or IsDeleted
- ServiceNow: number , short_description , sys_mod_count , workflow_state , or active
- Zendesk: id , title , updated_at , or draft
The variable is replaced with the actual value for a piece of content when calling GetContent.

type serverSideEncryptionConfiguration

dict

param serverSideEncryptionConfiguration

The configuration information for the customer managed key used for encryption.

This KMS key must have a policy that allows kms:CreateGrant , kms:DescribeKey , kms:Decrypt , and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect.

For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.

kmsKeyId (string) --

The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. For information about valid ID values, see Key identifiers (KeyId).

type sourceConfiguration

dict

param sourceConfiguration

The source of the knowledge base content. Only set this argument for EXTERNAL knowledge bases.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: appIntegrations, managedSourceConfiguration.

appIntegrations (dict) --

Configuration information for Amazon AppIntegrations to automatically ingest content.
- appIntegrationArn (string) -- [REQUIRED]
  
  The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.
  - For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least Id , ArticleNumber , VersionNumber , Title , PublishStatus , and IsDeleted as source fields.
  - For ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least number , short_description , sys_mod_count , workflow_state , and active as source fields.
  - For Zendesk, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least id , title , updated_at , and draft as source fields.
  - For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among docx , pdf , html , htm , and txt .
  - For Amazon S3, the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The SourceURI of your DataIntegration must use the following format: s3://your_s3_bucket_name .
  Warning
  
  The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principal app-integrations.amazonaws.com to perform s3:ListBucket , s3:GetObject , and s3:GetBucketLocation against the bucket.
- objectFields (list) --
  
  The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if ObjectConfiguration is included in the provided DataIntegration.
  - For Salesforce, you must include at least Id , ArticleNumber , VersionNumber , Title , PublishStatus , and IsDeleted .
  - For ServiceNow, you must include at least number , short_description , sys_mod_count , workflow_state , and active .
  - For Zendesk, you must include at least id , title , updated_at , and draft .
  Make sure to include additional fields. These fields are indexed and used to source recommendations.
  - (string) --
managedSourceConfiguration (dict) --

Source configuration for managed resources.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: webCrawlerConfiguration.
- webCrawlerConfiguration (dict) --
  
  Configuration data for web crawler data source.
  - crawlerLimits (dict) --
    
    The configuration of crawl limits for the web URLs.
    - rateLimit (integer) --
      
      Rate of web URLs retrieved per minute.
  - exclusionFilters (list) --
    
    A list of one or more exclusion regular expression patterns to exclude certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
    - (string) --
  - inclusionFilters (list) --
    
    A list of one or more inclusion regular expression patterns to include certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
    - (string) --
  - scope (string) --
    
    The scope of what is crawled for your URLs. You can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL https://docs.aws.amazon.com/bedrock/latest/userguide/ and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain aws.amazon.com can also include sub domain docs.aws.amazon.com .
  - urlConfiguration (dict) -- [REQUIRED]
    
    The configuration of the URL/URLs for the web content that you want to crawl. You should be authorized to crawl the URLs.
    - seedUrls (list) --
      
      List of URLs for crawling.
      - (dict) --
        
        A URL for crawling.
        
        url (string) --
        
        URL for crawling

type tags

dict

param tags

The tags used to organize, track, or control access for this resource.

(string) --
- (string) --

type vectorIngestionConfiguration

dict

param vectorIngestionConfiguration

Contains details about how to ingest the documents in a data source.

chunkingConfiguration (dict) --

Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
- chunkingStrategy (string) -- [REQUIRED]
  
  Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE , then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.
- fixedSizeChunkingConfiguration (dict) --
  
  Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE , exclude this field.
  - maxTokens (integer) -- [REQUIRED]
    
    The maximum number of tokens to include in a chunk.
  - overlapPercentage (integer) -- [REQUIRED]
    
    The percentage of overlap between adjacent chunks of a data source.
- hierarchicalChunkingConfiguration (dict) --
  
  Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.
  - levelConfigurations (list) -- [REQUIRED]
    
    Token settings for each layer.
    - (dict) --
      
      Token settings for each layer.
      - maxTokens (integer) -- [REQUIRED]
        
        The maximum number of tokens that a chunk can contain in this layer.
  - overlapTokens (integer) -- [REQUIRED]
    
    The number of tokens to repeat across chunks in the same layer.
- semanticChunkingConfiguration (dict) --
  
  Settings for semantic document chunking for a data source. Semantic chunking splits a document into smaller documents based on groups of similar content derived from the text with natural language processing.
  - breakpointPercentileThreshold (integer) -- [REQUIRED]
    
    The dissimilarity threshold for splitting chunks.
  - bufferSize (integer) -- [REQUIRED]
    
    The buffer size.
  - maxTokens (integer) -- [REQUIRED]
    
    The maximum number of tokens that a chunk can contain.
parsingConfiguration (dict) --

A custom parser for data source documents.
- bedrockFoundationModelConfiguration (dict) --
  
  Settings for a foundation model used to parse documents for a data source.
  - modelArn (string) -- [REQUIRED]
    
    The ARN of the foundation model.
  - parsingPrompt (dict) --
    
    Instructions for interpreting the contents of a document.
    - parsingPromptText (string) -- [REQUIRED]
      
      Instructions for interpreting the contents of a document.
- parsingStrategy (string) -- [REQUIRED]
  
  The parsing strategy for the data source.

rtype

dict

returns

Response Syntax

{
    'knowledgeBase': {
        'description': 'string',
        'ingestionFailureReasons': [
            'string',
        ],
        'ingestionStatus': 'SYNC_FAILED'|'SYNCING_IN_PROGRESS'|'SYNC_SUCCESS'|'CREATE_IN_PROGRESS',
        'knowledgeBaseArn': 'string',
        'knowledgeBaseId': 'string',
        'knowledgeBaseType': 'EXTERNAL'|'CUSTOM'|'QUICK_RESPONSES'|'MESSAGE_TEMPLATES'|'MANAGED',
        'lastContentModificationTime': datetime(2015, 1, 1),
        'name': 'string',
        'renderingConfiguration': {
            'templateUri': 'string'
        },
        'serverSideEncryptionConfiguration': {
            'kmsKeyId': 'string'
        },
        'sourceConfiguration': {
            'appIntegrations': {
                'appIntegrationArn': 'string',
                'objectFields': [
                    'string',
                ]
            },
            'managedSourceConfiguration': {
                'webCrawlerConfiguration': {
                    'crawlerLimits': {
                        'rateLimit': 123
                    },
                    'exclusionFilters': [
                        'string',
                    ],
                    'inclusionFilters': [
                        'string',
                    ],
                    'scope': 'HOST_ONLY'|'SUBDOMAINS',
                    'urlConfiguration': {
                        'seedUrls': [
                            {
                                'url': 'string'
                            },
                        ]
                    }
                }
            }
        },
        'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED',
        'tags': {
            'string': 'string'
        },
        'vectorIngestionConfiguration': {
            'chunkingConfiguration': {
                'chunkingStrategy': 'FIXED_SIZE'|'NONE'|'HIERARCHICAL'|'SEMANTIC',
                'fixedSizeChunkingConfiguration': {
                    'maxTokens': 123,
                    'overlapPercentage': 123
                },
                'hierarchicalChunkingConfiguration': {
                    'levelConfigurations': [
                        {
                            'maxTokens': 123
                        },
                    ],
                    'overlapTokens': 123
                },
                'semanticChunkingConfiguration': {
                    'breakpointPercentileThreshold': 123,
                    'bufferSize': 123,
                    'maxTokens': 123
                }
            },
            'parsingConfiguration': {
                'bedrockFoundationModelConfiguration': {
                    'modelArn': 'string',
                    'parsingPrompt': {
                        'parsingPromptText': 'string'
                    }
                },
                'parsingStrategy': 'BEDROCK_FOUNDATION_MODEL'
            }
        }
    }
}

Response Structure

(dict) --
- knowledgeBase (dict) --
  
  The knowledge base.
  - description (string) --
    
    The description.
  - ingestionFailureReasons (list) --
    
    List of failure reasons on ingestion per file.
    - (string) --
  - ingestionStatus (string) --
    
    Status of ingestion on data source.
  - knowledgeBaseArn (string) --
    
    The Amazon Resource Name (ARN) of the knowledge base.
  - knowledgeBaseId (string) --
    
    The identifier of the knowledge base.
  - knowledgeBaseType (string) --
    
    The type of knowledge base.
  - lastContentModificationTime (datetime) --
    
    An epoch timestamp indicating the most recent content modification inside the knowledge base. If no content exists in a knowledge base, this value is unset.
  - name (string) --
    
    The name of the knowledge base.
  - renderingConfiguration (dict) --
    
    Information about how to render the content.
    - templateUri (string) --
      
      A URI template containing exactly one variable in ${variableName} format. This can only be set for EXTERNAL knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following:
      - Salesforce: Id , ArticleNumber , VersionNumber , Title , PublishStatus , or IsDeleted
      - ServiceNow: number , short_description , sys_mod_count , workflow_state , or active
      - Zendesk: id , title , updated_at , or draft
      The variable is replaced with the actual value for a piece of content when calling GetContent.
  - serverSideEncryptionConfiguration (dict) --
    
    The configuration information for the customer managed key used for encryption.
    
    This KMS key must have a policy that allows kms:CreateGrant , kms:DescribeKey , kms:Decrypt , and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect.
    
    For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.
    - kmsKeyId (string) --
      
      The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. For information about valid ID values, see Key identifiers (KeyId).
  - sourceConfiguration (dict) --
    
    Source configuration information about the knowledge base.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: appIntegrations, managedSourceConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - appIntegrations (dict) --
      
      Configuration information for Amazon AppIntegrations to automatically ingest content.
      - appIntegrationArn (string) --
        
        The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.
        
        For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least Id , ArticleNumber , VersionNumber , Title , PublishStatus , and IsDeleted as source fields.
        
        For ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least number , short_description , sys_mod_count , workflow_state , and active as source fields.
        
        For Zendesk, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least id , title , updated_at , and draft as source fields.
        
        For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among docx , pdf , html , htm , and txt .
        
        For Amazon S3, the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The SourceURI of your DataIntegration must use the following format: s3://your_s3_bucket_name .
        
        Warning
        
        The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principal app-integrations.amazonaws.com to perform s3:ListBucket , s3:GetObject , and s3:GetBucketLocation against the bucket.
      - objectFields (list) --
        
        The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if ObjectConfiguration is included in the provided DataIntegration.
        
        For Salesforce, you must include at least Id , ArticleNumber , VersionNumber , Title , PublishStatus , and IsDeleted .
        
        For ServiceNow, you must include at least number , short_description , sys_mod_count , workflow_state , and active .
        
        For Zendesk, you must include at least id , title , updated_at , and draft .
        
        Make sure to include additional fields. These fields are indexed and used to source recommendations.
        
        (string) --
    - managedSourceConfiguration (dict) --
      
      Source configuration for managed resources.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: webCrawlerConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - webCrawlerConfiguration (dict) --
        
        Configuration data for web crawler data source.
        
        crawlerLimits (dict) --
        
        The configuration of crawl limits for the web URLs.
        
        rateLimit (integer) --
        
        Rate of web URLs retrieved per minute.
        
        exclusionFilters (list) --
        
        A list of one or more exclusion regular expression patterns to exclude certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
        
        (string) --
        
        inclusionFilters (list) --
        
        A list of one or more inclusion regular expression patterns to include certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
        
        (string) --
        
        scope (string) --
        
        The scope of what is crawled for your URLs. You can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL https://docs.aws.amazon.com/bedrock/latest/userguide/ and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain aws.amazon.com can also include sub domain docs.aws.amazon.com .
        
        urlConfiguration (dict) --
        
        The configuration of the URL/URLs for the web content that you want to crawl. You should be authorized to crawl the URLs.
        
        seedUrls (list) --
        
        List of URLs for crawling.
        
        (dict) --
        
        A URL for crawling.
        
        url (string) --
        
        URL for crawling
  - status (string) --
    
    The status of the knowledge base.
  - tags (dict) --
    
    The tags used to organize, track, or control access for this resource.
    - (string) --
      - (string) --
  - vectorIngestionConfiguration (dict) --
    
    Contains details about how to ingest the documents in a data source.
    - chunkingConfiguration (dict) --
      
      Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
      - chunkingStrategy (string) --
        
        Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE , then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.
      - fixedSizeChunkingConfiguration (dict) --
        
        Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE , exclude this field.
        
        maxTokens (integer) --
        
        The maximum number of tokens to include in a chunk.
        
        overlapPercentage (integer) --
        
        The percentage of overlap between adjacent chunks of a data source.
      - hierarchicalChunkingConfiguration (dict) --
        
        Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.
        
        levelConfigurations (list) --
        
        Token settings for each layer.
        
        (dict) --
        
        Token settings for each layer.
        
        maxTokens (integer) --
        
        The maximum number of tokens that a chunk can contain in this layer.
        
        overlapTokens (integer) --
        
        The number of tokens to repeat across chunks in the same layer.
      - semanticChunkingConfiguration (dict) --
        
        Settings for semantic document chunking for a data source. Semantic chunking splits a document into smaller documents based on groups of similar content derived from the text with natural language processing.
        
        breakpointPercentileThreshold (integer) --
        
        The dissimilarity threshold for splitting chunks.
        
        bufferSize (integer) --
        
        The buffer size.
        
        maxTokens (integer) --
        
        The maximum number of tokens that a chunk can contain.
    - parsingConfiguration (dict) --
      
      A custom parser for data source documents.
      - bedrockFoundationModelConfiguration (dict) --
        
        Settings for a foundation model used to parse documents for a data source.
        
        modelArn (string) --
        
        The ARN of the foundation model.
        
        parsingPrompt (dict) --
        
        Instructions for interpreting the contents of a document.
        
        parsingPromptText (string) --
        
        Instructions for interpreting the contents of a document.
      - parsingStrategy (string) --
        
        The parsing strategy for the data source.

CreateSession (updated)

Link ¶
Changes (request, response)
Request

{'aiAgentConfiguration': {'MANUAL_SEARCH | ANSWER_RECOMMENDATION': {'aiAgentId': 'string'}}}

Response

{'session': {'aiAgentConfiguration': {'MANUAL_SEARCH | ANSWER_RECOMMENDATION': {'aiAgentId': 'string'}}}}

Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.

See also: AWS API Documentation

Request Syntax

client.create_session(
    aiAgentConfiguration={
        'string': {
            'aiAgentId': 'string'
        }
    },
    assistantId='string',
    clientToken='string',
    description='string',
    name='string',
    tagFilter={
        'andConditions': [
            {
                'key': 'string',
                'value': 'string'
            },
        ],
        'orConditions': [
            {
                'andConditions': [
                    {
                        'key': 'string',
                        'value': 'string'
                    },
                ],
                'tagCondition': {
                    'key': 'string',
                    'value': 'string'
                }
            },
        ],
        'tagCondition': {
            'key': 'string',
            'value': 'string'
        }
    },
    tags={
        'string': 'string'
    }
)

type aiAgentConfiguration

dict

param aiAgentConfiguration

The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session.

(string) --
- (dict) --
  
  A type that specifies the AI Agent ID configuration data when mapping an AI Agents to be used for an AI Agent type on a session or assistant.
  - aiAgentId (string) -- [REQUIRED]
    
    The ID of the AI Agent to be configured.

type assistantId

string

param assistantId

[REQUIRED]

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

type clientToken

string

param clientToken

This field is autopopulated if not provided.

type description

string

param description

The description.

type name

string

param name

[REQUIRED]

The name of the session.

type tagFilter

dict

param tagFilter

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: andConditions, orConditions, 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.
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.
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.

type tags

dict

param tags

The tags used to organize, track, or control access for this resource.

(string) --
- (string) --

rtype

dict

returns

Response Syntax

{
    'session': {
        'aiAgentConfiguration': {
            'string': {
                'aiAgentId': 'string'
            }
        },
        'description': 'string',
        'integrationConfiguration': {
            'topicIntegrationArn': 'string'
        },
        'name': 'string',
        'sessionArn': 'string',
        'sessionId': 'string',
        'tagFilter': {
            'andConditions': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'orConditions': [
                {
                    'andConditions': [
                        {
                            'key': 'string',
                            'value': 'string'
                        },
                    ],
                    'tagCondition': {
                        'key': 'string',
                        'value': 'string'
                    }
                },
            ],
            'tagCondition': {
                'key': 'string',
                'value': 'string'
            }
        },
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

(dict) --
- session (dict) --
  
  The session.
  - aiAgentConfiguration (dict) --
    
    The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session.
    - (string) --
      - (dict) --
        
        A type that specifies the AI Agent ID configuration data when mapping an AI Agents to be used for an AI Agent type on a session or assistant.
        
        aiAgentId (string) --
        
        The ID of the AI Agent to be configured.
  - description (string) --
    
    The description of the session.
  - integrationConfiguration (dict) --
    
    The configuration information for the session integration.
    - topicIntegrationArn (string) --
      
      The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.
  - name (string) --
    
    The name of the session.
  - sessionArn (string) --
    
    The Amazon Resource Name (ARN) of the session.
  - sessionId (string) --
    
    The identifier of the session.
  - tagFilter (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: andConditions, orConditions, tagCondition. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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.
    - 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 set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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.
    - 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.
  - tags (dict) --
    
    The tags used to organize, track, or control access for this resource.
    - (string) --
      - (string) --

GetAssistant (updated)

Link ¶
Changes (response)

{'assistant': {'aiAgentConfiguration': {'MANUAL_SEARCH | ANSWER_RECOMMENDATION': {'aiAgentId': 'string'}}}}

Retrieves information about an assistant.

See also: AWS API Documentation

Request Syntax

client.get_assistant(
    assistantId='string'
)

type assistantId

string

param assistantId

[REQUIRED]

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

rtype

dict

returns

Response Syntax

{
    'assistant': {
        'aiAgentConfiguration': {
            'string': {
                'aiAgentId': 'string'
            }
        },
        'assistantArn': 'string',
        'assistantId': 'string',
        'capabilityConfiguration': {
            'type': 'V1'|'V2'
        },
        'description': 'string',
        'integrationConfiguration': {
            'topicIntegrationArn': 'string'
        },
        'name': 'string',
        'serverSideEncryptionConfiguration': {
            'kmsKeyId': 'string'
        },
        'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED',
        'tags': {
            'string': 'string'
        },
        'type': 'AGENT'
    }
}

Response Structure

(dict) --
- assistant (dict) --
  
  Information about the assistant.
  - aiAgentConfiguration (dict) --
    
    The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that is set on the Amazon Q in Connect Assistant.
    - (string) --
      - (dict) --
        
        A type that specifies the AI Agent ID configuration data when mapping an AI Agents to be used for an AI Agent type on a session or assistant.
        
        aiAgentId (string) --
        
        The ID of the AI Agent to be configured.
  - 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.
  - capabilityConfiguration (dict) --
    
    The configuration information for the Amazon Q in Connect assistant capability.
    - type (string) --
      
      The type of Amazon Q in Connect assistant capability.
  - description (string) --
    
    The description.
  - integrationConfiguration (dict) --
    
    The configuration information for the Amazon Q in Connect assistant integration.
    - topicIntegrationArn (string) --
      
      The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.
  - name (string) --
    
    The name.
  - serverSideEncryptionConfiguration (dict) --
    
    The configuration information for the customer managed key used for encryption.
    
    This KMS key must have a policy that allows kms:CreateGrant , kms:DescribeKey , kms:Decrypt , and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow kms:Decrypt , kms:GenerateDataKey* , and kms:DescribeKey permissions to the connect.amazonaws.com service principal.
    
    For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.
    - kmsKeyId (string) --
      
      The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. For information about valid ID values, see Key identifiers (KeyId).
  - status (string) --
    
    The status of the assistant.
  - tags (dict) --
    
    The tags used to organize, track, or control access for this resource.
    - (string) --
      - (string) --
  - type (string) --
    
    The type of assistant.

GetKnowledgeBase (updated)

Link ¶
Changes (response)

{'knowledgeBase': {'ingestionFailureReasons': ['string'],
                   'ingestionStatus': 'SYNC_FAILED | SYNCING_IN_PROGRESS | '
                                      'SYNC_SUCCESS | CREATE_IN_PROGRESS',
                   'knowledgeBaseType': {'MESSAGE_TEMPLATES', 'MANAGED'},
                   'sourceConfiguration': {'managedSourceConfiguration': {'webCrawlerConfiguration': {'crawlerLimits': {'rateLimit': 'integer'},
                                                                                                      'exclusionFilters': ['string'],
                                                                                                      'inclusionFilters': ['string'],
                                                                                                      'scope': 'HOST_ONLY '
                                                                                                               '| '
                                                                                                               'SUBDOMAINS',
                                                                                                      'urlConfiguration': {'seedUrls': [{'url': 'string'}]}}}},
                   'vectorIngestionConfiguration': {'chunkingConfiguration': {'chunkingStrategy': 'FIXED_SIZE '
                                                                                                  '| '
                                                                                                  'NONE '
                                                                                                  '| '
                                                                                                  'HIERARCHICAL '
                                                                                                  '| '
                                                                                                  'SEMANTIC',
                                                                              'fixedSizeChunkingConfiguration': {'maxTokens': 'integer',
                                                                                                                 'overlapPercentage': 'integer'},
                                                                              'hierarchicalChunkingConfiguration': {'levelConfigurations': [{'maxTokens': 'integer'}],
                                                                                                                    'overlapTokens': 'integer'},
                                                                              'semanticChunkingConfiguration': {'breakpointPercentileThreshold': 'integer',
                                                                                                                'bufferSize': 'integer',
                                                                                                                'maxTokens': 'integer'}},
                                                    'parsingConfiguration': {'bedrockFoundationModelConfiguration': {'modelArn': 'string',
                                                                                                                     'parsingPrompt': {'parsingPromptText': 'string'}},
                                                                             'parsingStrategy': 'BEDROCK_FOUNDATION_MODEL'}}}}

Retrieves information about the knowledge base.

See also: AWS API Documentation

Request Syntax

client.get_knowledge_base(
    knowledgeBaseId='string'
)

type knowledgeBaseId

string

param knowledgeBaseId

[REQUIRED]

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

rtype

dict

returns

Response Syntax

{
    'knowledgeBase': {
        'description': 'string',
        'ingestionFailureReasons': [
            'string',
        ],
        'ingestionStatus': 'SYNC_FAILED'|'SYNCING_IN_PROGRESS'|'SYNC_SUCCESS'|'CREATE_IN_PROGRESS',
        'knowledgeBaseArn': 'string',
        'knowledgeBaseId': 'string',
        'knowledgeBaseType': 'EXTERNAL'|'CUSTOM'|'QUICK_RESPONSES'|'MESSAGE_TEMPLATES'|'MANAGED',
        'lastContentModificationTime': datetime(2015, 1, 1),
        'name': 'string',
        'renderingConfiguration': {
            'templateUri': 'string'
        },
        'serverSideEncryptionConfiguration': {
            'kmsKeyId': 'string'
        },
        'sourceConfiguration': {
            'appIntegrations': {
                'appIntegrationArn': 'string',
                'objectFields': [
                    'string',
                ]
            },
            'managedSourceConfiguration': {
                'webCrawlerConfiguration': {
                    'crawlerLimits': {
                        'rateLimit': 123
                    },
                    'exclusionFilters': [
                        'string',
                    ],
                    'inclusionFilters': [
                        'string',
                    ],
                    'scope': 'HOST_ONLY'|'SUBDOMAINS',
                    'urlConfiguration': {
                        'seedUrls': [
                            {
                                'url': 'string'
                            },
                        ]
                    }
                }
            }
        },
        'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED',
        'tags': {
            'string': 'string'
        },
        'vectorIngestionConfiguration': {
            'chunkingConfiguration': {
                'chunkingStrategy': 'FIXED_SIZE'|'NONE'|'HIERARCHICAL'|'SEMANTIC',
                'fixedSizeChunkingConfiguration': {
                    'maxTokens': 123,
                    'overlapPercentage': 123
                },
                'hierarchicalChunkingConfiguration': {
                    'levelConfigurations': [
                        {
                            'maxTokens': 123
                        },
                    ],
                    'overlapTokens': 123
                },
                'semanticChunkingConfiguration': {
                    'breakpointPercentileThreshold': 123,
                    'bufferSize': 123,
                    'maxTokens': 123
                }
            },
            'parsingConfiguration': {
                'bedrockFoundationModelConfiguration': {
                    'modelArn': 'string',
                    'parsingPrompt': {
                        'parsingPromptText': 'string'
                    }
                },
                'parsingStrategy': 'BEDROCK_FOUNDATION_MODEL'
            }
        }
    }
}

Response Structure

(dict) --
- knowledgeBase (dict) --
  
  The knowledge base.
  - description (string) --
    
    The description.
  - ingestionFailureReasons (list) --
    
    List of failure reasons on ingestion per file.
    - (string) --
  - ingestionStatus (string) --
    
    Status of ingestion on data source.
  - knowledgeBaseArn (string) --
    
    The Amazon Resource Name (ARN) of the knowledge base.
  - knowledgeBaseId (string) --
    
    The identifier of the knowledge base.
  - knowledgeBaseType (string) --
    
    The type of knowledge base.
  - lastContentModificationTime (datetime) --
    
    An epoch timestamp indicating the most recent content modification inside the knowledge base. If no content exists in a knowledge base, this value is unset.
  - name (string) --
    
    The name of the knowledge base.
  - renderingConfiguration (dict) --
    
    Information about how to render the content.
    - templateUri (string) --
      
      A URI template containing exactly one variable in ${variableName} format. This can only be set for EXTERNAL knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following:
      - Salesforce: Id , ArticleNumber , VersionNumber , Title , PublishStatus , or IsDeleted
      - ServiceNow: number , short_description , sys_mod_count , workflow_state , or active
      - Zendesk: id , title , updated_at , or draft
      The variable is replaced with the actual value for a piece of content when calling GetContent.
  - serverSideEncryptionConfiguration (dict) --
    
    The configuration information for the customer managed key used for encryption.
    
    This KMS key must have a policy that allows kms:CreateGrant , kms:DescribeKey , kms:Decrypt , and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect.
    
    For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.
    - kmsKeyId (string) --
      
      The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. For information about valid ID values, see Key identifiers (KeyId).
  - sourceConfiguration (dict) --
    
    Source configuration information about the knowledge base.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: appIntegrations, managedSourceConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - appIntegrations (dict) --
      
      Configuration information for Amazon AppIntegrations to automatically ingest content.
      - appIntegrationArn (string) --
        
        The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.
        
        For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least Id , ArticleNumber , VersionNumber , Title , PublishStatus , and IsDeleted as source fields.
        
        For ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least number , short_description , sys_mod_count , workflow_state , and active as source fields.
        
        For Zendesk, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least id , title , updated_at , and draft as source fields.
        
        For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among docx , pdf , html , htm , and txt .
        
        For Amazon S3, the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The SourceURI of your DataIntegration must use the following format: s3://your_s3_bucket_name .
        
        Warning
        
        The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principal app-integrations.amazonaws.com to perform s3:ListBucket , s3:GetObject , and s3:GetBucketLocation against the bucket.
      - objectFields (list) --
        
        The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if ObjectConfiguration is included in the provided DataIntegration.
        
        For Salesforce, you must include at least Id , ArticleNumber , VersionNumber , Title , PublishStatus , and IsDeleted .
        
        For ServiceNow, you must include at least number , short_description , sys_mod_count , workflow_state , and active .
        
        For Zendesk, you must include at least id , title , updated_at , and draft .
        
        Make sure to include additional fields. These fields are indexed and used to source recommendations.
        
        (string) --
    - managedSourceConfiguration (dict) --
      
      Source configuration for managed resources.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: webCrawlerConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - webCrawlerConfiguration (dict) --
        
        Configuration data for web crawler data source.
        
        crawlerLimits (dict) --
        
        The configuration of crawl limits for the web URLs.
        
        rateLimit (integer) --
        
        Rate of web URLs retrieved per minute.
        
        exclusionFilters (list) --
        
        A list of one or more exclusion regular expression patterns to exclude certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
        
        (string) --
        
        inclusionFilters (list) --
        
        A list of one or more inclusion regular expression patterns to include certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
        
        (string) --
        
        scope (string) --
        
        The scope of what is crawled for your URLs. You can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL https://docs.aws.amazon.com/bedrock/latest/userguide/ and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain aws.amazon.com can also include sub domain docs.aws.amazon.com .
        
        urlConfiguration (dict) --
        
        The configuration of the URL/URLs for the web content that you want to crawl. You should be authorized to crawl the URLs.
        
        seedUrls (list) --
        
        List of URLs for crawling.
        
        (dict) --
        
        A URL for crawling.
        
        url (string) --
        
        URL for crawling
  - status (string) --
    
    The status of the knowledge base.
  - tags (dict) --
    
    The tags used to organize, track, or control access for this resource.
    - (string) --
      - (string) --
  - vectorIngestionConfiguration (dict) --
    
    Contains details about how to ingest the documents in a data source.
    - chunkingConfiguration (dict) --
      
      Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
      - chunkingStrategy (string) --
        
        Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE , then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.
      - fixedSizeChunkingConfiguration (dict) --
        
        Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE , exclude this field.
        
        maxTokens (integer) --
        
        The maximum number of tokens to include in a chunk.
        
        overlapPercentage (integer) --
        
        The percentage of overlap between adjacent chunks of a data source.
      - hierarchicalChunkingConfiguration (dict) --
        
        Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.
        
        levelConfigurations (list) --
        
        Token settings for each layer.
        
        (dict) --
        
        Token settings for each layer.
        
        maxTokens (integer) --
        
        The maximum number of tokens that a chunk can contain in this layer.
        
        overlapTokens (integer) --
        
        The number of tokens to repeat across chunks in the same layer.
      - semanticChunkingConfiguration (dict) --
        
        Settings for semantic document chunking for a data source. Semantic chunking splits a document into smaller documents based on groups of similar content derived from the text with natural language processing.
        
        breakpointPercentileThreshold (integer) --
        
        The dissimilarity threshold for splitting chunks.
        
        bufferSize (integer) --
        
        The buffer size.
        
        maxTokens (integer) --
        
        The maximum number of tokens that a chunk can contain.
    - parsingConfiguration (dict) --
      
      A custom parser for data source documents.
      - bedrockFoundationModelConfiguration (dict) --
        
        Settings for a foundation model used to parse documents for a data source.
        
        modelArn (string) --
        
        The ARN of the foundation model.
        
        parsingPrompt (dict) --
        
        Instructions for interpreting the contents of a document.
        
        parsingPromptText (string) --
        
        Instructions for interpreting the contents of a document.
      - parsingStrategy (string) --
        
        The parsing strategy for the data source.

GetRecommendations (updated)

Link ¶
Changes (response)

{'recommendations': {'data': {'details': {'intentDetectedData': {'intent': 'string',
                                                                 'intentId': 'string'},
                                          'sourceContentData': {'citationSpan': {'beginOffsetInclusive': 'integer',
                                                                                 'endOffsetExclusive': 'integer'}}},
                              'reference': {'contentReference': {'referenceType': 'WEB_CRAWLER '
                                                                                  '| '
                                                                                  'KNOWLEDGE_BASE',
                                                                 'sourceURL': 'string'}}},
                     'document': {'contentReference': {'referenceType': 'WEB_CRAWLER '
                                                                        '| '
                                                                        'KNOWLEDGE_BASE',
                                                       'sourceURL': 'string'}},
                     'type': {'DETECTED_INTENT'}}}

Warning

This API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024, you will need to create a new Assistant in the Amazon Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.

Retrieves recommendations for the specified session. To avoid retrieving the same recommendations in subsequent calls, use NotifyRecommendationsReceived. This API supports long-polling behavior with the waitTimeSeconds parameter. Short poll is the default behavior and only returns recommendations already available. To perform a manual query against an assistant, use QueryAssistant.

!DANGER!

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

client.get_recommendations(
    assistantId='string',
    maxResults=123,
    sessionId='string',
    waitTimeSeconds=123
)

type assistantId

string

param assistantId

[REQUIRED]

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

type maxResults

integer

param maxResults

The maximum number of results to return per page.

type sessionId

string

param sessionId

[REQUIRED]

The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.

type waitTimeSeconds

integer

param waitTimeSeconds

The duration (in seconds) for which the call waits for a recommendation to be made available before returning. If a recommendation is available, the call returns sooner than WaitTimeSeconds . If no messages are available and the wait time expires, the call returns successfully with an empty list.

rtype

dict

returns

Response Syntax

{
    'recommendations': [
        {
            'data': {
                'details': {
                    'contentData': {
                        'rankingData': {
                            'relevanceLevel': 'HIGH'|'MEDIUM'|'LOW',
                            'relevanceScore': 123.0
                        },
                        'textData': {
                            'excerpt': {
                                'highlights': [
                                    {
                                        'beginOffsetInclusive': 123,
                                        'endOffsetExclusive': 123
                                    },
                                ],
                                'text': 'string'
                            },
                            'title': {
                                'highlights': [
                                    {
                                        'beginOffsetInclusive': 123,
                                        'endOffsetExclusive': 123
                                    },
                                ],
                                'text': 'string'
                            }
                        }
                    },
                    'generativeData': {
                        'completion': 'string',
                        'rankingData': {
                            'relevanceLevel': 'HIGH'|'MEDIUM'|'LOW',
                            'relevanceScore': 123.0
                        },
                        'references': [
                            {'... recursive ...'},
                        ]
                    },
                    'intentDetectedData': {
                        'intent': 'string',
                        'intentId': 'string'
                    },
                    'sourceContentData': {
                        'citationSpan': {
                            'beginOffsetInclusive': 123,
                            'endOffsetExclusive': 123
                        },
                        'id': 'string',
                        'rankingData': {
                            'relevanceLevel': 'HIGH'|'MEDIUM'|'LOW',
                            'relevanceScore': 123.0
                        },
                        'textData': {
                            'excerpt': {
                                'highlights': [
                                    {
                                        'beginOffsetInclusive': 123,
                                        'endOffsetExclusive': 123
                                    },
                                ],
                                'text': 'string'
                            },
                            'title': {
                                'highlights': [
                                    {
                                        'beginOffsetInclusive': 123,
                                        'endOffsetExclusive': 123
                                    },
                                ],
                                'text': 'string'
                            }
                        },
                        'type': 'KNOWLEDGE_CONTENT'
                    }
                },
                'reference': {
                    'contentReference': {
                        'contentArn': 'string',
                        'contentId': 'string',
                        'knowledgeBaseArn': 'string',
                        'knowledgeBaseId': 'string',
                        'referenceType': 'WEB_CRAWLER'|'KNOWLEDGE_BASE',
                        'sourceURL': 'string'
                    },
                    'generativeReference': {
                        'generationId': 'string',
                        'modelId': 'string'
                    }
                }
            },
            'document': {
                'contentReference': {
                    'contentArn': 'string',
                    'contentId': 'string',
                    'knowledgeBaseArn': 'string',
                    'knowledgeBaseId': 'string',
                    'referenceType': 'WEB_CRAWLER'|'KNOWLEDGE_BASE',
                    'sourceURL': 'string'
                },
                'excerpt': {
                    'highlights': [
                        {
                            'beginOffsetInclusive': 123,
                            'endOffsetExclusive': 123
                        },
                    ],
                    'text': 'string'
                },
                'title': {
                    'highlights': [
                        {
                            'beginOffsetInclusive': 123,
                            'endOffsetExclusive': 123
                        },
                    ],
                    'text': 'string'
                }
            },
            'recommendationId': 'string',
            'relevanceLevel': 'HIGH'|'MEDIUM'|'LOW',
            'relevanceScore': 123.0,
            'type': 'KNOWLEDGE_CONTENT'|'GENERATIVE_RESPONSE'|'GENERATIVE_ANSWER'|'DETECTED_INTENT'
        },
    ],
    'triggers': [
        {
            'data': {
                'query': {
                    'text': 'string'
                }
            },
            'id': 'string',
            'recommendationIds': [
                'string',
            ],
            'source': 'ISSUE_DETECTION'|'RULE_EVALUATION'|'OTHER',
            'type': 'QUERY'|'GENERATIVE'
        },
    ]
}

Response Structure

(dict) --
- recommendations (list) --
  
  The recommendations.
  - (dict) --
    
    Information about the recommendation.
    - data (dict) --
      
      Summary of the recommended content.
      - details (dict) --
        
        Details about the data.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: contentData, generativeData, intentDetectedData, sourceContentData. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        contentData (dict) --
        
        Details about the content data.
        
        rankingData (dict) --
        
        Details about the content ranking data.
        
        relevanceLevel (string) --
        
        The relevance score of the content.
        
        relevanceScore (float) --
        
        The relevance level of the recommendation.
        
        textData (dict) --
        
        Details about the content text data.
        
        excerpt (dict) --
        
        The text of the document.
        
        highlights (list) --
        
        Highlights in the document text.
        
        (dict) --
        
        Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.
        
        beginOffsetInclusive (integer) --
        
        The offset for the start of the highlight.
        
        endOffsetExclusive (integer) --
        
        The offset for the end of the highlight.
        
        text (string) --
        
        Text in the document.
        
        title (dict) --
        
        The text of the document.
        
        highlights (list) --
        
        Highlights in the document text.
        
        (dict) --
        
        Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.
        
        beginOffsetInclusive (integer) --
        
        The offset for the start of the highlight.
        
        endOffsetExclusive (integer) --
        
        The offset for the end of the highlight.
        
        text (string) --
        
        Text in the document.
        
        generativeData (dict) --
        
        Details about the generative data.
        
        completion (string) --
        
        The LLM response.
        
        rankingData (dict) --
        
        Details about the generative content ranking data.
        
        relevanceLevel (string) --
        
        The relevance score of the content.
        
        relevanceScore (float) --
        
        The relevance level of the recommendation.
        
        references (list) --
        
        The references used to generative the LLM response.
        
        (dict) --
        
        Summary of the data.
        
        intentDetectedData (dict) --
        
        Details about the intent data.
        
        intent (string) --
        
        The detected intent.
        
        intentId (string) --
        
        The identifier of the detected intent.
        
        sourceContentData (dict) --
        
        Details about the content data.
        
        citationSpan (dict) --
        
        Contains information about where the text with a citation begins and ends in the generated output.
        
        beginOffsetInclusive (integer) --
        
        Where the text with a citation starts in the generated output.
        
        endOffsetExclusive (integer) --
        
        Where the text with a citation ends in the generated output.
        
        id (string) --
        
        The identifier of the source content.
        
        rankingData (dict) --
        
        Details about the source content ranking data.
        
        relevanceLevel (string) --
        
        The relevance score of the content.
        
        relevanceScore (float) --
        
        The relevance level of the recommendation.
        
        textData (dict) --
        
        Details about the source content text data.
        
        excerpt (dict) --
        
        The text of the document.
        
        highlights (list) --
        
        Highlights in the document text.
        
        (dict) --
        
        Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.
        
        beginOffsetInclusive (integer) --
        
        The offset for the start of the highlight.
        
        endOffsetExclusive (integer) --
        
        The offset for the end of the highlight.
        
        text (string) --
        
        Text in the document.
        
        title (dict) --
        
        The text of the document.
        
        highlights (list) --
        
        Highlights in the document text.
        
        (dict) --
        
        Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.
        
        beginOffsetInclusive (integer) --
        
        The offset for the start of the highlight.
        
        endOffsetExclusive (integer) --
        
        The offset for the end of the highlight.
        
        text (string) --
        
        Text in the document.
        
        type (string) --
        
        The type of the source content.
      - reference (dict) --
        
        Reference information about the content.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: contentReference, generativeReference. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        contentReference (dict) --
        
        Reference information about the content.
        
        contentArn (string) --
        
        The Amazon Resource Name (ARN) of the content.
        
        contentId (string) --
        
        The identifier of the content.
        
        knowledgeBaseArn (string) --
        
        The Amazon Resource Name (ARN) of the knowledge base.
        
        knowledgeBaseId (string) --
        
        The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.
        
        referenceType (string) --
        
        The type of reference content.
        
        sourceURL (string) --
        
        The web URL of the source content.
        
        generativeReference (dict) --
        
        Reference information about the generative content.
        
        generationId (string) --
        
        The identifier of the LLM model.
        
        modelId (string) --
        
        The identifier of the LLM model.
    - document (dict) --
      
      The recommended document.
      - contentReference (dict) --
        
        A reference to the content resource.
        
        contentArn (string) --
        
        The Amazon Resource Name (ARN) of the content.
        
        contentId (string) --
        
        The identifier of the content.
        
        knowledgeBaseArn (string) --
        
        The Amazon Resource Name (ARN) of the knowledge base.
        
        knowledgeBaseId (string) --
        
        The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.
        
        referenceType (string) --
        
        The type of reference content.
        
        sourceURL (string) --
        
        The web URL of the source content.
      - excerpt (dict) --
        
        The excerpt from the document.
        
        highlights (list) --
        
        Highlights in the document text.
        
        (dict) --
        
        Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.
        
        beginOffsetInclusive (integer) --
        
        The offset for the start of the highlight.
        
        endOffsetExclusive (integer) --
        
        The offset for the end of the highlight.
        
        text (string) --
        
        Text in the document.
      - title (dict) --
        
        The title of the document.
        
        highlights (list) --
        
        Highlights in the document text.
        
        (dict) --
        
        Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.
        
        beginOffsetInclusive (integer) --
        
        The offset for the start of the highlight.
        
        endOffsetExclusive (integer) --
        
        The offset for the end of the highlight.
        
        text (string) --
        
        Text in the document.
    - recommendationId (string) --
      
      The identifier of the recommendation.
    - relevanceLevel (string) --
      
      The relevance level of the recommendation.
    - relevanceScore (float) --
      
      The relevance score of the recommendation.
    - type (string) --
      
      The type of recommendation.
- triggers (list) --
  
  The triggers corresponding to recommendations.
  - (dict) --
    
    A recommendation trigger provides context on the event that produced the referenced recommendations. Recommendations are only referenced in recommendationIds by a single RecommendationTrigger.
    - data (dict) --
      
      A union type containing information related to the trigger.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: query. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - query (dict) --
        
        Data associated with the QUERY RecommendationTriggerType.
        
        text (string) --
        
        The text associated with the recommendation trigger.
    - id (string) --
      
      The identifier of the recommendation trigger.
    - recommendationIds (list) --
      
      The identifiers of the recommendations.
      - (string) --
    - source (string) --
      
      The source of the recommendation trigger.
      - ISSUE_DETECTION: The corresponding recommendations were triggered by a Contact Lens issue.
      - RULE_EVALUATION: The corresponding recommendations were triggered by a Contact Lens rule.
    - type (string) --
      
      The type of recommendation trigger.

GetSession (updated)

Link ¶
Changes (response)

{'session': {'aiAgentConfiguration': {'MANUAL_SEARCH | ANSWER_RECOMMENDATION': {'aiAgentId': 'string'}}}}

Retrieves information for a specified session.

See also: AWS API Documentation

Request Syntax

client.get_session(
    assistantId='string',
    sessionId='string'
)

type assistantId

string

param assistantId

[REQUIRED]

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

type sessionId

string

param sessionId

[REQUIRED]

The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.

rtype

dict

returns

Response Syntax

{
    'session': {
        'aiAgentConfiguration': {
            'string': {
                'aiAgentId': 'string'
            }
        },
        'description': 'string',
        'integrationConfiguration': {
            'topicIntegrationArn': 'string'
        },
        'name': 'string',
        'sessionArn': 'string',
        'sessionId': 'string',
        'tagFilter': {
            'andConditions': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'orConditions': [
                {
                    'andConditions': [
                        {
                            'key': 'string',
                            'value': 'string'
                        },
                    ],
                    'tagCondition': {
                        'key': 'string',
                        'value': 'string'
                    }
                },
            ],
            'tagCondition': {
                'key': 'string',
                'value': 'string'
            }
        },
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

(dict) --
- session (dict) --
  
  The session.
  - aiAgentConfiguration (dict) --
    
    The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session.
    - (string) --
      - (dict) --
        
        A type that specifies the AI Agent ID configuration data when mapping an AI Agents to be used for an AI Agent type on a session or assistant.
        
        aiAgentId (string) --
        
        The ID of the AI Agent to be configured.
  - description (string) --
    
    The description of the session.
  - integrationConfiguration (dict) --
    
    The configuration information for the session integration.
    - topicIntegrationArn (string) --
      
      The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.
  - name (string) --
    
    The name of the session.
  - sessionArn (string) --
    
    The Amazon Resource Name (ARN) of the session.
  - sessionId (string) --
    
    The identifier of the session.
  - tagFilter (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: andConditions, orConditions, tagCondition. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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.
    - 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 set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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.
    - 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.
  - tags (dict) --
    
    The tags used to organize, track, or control access for this resource.
    - (string) --
      - (string) --

ListAssistants (updated)

Link ¶
Changes (response)

{'assistantSummaries': {'aiAgentConfiguration': {'MANUAL_SEARCH | ANSWER_RECOMMENDATION': {'aiAgentId': 'string'}}}}

Lists information about assistants.

See also: AWS API Documentation

Request Syntax

client.list_assistants(
    maxResults=123,
    nextToken='string'
)

type maxResults

integer

param maxResults

The maximum number of results to return per page.

type nextToken

string

param nextToken

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.

rtype

dict

returns

Response Syntax

{
    'assistantSummaries': [
        {
            'aiAgentConfiguration': {
                'string': {
                    'aiAgentId': 'string'
                }
            },
            'assistantArn': 'string',
            'assistantId': 'string',
            'capabilityConfiguration': {
                'type': 'V1'|'V2'
            },
            'description': 'string',
            'integrationConfiguration': {
                'topicIntegrationArn': 'string'
            },
            'name': 'string',
            'serverSideEncryptionConfiguration': {
                'kmsKeyId': 'string'
            },
            'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED',
            'tags': {
                'string': 'string'
            },
            'type': 'AGENT'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- assistantSummaries (list) --
  
  Information about the assistants.
  - (dict) --
    
    Summary information about the assistant.
    - aiAgentConfiguration (dict) --
      
      The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that is set on the Amazon Q in Connect Assistant.
      - (string) --
        
        (dict) --
        
        A type that specifies the AI Agent ID configuration data when mapping an AI Agents to be used for an AI Agent type on a session or assistant.
        
        aiAgentId (string) --
        
        The ID of the AI Agent to be configured.
    - 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.
    - capabilityConfiguration (dict) --
      
      The configuration information for the Amazon Q in Connect assistant capability.
      - type (string) --
        
        The type of Amazon Q in Connect assistant capability.
    - description (string) --
      
      The description of the assistant.
    - integrationConfiguration (dict) --
      
      The configuration information for the Amazon Q in Connect assistant integration.
      - topicIntegrationArn (string) --
        
        The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.
    - name (string) --
      
      The name of the assistant.
    - serverSideEncryptionConfiguration (dict) --
      
      The configuration information for the customer managed key used for encryption.
      
      This KMS key must have a policy that allows kms:CreateGrant , kms:DescribeKey , kms:Decrypt , and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow kms:Decrypt , kms:GenerateDataKey* , and kms:DescribeKey permissions to the connect.amazonaws.com service principal.
      
      For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.
      - kmsKeyId (string) --
        
        The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. For information about valid ID values, see Key identifiers (KeyId).
    - status (string) --
      
      The status of the assistant.
    - tags (dict) --
      
      The tags used to organize, track, or control access for this resource.
      - (string) --
        
        (string) --
    - type (string) --
      
      The type of the assistant.
- nextToken (string) --
  
  If there are additional results, this is the token for the next set of results.

ListKnowledgeBases (updated)

Link ¶
Changes (response)

{'knowledgeBaseSummaries': {'knowledgeBaseType': {'MANAGED',
                                                  'MESSAGE_TEMPLATES'},
                            'sourceConfiguration': {'managedSourceConfiguration': {'webCrawlerConfiguration': {'crawlerLimits': {'rateLimit': 'integer'},
                                                                                                               'exclusionFilters': ['string'],
                                                                                                               'inclusionFilters': ['string'],
                                                                                                               'scope': 'HOST_ONLY '
                                                                                                                        '| '
                                                                                                                        'SUBDOMAINS',
                                                                                                               'urlConfiguration': {'seedUrls': [{'url': 'string'}]}}}},
                            'vectorIngestionConfiguration': {'chunkingConfiguration': {'chunkingStrategy': 'FIXED_SIZE '
                                                                                                           '| '
                                                                                                           'NONE '
                                                                                                           '| '
                                                                                                           'HIERARCHICAL '
                                                                                                           '| '
                                                                                                           'SEMANTIC',
                                                                                       'fixedSizeChunkingConfiguration': {'maxTokens': 'integer',
                                                                                                                          'overlapPercentage': 'integer'},
                                                                                       'hierarchicalChunkingConfiguration': {'levelConfigurations': [{'maxTokens': 'integer'}],
                                                                                                                             'overlapTokens': 'integer'},
                                                                                       'semanticChunkingConfiguration': {'breakpointPercentileThreshold': 'integer',
                                                                                                                         'bufferSize': 'integer',
                                                                                                                         'maxTokens': 'integer'}},
                                                             'parsingConfiguration': {'bedrockFoundationModelConfiguration': {'modelArn': 'string',
                                                                                                                              'parsingPrompt': {'parsingPromptText': 'string'}},
                                                                                      'parsingStrategy': 'BEDROCK_FOUNDATION_MODEL'}}}}

Lists the knowledge bases.

See also: AWS API Documentation

Request Syntax

client.list_knowledge_bases(
    maxResults=123,
    nextToken='string'
)

type maxResults

integer

param maxResults

The maximum number of results to return per page.

type nextToken

string

param nextToken

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.

rtype

dict

returns

Response Syntax

{
    'knowledgeBaseSummaries': [
        {
            'description': 'string',
            'knowledgeBaseArn': 'string',
            'knowledgeBaseId': 'string',
            'knowledgeBaseType': 'EXTERNAL'|'CUSTOM'|'QUICK_RESPONSES'|'MESSAGE_TEMPLATES'|'MANAGED',
            'name': 'string',
            'renderingConfiguration': {
                'templateUri': 'string'
            },
            'serverSideEncryptionConfiguration': {
                'kmsKeyId': 'string'
            },
            'sourceConfiguration': {
                'appIntegrations': {
                    'appIntegrationArn': 'string',
                    'objectFields': [
                        'string',
                    ]
                },
                'managedSourceConfiguration': {
                    'webCrawlerConfiguration': {
                        'crawlerLimits': {
                            'rateLimit': 123
                        },
                        'exclusionFilters': [
                            'string',
                        ],
                        'inclusionFilters': [
                            'string',
                        ],
                        'scope': 'HOST_ONLY'|'SUBDOMAINS',
                        'urlConfiguration': {
                            'seedUrls': [
                                {
                                    'url': 'string'
                                },
                            ]
                        }
                    }
                }
            },
            'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED',
            'tags': {
                'string': 'string'
            },
            'vectorIngestionConfiguration': {
                'chunkingConfiguration': {
                    'chunkingStrategy': 'FIXED_SIZE'|'NONE'|'HIERARCHICAL'|'SEMANTIC',
                    'fixedSizeChunkingConfiguration': {
                        'maxTokens': 123,
                        'overlapPercentage': 123
                    },
                    'hierarchicalChunkingConfiguration': {
                        'levelConfigurations': [
                            {
                                'maxTokens': 123
                            },
                        ],
                        'overlapTokens': 123
                    },
                    'semanticChunkingConfiguration': {
                        'breakpointPercentileThreshold': 123,
                        'bufferSize': 123,
                        'maxTokens': 123
                    }
                },
                'parsingConfiguration': {
                    'bedrockFoundationModelConfiguration': {
                        'modelArn': 'string',
                        'parsingPrompt': {
                            'parsingPromptText': 'string'
                        }
                    },
                    'parsingStrategy': 'BEDROCK_FOUNDATION_MODEL'
                }
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- knowledgeBaseSummaries (list) --
  
  Information about the knowledge bases.
  - (dict) --
    
    Summary information about the knowledge base.
    - description (string) --
      
      The description of the knowledge base.
    - knowledgeBaseArn (string) --
      
      The Amazon Resource Name (ARN) of the knowledge base.
    - knowledgeBaseId (string) --
      
      The identifier of the knowledge base.
    - knowledgeBaseType (string) --
      
      The type of knowledge base.
    - name (string) --
      
      The name of the knowledge base.
    - renderingConfiguration (dict) --
      
      Information about how to render the content.
      - templateUri (string) --
        
        A URI template containing exactly one variable in ${variableName} format. This can only be set for EXTERNAL knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following:
        
        Salesforce: Id , ArticleNumber , VersionNumber , Title , PublishStatus , or IsDeleted
        
        ServiceNow: number , short_description , sys_mod_count , workflow_state , or active
        
        Zendesk: id , title , updated_at , or draft
        
        The variable is replaced with the actual value for a piece of content when calling GetContent.
    - serverSideEncryptionConfiguration (dict) --
      
      The configuration information for the customer managed key used for encryption.
      
      This KMS key must have a policy that allows kms:CreateGrant , kms:DescribeKey , kms:Decrypt , and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect.
      
      For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.
      - kmsKeyId (string) --
        
        The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. For information about valid ID values, see Key identifiers (KeyId).
    - sourceConfiguration (dict) --
      
      Configuration information about the external data source.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: appIntegrations, managedSourceConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - appIntegrations (dict) --
        
        Configuration information for Amazon AppIntegrations to automatically ingest content.
        
        appIntegrationArn (string) --
        
        The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.
        
        For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least Id , ArticleNumber , VersionNumber , Title , PublishStatus , and IsDeleted as source fields.
        
        For ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least number , short_description , sys_mod_count , workflow_state , and active as source fields.
        
        For Zendesk, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least id , title , updated_at , and draft as source fields.
        
        For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among docx , pdf , html , htm , and txt .
        
        For Amazon S3, the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The SourceURI of your DataIntegration must use the following format: s3://your_s3_bucket_name .
        
        Warning
        
        The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principal app-integrations.amazonaws.com to perform s3:ListBucket , s3:GetObject , and s3:GetBucketLocation against the bucket.
        
        objectFields (list) --
        
        The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if ObjectConfiguration is included in the provided DataIntegration.
        
        For Salesforce, you must include at least Id , ArticleNumber , VersionNumber , Title , PublishStatus , and IsDeleted .
        
        For ServiceNow, you must include at least number , short_description , sys_mod_count , workflow_state , and active .
        
        For Zendesk, you must include at least id , title , updated_at , and draft .
        
        Make sure to include additional fields. These fields are indexed and used to source recommendations.
        
        (string) --
      - managedSourceConfiguration (dict) --
        
        Source configuration for managed resources.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: webCrawlerConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        webCrawlerConfiguration (dict) --
        
        Configuration data for web crawler data source.
        
        crawlerLimits (dict) --
        
        The configuration of crawl limits for the web URLs.
        
        rateLimit (integer) --
        
        Rate of web URLs retrieved per minute.
        
        exclusionFilters (list) --
        
        A list of one or more exclusion regular expression patterns to exclude certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
        
        (string) --
        
        inclusionFilters (list) --
        
        A list of one or more inclusion regular expression patterns to include certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
        
        (string) --
        
        scope (string) --
        
        The scope of what is crawled for your URLs. You can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL https://docs.aws.amazon.com/bedrock/latest/userguide/ and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain aws.amazon.com can also include sub domain docs.aws.amazon.com .
        
        urlConfiguration (dict) --
        
        The configuration of the URL/URLs for the web content that you want to crawl. You should be authorized to crawl the URLs.
        
        seedUrls (list) --
        
        List of URLs for crawling.
        
        (dict) --
        
        A URL for crawling.
        
        url (string) --
        
        URL for crawling
    - status (string) --
      
      The status of the knowledge base summary.
    - tags (dict) --
      
      The tags used to organize, track, or control access for this resource.
      - (string) --
        
        (string) --
    - vectorIngestionConfiguration (dict) --
      
      Contains details about how to ingest the documents in a data source.
      - chunkingConfiguration (dict) --
        
        Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
        
        chunkingStrategy (string) --
        
        Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE , then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.
        
        fixedSizeChunkingConfiguration (dict) --
        
        Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE , exclude this field.
        
        maxTokens (integer) --
        
        The maximum number of tokens to include in a chunk.
        
        overlapPercentage (integer) --
        
        The percentage of overlap between adjacent chunks of a data source.
        
        hierarchicalChunkingConfiguration (dict) --
        
        Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.
        
        levelConfigurations (list) --
        
        Token settings for each layer.
        
        (dict) --
        
        Token settings for each layer.
        
        maxTokens (integer) --
        
        The maximum number of tokens that a chunk can contain in this layer.
        
        overlapTokens (integer) --
        
        The number of tokens to repeat across chunks in the same layer.
        
        semanticChunkingConfiguration (dict) --
        
        Settings for semantic document chunking for a data source. Semantic chunking splits a document into smaller documents based on groups of similar content derived from the text with natural language processing.
        
        breakpointPercentileThreshold (integer) --
        
        The dissimilarity threshold for splitting chunks.
        
        bufferSize (integer) --
        
        The buffer size.
        
        maxTokens (integer) --
        
        The maximum number of tokens that a chunk can contain.
      - parsingConfiguration (dict) --
        
        A custom parser for data source documents.
        
        bedrockFoundationModelConfiguration (dict) --
        
        Settings for a foundation model used to parse documents for a data source.
        
        modelArn (string) --
        
        The ARN of the foundation model.
        
        parsingPrompt (dict) --
        
        Instructions for interpreting the contents of a document.
        
        parsingPromptText (string) --
        
        Instructions for interpreting the contents of a document.
        
        parsingStrategy (string) --
        
        The parsing strategy for the data source.
- nextToken (string) --
  
  If there are additional results, this is the token for the next set of results.

QueryAssistant (updated)

Link ¶
Changes (request, response)
Request

{'overrideKnowledgeBaseSearchType': 'HYBRID | SEMANTIC',
 'queryInputData': {'intentInputData': {'intentId': 'string'},
                    'queryTextInputData': {'text': 'string'}}}

Response

{'results': {'data': {'details': {'intentDetectedData': {'intent': 'string',
                                                         'intentId': 'string'},
                                  'sourceContentData': {'citationSpan': {'beginOffsetInclusive': 'integer',
                                                                         'endOffsetExclusive': 'integer'}}},
                      'reference': {'contentReference': {'referenceType': 'WEB_CRAWLER '
                                                                          '| '
                                                                          'KNOWLEDGE_BASE',
                                                         'sourceURL': 'string'}}},
             'document': {'contentReference': {'referenceType': 'WEB_CRAWLER | '
                                                                'KNOWLEDGE_BASE',
                                               'sourceURL': 'string'}},
             'type': {'INTENT_ANSWER'}}}

Warning

Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations.

!DANGER!

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

client.query_assistant(
    assistantId='string',
    maxResults=123,
    nextToken='string',
    overrideKnowledgeBaseSearchType='HYBRID'|'SEMANTIC',
    queryCondition=[
        {
            'single': {
                'comparator': 'EQUALS',
                'field': 'RESULT_TYPE',
                'value': 'string'
            }
        },
    ],
    queryInputData={
        'intentInputData': {
            'intentId': 'string'
        },
        'queryTextInputData': {
            'text': 'string'
        }
    },
    queryText='string',
    sessionId='string'
)

type assistantId

string

param assistantId

[REQUIRED]

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

type maxResults

integer

param maxResults

The maximum number of results to return per page.

type nextToken

string

param nextToken

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.

type overrideKnowledgeBaseSearchType

string

param overrideKnowledgeBaseSearchType

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.

type queryCondition

list

param queryCondition

Information about how to query content.

(dict) --

Information about how to query content.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: single.
- single (dict) --
  
  The condition for the query.
  - comparator (string) -- [REQUIRED]
    
    The comparison operator for query condition to query on.
  - field (string) -- [REQUIRED]
    
    The name of the field for query condition to query on.
  - value (string) -- [REQUIRED]
    
    The value for the query condition to query on.

type queryInputData

dict

param queryInputData

Information about the query.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: intentInputData, queryTextInputData.

intentInputData (dict) --

Input information for the intent.
- intentId (string) -- [REQUIRED]
  
  The identifier of the Amazon Q intent.
queryTextInputData (dict) --

Input information for the query.
- text (string) -- [REQUIRED]
  
  The text to search for.

type queryText

string

param queryText

The text to search for.

type sessionId

string

param sessionId

The identifier of the Amazon Q in Connect session. Can be either the ID or the ARN. URLs cannot contain the ARN.

rtype

dict

returns

Response Syntax

{
    'nextToken': 'string',
    'results': [
        {
            'data': {
                'details': {
                    'contentData': {
                        'rankingData': {
                            'relevanceLevel': 'HIGH'|'MEDIUM'|'LOW',
                            'relevanceScore': 123.0
                        },
                        'textData': {
                            'excerpt': {
                                'highlights': [
                                    {
                                        'beginOffsetInclusive': 123,
                                        'endOffsetExclusive': 123
                                    },
                                ],
                                'text': 'string'
                            },
                            'title': {
                                'highlights': [
                                    {
                                        'beginOffsetInclusive': 123,
                                        'endOffsetExclusive': 123
                                    },
                                ],
                                'text': 'string'
                            }
                        }
                    },
                    'generativeData': {
                        'completion': 'string',
                        'rankingData': {
                            'relevanceLevel': 'HIGH'|'MEDIUM'|'LOW',
                            'relevanceScore': 123.0
                        },
                        'references': [
                            {'... recursive ...'},
                        ]
                    },
                    'intentDetectedData': {
                        'intent': 'string',
                        'intentId': 'string'
                    },
                    'sourceContentData': {
                        'citationSpan': {
                            'beginOffsetInclusive': 123,
                            'endOffsetExclusive': 123
                        },
                        'id': 'string',
                        'rankingData': {
                            'relevanceLevel': 'HIGH'|'MEDIUM'|'LOW',
                            'relevanceScore': 123.0
                        },
                        'textData': {
                            'excerpt': {
                                'highlights': [
                                    {
                                        'beginOffsetInclusive': 123,
                                        'endOffsetExclusive': 123
                                    },
                                ],
                                'text': 'string'
                            },
                            'title': {
                                'highlights': [
                                    {
                                        'beginOffsetInclusive': 123,
                                        'endOffsetExclusive': 123
                                    },
                                ],
                                'text': 'string'
                            }
                        },
                        'type': 'KNOWLEDGE_CONTENT'
                    }
                },
                'reference': {
                    'contentReference': {
                        'contentArn': 'string',
                        'contentId': 'string',
                        'knowledgeBaseArn': 'string',
                        'knowledgeBaseId': 'string',
                        'referenceType': 'WEB_CRAWLER'|'KNOWLEDGE_BASE',
                        'sourceURL': 'string'
                    },
                    'generativeReference': {
                        'generationId': 'string',
                        'modelId': 'string'
                    }
                }
            },
            'document': {
                'contentReference': {
                    'contentArn': 'string',
                    'contentId': 'string',
                    'knowledgeBaseArn': 'string',
                    'knowledgeBaseId': 'string',
                    'referenceType': 'WEB_CRAWLER'|'KNOWLEDGE_BASE',
                    'sourceURL': 'string'
                },
                'excerpt': {
                    'highlights': [
                        {
                            'beginOffsetInclusive': 123,
                            'endOffsetExclusive': 123
                        },
                    ],
                    'text': 'string'
                },
                'title': {
                    'highlights': [
                        {
                            'beginOffsetInclusive': 123,
                            'endOffsetExclusive': 123
                        },
                    ],
                    'text': 'string'
                }
            },
            'relevanceScore': 123.0,
            'resultId': 'string',
            'type': 'KNOWLEDGE_CONTENT'|'INTENT_ANSWER'|'GENERATIVE_ANSWER'
        },
    ]
}

Response Structure

(dict) --
- nextToken (string) --
  
  If there are additional results, this is the token for the next set of results.
- results (list) --
  
  The results of the query.
  - (dict) --
    
    Information about the result.
    - data (dict) --
      
      Summary of the recommended content.
      - details (dict) --
        
        Details about the data.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: contentData, generativeData, intentDetectedData, sourceContentData. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        contentData (dict) --
        
        Details about the content data.
        
        rankingData (dict) --
        
        Details about the content ranking data.
        
        relevanceLevel (string) --
        
        The relevance score of the content.
        
        relevanceScore (float) --
        
        The relevance level of the recommendation.
        
        textData (dict) --
        
        Details about the content text data.
        
        excerpt (dict) --
        
        The text of the document.
        
        highlights (list) --
        
        Highlights in the document text.
        
        (dict) --
        
        Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.
        
        beginOffsetInclusive (integer) --
        
        The offset for the start of the highlight.
        
        endOffsetExclusive (integer) --
        
        The offset for the end of the highlight.
        
        text (string) --
        
        Text in the document.
        
        title (dict) --
        
        The text of the document.
        
        highlights (list) --
        
        Highlights in the document text.
        
        (dict) --
        
        Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.
        
        beginOffsetInclusive (integer) --
        
        The offset for the start of the highlight.
        
        endOffsetExclusive (integer) --
        
        The offset for the end of the highlight.
        
        text (string) --
        
        Text in the document.
        
        generativeData (dict) --
        
        Details about the generative data.
        
        completion (string) --
        
        The LLM response.
        
        rankingData (dict) --
        
        Details about the generative content ranking data.
        
        relevanceLevel (string) --
        
        The relevance score of the content.
        
        relevanceScore (float) --
        
        The relevance level of the recommendation.
        
        references (list) --
        
        The references used to generative the LLM response.
        
        (dict) --
        
        Summary of the data.
        
        intentDetectedData (dict) --
        
        Details about the intent data.
        
        intent (string) --
        
        The detected intent.
        
        intentId (string) --
        
        The identifier of the detected intent.
        
        sourceContentData (dict) --
        
        Details about the content data.
        
        citationSpan (dict) --
        
        Contains information about where the text with a citation begins and ends in the generated output.
        
        beginOffsetInclusive (integer) --
        
        Where the text with a citation starts in the generated output.
        
        endOffsetExclusive (integer) --
        
        Where the text with a citation ends in the generated output.
        
        id (string) --
        
        The identifier of the source content.
        
        rankingData (dict) --
        
        Details about the source content ranking data.
        
        relevanceLevel (string) --
        
        The relevance score of the content.
        
        relevanceScore (float) --
        
        The relevance level of the recommendation.
        
        textData (dict) --
        
        Details about the source content text data.
        
        excerpt (dict) --
        
        The text of the document.
        
        highlights (list) --
        
        Highlights in the document text.
        
        (dict) --
        
        Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.
        
        beginOffsetInclusive (integer) --
        
        The offset for the start of the highlight.
        
        endOffsetExclusive (integer) --
        
        The offset for the end of the highlight.
        
        text (string) --
        
        Text in the document.
        
        title (dict) --
        
        The text of the document.
        
        highlights (list) --
        
        Highlights in the document text.
        
        (dict) --
        
        Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.
        
        beginOffsetInclusive (integer) --
        
        The offset for the start of the highlight.
        
        endOffsetExclusive (integer) --
        
        The offset for the end of the highlight.
        
        text (string) --
        
        Text in the document.
        
        type (string) --
        
        The type of the source content.
      - reference (dict) --
        
        Reference information about the content.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: contentReference, generativeReference. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        contentReference (dict) --
        
        Reference information about the content.
        
        contentArn (string) --
        
        The Amazon Resource Name (ARN) of the content.
        
        contentId (string) --
        
        The identifier of the content.
        
        knowledgeBaseArn (string) --
        
        The Amazon Resource Name (ARN) of the knowledge base.
        
        knowledgeBaseId (string) --
        
        The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.
        
        referenceType (string) --
        
        The type of reference content.
        
        sourceURL (string) --
        
        The web URL of the source content.
        
        generativeReference (dict) --
        
        Reference information about the generative content.
        
        generationId (string) --
        
        The identifier of the LLM model.
        
        modelId (string) --
        
        The identifier of the LLM model.
    - document (dict) --
      
      The document.
      - contentReference (dict) --
        
        A reference to the content resource.
        
        contentArn (string) --
        
        The Amazon Resource Name (ARN) of the content.
        
        contentId (string) --
        
        The identifier of the content.
        
        knowledgeBaseArn (string) --
        
        The Amazon Resource Name (ARN) of the knowledge base.
        
        knowledgeBaseId (string) --
        
        The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.
        
        referenceType (string) --
        
        The type of reference content.
        
        sourceURL (string) --
        
        The web URL of the source content.
      - excerpt (dict) --
        
        The excerpt from the document.
        
        highlights (list) --
        
        Highlights in the document text.
        
        (dict) --
        
        Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.
        
        beginOffsetInclusive (integer) --
        
        The offset for the start of the highlight.
        
        endOffsetExclusive (integer) --
        
        The offset for the end of the highlight.
        
        text (string) --
        
        Text in the document.
      - title (dict) --
        
        The title of the document.
        
        highlights (list) --
        
        Highlights in the document text.
        
        (dict) --
        
        Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.
        
        beginOffsetInclusive (integer) --
        
        The offset for the start of the highlight.
        
        endOffsetExclusive (integer) --
        
        The offset for the end of the highlight.
        
        text (string) --
        
        Text in the document.
    - relevanceScore (float) --
      
      The relevance score of the results.
    - resultId (string) --
      
      The identifier of the result data.
    - type (string) --
      
      The type of the query result.

UpdateKnowledgeBaseTemplateUri (updated)

Link ¶
Changes (response)

{'knowledgeBase': {'ingestionFailureReasons': ['string'],
                   'ingestionStatus': 'SYNC_FAILED | SYNCING_IN_PROGRESS | '
                                      'SYNC_SUCCESS | CREATE_IN_PROGRESS',
                   'knowledgeBaseType': {'MESSAGE_TEMPLATES', 'MANAGED'},
                   'sourceConfiguration': {'managedSourceConfiguration': {'webCrawlerConfiguration': {'crawlerLimits': {'rateLimit': 'integer'},
                                                                                                      'exclusionFilters': ['string'],
                                                                                                      'inclusionFilters': ['string'],
                                                                                                      'scope': 'HOST_ONLY '
                                                                                                               '| '
                                                                                                               'SUBDOMAINS',
                                                                                                      'urlConfiguration': {'seedUrls': [{'url': 'string'}]}}}},
                   'vectorIngestionConfiguration': {'chunkingConfiguration': {'chunkingStrategy': 'FIXED_SIZE '
                                                                                                  '| '
                                                                                                  'NONE '
                                                                                                  '| '
                                                                                                  'HIERARCHICAL '
                                                                                                  '| '
                                                                                                  'SEMANTIC',
                                                                              'fixedSizeChunkingConfiguration': {'maxTokens': 'integer',
                                                                                                                 'overlapPercentage': 'integer'},
                                                                              'hierarchicalChunkingConfiguration': {'levelConfigurations': [{'maxTokens': 'integer'}],
                                                                                                                    'overlapTokens': 'integer'},
                                                                              'semanticChunkingConfiguration': {'breakpointPercentileThreshold': 'integer',
                                                                                                                'bufferSize': 'integer',
                                                                                                                'maxTokens': 'integer'}},
                                                    'parsingConfiguration': {'bedrockFoundationModelConfiguration': {'modelArn': 'string',
                                                                                                                     'parsingPrompt': {'parsingPromptText': 'string'}},
                                                                             'parsingStrategy': 'BEDROCK_FOUNDATION_MODEL'}}}}

Updates the template URI of a knowledge base. This is only supported for knowledge bases of type EXTERNAL. Include a single variable in ${variable} format; this interpolated by Amazon Q in Connect using ingested content. For example, if you ingest a Salesforce article, it has an Id value, and you can set the template URI to https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*/view .

See also: AWS API Documentation

Request Syntax

client.update_knowledge_base_template_uri(
    knowledgeBaseId='string',
    templateUri='string'
)

type knowledgeBaseId

string

param knowledgeBaseId

[REQUIRED]

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

type templateUri

string

param templateUri

[REQUIRED]

The template URI to update.

rtype

dict

returns

Response Syntax

{
    'knowledgeBase': {
        'description': 'string',
        'ingestionFailureReasons': [
            'string',
        ],
        'ingestionStatus': 'SYNC_FAILED'|'SYNCING_IN_PROGRESS'|'SYNC_SUCCESS'|'CREATE_IN_PROGRESS',
        'knowledgeBaseArn': 'string',
        'knowledgeBaseId': 'string',
        'knowledgeBaseType': 'EXTERNAL'|'CUSTOM'|'QUICK_RESPONSES'|'MESSAGE_TEMPLATES'|'MANAGED',
        'lastContentModificationTime': datetime(2015, 1, 1),
        'name': 'string',
        'renderingConfiguration': {
            'templateUri': 'string'
        },
        'serverSideEncryptionConfiguration': {
            'kmsKeyId': 'string'
        },
        'sourceConfiguration': {
            'appIntegrations': {
                'appIntegrationArn': 'string',
                'objectFields': [
                    'string',
                ]
            },
            'managedSourceConfiguration': {
                'webCrawlerConfiguration': {
                    'crawlerLimits': {
                        'rateLimit': 123
                    },
                    'exclusionFilters': [
                        'string',
                    ],
                    'inclusionFilters': [
                        'string',
                    ],
                    'scope': 'HOST_ONLY'|'SUBDOMAINS',
                    'urlConfiguration': {
                        'seedUrls': [
                            {
                                'url': 'string'
                            },
                        ]
                    }
                }
            }
        },
        'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED',
        'tags': {
            'string': 'string'
        },
        'vectorIngestionConfiguration': {
            'chunkingConfiguration': {
                'chunkingStrategy': 'FIXED_SIZE'|'NONE'|'HIERARCHICAL'|'SEMANTIC',
                'fixedSizeChunkingConfiguration': {
                    'maxTokens': 123,
                    'overlapPercentage': 123
                },
                'hierarchicalChunkingConfiguration': {
                    'levelConfigurations': [
                        {
                            'maxTokens': 123
                        },
                    ],
                    'overlapTokens': 123
                },
                'semanticChunkingConfiguration': {
                    'breakpointPercentileThreshold': 123,
                    'bufferSize': 123,
                    'maxTokens': 123
                }
            },
            'parsingConfiguration': {
                'bedrockFoundationModelConfiguration': {
                    'modelArn': 'string',
                    'parsingPrompt': {
                        'parsingPromptText': 'string'
                    }
                },
                'parsingStrategy': 'BEDROCK_FOUNDATION_MODEL'
            }
        }
    }
}

Response Structure

(dict) --
- knowledgeBase (dict) --
  
  The knowledge base to update.
  - description (string) --
    
    The description.
  - ingestionFailureReasons (list) --
    
    List of failure reasons on ingestion per file.
    - (string) --
  - ingestionStatus (string) --
    
    Status of ingestion on data source.
  - knowledgeBaseArn (string) --
    
    The Amazon Resource Name (ARN) of the knowledge base.
  - knowledgeBaseId (string) --
    
    The identifier of the knowledge base.
  - knowledgeBaseType (string) --
    
    The type of knowledge base.
  - lastContentModificationTime (datetime) --
    
    An epoch timestamp indicating the most recent content modification inside the knowledge base. If no content exists in a knowledge base, this value is unset.
  - name (string) --
    
    The name of the knowledge base.
  - renderingConfiguration (dict) --
    
    Information about how to render the content.
    - templateUri (string) --
      
      A URI template containing exactly one variable in ${variableName} format. This can only be set for EXTERNAL knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following:
      - Salesforce: Id , ArticleNumber , VersionNumber , Title , PublishStatus , or IsDeleted
      - ServiceNow: number , short_description , sys_mod_count , workflow_state , or active
      - Zendesk: id , title , updated_at , or draft
      The variable is replaced with the actual value for a piece of content when calling GetContent.
  - serverSideEncryptionConfiguration (dict) --
    
    The configuration information for the customer managed key used for encryption.
    
    This KMS key must have a policy that allows kms:CreateGrant , kms:DescribeKey , kms:Decrypt , and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect.
    
    For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.
    - kmsKeyId (string) --
      
      The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. For information about valid ID values, see Key identifiers (KeyId).
  - sourceConfiguration (dict) --
    
    Source configuration information about the knowledge base.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: appIntegrations, managedSourceConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - appIntegrations (dict) --
      
      Configuration information for Amazon AppIntegrations to automatically ingest content.
      - appIntegrationArn (string) --
        
        The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.
        
        For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least Id , ArticleNumber , VersionNumber , Title , PublishStatus , and IsDeleted as source fields.
        
        For ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least number , short_description , sys_mod_count , workflow_state , and active as source fields.
        
        For Zendesk, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least id , title , updated_at , and draft as source fields.
        
        For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among docx , pdf , html , htm , and txt .
        
        For Amazon S3, the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The SourceURI of your DataIntegration must use the following format: s3://your_s3_bucket_name .
        
        Warning
        
        The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principal app-integrations.amazonaws.com to perform s3:ListBucket , s3:GetObject , and s3:GetBucketLocation against the bucket.
      - objectFields (list) --
        
        The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if ObjectConfiguration is included in the provided DataIntegration.
        
        For Salesforce, you must include at least Id , ArticleNumber , VersionNumber , Title , PublishStatus , and IsDeleted .
        
        For ServiceNow, you must include at least number , short_description , sys_mod_count , workflow_state , and active .
        
        For Zendesk, you must include at least id , title , updated_at , and draft .
        
        Make sure to include additional fields. These fields are indexed and used to source recommendations.
        
        (string) --
    - managedSourceConfiguration (dict) --
      
      Source configuration for managed resources.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: webCrawlerConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - webCrawlerConfiguration (dict) --
        
        Configuration data for web crawler data source.
        
        crawlerLimits (dict) --
        
        The configuration of crawl limits for the web URLs.
        
        rateLimit (integer) --
        
        Rate of web URLs retrieved per minute.
        
        exclusionFilters (list) --
        
        A list of one or more exclusion regular expression patterns to exclude certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
        
        (string) --
        
        inclusionFilters (list) --
        
        A list of one or more inclusion regular expression patterns to include certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
        
        (string) --
        
        scope (string) --
        
        The scope of what is crawled for your URLs. You can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL https://docs.aws.amazon.com/bedrock/latest/userguide/ and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain aws.amazon.com can also include sub domain docs.aws.amazon.com .
        
        urlConfiguration (dict) --
        
        The configuration of the URL/URLs for the web content that you want to crawl. You should be authorized to crawl the URLs.
        
        seedUrls (list) --
        
        List of URLs for crawling.
        
        (dict) --
        
        A URL for crawling.
        
        url (string) --
        
        URL for crawling
  - status (string) --
    
    The status of the knowledge base.
  - tags (dict) --
    
    The tags used to organize, track, or control access for this resource.
    - (string) --
      - (string) --
  - vectorIngestionConfiguration (dict) --
    
    Contains details about how to ingest the documents in a data source.
    - chunkingConfiguration (dict) --
      
      Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
      - chunkingStrategy (string) --
        
        Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE , then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.
      - fixedSizeChunkingConfiguration (dict) --
        
        Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE , exclude this field.
        
        maxTokens (integer) --
        
        The maximum number of tokens to include in a chunk.
        
        overlapPercentage (integer) --
        
        The percentage of overlap between adjacent chunks of a data source.
      - hierarchicalChunkingConfiguration (dict) --
        
        Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.
        
        levelConfigurations (list) --
        
        Token settings for each layer.
        
        (dict) --
        
        Token settings for each layer.
        
        maxTokens (integer) --
        
        The maximum number of tokens that a chunk can contain in this layer.
        
        overlapTokens (integer) --
        
        The number of tokens to repeat across chunks in the same layer.
      - semanticChunkingConfiguration (dict) --
        
        Settings for semantic document chunking for a data source. Semantic chunking splits a document into smaller documents based on groups of similar content derived from the text with natural language processing.
        
        breakpointPercentileThreshold (integer) --
        
        The dissimilarity threshold for splitting chunks.
        
        bufferSize (integer) --
        
        The buffer size.
        
        maxTokens (integer) --
        
        The maximum number of tokens that a chunk can contain.
    - parsingConfiguration (dict) --
      
      A custom parser for data source documents.
      - bedrockFoundationModelConfiguration (dict) --
        
        Settings for a foundation model used to parse documents for a data source.
        
        modelArn (string) --
        
        The ARN of the foundation model.
        
        parsingPrompt (dict) --
        
        Instructions for interpreting the contents of a document.
        
        parsingPromptText (string) --
        
        Instructions for interpreting the contents of a document.
      - parsingStrategy (string) --
        
        The parsing strategy for the data source.

UpdateSession (updated)

Link ¶
Changes (request, response)
Request

{'aiAgentConfiguration': {'MANUAL_SEARCH | ANSWER_RECOMMENDATION': {'aiAgentId': 'string'}}}

Response

{'session': {'aiAgentConfiguration': {'MANUAL_SEARCH | ANSWER_RECOMMENDATION': {'aiAgentId': 'string'}}}}

Updates a session. A session is a contextual container used for generating recommendations. Amazon Connect updates the existing Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.

See also: AWS API Documentation

Request Syntax

client.update_session(
    aiAgentConfiguration={
        'string': {
            'aiAgentId': 'string'
        }
    },
    assistantId='string',
    description='string',
    sessionId='string',
    tagFilter={
        'andConditions': [
            {
                'key': 'string',
                'value': 'string'
            },
        ],
        'orConditions': [
            {
                'andConditions': [
                    {
                        'key': 'string',
                        'value': 'string'
                    },
                ],
                'tagCondition': {
                    'key': 'string',
                    'value': 'string'
                }
            },
        ],
        'tagCondition': {
            'key': 'string',
            'value': 'string'
        }
    }
)

type aiAgentConfiguration

dict

param aiAgentConfiguration

The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session.

(string) --
- (dict) --
  
  A type that specifies the AI Agent ID configuration data when mapping an AI Agents to be used for an AI Agent type on a session or assistant.
  - aiAgentId (string) -- [REQUIRED]
    
    The ID of the AI Agent to be configured.

type assistantId

string

param assistantId

[REQUIRED]

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

type description

string

param description

The description.

type sessionId

string

param sessionId

[REQUIRED]

The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.

type tagFilter

dict

param tagFilter

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: andConditions, orConditions, 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.
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.
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.

rtype

dict

returns

Response Syntax

{
    'session': {
        'aiAgentConfiguration': {
            'string': {
                'aiAgentId': 'string'
            }
        },
        'description': 'string',
        'integrationConfiguration': {
            'topicIntegrationArn': 'string'
        },
        'name': 'string',
        'sessionArn': 'string',
        'sessionId': 'string',
        'tagFilter': {
            'andConditions': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'orConditions': [
                {
                    'andConditions': [
                        {
                            'key': 'string',
                            'value': 'string'
                        },
                    ],
                    'tagCondition': {
                        'key': 'string',
                        'value': 'string'
                    }
                },
            ],
            'tagCondition': {
                'key': 'string',
                'value': 'string'
            }
        },
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

(dict) --
- session (dict) --
  
  Information about the session.
  - aiAgentConfiguration (dict) --
    
    The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session.
    - (string) --
      - (dict) --
        
        A type that specifies the AI Agent ID configuration data when mapping an AI Agents to be used for an AI Agent type on a session or assistant.
        
        aiAgentId (string) --
        
        The ID of the AI Agent to be configured.
  - description (string) --
    
    The description of the session.
  - integrationConfiguration (dict) --
    
    The configuration information for the session integration.
    - topicIntegrationArn (string) --
      
      The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.
  - name (string) --
    
    The name of the session.
  - sessionArn (string) --
    
    The Amazon Resource Name (ARN) of the session.
  - sessionId (string) --
    
    The identifier of the session.
  - tagFilter (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: andConditions, orConditions, tagCondition. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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.
    - 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 set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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.
    - 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.
  - tags (dict) --
    
    The tags used to organize, track, or control access for this resource.
    - (string) --
      - (string) --