Create embeddings

Creates an embedding vector representing the input text. This endpoint is compatible with the OpenAI Embeddings API and may be used with the OpenAI JS or Python SDK by setting the base URL to https://api.telnyx.com/v2/ai/openai.

POST /ai/openai/embeddings

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const response = await client.ai.openai.embeddings.createEmbeddings({
  input: 'The quick brown fox jumps over the lazy dog',
  model: 'thenlper/gte-large',
});

console.log(response.data);

200

{
  "object": "list",
  "data": [
    {
      "object": "embedding",
      "embedding": [
        123
      ],
      "index": 123
    }
  ],
  "model": "<string>",
  "usage": {
    "prompt_tokens": 123,
    "total_tokens": 123
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

input · string string[] · required

Input text to embed. Can be a string or array of strings.

model · string · required

ID of the model to use. Use the List embedding models endpoint to see available models.

Example:

"thenlper/gte-large"

encoding_format · enum<string> · default: float

The format to return the embeddings in.

Available options: float, base64

dimensions · integer

The number of dimensions the resulting output embeddings should have. Only supported in some models.

user · string

A unique identifier representing your end-user for monitoring and abuse detection.

Response

200

application/json

Successful Response

object · string · default: list · required

The object type, always 'list'

data · OpenAIEmbeddingData · object[] · required

List of embedding objects

Show child attributes

model · string · required

The model used for embedding

usage · OpenAIEmbeddingUsage · object · required

Show child attributes