[ aws . qconnect ]

query-assistant

Description

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.

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

See also: AWS API Documentation

query-assistant is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: results

Synopsis

  query-assistant
--assistant-id <value>
[--override-knowledge-base-search-type <value>]
[--query-condition <value>]
[--query-input-data <value>]
[--query-text <value>]
[--session-id <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--assistant-id (string)

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

--override-knowledge-base-search-type (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.

Possible values:

• HYBRID
• SEMANTIC

--query-condition (list)

Information about how to query content.

(tagged union structure)

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

The condition for the query.

comparator -> (string)

The comparison operator for query condition to query on.

field -> (string)

The name of the field for query condition to query on.

value -> (string)

The value for the query condition to query on.

Shorthand Syntax:

single={comparator=string,field=string,value=string} ...

JSON Syntax:

[
  {
    "single": {
      "comparator": "EQUALS",
      "field": "RESULT_TYPE",
      "value": "string"
    }
  }
  ...
]

--query-input-data (tagged union structure)

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

Input information for the intent.

intentId -> (string)

The identifier of the Amazon Q intent.

queryTextInputData -> (structure)

Input information for the query.

text -> (string)

The text to search for.

Shorthand Syntax:

intentInputData={intentId=string},queryTextInputData={text=string}

JSON Syntax:

{
  "intentInputData": {
    "intentId": "string"
  },
  "queryTextInputData": {
    "text": "string"
  }
}

--query-text (string)

The text to search for.

--session-id (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

nextToken -> (string)

If there are additional results, this is the token for the next set of results.

results -> (list)

The results of the query.

(structure)

Information about the result.

data -> (structure)

Summary of the recommended content.

details -> (tagged union structure)

Details about the data.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: contentData, generativeData, intentDetectedData, sourceContentData.

contentData -> (structure)

Details about the content data.

rankingData -> (structure)

Details about the content ranking data.

relevanceLevel -> (string)

The relevance score of the content.

relevanceScore -> (double)

The relevance level of the recommendation.

textData -> (structure)

Details about the content text data.

excerpt -> (structure)

The text of the document.

highlights -> (list)

Highlights in the document text.

(structure)

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

The text of the document.

highlights -> (list)

Highlights in the document text.

(structure)

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

Details about the generative data.

completion -> (string)

The LLM response.

rankingData -> (structure)

Details about the generative content ranking data.

relevanceLevel -> (string)

The relevance score of the content.

relevanceScore -> (double)

The relevance level of the recommendation.

references -> (list)

The references used to generative the LLM response.

(structure)

Summary of the data.

details -> (tagged union structure)

Details about the data.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: contentData, generativeData, intentDetectedData, sourceContentData.

contentData -> (structure)

Details about the content data.

rankingData -> (structure)

Details about the content ranking data.

relevanceLevel -> (string)

The relevance score of the content.

relevanceScore -> (double)

The relevance level of the recommendation.

textData -> (structure)

Details about the content text data.

excerpt -> (structure)

The text of the document.

highlights -> (list)

Highlights in the document text.

(structure)

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

The text of the document.

highlights -> (list)

Highlights in the document text.

(structure)

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

Details about the generative data.

completion -> (string)

The LLM response.

rankingData -> (structure)

Details about the generative content ranking data.

relevanceLevel -> (string)

The relevance score of the content.

relevanceScore -> (double)

The relevance level of the recommendation.

references -> (list)

The references used to generative the LLM response.

( … recursive … )

intentDetectedData -> (structure)

Details about the intent data.

intent -> (string)

The detected intent.

intentId -> (string)

The identifier of the detected intent.

sourceContentData -> (structure)

Details about the content data.

citationSpan -> (structure)

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

Details about the source content ranking data.

relevanceLevel -> (string)

The relevance score of the content.

relevanceScore -> (double)

The relevance level of the recommendation.

textData -> (structure)

Details about the source content text data.

excerpt -> (structure)

The text of the document.

highlights -> (list)

Highlights in the document text.

(structure)

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

The text of the document.

highlights -> (list)

Highlights in the document text.

(structure)

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 -> (tagged union structure)

Reference information about the content.

Note

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

contentReference -> (structure)

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

Reference information about the generative content.

generationId -> (string)

The identifier of the LLM model.

modelId -> (string)

The identifier of the LLM model.

intentDetectedData -> (structure)

Details about the intent data.

intent -> (string)

The detected intent.

intentId -> (string)

The identifier of the detected intent.

sourceContentData -> (structure)

Details about the content data.

citationSpan -> (structure)

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

Details about the source content ranking data.

relevanceLevel -> (string)

The relevance score of the content.

relevanceScore -> (double)

The relevance level of the recommendation.

textData -> (structure)

Details about the source content text data.

excerpt -> (structure)

The text of the document.

highlights -> (list)

Highlights in the document text.

(structure)

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

The text of the document.

highlights -> (list)

Highlights in the document text.

(structure)

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 -> (tagged union structure)

Reference information about the content.

Note

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

contentReference -> (structure)

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

Reference information about the generative content.

generationId -> (string)

The identifier of the LLM model.

modelId -> (string)

The identifier of the LLM model.

document -> (structure)

The document.

contentReference -> (structure)

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

The excerpt from the document.

highlights -> (list)

Highlights in the document text.

(structure)

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

The title of the document.

highlights -> (list)

Highlights in the document text.

(structure)

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

The relevance score of the results.

resultId -> (string)

The identifier of the result data.

type -> (string)

The type of the query result.