Search
K
OpenAI API

BatchRequestOutput

object

The per-line object of the batch output and error files

idstring
custom_idstring

A developer-provided per-request id that will be used to match outputs to inputs.

responseobject
Show Child Parameters
errorobject

For requests that failed with a non-HTTP error, this will contain more information on the cause of the failure.

Show Child Parameters
Example

CancelUploadRequest

object
* Additional properties are NOT allowed.

ChatCompletionFunctionCallOption

object

Specifying a particular function via {"name": "my_function"} forces the model to call that function.

namestringrequired

The name of the function to call.

Example

ChatCompletionFunctions

object
descriptionstring

A description of what the function does, used by the model to choose when and how to call the function.

namestringrequired

The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.

parametersobject

The parameters the functions accepts, described as a JSON Schema object. See the guide for examples, and the JSON Schema reference for documentation about the format.

Omitting parameters defines a function with an empty parameter list.

* Additional properties are allowed.
Example

ChatCompletionMessageToolCall

object
idstringrequired

The ID of the tool call.

typestringrequired

The type of the tool. Currently, only function is supported.

Allowed values:function

functionobjectrequired

The function that the model called.

Show Child Parameters
Example