Skip to main content
Using Deno in production at your company? Earn free Deno merch.
Give us feedback
Module

x/openai/resources/embeddings.ts>EmbeddingCreateParams

Deno build of the official Typescript library for the OpenAI API.
Extremely Popular
Go to Latest
interface EmbeddingCreateParams
import { type EmbeddingCreateParams } from "https://deno.land/x/openai@v4.38.5/resources/embeddings.ts";

Properties

input:
| string
| Array<string>
| Array<number>
| Array<Array<number>>

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.

model:
| (string & { })
| "text-embedding-ada-002"
| "text-embedding-3-small"
| "text-embedding-3-large"

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.

optional
dimensions: number

The number of dimensions the resulting output embeddings should have. Only supported in text-embedding-3 and later models.

optional
encoding_format: "float" | "base64"

The format to return the embeddings in. Can be either float or base64.

optional
user: string

A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.