OpenAI API

DoneEvent

object

Occurs when a stream ends.

eventstringrequired

Allowed values:done

datastringrequired

Allowed values:[DONE]

Example

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