For the complete documentation index, see llms.txt. Markdown versions of all pages are available by appending .md to any URL (e.g. /get-started.md).

Python class

ResponseResource

ResponseResource

class max.pipelines.request.ResponseResource(*, id, object='response', created_at, status, model, citations=None, error=None, frequency_penalty=None, include=None, incomplete_details=None, logit_bias=None, logprobs=None, max_output_tokens=None, metadata=None, modalities=None, n=None, output=None, parallel_tool_calls=None, presence_penalty=None, reasoning=None, reasoning_reference=None, response_format=None, seed=None, service_tier=None, stop=None, store=None, stream=None, stream_options=None, temperature=None, tool_choice=None, tools=None, top_logprobs=None, top_p=None, truncation=None, usage=None, user=None, verbosity=None)

source

Bases: BaseModel

The response from the model.

Parameters:

• id (str)
• object (Literal['response'])
• created_at (int)
• status (str)
• model (str)
• citations (list[UrlCitationBody | ItemReferenceParam] | None)
• error (Error | None)
• frequency_penalty (float | None)
• include (list[IncludeEnum] | None)
• incomplete_details (IncompleteDetails | None)
• logit_bias (dict[str, float] | None)
• logprobs (bool | None)
• max_output_tokens (int | None)
• metadata (dict[str, str] | None)
• modalities (list[str] | None)
• n (int | None)
• output (list[Message] | None)
• parallel_tool_calls (bool | None)
• presence_penalty (float | None)
• reasoning (ReasoningBody | None)
• reasoning_reference (ReasoningReference | None)
• response_format (TextField | JsonObjectField | JsonSchemaField | None)
• seed (int | None)
• service_tier (ServiceTierEnum | None)
• stop (str | list[str] | None)
• store (bool | None)
• stream (bool | None)
• stream_options (StreamOptionsParam | None)
• temperature (float | None)
• tool_choice (ToolChoiceValueEnum | FunctionToolChoice | AllowedToolChoice | None)
• tools (list[FunctionTool] | None)
• top_logprobs (int | None)
• top_p (float | None)
• truncation (TruncationEnum | None)
• usage (Usage | None)
• user (str | None)
• verbosity (VerbosityEnum | None)

citations

citations: list[UrlCitationBody | ItemReferenceParam] | None

source

created_at

created_at: int

source

error

error: Error | None

source

frequency_penalty

frequency_penalty: float | None

source

from_generation_output()

classmethod from_generation_output(generation_output, model)

source

Create a ResponseResource from a GenerationOutput.

Converts pipeline generation output to the OpenResponses API response format.

Parameters:

• generation_output (Any) – The generation output from the pipeline, containing the generated content (images, etc.) and request metadata.
• model (str) – The model name used for generation.

Returns:

A ResponseResource instance with the generated content formatted as an assistant message in the output field.

Return type:

ResponseResource

Example:

>>> from max.pipelines.context import GenerationOutput
>>> from max.pipelines.request import RequestID
>>> from max.pipelines.request.open_responses import OutputImageContent
>>> from max.pipelines.modeling.types.status import GenerationStatus
>>> import numpy as np
>>>
>>> # Create generation output
>>> img_array = (np.random.rand(512, 512, 3) * 255).astype(np.uint8)
>>> gen_output = GenerationOutput(
...     request_id=RequestID(value="req-123"),
...     final_status=GenerationStatus.END_OF_SEQUENCE,
...     output=[OutputImageContent.from_numpy(img_array, format="png")]
... )
>>>
>>> # Convert to ResponseResource
>>> response = ResponseResource.from_generation_output(
...     gen_output, model="flux-2-dev-t2i-bfloat16-v2"
... )

id

id: str

source

include

include: list[IncludeEnum] | None

source

incomplete_details

incomplete_details: IncompleteDetails | None

source

logit_bias

logit_bias: dict[str, float] | None

source

logprobs

logprobs: bool | None

source

max_output_tokens

max_output_tokens: int | None

source

metadata

metadata: dict[str, str] | None

source

modalities

modalities: list[str] | None

source

model

model: str

source

model_config

model_config: ClassVar[ConfigDict] = {'frozen': True}

source

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

n

n: int | None

source

object

object: Literal['response']

source

output

output: list[Message] | None

source

parallel_tool_calls

parallel_tool_calls: bool | None

source

presence_penalty

presence_penalty: float | None

source

reasoning

reasoning: ReasoningBody | None

source

reasoning_reference

reasoning_reference: ReasoningReference | None

source

response_format

response_format: ResponseFormat | None

source

seed

seed: int | None

source

service_tier

service_tier: ServiceTierEnum | None

source

status

status: str

source

stop

stop: str | list[str] | None

source

store

store: bool | None

source

stream

stream: bool | None

source

stream_options

stream_options: StreamOptionsParam | None

source

temperature

temperature: float | None

source

tool_choice

tool_choice: ToolChoice | None

source

tools

tools: list[FunctionTool] | None

source

top_logprobs

top_logprobs: int | None

source

top_p

top_p: float | None

source

truncation

truncation: TruncationEnum | None

source

usage

usage: Usage | None

source

user

user: str | None

source

verbosity

verbosity: VerbosityEnum | None

source