ChatGPT-Java-API/com.cjcrafter.openai.embeddings

Package-level declarations

Types

data class Embedding(val embedding: List<Any>, val index: Int)

Represents 1 embedding as a vector of floats or strings.

EmbeddingsRequest

data class EmbeddingsRequest

Holds the options sent to the embeddings endpoint. The generated embeddings can be used in Machine Learning models.

EmbeddingsResponse

data class EmbeddingsResponse(val data: List<Embedding>, val model: String, val usage: EmbeddingsUsage)

The API response from the EmbeddingsRequest.

EmbeddingsUsage

data class EmbeddingsUsage(val promptTokens: Int, val totalTokens: Int)

Holds the number of tokens used by the API request. Exact pricing can vary based on the model used.

enum EncodingFormat : Enum<EncodingFormat>

Determines how the embeddings are encoded.

Functions

embeddingsRequest

fun embeddingsRequest(block: EmbeddingsRequest.Builder.() -> Unit): EmbeddingsRequest

Creates an EmbeddingsRequest using the EmbeddingsRequest.Builder using Kotlin DSL.