[ aws . sagemakertrainingsessionruntime ]

get-sampling-operation-result

Description

Retrieves the current status and result of a previously submitted sampling operation. Poll this operation until the status reaches a terminal state (Completed or Failed).

See also: AWS API Documentation

Synopsis

  get-sampling-operation-result
--training-session-name <value>
--operation-id <value>
[--cli-input-json | --cli-input-yaml]
[--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]
[--cli-error-format <value>]

Options

--training-session-name (string) [required]

The name of the training session that owns the sample operation.

Constraints:

• min: 1
• max: 64
• pattern: [a-zA-Z0-9-]+

--operation-id (string) [required]

The unique identifier of the sample operation to retrieve, returned by ExecuteSamplingOperation .

Constraints:

• min: 1
• max: 64
• pattern: [a-zA-Z0-9-]+

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

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
• off

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

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

• legacy
• json
• yaml
• text
• table
• enhanced

Output

status -> (string)

The current status of the sample operation. Possible values are Pending , InProgress , Completed , or Failed .

Possible values:

• Pending
• InProgress
• Completed
• Failed
• Skipped

operationResult -> (tagged union structure)

The result payload of the sample operation. The service populates this field only when the status is Completed .

Note

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

sample -> (structure)

The generated text samples from the model.

sequences -> (list) [required]

The list of generated sequences.

(structure)

A single generated sequence from the model.

stopReason -> (string) [required]

The reason why generation stopped. A value of stop indicates a stop sequence was encountered. A value of length indicates the maximum token limit was reached.

Possible values:

• stop
• length

tokens -> (list) [required]

The token IDs of the generated sequence.

(integer)

logprobs -> (list)

The per-token log-probabilities for the generated tokens.

(double)

tokenUsage -> (structure)

The token usage statistics for this individual sample.

prefill -> (integer) [required]

The number of tokens in the input prompt (prefill phase).

decode -> (integer) [required]

The number of tokens generated (decode phase).

promptLogprobs -> (list)

The per-token log-probabilities for the input prompt. Populated only when includePromptLogprobs is true.

(double)

topkPromptLogprobs -> (list)

The top-k log-probabilities per prompt token, as a list of lists. Populated only when topkPromptLogprobs is greater than 0.

(list)

(structure)

The log-probability for a single token.

tokenId -> (integer) [required]

The vocabulary token ID.

logprob -> (double) [required]

The log-probability of the token.

computeLogprobs -> (structure)

The computed log-probabilities for the prompt tokens.

logprobs -> (list) [required]

The per-token log-probabilities for the input prompt.

(double)

loadWeightsForSampling -> (structure)

The result from loading weights for sampling.

errorDetails -> (string)

A message describing why the sample operation failed. The service populates this field only when the status is Failed .