Skip to content

Latest commit

 

History

History
24 lines (19 loc) · 15.9 KB

createembeddingrequest.md

File metadata and controls

24 lines (19 loc) · 15.9 KB

CreateEmbeddingRequest

Example Usage

import { CreateEmbeddingRequest } from "argot-open-ai/models/components";

let value: CreateEmbeddingRequest = {
  input: "The quick brown fox jumped over the lazy dog",
  model: "text-embedding-3-small",
  encodingFormat: "float",
  user: "user-1234",
};

Fields

Field Type Required Description Example
input components.Input ✔️ Input text to embed, encoded as a string or array of tokens. To embed multiple inputs in a single request, pass an array of strings or array of token arrays. The input must not exceed the max input tokens for the model (8192 tokens for text-embedding-ada-002), cannot be an empty string, and any array must be 2048 dimensions or less. Example Python code for counting tokens.
 The quick brown fox jumped over the lazy dog
model components.CreateEmbeddingRequestModel ✔️ ID of the model to use. You can use the List models API to see all of your available models, or see our Model overview for descriptions of them.
 text-embedding-3-small
encodingFormat components.EncodingFormat ➖ The format to return the embeddings in. Can be either float or base64. float
dimensions number ➖ The number of dimensions the resulting output embeddings should have. Only supported in text-embedding-3 and later models.
user string ➖ A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.
 user-1234