[ aws . wisdom ]

query-assistant

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

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>
--query-text <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--assistant-id (string)

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

--query-text (string)

The text to search for.

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

See ‘aws help’ for descriptions of global 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.

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 the identifier of the knowledge base.

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.