OpenAI API

Thread Truncation Controls

object

Controls for how a thread will be truncated prior to the run. Use this to control the intial context window of the run.

typestringrequired

The truncation strategy to use for the thread. The default is auto. If set to last_messages, the thread will be truncated to the n most recent messages in the thread. When set to auto, messages in the middle of the thread will be dropped to fit the context length of the model, max_prompt_tokens.

Allowed values:autolast_messages

last_messagesinteger

The number of most recent messages from the thread when constructing the context for the run.

>= 1

Example

UpdateVectorStoreRequest

object
* Additional properties are NOT allowed.
namestring

The name of the vector store.

expires_afterobject

The expiration policy for a vector store.

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

Upload

object

The Upload object can accept byte chunks in the form of Parts.

idstringrequired

The Upload unique identifier, which can be referenced in API endpoints.

created_atintegerrequired

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

filenamestringrequired

The name of the file to be uploaded.

bytesintegerrequired

The intended number of bytes to be uploaded.

purposestringrequired

The intended purpose of the file. Please refer here for acceptable values.

statusstringrequired

The status of the Upload.

Allowed values:pendingcompletedcancelledexpired

expires_atintegerrequired

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

objectstring

The object type, which is always “upload”.

Allowed values:upload

file

The ready File object after the Upload is completed.

Show Child Parameters
Example

UploadPart

object

The upload Part represents a chunk of bytes we can add to an Upload object.

idstringrequired

The upload Part unique identifier, which can be referenced in API endpoints.

created_atintegerrequired

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

upload_idstringrequired

The ID of the Upload object that this Part was added to.

objectstringrequired

The object type, which is always upload.part.

Allowed values:upload.part

Example

UsageAudioSpeechesResult

object

The aggregated audio speeches usage details of the specific time bucket.

objectstringrequired

Allowed values:organization.usage.audio_speeches.result

charactersintegerrequired

The number of characters processed.

num_model_requestsintegerrequired

The count of requests made to the model.

project_idstring

When group_by=project_id, this field provides the project ID of the grouped usage result.

user_idstring

When group_by=user_id, this field provides the user ID of the grouped usage result.

api_key_idstring

When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

modelstring

When group_by=model, this field provides the model name of the grouped usage result.

Example