ResponseObject Class

Override generated ResponseObject to correct temperature/top_p types and fix Sphinx docstring warnings.

Constructor

ResponseObject(*args: Any, **kwargs: Any)

Methods

as_dict	Return a dict that can be turned into json using json.dump.
clear	Remove all items from D.
copy
get	Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
items
keys
pop	Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
popitem	Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
setdefault	Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
update	Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
values

as_dict

Return a dict that can be turned into json using json.dump.

as_dict(*, exclude_readonly: bool = False) -> dict[str, Any]

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties. Default value: False

Returns

Type	Description
dict	A dict JSON compatible object

clear

Remove all items from D.

clear() -> None

copy

copy() -> Model

get

Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any

get(key: str, default: Any = None) -> Any

Parameters

Name	Description
key Required
default	Default value: None

items

items() -> ItemsView[str, Any]

Returns

Type	Description
ItemsView	set-like object providing a view on D's items

keys

keys() -> KeysView[str]

Returns

Type	Description
KeysView	a set-like object providing a view on D's keys

pop

Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default

popitem

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.

popitem() -> tuple[str, Any]

setdefault

Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default

update

Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.

update(*args: Any, **kwargs: Any) -> None

values

values() -> ValuesView[Any]

Returns

Type	Description
ValuesView	an object providing a view on D's values

Attributes

agent_reference

The agent used for this response. Required.

agent_reference: _models.AgentReference

created_at

Unix timestamp (in seconds) of when this Response was created. Required.

created_at: datetime.datetime

error

Required.

error: _models.ResponseErrorInfo

id

Unique identifier for this Response. Required.

id: str

incomplete_details

Required.

incomplete_details: _models.ResponseIncompleteDetails

instructions

Required. Is either a str type or a [Item] type.

instructions: str | list['_models.Item']

model

The model deployment to use for the creation of this response.

model: str | None

object

The object type of this resource - always set to response. Required. Default value is "response".

object: Literal['response']

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.

Required.

output: list['OutputItem']

parallel_tool_calls

Whether to allow the model to run tool calls in parallel. Required.

parallel_tool_calls: bool

prompt_cache_key

Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the user field. Learn more.

prompt_cache_key: str | None

prompt_cache_retention

Is either a Literal["in-memory"] type or a Literal["24h"] type.

prompt_cache_retention: Literal['in-memory', '24h'] | None

safety_identifier

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. Learn more.

safety_identifier: str | None

service_tier

Literal["auto"], Literal["default"], Literal["flex"], Literal["scale"], Literal["priority"]

service_tier: Literal['auto', 'default', 'flex', 'scale', 'priority'] | None

status

The status of the response generation. One of completed, failed, in_progress, cancelled, queued, or incomplete. Is one of the following types: Literal["completed"], Literal["failed"], Literal["in_progress"], Literal["cancelled"], Literal["queued"], Literal["incomplete"]

status: Literal['completed', 'failed', 'in_progress', 'cancelled', 'queued', 'incomplete'] | None

temperature

Sampling temperature. Float between 0 and 2.

temperature: float | None

tool_choice

Is either a Union[str, "_models.ToolChoiceOptions"] type or a ToolChoiceParam type.

tool_choice: str | '_models.ToolChoiceOptions' | '_models.ToolChoiceParam' | None

top_p

Nucleus sampling parameter. Float between 0 and 1.

top_p: float | None

truncation

Is either a Literal["auto"] type or a Literal["disabled"] type.

truncation: Literal['auto', 'disabled'] | None

user

This field is being replaced by safety_identifier and prompt_cache_key. Use prompt_cache_key instead to maintain caching optimizations. A stable identifier for your end-users. Used to boost cache hit rates by better bucketing similar requests and to help OpenAI detect and prevent abuse. Learn more.

user: str | None

background

background: bool | None

completed_at

completed_at: datetime.datetime | None

conversation

conversation: '_models.ConversationReference' | None

max_output_tokens

max_output_tokens: int | None

max_tool_calls

max_tool_calls: int | None

metadata

metadata: '_models.Metadata' | None

output_text

output_text: str | None

previous_response_id

previous_response_id: str | None

prompt

prompt: '_models.Prompt' | None

reasoning

reasoning: '_models.Reasoning' | None

text

text: '_models.ResponseTextParam' | None

tools

tools: list['_models.Tool'] | None

top_logprobs

top_logprobs: int | None

usage

usage: '_models.ResponseUsage' | None

Feedback

Was this page helpful?