HuggingFaceInferenceAPIEmbedding
Defined in: .build/typescript/packages/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
Section titled “Extends”BaseEmbedding
HuggingFaceInferenceAPIEmbedding<
Options>(nodes,options?):Promise
Defined in: .build/typescript/packages/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
Section titled “Type Parameters”Options
Section titled “Options”Options extends Record<string, unknown>
Parameters
Section titled “Parameters”BaseNode<Metadata>[]
options?
Section titled “options?”Options
Returns
Section titled “Returns”Promise
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new HuggingFaceInferenceAPIEmbedding(
init):HuggingFaceInferenceAPIEmbedding
Defined in: .build/typescript/packages/providers/huggingface/src/shared.ts:38
Parameters
Section titled “Parameters”Returns
Section titled “Returns”HuggingFaceInferenceAPIEmbedding
Overrides
Section titled “Overrides”BaseEmbedding.constructor
Properties
Section titled “Properties”model:
string
Defined in: .build/typescript/packages/providers/huggingface/src/shared.ts:35
hf:
HfInference
Defined in: .build/typescript/packages/providers/huggingface/src/shared.ts:36
Methods
Section titled “Methods”getTextEmbedding()
Section titled “getTextEmbedding()”getTextEmbedding(
text):Promise<number[]>
Defined in: .build/typescript/packages/providers/huggingface/src/shared.ts:47
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<number[]>
Overrides
Section titled “Overrides”BaseEmbedding.getTextEmbedding
getTextEmbeddings()
Section titled “getTextEmbeddings()”getTextEmbeddings(
texts):Promise<number[][]>
Defined in: .build/typescript/packages/providers/huggingface/src/shared.ts:55
Parameters
Section titled “Parameters”string[]
Returns
Section titled “Returns”Promise<number[][]>
Overrides
Section titled “Overrides”BaseEmbedding.getTextEmbeddings