Skip to content

EmbeddingsRequest

Request parameters for creating embeddings. Generates vector representations of the input text(s).

Example Usage

typescript
import { EmbeddingsRequest } from "@meetkai/mka1/models/components";

let value: EmbeddingsRequest = {
  input: [
    "<value 1>",
  ],
  model: "Camaro",
};

Fields

FieldTypeRequiredDescription
inputcomponents.Input✔️The input text or array of texts to generate embeddings for. Can be a single string or an array of strings.
modelstring✔️ID of the model to use for generating embeddings. You can use provider:model format (e.g., 'openai:text-embedding-3-small') or just the model name with a default provider.
dimensionsnumberThe number of dimensions the resulting output embeddings should have. Only supported in OpenAI's text-embedding-3 and later models.
encodingFormatcomponents.EncodingFormatThe format to return the embeddings in. Can be either 'float' (array of numbers) or 'base64' (base64-encoded binary).
userstringA unique identifier representing your end-user.