Response¶

This docs was updated at: 2026-03-21

com.paragon.responses.spec.Response · Class

Methods¶

`Response`¶

public Response(
      @JsonProperty("background") @Nullable Boolean background,
      @JsonProperty("conversation") @Nullable Conversation conversation,
      @JsonProperty("created_at") @Nullable Number createdAt,
      @JsonProperty("error") @Nullable ResponseError error,
      @JsonProperty("id") @Nullable String id,
      @JsonProperty("incomplete_details") @Nullable IncompleteDetails incompleteDetails,
      @JsonProperty("instructions") @Nullable String instructions,
      @JsonProperty("max_output_tokens") @Nullable Integer maxOutputTokens,
      @JsonProperty("max_to

Parameters

Name	Description
`background`	Whether the response was configured to run in the background. See https://platform.openai.com/docs/guides/background
`conversation`	The conversation that this response belongs to. Input items and output items from this response are automatically added to this conversation.
`createdAt`	Unix timestamp (in seconds) of when this Response was created.
`error`	An error object returned when the model fails to generate a Response.
`id`	Unique identifier for this Response.
`incompleteDetails`	Details about why the response is incomplete.
`instructions`	A system (or developer) message inserted into the model's context. When using along with previous_response_id, the instructions from a previous response will not be carried over to the next response. This makes it simple to swap out system (or developer) messages in new responses.
`maxOutputTokens`	The configured upper bound for the number of generated tokens, including reasoning tokens. See https://platform.openai.com/docs/guides/reasoning
`maxToolCalls`	The maximum number of total calls to built-in tools that can be processed in a response. This maximum number applies across all built-in tool calls, not per individual tool. Any further attempts to call a tool by the model will be ignored.
`metadata`	Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.
`model`	Model ID used to generate the response, like gpt-4o or o3. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the model guide to browse and compare available models.
`object`	The object type of this resource - always set to `ResponseObject`.
`output`	An array of content items generated by the model. The length and order of items in the output array is dependent on the model's response. Rather than accessing the first item in the output array and assuming it's an assistant message with the content generated by the model, you might consider using the output_text property where supported in SDKs.
`parallelToolCalls`	Whether to allow the model to run tool calls in parallel.
`prompt`	Reference to a prompt template and its variables. See https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts
`promptCacheKey`	Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the user field. See https://platform.openai.com/docs/guides/prompt-caching
`promptCacheRetention`	The retention policy for the prompt cache. Set to 24h to enable extended prompt caching, which keeps cached prefixes active for longer, up to a maximum of 24 hours. Learn more.
`reasoning`	Configuration returned for reasoning models. See https://platform.openai.com/docs/guides/reasoning
`safetyIdentifier`	A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies. The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. See https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers
`serviceTier`	Specifies the processing type used for serving the request. If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'. If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. If set to 'flex' or 'priority', then the request will be processed with the corresponding service tier. When not set, the default behavior is 'auto'. When the service_tier parameter is set, the response body will include the service_tier value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.
`status`	The status of the response generation. One of `completed`, `failed`, `in_progress`, `cancelled`, `queued`, or `incomplete`.
`temperature`	What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both.
`text`	Configuration options for a text response from the model. Can be plain text or structured JSON data. See https://platform.openai.com/docs/guides/text and https://platform.openai.com/docs/guides/structured-outputs
`toolChoice`	How the model should select which tool (or tools) to use when generating a response. See the `tools` parameter to see how to specify which tools the model can call.
`tools`	An array of tools the model may call while generating a response. Supported categories include built-in tools, MCP tools, and function tools. References: web search https://platform.openai.com/docs/guides/tools-web-search?api-mode=responses, file search https://platform.openai.com/docs/guides/tools-file-search, built-in tools https://platform.openai.com/docs/guides/tools, MCP tools https://platform.openai.com/docs/guides/tools-connectors-mcp, function calling https://platform.openai.com/docs/guides/function-calling
`topLogprobs`	An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability.
`topP`	An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both.
`truncation`	The truncation strategy used for the response. `auto` drops items from the beginning of the conversation when needed to fit the context window; `disabled` fails the request instead.

`outputText`¶

public @Nullable String outputText()

SDK-only convenience property that contains the aggregated text output from all output_text items in the output array, if any are present. Supported in the Python and JavaScript SDKs.

Returns

string representation of the output

`functionToolCalls`¶

public @NonNull List<FunctionToolCall> functionToolCalls()

Returns all function tool calls from the response output.

Note: These are raw tool calls that cannot be invoked directly.

Returns

list of function tool calls

`functionToolCalls`¶

public @NonNull List<BoundedFunctionCall> functionToolCalls(@NonNull FunctionToolStore store)

Returns all function tool calls bound to their implementations from the store.

The returned BoundedFunctionCall instances can be invoked via BoundedFunctionCall.call().

Parameters

Name	Description
`store`	the store containing the function implementations

Returns

list of callable bounded function calls

Throws

Type	Condition
`IllegalArgumentException`	if any tool call references a function not in the store

Response¶

Methods¶

Response¶

outputText¶

functionToolCalls¶

functionToolCalls¶

`Response`¶

`outputText`¶

`functionToolCalls`¶

`functionToolCalls`¶