Class CloudflareWorkersAIEmbeddings

An abstract class that provides methods for embedding documents and queries using LangChain.

Hierarchy

Embeddings
- CloudflareWorkersAIEmbeddings

Index

Constructors

Properties

ai batchSize caller modelName stripNewLines

Methods

embedDocuments embedQuery

Constructors

constructor

new CloudflareWorkersAIEmbeddings(fields): CloudflareWorkersAIEmbeddings
Parameters
- fields: CloudflareWorkersAIEmbeddingsParams
Returns CloudflareWorkersAIEmbeddings
Overrides Embeddings.constructor
- Defined in langchain/src/embeddings/cloudflare_workersai.ts:43

Properties

ai

ai: Ai

batchSize

batchSize: number = 50

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.

modelName

modelName: string = "@cf/baai/bge-base-en-v1.5"

stripNewLines

stripNewLines: boolean = true

Methods

embedDocuments

embedDocuments(texts): Promise<number[][]>
An abstract method that takes an array of documents as input and returns a promise that resolves to an array of vectors for each document.
Parameters
- texts: string[]
  
  An array of documents to be embedded.
Returns Promise<number[][]>
A promise that resolves to an array of vectors for each document.
Overrides Embeddings.embedDocuments
- Defined in langchain/src/embeddings/cloudflare_workersai.ts:56

embedQuery

embedQuery(text): Promise<number[]>
An abstract method that takes a single document as input and returns a promise that resolves to a vector for the query document.
Parameters
- text: string
  
  A single document to be embedded.
Returns Promise<number[]>
A promise that resolves to a vector for the query document.
Overrides Embeddings.embedQuery
- Defined in langchain/src/embeddings/cloudflare_workersai.ts:76

Generated using TypeDoc