Search
K
OpenAI API

ModifyRunRequest

object
* Additional properties are NOT allowed.
metadataobject

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

ModifyThreadRequest

object
* Additional properties are NOT allowed.
tool_resourcesobject

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
metadataobject

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

OpenAIFile

The File object represents a document that has been uploaded to OpenAI.

idstringrequired

The file identifier, which can be referenced in the API endpoints.

bytesintegerrequired

The size of the file, in bytes.

created_atintegerrequired

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

filenamestringrequired

The name of the file.

objectstringrequired

The object type, which is always file.

Allowed values:file

purposestringrequired

The intended purpose of the file. Supported values are assistants, assistants_output, batch, batch_output, fine-tune, fine-tune-results and vision.

Allowed values:assistantsassistants_outputbatchbatch_outputfine-tunefine-tune-resultsvision

statusstringrequiredDEPRECATED

Deprecated. The current status of the file, which can be either uploaded, processed, or error.

Allowed values:uploadedprocessederror

status_detailsstringDEPRECATED

Deprecated. For details on why a fine-tuning training file failed validation, see the error field on fine_tuning.job.

Example

Other Chunking Strategy

object

This is returned when the chunking strategy is unknown. Typically, this is because the file was indexed before the chunking_strategy concept was introduced in the API.

* Additional properties are NOT allowed.
typestringrequired

Always other.

Allowed values:other

Example

ParallelToolCalls

boolean

Whether to enable parallel function calling during tool use.

Default:true