Deserialised response from OpenAI's Responses endpoint (POST /v1/responses), returned by OpenAiClient.doResponses. Wraps the generated output items, the model and status of the request, and its token usage, and is used by the agent orchestration code (PlanPhase, ActPhase, LlmPlanJudge) to read the model's output. Any JSON fields OpenAI returns that are not otherwise mapped are captured in extraFields so they round-trip rather than being lost. The XML element name is "responses-response".

Group: AI Agents

Properties

Methods

getId()

Returns: String

Unique identifier OpenAI assigned to this response.

getStatus()

Returns: String

Lifecycle status of the response, such as completed, in_progress or failed.

getModel()

Returns: String

Name of the OpenAI model that generated the response.

getUsage()

Returns: ResponsesUsage

Token usage recorded by OpenAI for this responses request.

getOutput()

Returns: List<Map<String,Object>>

Output items produced by the model, each a map of the raw OpenAI JSON for one item. An item's content list holds the generated text; callers such as PlanPhase and LlmPlanJudge walk this structure to extract the model's text output or tool calls.

getExtraFields()

Returns: Map<String,Object>

Any JSON fields OpenAI returned that are not mapped to a named property on this class, keyed by their original JSON field name. Used so that fields the platform does not yet model are preserved when the response is re-serialised rather than silently dropped.

setExtraFields(Map<String,Object> extraFields)

Returns: void

Replaces the map of JSON fields not otherwise mapped to a named property on this class.