BatchRequestInput
objectThe per-line object of the batch input file
A developer-provided per-request id that will be used to match outputs to inputs. Must be unique for each request in a batch.
The HTTP method to be used for the request. Currently only POST is supported.
Allowed values:POST
The OpenAI API relative URL to be used for the request. Currently /v1/chat/completions, /v1/embeddings, and /v1/completions are supported.
BatchRequestOutput
objectThe per-line object of the batch output and error files
A developer-provided per-request id that will be used to match outputs to inputs.
Show Child Parameters
For requests that failed with a non-HTTP error, this will contain more information on the cause of the failure.
Show Child Parameters
CancelUploadRequest
objectChatCompletionFunctionCallOption
objectSpecifying a particular function via {"name": "my_function"} forces the model to call that function.
The name of the function to call.
ChatCompletionFunctions
objectA description of what the function does, used by the model to choose when and how to call the function.
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.
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.