Class GooglePaLMEmbeddings

⚠️ Deprecated ⚠️

This feature is deprecated and will be removed in the future.

It is not recommended for use.

  • Deprecated by Google. Will be removed in 0.3.0

Class that extends the Embeddings class and provides methods for generating embeddings using the Google Palm API.

Example

const model = new GooglePaLMEmbeddings({
  apiKey: "<YOUR API KEY>",
  model: "models/embedding-gecko-001",
});

// Embed a single query
const res = await model.embedQuery(
  "What would be a good company name for a company that makes colorful socks?"
);
console.log({ res });

// Embed multiple documents
const documentRes = await model.embedDocuments(["Hello world", "Bye bye"]);
console.log({ documentRes });

Hierarchy (view full)

Implements

Constructors

constructor

Properties

model modelName apiKey?

Methods

embedDocuments embedQuery

Constructors

constructor

Properties

model

model: string = "models/embedding-gecko-001"

Model Name to use

Note: The format must follow the pattern - models/{model}

modelName

modelName: string = "models/embedding-gecko-001"

Model Name to use

Alias for model

Note: The format must follow the pattern - models/{model}

Optional apiKey

apiKey?: string

Google Palm API key to use

Methods

embedDocuments

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

  • 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 _embedText method for each document in the array.

    Parameters

    • documents: string[]

      Array of documents for which to generate embeddings.

    Returns Promise<number[][]>

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

embedQuery

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

  • Method that takes a document as input and returns a promise that resolves to an embedding for the document. It calls the _embedText method with the document as the input.

    Parameters

    • document: string

      Document for which to generate an embedding.

    Returns Promise<number[]>

    Promise that resolves to an embedding for the input document.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc