assistants

Creates, updates, deletes, gets or lists an assistants resource.

Overview

Name	assistants
Type	Resource
Id	aws.qconnect.assistants

Fields

The following fields are returned by SELECT queries:

get_assistant

Name	Datatype	Description
name	string	The name. (pattern: <code>[a-zA-Z0-9\s_.,-]+.*</code>)
ai_agent_configuration	object	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.
assistant_arn	string	The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant. (pattern: <code>arn:[a-z-]?:wisdom:[a-z0-9-]?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}</code>)
assistant_id	string	The identifier of the Amazon Q in Connect assistant. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
capability_configuration	object	The configuration information for the Amazon Q in Connect assistant capability.
description	string	The description. (pattern: <code>[a-zA-Z0-9\s_.,-]+.*</code>)
integration_configuration	object	The configuration information for the Amazon Q in Connect assistant integration.
orchestrator_configuration_list	array	The list of orchestrator configurations for the assistant.
server_side_encryption_configuration	object	The configuration information for the customer managed key used for encryption.
status	string	The status of the assistant. (CREATE_IN_PROGRESS, CREATE_FAILED, ACTIVE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETED)
tags	object	The tags used to organize, track, or control access for this resource.
type_	string	The type of assistant. (AGENT)

list_assistants

Name	Datatype	Description
name	string	The name of the assistant. (pattern: <code>[a-zA-Z0-9\s_.,-]+.*</code>)
ai_agent_configuration	object	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.
assistant_arn	string	The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant. (pattern: <code>arn:[a-z-]?:wisdom:[a-z0-9-]?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}</code>)
assistant_id	string	The identifier of the Amazon Q in Connect assistant. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
capability_configuration	object	The configuration information for the Amazon Q in Connect assistant capability.
description	string	The description of the assistant. (pattern: <code>[a-zA-Z0-9\s_.,-]+.*</code>)
integration_configuration	object	The configuration information for the Amazon Q in Connect assistant integration.
orchestrator_configuration_list	array	The list of orchestrator configurations for the assistant.
server_side_encryption_configuration	object	The configuration information for the customer managed key used for encryption.
status	string	The status of the assistant. (CREATE_IN_PROGRESS, CREATE_FAILED, ACTIVE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETED)
tags	object	The tags used to organize, track, or control access for this resource.
type_	string	The type of the assistant. (AGENT)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_assistant	select	assistant_id, region		Retrieves information about an assistant.
list_assistants	select	region	nextToken, maxResults	Lists information about assistants.
create_assistant	insert	region, name, type		Creates an Amazon Q in Connect assistant.
put_feedback	replace	assistant_id, region, targetId, targetType, contentFeedback		Provides feedback against the specified assistant for the specified target. This API only supports generative targets.
delete_assistant	delete	assistant_id, region		Deletes an assistant.
query_assistant	exec	assistant_id, region		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. Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations.
retrieve	exec	assistant_id, region, retrievalConfiguration, retrievalQuery		Retrieves content from knowledge sources based on a query.
send_message	exec	assistant_id, session_id, region, type, message		Submits a message to the Amazon Q in Connect session.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
assistant_id	string	The identifier of the Amazon Q in Connect assistant.
region	string	AWS region (default: us-east-1)
session_id	string	The identifier of the Amazon Q in Connect session.
maxResults	integer	The maximum number of results to return per page.
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.

SELECT examples

get_assistant

Retrieves information about an assistant.

SELECT
name,
ai_agent_configuration,
assistant_arn,
assistant_id,
capability_configuration,
description,
integration_configuration,
orchestrator_configuration_list,
server_side_encryption_configuration,
status,
tags,
type_
FROM aws.qconnect.assistants
WHERE assistant_id = '{{ assistant_id }}' -- required
AND region = '{{ region }}' -- required
;

list_assistants

Lists information about assistants.

SELECT
name,
ai_agent_configuration,
assistant_arn,
assistant_id,
capability_configuration,
description,
integration_configuration,
orchestrator_configuration_list,
server_side_encryption_configuration,
status,
tags,
type_
FROM aws.qconnect.assistants
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_assistant

Creates an Amazon Q in Connect assistant.

INSERT INTO aws.qconnect.assistants (
clientToken,
name,
type,
description,
tags,
serverSideEncryptionConfiguration,
region
)
SELECT 
'{{ clientToken }}',
'{{ name }}' /* required */,
'{{ type }}' /* required */,
'{{ description }}',
'{{ tags }}',
'{{ serverSideEncryptionConfiguration }}',
'{{ region }}'
RETURNING
assistant
;

Manifest

# Description fields are for documentation purposes
- name: assistants
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the assistants resource.
  - name: clientToken
    value: "{{ clientToken }}"
  - name: name
    value: "{{ name }}"
  - name: type
    value: "{{ type }}"
    valid_values: ['AGENT']
  - name: description
    value: "{{ description }}"
  - name: tags
    value: "{{ tags }}"
  - name: serverSideEncryptionConfiguration
    description: |
      The configuration information for the customer managed key used for encryption.
    value:
      kmsKeyId: "{{ kmsKeyId }}"

REPLACE examples

put_feedback

Provides feedback against the specified assistant for the specified target. This API only supports generative targets.

REPLACE aws.qconnect.assistants
SET 
targetId = '{{ targetId }}',
targetType = '{{ targetType }}',
contentFeedback = '{{ contentFeedback }}'
WHERE 
assistant_id = '{{ assistant_id }}' --required
AND region = '{{ region }}' --required
AND targetId = '{{ targetId }}' --required
AND targetType = '{{ targetType }}' --required
AND contentFeedback = '{{ contentFeedback }}' --required
RETURNING
assistant_arn,
assistant_id,
content_feedback,
target_id,
target_type;

DELETE examples

delete_assistant

Deletes an assistant.

DELETE FROM aws.qconnect.assistants
WHERE assistant_id = '{{ assistant_id }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

query_assistant

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. Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations.

EXEC aws.qconnect.assistants.query_assistant 
@assistant_id='{{ assistant_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"queryText": "{{ queryText }}", 
"nextToken": "{{ nextToken }}", 
"maxResults": {{ maxResults }}, 
"sessionId": "{{ sessionId }}", 
"queryCondition": "{{ queryCondition }}", 
"queryInputData": "{{ queryInputData }}", 
"overrideKnowledgeBaseSearchType": "{{ overrideKnowledgeBaseSearchType }}"
}'
;

retrieve

Retrieves content from knowledge sources based on a query.

EXEC aws.qconnect.assistants.retrieve 
@assistant_id='{{ assistant_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"retrievalConfiguration": "{{ retrievalConfiguration }}", 
"retrievalQuery": "{{ retrievalQuery }}"
}'
;

send_message

Submits a message to the Amazon Q in Connect session.

EXEC aws.qconnect.assistants.send_message 
@assistant_id='{{ assistant_id }}' --required, 
@session_id='{{ session_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"type": "{{ type }}", 
"message": "{{ message }}", 
"aiAgentId": "{{ aiAgentId }}", 
"conversationContext": "{{ conversationContext }}", 
"configuration": "{{ configuration }}", 
"clientToken": "{{ clientToken }}", 
"orchestratorUseCase": "{{ orchestratorUseCase }}", 
"metadata": "{{ metadata }}", 
"originRequestId": "{{ originRequestId }}"
}'
;