Skip to main content

Class: HuggingFaceInferenceAPIEmbedding

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​

Constructors​

new HuggingFaceInferenceAPIEmbedding()​

new HuggingFaceInferenceAPIEmbedding(init): HuggingFaceInferenceAPIEmbedding

Parameters​

• init: any

Returns​

HuggingFaceInferenceAPIEmbedding

Overrides​

BaseEmbedding . constructor

Source​

packages/llamaindex/src/embeddings/HuggingFaceEmbedding.ts:77

Properties​

embedBatchSize​

embedBatchSize: number = DEFAULT_EMBED_BATCH_SIZE

Inherited from​

BaseEmbedding . embedBatchSize

Source​

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

embedInfo?​

optional embedInfo: EmbeddingInfo

Inherited from​

BaseEmbedding . embedInfo

Source​

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

hf​

hf: HfInference

Source​

packages/llamaindex/src/embeddings/HuggingFaceEmbedding.ts:75

model​

model: string

Source​

packages/llamaindex/src/embeddings/HuggingFaceEmbedding.ts:74

Methods​

getQueryEmbedding()​

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

Parameters​

• query: MessageContentDetail

Returns​

Promise<null | number[]>

Inherited from​

BaseEmbedding . getQueryEmbedding

Source​

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

getTextEmbedding()​

getTextEmbedding(text): Promise<number[]>

Parameters​

• text: string

Returns​

Promise<number[]>

Overrides​

BaseEmbedding . getTextEmbedding

Source​

packages/llamaindex/src/embeddings/HuggingFaceEmbedding.ts:86

getTextEmbeddings()​

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

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

Parameters​

• texts: string[]

Returns​

Promise<number[][]>

Overrides​

BaseEmbedding . getTextEmbeddings

Source​

packages/llamaindex/src/embeddings/HuggingFaceEmbedding.ts:94

getTextEmbeddingsBatch()​

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

Get embeddings for a batch of texts

Parameters​

• texts: string[]

• options?

• options.logProgress?: boolean

Returns​

Promise<number[][]>

Inherited from​

BaseEmbedding . getTextEmbeddingsBatch

Source​

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

similarity()​

similarity(embedding1, embedding2, mode): number

Parameters​

• embedding1: number[]

• embedding2: number[]

• mode: SimilarityType= SimilarityType.DEFAULT

Returns​

number

Inherited from​

BaseEmbedding . similarity

Source​

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

transform()​

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

Parameters​

• nodes: BaseNode <Metadata>[]

• _options?: any

Returns​

Promise <BaseNode <Metadata>[]>

Inherited from​

BaseEmbedding . transform

Source​

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

truncateMaxTokens()​

truncateMaxTokens(input): string[]

Parameters​

• input: string[]

Returns​

string[]

Inherited from​

BaseEmbedding . truncateMaxTokens

Source​

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