Class BaseGoogleEmbeddings<AuthOptions>`Abstract`

Enables calls to Google APIs for generating text embeddings.

Type Parameters

AuthOptions

Hierarchy

Embeddings
- BaseGoogleEmbeddings

Implements

BaseGoogleEmbeddingsParams<AuthOptions>

Index

Constructors

Properties

Methods

buildAbstractedClient buildApiKey buildApiKeyClient buildClient embedDocuments embedQuery

Constructors

constructor

new BaseGoogleEmbeddings<AuthOptions>(fields): BaseGoogleEmbeddings<AuthOptions>
Type Parameters
- AuthOptions
Parameters
- fields: BaseGoogleEmbeddingsParams<AuthOptions>
Returns BaseGoogleEmbeddings<AuthOptions>
Overrides Embeddings.constructor
- Defined in libs/langchain-google-common/src/embeddings.ts:111

Properties

caller

caller: AsyncCaller

The async caller should be used by subclasses to make any async calls, which will thus benefit from the concurrency and retry logic.

model

model: string

Methods

`Abstract`buildAbstractedClient

buildAbstractedClient(fields?): GoogleAbstractedClient
Parameters
- Optionalfields: GoogleConnectionParams<AuthOptions>
Returns GoogleAbstractedClient
- Defined in libs/langchain-google-common/src/embeddings.ts:123

buildApiKey

buildApiKey(fields?): undefined | string
Parameters
- Optionalfields: GoogleConnectionParams<AuthOptions>
Returns undefined | string
- Defined in libs/langchain-google-common/src/embeddings.ts:131

buildApiKeyClient

buildApiKeyClient(apiKey): GoogleAbstractedClient
Parameters
- apiKey: string
Returns GoogleAbstractedClient
- Defined in libs/langchain-google-common/src/embeddings.ts:127

buildClient

buildClient(fields?): GoogleAbstractedClient
Parameters
- Optionalfields: GoogleConnectionParams<AuthOptions>
Returns GoogleAbstractedClient
- Defined in libs/langchain-google-common/src/embeddings.ts:137

embedDocuments

embedDocuments(documents): Promise<number[][]>
Takes an array of documents as input and returns a promise that resolves to a 2D array of embeddings for each document. It splits the documents into chunks and makes requests to the Google Vertex AI API to generate embeddings.
Parameters
- documents: string[]
  An array of documents to be embedded.
Returns Promise<number[][]>
A promise that resolves to a 2D array of embeddings for each document.
Overrides Embeddings.embedDocuments
- Defined in libs/langchain-google-common/src/embeddings.ts:156

embedQuery

embedQuery(document): Promise<number[]>
Takes a document as input and returns a promise that resolves to an embedding for the document. It calls the embedDocuments method with the document as the input.
Parameters
- document: string
  A document to be embedded.
Returns Promise<number[]>
A promise that resolves to an embedding for the document.
Overrides Embeddings.embedQuery
- Defined in libs/langchain-google-common/src/embeddings.ts:190