Search
K
OpenAI API

Embedding

object

Represents an embedding vector returned by embedding endpoint.

indexintegerrequired

The index of the embedding in the list of embeddings.

embeddingarray[number]required

The embedding vector, which is a list of floats. The length of vector depends on the model as listed in the embedding guide.

objectstringrequired

The object type, which is always “embedding”.

Allowed values:embedding

Example

Error

object
codestringrequired
messagestringrequired
paramstringrequired
typestringrequired
Example

ErrorEvent

object

Occurs when an error occurs. This can happen due to an internal server error or a timeout.

eventstringrequired

Allowed values:error

dataobjectrequired
Show Child Parameters
Example

ErrorResponse

object
errorobjectrequired
Show Child Parameters
Example

File search tool call ranking options

object

The ranking options for the file search. If not specified, the file search tool will use the auto ranker and a score_threshold of 0.

See the file search tool documentation for more information.

rankerstring

The ranker to use for the file search. If not specified will use the auto ranker.

Allowed values:autodefault_2024_08_21

score_thresholdnumberrequired

The score threshold for the file search. All values must be a floating point number between 0 and 1.

>= 0<= 1

Example