Skip to main content

Class: OpenAIEmbedding()

Extends

Extended by

OpenAIEmbedding<Options>(nodes, options?): Promise<BaseNode<Metadata>[]>

Type Parameters

Options extends Record<string, unknown>

Parameters

nodes: BaseNode<Metadata>[]

options?: Options

Returns

Promise<BaseNode<Metadata>[]>

Defined in

packages/llm/openai/dist/index.d.ts:270

Constructors

new OpenAIEmbedding()

new OpenAIEmbedding(init?): OpenAIEmbedding

OpenAI Embedding

Parameters

init?: Partial<OpenAIEmbedding> & object

initial parameters

Returns

OpenAIEmbedding

Overrides

BaseEmbedding.constructor

Defined in

packages/llm/openai/dist/index.d.ts:289

Properties

additionalSessionOptions?

optional additionalSessionOptions: Omit<Partial<ClientOptions>, "apiKey" | "maxRetries" | "timeout">

other session options for OpenAI

Defined in

packages/llm/openai/dist/index.d.ts:282


apiKey?

optional apiKey: string

api key

Defined in

packages/llm/openai/dist/index.d.ts:276


dimensions?

optional dimensions: number

number of dimensions of the resulting vector, for models that support choosing fewer dimensions. undefined will default to model default

Defined in

packages/llm/openai/dist/index.d.ts:274


embedBatchSize

embedBatchSize: number

Inherited from

BaseEmbedding.embedBatchSize

Defined in

packages/core/embeddings/dist/index.d.ts:34


embedInfo?

optional embedInfo: EmbeddingInfo

Inherited from

BaseEmbedding.embedInfo

Defined in

packages/core/embeddings/dist/index.d.ts:35


getTextEmbeddings()

getTextEmbeddings: (texts) => Promise<number[][]>

Get embeddings for a batch of texts

Parameters

texts: string[]

Returns

Promise<number[][]>

Overrides

BaseEmbedding.getTextEmbeddings

Defined in

packages/llm/openai/dist/index.d.ts:302


id

id: string

Inherited from

BaseEmbedding.id

Defined in

packages/core/schema/dist/index.d.ts:171


maxRetries

maxRetries: number

maximum number of retries, default 10

Defined in

packages/llm/openai/dist/index.d.ts:278


model

model: string

embeddding model. defaults to "text-embedding-ada-002"

Defined in

packages/llm/openai/dist/index.d.ts:272


session

session: OpenAISession

session object

Defined in

packages/llm/openai/dist/index.d.ts:284


timeout?

optional timeout: number

timeout in ms, default 60 seconds

Defined in

packages/llm/openai/dist/index.d.ts:280

Methods

getQueryEmbedding()

getQueryEmbedding(query): Promise<null | number[]>

Parameters

query: MessageContentDetail

Returns

Promise<null | number[]>

Inherited from

BaseEmbedding.getQueryEmbedding

Defined in

packages/core/embeddings/dist/index.d.ts:39


getTextEmbedding()

getTextEmbedding(text): Promise<number[]>

Get embeddings for a single text

Parameters

text: string

Returns

Promise<number[]>

Overrides

BaseEmbedding.getTextEmbedding

Defined in

packages/llm/openai/dist/index.d.ts:307


getTextEmbeddingsBatch()

getTextEmbeddingsBatch(texts, options?): Promise<number[][]>

Get embeddings for a batch of texts

Parameters

texts: string[]

options?: BaseEmbeddingOptions

Returns

Promise<number[][]>

Inherited from

BaseEmbedding.getTextEmbeddingsBatch

Defined in

packages/core/embeddings/dist/index.d.ts:50


similarity()

similarity(embedding1, embedding2, mode?): number

Parameters

embedding1: number[]

embedding2: number[]

mode?: SimilarityType

Returns

number

Inherited from

BaseEmbedding.similarity

Defined in

packages/core/embeddings/dist/index.d.ts:37


truncateMaxTokens()

truncateMaxTokens(input): string[]

Parameters

input: string[]

Returns

string[]

Inherited from

BaseEmbedding.truncateMaxTokens

Defined in

packages/core/embeddings/dist/index.d.ts:51