Search
K
OpenAI API

ChatCompletionTool

object
typestringrequired

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

Allowed values:function

functionobjectrequired
Show Child Parameters
Example

ChatCompletionToolChoiceOption

Controls which (if any) tool is called by the model.
none means the model will not call any tool and instead generates a message.
auto means the model can pick between generating a message or calling one or more tools.
required means the model must call one or more tools.
Specifying a particular tool via {"type": "function", "function": {"name": "my_function"}} forces the model to call that tool.

none is the default when no tools are present. auto is the default if tools are present.

One Of

ChunkingStrategyRequestParam

object

The chunking strategy used to chunk the file(s). If not set, will use the auto strategy.

One Of
typestringrequired

Always auto.

Allowed values:auto

Example

CompleteUploadRequest

object
* Additional properties are NOT allowed.
part_idsarray[string]required

The ordered list of Part IDs.

md5string

The optional md5 checksum for the file contents to verify if the bytes uploaded matches what you expect.

Example

CompletionUsage

object

Usage statistics for the completion request.

completion_tokensintegerrequired

Number of tokens in the generated completion.

Default:0

prompt_tokensintegerrequired

Number of tokens in the prompt.

Default:0

total_tokensintegerrequired

Total number of tokens used in the request (prompt + completion).

Default:0

completion_tokens_detailsobject

Breakdown of tokens used in a completion.

Show Child Parameters
prompt_tokens_detailsobject

Breakdown of tokens used in the prompt.

Show Child Parameters
Example