ChatSync
Starts or continues a non-streaming Amazon Q Business conversation.
Request Syntax
POST /applications/applicationId
/conversations?sync&userGroups=userGroups
&userId=userId
HTTP/1.1
Content-type: application/json
{
"actionExecution": {
"payload": {
"string
" : {
"value": JSON value
}
},
"payloadFieldNameSeparator": "string
",
"pluginId": "string
"
},
"attachments": [
{
"data": blob
,
"name": "string
"
}
],
"attributeFilter": {
"andAllFilters": [
"AttributeFilter"
],
"containsAll": {
"name": "string
",
"value": { ... }
},
"containsAny": {
"name": "string
",
"value": { ... }
},
"equalsTo": {
"name": "string
",
"value": { ... }
},
"greaterThan": {
"name": "string
",
"value": { ... }
},
"greaterThanOrEquals": {
"name": "string
",
"value": { ... }
},
"lessThan": {
"name": "string
",
"value": { ... }
},
"lessThanOrEquals": {
"name": "string
",
"value": { ... }
},
"notFilter": "AttributeFilter",
"orAllFilters": [
"AttributeFilter"
]
},
"authChallengeResponse": {
"responseMap": {
"string
" : "string
"
}
},
"chatMode": "string
",
"chatModeConfiguration": { ... },
"clientToken": "string
",
"conversationId": "string
",
"parentMessageId": "string
",
"userMessage": "string
"
}
URI Request Parameters
The request uses the following URI parameters.
- applicationId
-
The identifier of the Amazon Q Business application linked to the Amazon Q Business conversation.
Length Constraints: Fixed length of 36.
Pattern:
^[a-zA-Z0-9][a-zA-Z0-9-]{35}$
Required: Yes
- userGroups
-
The group names that a user associated with the chat input belongs to.
Length Constraints: Minimum length of 1. Maximum length of 2048.
- userId
-
The identifier of the user attached to the chat input.
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
^\P{C}*$
Request Body
The request accepts the following data in JSON format.
- actionExecution
-
A request from an end user to perform an Amazon Q Business plugin action.
Type: ActionExecution object
Required: No
- attachments
-
A list of files uploaded directly during chat. You can upload a maximum of 5 files of upto 10 MB each.
Type: Array of AttachmentInput objects
Array Members: Minimum number of 1 item.
Required: No
- attributeFilter
-
Enables filtering of Amazon Q Business web experience responses based on document attributes or metadata fields.
Type: AttributeFilter object
Required: No
- authChallengeResponse
-
An authentication verification event response by a third party authentication server to Amazon Q Business.
Type: AuthChallengeResponse object
Required: No
- chatMode
-
The chat modes available to an Amazon Q Business end user.
-
RETRIEVAL_MODE
- The default chat mode for an Amazon Q Business application. When this mode is enabled, Amazon Q Business generates responses only from data sources connected to an Amazon Q Business application. -
CREATOR_MODE
- By selecting this mode, users can choose to generate responses only from the LLM knowledge, without consulting connected data sources, for a chat request. -
PLUGIN_MODE
- By selecting this mode, users can choose to use plugins in chat.
For more information, see Admin controls and guardrails, Plugins, and Conversation settings.
Type: String
Valid Values:
RETRIEVAL_MODE | CREATOR_MODE | PLUGIN_MODE
Required: No
-
- chatModeConfiguration
-
The chat mode configuration for an Amazon Q Business application.
Type: ChatModeConfiguration object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: No
- clientToken
-
A token that you provide to identify a chat request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
- conversationId
-
The identifier of the Amazon Q Business conversation.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
^[a-zA-Z0-9][a-zA-Z0-9-]{35}$
Required: No
- parentMessageId
-
The identifier of the previous system message in a conversation.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
^[a-zA-Z0-9][a-zA-Z0-9-]{35}$
Required: No
- userMessage
-
A end user message in a conversation.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 7000.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"actionReview": {
"payload": {
"string" : {
"allowedFormat": "string",
"allowedValues": [
{
"displayValue": JSON value,
"value": JSON value
}
],
"displayDescription": "string",
"displayName": "string",
"displayOrder": number,
"required": boolean,
"type": "string",
"value": JSON value
}
},
"payloadFieldNameSeparator": "string",
"pluginId": "string",
"pluginType": "string"
},
"authChallengeRequest": {
"authorizationUrl": "string"
},
"conversationId": "string",
"failedAttachments": [
{
"error": {
"errorCode": "string",
"errorMessage": "string"
},
"name": "string",
"status": "string"
}
],
"sourceAttributions": [
{
"citationNumber": number,
"snippet": "string",
"textMessageSegments": [
{
"beginOffset": number,
"endOffset": number,
"snippetExcerpt": {
"text": "string"
}
}
],
"title": "string",
"updatedAt": number,
"url": "string"
}
],
"systemMessage": "string",
"systemMessageId": "string",
"userMessageId": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- actionReview
-
A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.
Type: ActionReview object
- authChallengeRequest
-
An authentication verification event activated by an end user request to use a custom plugin.
Type: AuthChallengeRequest object
- conversationId
-
The identifier of the Amazon Q Business conversation.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
^[a-zA-Z0-9][a-zA-Z0-9-]{35}$
- failedAttachments
-
A list of files which failed to upload during chat.
Type: Array of AttachmentOutput objects
- sourceAttributions
-
The source documents used to generate the conversation response.
Type: Array of SourceAttribution objects
- systemMessage
-
An AI-generated message in a conversation.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
- systemMessageId
-
The identifier of an Amazon Q Business AI generated message within the conversation.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
^[a-zA-Z0-9][a-zA-Z0-9-]{35}$
- userMessageId
-
The identifier of an Amazon Q Business end user text input message within the conversation.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
^[a-zA-Z0-9][a-zA-Z0-9-]{35}$
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
HTTP Status Code: 403
- ConflictException
-
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
HTTP Status Code: 409
- InternalServerException
-
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support
for help. HTTP Status Code: 500
- LicenseNotFoundException
-
You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.
HTTP Status Code: 400
- ResourceNotFoundException
-
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to throttling. Reduce the number of requests and try again.
HTTP Status Code: 429
- ValidationException
-
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: