HuggingFaceInferenceAPIEmbedding

Defined in: providers/huggingface/src/shared.ts:34

Uses feature extraction from Hugging Face's Inference API to generate embeddings.

Set the model and accessToken parameter in the constructor, e.g.:

new HuggingFaceInferenceAPIEmbedding({
    model: HuggingFaceEmbeddingModelType.XENOVA_ALL_MPNET_BASE_V2,
    accessToken: "<your-access-token>"
});

Extends

• BaseEmbedding

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

Defined in: providers/huggingface/src/shared.ts:34

Uses feature extraction from Hugging Face's Inference API to generate embeddings.

Set the model and accessToken parameter in the constructor, e.g.:

new HuggingFaceInferenceAPIEmbedding({
    model: HuggingFaceEmbeddingModelType.XENOVA_ALL_MPNET_BASE_V2,
    accessToken: "<your-access-token>"
});

Type Parameters

• Options extends Record<string, unknown>

Parameters

nodes

BaseNode<Metadata>[]

options?

Options

Returns

Promise<BaseNode<Metadata>[]>

Constructors

new HuggingFaceInferenceAPIEmbedding()

new HuggingFaceInferenceAPIEmbedding(init): HuggingFaceInferenceAPIEmbedding

Defined in: providers/huggingface/src/shared.ts:38

Parameters

init

HFConfig

Returns

HuggingFaceInferenceAPIEmbedding

Overrides

BaseEmbedding.constructor

Properties

model

model: string

Defined in: providers/huggingface/src/shared.ts:35

hf

hf: HfInference

Defined in: providers/huggingface/src/shared.ts:36

Methods

getTextEmbedding()

getTextEmbedding(text): Promise<number[]>

Defined in: providers/huggingface/src/shared.ts:47

Parameters

text

string

Returns

Promise<number[]>

Overrides

BaseEmbedding.getTextEmbedding

getTextEmbeddings()

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

Defined in: providers/huggingface/src/shared.ts:55

Parameters

texts

string[]

Returns

Promise<number[][]>

Overrides

BaseEmbedding.getTextEmbeddings