Class JinaEmbeddings

A class for generating embeddings using the Jina API.

Example

// Embed a query using the JinaEmbeddings class
const model = new JinaEmbeddings();
const res = await model.embedQuery(
  "What would be a good name for a semantic search engine ?",
);
console.log({ res });

Hierarchy (view full)

Implements

Constructors

constructor

Properties

apiKey modelName

Methods

embedDocuments embedImages embedQuery

Constructors

constructor

Properties

apiKey

apiKey: string

The API key to use for authentication. If not provided, it will be read from the JINA_API_KEY environment variable.

modelName

modelName: string

The model ID to use for generating embeddings. Default: jina-embeddings-v2-base-en

Methods

embedDocuments

  • embedDocuments(texts): Promise<number[][]>

  • Generates embeddings for an array of texts.

    Parameters

    • texts: string[]

      An array of strings to generate embeddings for.

    Returns Promise<number[][]>

    A Promise that resolves to an array of embeddings.

embedImages

  • embedImages(uris): Promise<number[][]>

  • Generates embeddings for an array of image URIs.

    Parameters

    • uris: string[]

      An array of image URIs to generate embeddings for.

    Returns Promise<number[][]>

    A Promise that resolves to an array of embeddings.

embedQuery

  • embedQuery(text): Promise<number[]>

  • Generates an embedding for a single text.

    Parameters

    • text: string

      A string to generate an embedding for.

    Returns Promise<number[]>

    A Promise that resolves to an array of numbers representing the embedding.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc