OpenAI API

CreateUploadRequest

object
* Additional properties are NOT allowed.
filenamestringrequired

The name of the file to upload.

purposestringrequired

The intended purpose of the uploaded file.

See the documentation on File purposes.

Allowed values:assistantsbatchfine-tunevision

bytesintegerrequired

The number of bytes in the file you are uploading.

mime_typestringrequired

The MIME type of the file.

This must fall within the supported MIME types for your file purpose. See the supported MIME types for assistants and vision.

Example

CreateVectorStoreFileBatchRequest

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

A list of File IDs that the vector store should use. Useful for tools like file_search that can access files.

>= 1 items<= 500 items

chunking_strategyOne Of
object

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

Auto Chunking Strategyobject

The default strategy. This strategy currently uses a max_chunk_size_tokens of 800 and chunk_overlap_tokens of 400.

* Additional properties are NOT allowed.
Show Child Parameters
Example

CreateVectorStoreFileRequest

object
* Additional properties are NOT allowed.
file_idstringrequired

A File ID that the vector store should use. Useful for tools like file_search that can access files.

chunking_strategyOne Of
object

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

Auto Chunking Strategyobject

The default strategy. This strategy currently uses a max_chunk_size_tokens of 800 and chunk_overlap_tokens of 400.

* Additional properties are NOT allowed.
Show Child Parameters
Example

CreateVectorStoreRequest

object
* Additional properties are NOT allowed.
file_idsarray[string]

A list of File IDs that the vector store should use. Useful for tools like file_search that can access files.

<= 500 items

namestring

The name of the vector store.

expires_afterobject

The expiration policy for a vector store.

Show Child Parameters
chunking_strategyOne Of
object

The chunking strategy used to chunk the file(s). If not set, will use the auto strategy. Only applicable if file_ids is non-empty.

Auto Chunking Strategyobject

The default strategy. This strategy currently uses a max_chunk_size_tokens of 800 and chunk_overlap_tokens of 400.

* Additional properties are NOT allowed.
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

DefaultProjectErrorResponse

object
codeintegerrequired
messagestringrequired
Example