README.md

Embeddings

(embeddings)

Overview

Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms.

Available Operations

• createEmbedding - Creates an embedding vector representing the input text.

createEmbedding

Creates an embedding vector representing the input text.

Example Usage

import { ArgotOpenAi } from "argot-open-ai";

const argotOpenAi = new ArgotOpenAi({
  apiKeyAuth: process.env["ARGOTOPENAI_API_KEY_AUTH"] ?? "",
});

async function run() {
  const result = await argotOpenAi.embeddings.createEmbedding({
    input: "The quick brown fox jumped over the lazy dog",
    model: "text-embedding-3-small",
    encodingFormat: "float",
    user: "user-1234",
  });

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { ArgotOpenAiCore } from "argot-open-ai/core.js";
import { embeddingsCreateEmbedding } from "argot-open-ai/funcs/embeddingsCreateEmbedding.js";

// Use `ArgotOpenAiCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const argotOpenAi = new ArgotOpenAiCore({
  apiKeyAuth: process.env["ARGOTOPENAI_API_KEY_AUTH"] ?? "",
});

async function run() {
  const res = await embeddingsCreateEmbedding(argotOpenAi, {
    input: "The quick brown fox jumped over the lazy dog",
    model: "text-embedding-3-small",
    encodingFormat: "float",
    user: "user-1234",
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

Parameters

Parameter	Type	Required	Description
request	components.CreateEmbeddingRequest	✔️	The request object to use for the request.
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.CreateEmbeddingResponse>

Errors

Error Type	Status Code	Content Type
errors.SDKError	4XX, 5XX	*/*