Search
K
OpenAI API

RunToolCallObject

object

Tool call objects

idstringrequired

The ID of the tool call. This ID must be referenced when you submit the tool outputs in using the Submit tool outputs to run endpoint.

typestringrequired

The type of tool call the output is required for. For now, this is always function.

Allowed values:function

functionobjectrequired

The function definition.

Show Child Parameters
Example

StaticChunkingStrategy

object
* Additional properties are NOT allowed.
max_chunk_size_tokensintegerrequired

The maximum number of tokens in each chunk. The default value is 800. The minimum value is 100 and the maximum value is 4096.

>= 100<= 4096

chunk_overlap_tokensintegerrequired

The number of tokens that overlap between chunks. The default value is 400.

Note that the overlap must not exceed half of max_chunk_size_tokens.

Example

Static Chunking Strategy

object
* Additional properties are NOT allowed.
typestringrequired

Always static.

Allowed values:static

staticobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
Example

Static Chunking Strategy

object
* Additional properties are NOT allowed.
typestringrequired

Always static.

Allowed values:static

staticobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
Example

SubmitToolOutputsRunRequest

object
* Additional properties are NOT allowed.
tool_outputsarray[object]required

A list of tools for which the outputs are being submitted.

Show Child Parameters
streamboolean

If true, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a data: [DONE] message.

Example