OpenAI API

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

Thread

object

Represents a thread that contains messages.

idstringrequired

The identifier, which can be referenced in API endpoints.

objectstringrequired

The object type, which is always thread.

Allowed values:thread

created_atintegerrequired

The Unix timestamp (in seconds) for when the thread was created.

tool_resourcesobjectrequired

A set of resources that are made available to the assistant’s tools in this thread. The resources are specific to the type of tool. For example, the code_interpreter tool requires a list of file IDs, while the file_search tool requires a list of vector store IDs.

Show Child Parameters
metadataobjectrequired

Set of 16 key-value pairs that can be attached to an object. This can be
useful for storing additional information about the object in a structured
format, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings
with a maximum length of 512 characters.

Example