CreateEmbeddingsRequest

data class CreateEmbeddingsRequest(val model: String, val input: List<String>, val dimensions: Int? = null, val encodingFormat: String? = "float", val user: String? = null)(source)

Represents a request to the OpenAI embeddings API.

Constructors

constructor(model: String, input: List<String>, dimensions: Int? = null, encodingFormat: String? = "float", user: String? = null)

The number of dimensions the resulting output embeddings should have. Only supported in text-embedding-3 and later models.

@SerialName(value = "encoding_format")

The format to return the embeddings in. Can be either "float" or "base64".

@Serializable(with = StringOrListSerializer::class)

Input text to embed, encoded as a string or array of strings.

ID of the model to use for generating embeddings.

A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.