[ aws . wisdom ]

get-recommendations

Description

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 .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-recommendations
--assistant-id <value>
[--max-results <value>]
--session-id <value>
[--wait-time-seconds <value>]
[--cli-input-json | --cli-input-yaml]
[--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.

--max-results (integer)

The maximum number of results to return per page.

--session-id (string)

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

--wait-time-seconds (integer)

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.

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

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

See ‘aws help’ for descriptions of global parameters.

Output

recommendations -> (list)

The recommendations.

(structure)

Information about the recommendation.

document -> (structure)

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

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.

recommendationId -> (string)

The identifier of the recommendation.

relevanceLevel -> (string)

The relevance level of the recommendation.

relevanceScore -> (double)

The relevance score of the recommendation.

type -> (string)

The type of recommendation.

triggers -> (list)

The triggers corresponding to recommendations.

(structure)

A recommendation trigger provides context on the event that produced the referenced recommendations. Recommendations are only referenced in recommendationIds by a single RecommendationTrigger.

data -> (structure)

A union type containing information related to the trigger.

query -> (structure)

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.