LLMResult#

class langchain_core.outputs.llm_result.LLMResult[source]#

Bases: BaseModel

A container for results of an LLM call.

Both chat models and LLMs generate an LLMResult object. This object contains the generated outputs and any additional information that the model provider wants to return.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

param generations: list[list[Generation | ChatGeneration | GenerationChunk | ChatGenerationChunk]] [Required]#

Generated outputs.

The first dimension of the list represents completions for different input prompts.

The second dimension of the list represents different candidate generations for a given prompt.

When returned from an LLM the type is List[List[Generation]]. When returned from a chat model the type is List[List[ChatGeneration]].

ChatGeneration is a subclass of Generation that has a field for a structured chat message.

param llm_output: dict | None = None#

For arbitrary LLM provider specific output.

This dictionary is a free-form dictionary that can contain any information that the provider wants to return. It is not standardized and is provider-specific.

Users should generally avoid relying on this field and instead rely on accessing relevant information from standardized fields present in AIMessage.

param run: list[RunInfo] | None = None#: List of metadata info for model call for each input.

param type: Literal['LLMResult'] = 'LLMResult'#: Type is used exclusively for serialization purposes.

flatten() → list[LLMResult][source]#

Flatten generations into a single list.

Unpack List[List[Generation]] -> List[LLMResult] where each returned LLMResult contains only a single Generation. If token usage information is available, it is kept only for the LLMResult corresponding to the top-choice Generation, to avoid over-counting of token usage downstream.

Returns:

List of LLMResults where each returned LLMResult contains a single: Generation.

Return type:

list[LLMResult]

Examples using LLMResult