Skip to content

@ralphschuler.ai function caller.index.<internal>.OpenAI.Embeddings.EmbeddingCreateParams

github-actions edited this page Nov 26, 2023 · 1 revision

Interface: EmbeddingCreateParams

OpenAI.Embeddings.EmbeddingCreateParams

Table of contents

Properties

Properties

encoding_format

Optional encoding_format: "base64" | "float"

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

Defined in

node_modules/openai/resources/embeddings.d.ts:84


input

input: string | string[] | number[] | 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) and cannot be an empty string. Example Python code for counting tokens.

Defined in

node_modules/openai/resources/embeddings.d.ts:71


model

model: string & {} | "text-embedding-ada-002"

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.

Defined in

node_modules/openai/resources/embeddings.d.ts:79


user

Optional user: string

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

Defined in

node_modules/openai/resources/embeddings.d.ts:90

Typescript Libraries

Modules

Namespaces

Clone this wiki locally