BaseEmbedding

Defined in: packages/core/src/embeddings/base.ts:22

Extends

• TransformComponent<Promise<BaseNode[]>>

Extended by

• MultiModalEmbedding

abstract BaseEmbedding<Options>(nodes, options?): Promise

Defined in: packages/core/src/embeddings/base.ts:22

Type Parameters

Options

Options extends Record<string, unknown>

Parameters

nodes

BaseNode<Metadata>[]

options?

Options

Returns

Promise

Constructors

Constructor

protected new BaseEmbedding(transformFn?): BaseEmbedding

Defined in: packages/core/src/embeddings/base.ts:28

Parameters

transformFn?

(nodes, options?) => Promise<BaseNode<Metadata>[]>

Returns

BaseEmbedding

Overrides

TransformComponent.constructor

Properties

embedBatchSize

embedBatchSize: number = DEFAULT_EMBED_BATCH_SIZE

Defined in: packages/core/src/embeddings/base.ts:25

---

embedInfo?

optional embedInfo: EmbeddingInfo

Defined in: packages/core/src/embeddings/base.ts:26

---

id

id: string

Defined in: packages/core/src/schema/type.ts:22

Inherited from

TransformComponent.id

Methods

similarity()

similarity(embedding1, embedding2, mode): number

Defined in: packages/core/src/embeddings/base.ts:58

Parameters

embedding1

number[]

embedding2

number[]

mode

SimilarityType = SimilarityType.DEFAULT

Returns

number

---

getTextEmbedding()

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

Defined in: packages/core/src/embeddings/base.ts:66

Parameters

text

string

Returns

Promise<number[]>

---

getQueryEmbedding()

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

Defined in: packages/core/src/embeddings/base.ts:68

Parameters

query

MessageContentDetail

Returns

Promise<null | number[]>

---

getTextEmbeddings()

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

Defined in: packages/core/src/embeddings/base.ts:82

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

Parameters

texts

string[]

Returns

Promise<number[][]>

---

getTextEmbeddingsBatch()

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

Defined in: packages/core/src/embeddings/base.ts:98

Get embeddings for a batch of texts

Parameters

texts

string[]

options?

BaseEmbeddingOptions

Returns

Promise<number[][]>

---

truncateMaxTokens()

truncateMaxTokens(input): string[]

Defined in: packages/core/src/embeddings/base.ts:110

Parameters

input

string[]

Returns

string[]