Class that extends the Embeddings class and provides methods for generating embeddings using Hugging Face models through the HuggingFaceInference API.

Hierarchy

  • Toolkit
    • HuggingFaceInferenceEmbeddings

Implements

Constructors

Properties

client: HfInference | HfInferenceEndpoint
model: string
apiKey?: string
endpointUrl?: string

Methods

  • Method that takes an array of documents as input and returns a promise that resolves to a 2D array of embeddings for each document. It calls the _embed method with the documents as the input.

    Parameters

    • documents: string[]

      Array of documents to generate embeddings for.

    Returns Promise<number[][]>

    Promise that resolves to a 2D array of embeddings for each document.

  • Method that takes a document as input and returns a promise that resolves to an embedding for the document. It calls the _embed method with the document as the input and returns the first embedding in the resulting array.

    Parameters

    • document: string

      Document to generate an embedding for.

    Returns Promise<number[]>

    Promise that resolves to an embedding for the document.

Generated using TypeDoc