OpenAI API

ResponseFormatJsonObject

object
typestringrequired

The type of response format being defined: json_object

Allowed values:json_object

Example

ResponseFormatJsonSchema

object
typestringrequired

The type of response format being defined: json_schema

Allowed values:json_schema

json_schemaobjectrequired
Show Child Parameters
Example

ResponseFormatJsonSchemaSchema

object

The schema for the response format, described as a JSON Schema object.

* Additional properties are allowed.

ResponseFormatText

object
typestringrequired

The type of response format being defined: text

Allowed values:text

Example

RunCompletionUsage

object

Usage statistics related to the run. This value will be null if the run is not in a terminal state (i.e. in_progress, queued, etc.).

completion_tokensintegerrequired

Number of completion tokens used over the course of the run.

prompt_tokensintegerrequired

Number of prompt tokens used over the course of the run.

total_tokensintegerrequired

Total number of tokens used (prompt + completion).

Example