Python class

TextGenerationOutput

`TextGenerationOutput`

class max.interfaces.TextGenerationOutput(*, request_id, tokens, final_status, log_probabilities=None, num_cached_tokens=None)

source

Represents the output of a text generation operation.

Combines token IDs, final generation status, request ID, and optional log probabilities for each token.

Parameters:

final_status: GenerationStatus

source

The final status of the generation process.

property is_done: bool

source

Indicates whether the text generation process is complete.

log_probabilities: list[LogProbabilities] | None = None

source

Optional list of log probabilities for each token.

classmethod merge(outputs)

source

Combine many TextGenerationOutput chunks into a single TextGenerationOutput.

num_cached_tokens: int | None = None

source

Number of prompt tokens served from the KV prefix cache.

request_id: RequestID

source

The unique identifier for the generation request.

tokens: list[int]

source

List of generated token IDs.