Search
K
OpenAI API

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

ChatCompletionMessageToolCallChunk

object
indexintegerrequired
idstring

The ID of the tool call.

typestring

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

Allowed values:function

functionobject
Show Child Parameters
Example