Ga naar hoofdinhoud

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

Constructors

constructor

new HuggingFaceEmbedding(init?): HuggingFaceEmbedding

Parameters

NameType
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

NameType
querystring

Returns

Promise<number[]>

Overrides

BaseEmbedding.getQueryEmbedding

Defined in

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


getTextEmbedding

getTextEmbedding(text): Promise<number[]>

Parameters

NameType
textstring

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

NameType
textsstring[]

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

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

NameTypeDefault value
embedding1number[]undefined
embedding2number[]undefined
modeSimilarityTypeSimilarityType.DEFAULT

Returns

number

Inherited from

BaseEmbedding.similarity

Defined in

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


transform

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

Parameters

NameType
nodesBaseNode<Metadata>[]
_options?any

Returns

Promise<BaseNode<Metadata>[]>

Inherited from

BaseEmbedding.transform

Defined in

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