Skip to main content

Class: abstract BaseEmbedding()

Extends

Extended by

abstract BaseEmbedding<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/core/embeddings/dist/embeddings/index.d.ts:33

Constructors

new BaseEmbedding()

protected new BaseEmbedding(transformFn?): BaseEmbedding

Parameters

transformFn?

Returns

BaseEmbedding

Overrides

TransformComponent.constructor

Defined in

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

Properties

embedBatchSize

embedBatchSize: number

Defined in

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


embedInfo?

optional embedInfo: EmbeddingInfo

Defined in

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


getTextEmbeddings()

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

Optionally override this method to retrieve multiple embeddings in a single request

Parameters

texts: string[]

Returns

Promise<number[][]>

Defined in

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


id

id: string

Inherited from

TransformComponent.id

Defined in

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

Methods

getQueryEmbedding()

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

Parameters

query: MessageContentDetail

Returns

Promise<null | number[]>

Defined in

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


getTextEmbedding()

abstract getTextEmbedding(text): Promise<number[]>

Parameters

text: string

Returns

Promise<number[]>

Defined in

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


getTextEmbeddingsBatch()

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

Get embeddings for a batch of texts

Parameters

texts: string[]

options?: BaseEmbeddingOptions

Returns

Promise<number[][]>

Defined in

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


similarity()

similarity(embedding1, embedding2, mode?): number

Parameters

embedding1: number[]

embedding2: number[]

mode?: SimilarityType

Returns

number

Defined in

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


truncateMaxTokens()

truncateMaxTokens(input): string[]

Parameters

input: string[]

Returns

string[]

Defined in

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