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,
});

Hierarchy

• BaseEmbedding

  ↳ HuggingFaceEmbedding

Constructors

constructor

• new HuggingFaceEmbedding(init?): HuggingFaceEmbedding

Parameters

Name	Type
init?	Partial<HuggingFaceEmbedding>

Returns

HuggingFaceEmbedding

Overrides

BaseEmbedding.constructor

Defined in

packages/core/src/embeddings/HuggingFaceEmbedding.ts:27

Properties

embedBatchSize

• embedBatchSize: number = DEFAULT_EMBED_BATCH_SIZE

Inherited from

BaseEmbedding.embedBatchSize

Defined in

packages/core/src/embeddings/types.ts:9

---

extractor

• Private extractor: any

Defined in

packages/core/src/embeddings/HuggingFaceEmbedding.ts:25

---

modelType

• modelType: string = HuggingFaceEmbeddingModelType.XENOVA_ALL_MINILM_L6_V2

Defined in

packages/core/src/embeddings/HuggingFaceEmbedding.ts:22

---

quantized

• quantized: boolean = true

Defined in

packages/core/src/embeddings/HuggingFaceEmbedding.ts:23

Methods

getExtractor

▸ getExtractor(): Promise<any>

Returns

Promise<any>

Defined in

packages/core/src/embeddings/HuggingFaceEmbedding.ts:32

---

getQueryEmbedding

▸ getQueryEmbedding(query): Promise<number[]>

Parameters

Name	Type
query	string

Returns

Promise<number[]>

Overrides

BaseEmbedding.getQueryEmbedding

Defined in

packages/core/src/embeddings/HuggingFaceEmbedding.ts:48

---

getTextEmbedding

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

Parameters

Name	Type
text	string

Returns

Promise<number[]>

Overrides

BaseEmbedding.getTextEmbedding

Defined in

packages/core/src/embeddings/HuggingFaceEmbedding.ts:42

---

getTextEmbeddings

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

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

Parameters

Name	Type
texts	string[]

Returns

Promise<number[][]>

Inherited from

BaseEmbedding.getTextEmbeddings

Defined in

packages/core/src/embeddings/types.ts:26

---

getTextEmbeddingsBatch

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

Get embeddings for a batch of texts

Parameters

Name	Type
texts	string[]
options?	Object
options.logProgress?	boolean

Returns

Promise<number[][]>

Inherited from

BaseEmbedding.getTextEmbeddingsBatch

Defined in

packages/core/src/embeddings/types.ts:42

---

similarity

▸ similarity(embedding1, embedding2, mode?): number

Parameters

Name	Type	Default value
embedding1	number[]	undefined
embedding2	number[]	undefined
mode	SimilarityType	SimilarityType.DEFAULT

Returns

number

Inherited from

BaseEmbedding.similarity

Defined in

packages/core/src/embeddings/types.ts:11

---

transform

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

Parameters

Name	Type
nodes	BaseNode<Metadata>[]
_options?	any

Returns

Promise<BaseNode<Metadata>[]>

Inherited from

BaseEmbedding.transform

Defined in

packages/core/src/embeddings/types.ts:73