Skip to main content

Class: HuggingFaceEmbedding()

Uses feature extraction from '@xenova/transformers' to generate embeddings. Per default the model XENOVA_ALL_MINILM_L6_V2 is used.

Can be changed by setting the modelType parameter in the constructor, e.g.:

new HuggingFaceEmbedding({
    modelType: HuggingFaceEmbeddingModelType.XENOVA_ALL_MPNET_BASE_V2,
});

Extends​

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

Uses feature extraction from '@xenova/transformers' to generate embeddings. Per default the model XENOVA_ALL_MINILM_L6_V2 is used.

Can be changed by setting the modelType parameter in the constructor, e.g.:

new HuggingFaceEmbedding({
    modelType: HuggingFaceEmbeddingModelType.XENOVA_ALL_MPNET_BASE_V2,
});

Type Parameters​

• Options extends Record<string, unknown>

Parameters​

• nodes: BaseNode<Metadata>[]

• options?: Options

Returns​

Promise<BaseNode<Metadata>[]>

Defined in​

packages/embedding/huggingface/dist/index.d.ts:25

Constructors​

new HuggingFaceEmbedding()​

new HuggingFaceEmbedding(init?): HuggingFaceEmbedding

Parameters​

• init?: Partial<HuggingFaceEmbedding>

Returns​

HuggingFaceEmbedding

Overrides​

BaseEmbedding.constructor

Defined in​

packages/embedding/huggingface/dist/index.d.ts:29

Properties​

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[][]>

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

Parameters​

• texts: string[]

Returns​

Promise<number[][]>

Inherited from​

BaseEmbedding.getTextEmbeddings

Defined in​

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

id​

id: string

Inherited from​

BaseEmbedding.id

Defined in​

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

modelType​

modelType: string

Defined in​

packages/embedding/huggingface/dist/index.d.ts:26

quantized​

quantized: boolean

Defined in​

packages/embedding/huggingface/dist/index.d.ts:27

Methods​

getExtractor()​

getExtractor(): Promise<any>

Returns​

Promise<any>

Defined in​

packages/embedding/huggingface/dist/index.d.ts:30

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[]>

Parameters​

• text: string

Returns​

Promise<number[]>

Overrides​

BaseEmbedding.getTextEmbedding

Defined in​

packages/embedding/huggingface/dist/index.d.ts:31

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