Skip to main content

Class: abstract BaseEmbedding

Extended by​

Implements​

Constructors​

new BaseEmbedding()​

new BaseEmbedding(): BaseEmbedding

Returns​

BaseEmbedding

Properties​

embedBatchSize​

embedBatchSize: number = DEFAULT_EMBED_BATCH_SIZE

Defined in​

packages/llamaindex/src/embeddings/types.ts:21

embedInfo?​

optional embedInfo: EmbeddingInfo

Defined in​

packages/llamaindex/src/embeddings/types.ts:22

Methods​

getQueryEmbedding()​

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

Parameters​

• query: MessageContentDetail

Returns​

Promise<null | number[]>

Defined in​

packages/llamaindex/src/embeddings/types.ts:34

getTextEmbedding()​

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

Parameters​

• text: string

Returns​

Promise<number[]>

Defined in​

packages/llamaindex/src/embeddings/types.ts:32

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/llamaindex/src/embeddings/types.ts:48

getTextEmbeddingsBatch()​

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

Get embeddings for a batch of texts

Parameters​

• texts: string[]

• options?

• options.logProgress?: boolean

Returns​

Promise<number[][]>

Defined in​

packages/llamaindex/src/embeddings/types.ts:64

similarity()​

similarity(embedding1, embedding2, mode): number

Parameters​

• embedding1: number[]

• embedding2: number[]

• mode: SimilarityType = SimilarityType.DEFAULT

Returns​

number

Defined in​

packages/llamaindex/src/embeddings/types.ts:24

transform()​

transform(nodes, _options?): Promise<BaseNode<Metadata>[]>

Parameters​

• nodes: BaseNode<Metadata>[]

• _options?: any

Returns​

Promise<BaseNode<Metadata>[]>

Implementation of​

TransformComponent.transform

Defined in​

packages/llamaindex/src/embeddings/types.ts:78

truncateMaxTokens()​

truncateMaxTokens(input): string[]

Parameters​

• input: string[]

Returns​

string[]

Defined in​

packages/llamaindex/src/embeddings/types.ts:90