Class: OpenAIEmbeddings

embeddings/openai.OpenAIEmbeddings

Hierarchy

• Embeddings

  ↳ OpenAIEmbeddings

Implements

• ModelParams

Constructors

constructor

• new OpenAIEmbeddings(fields?, configuration?)

Parameters

Name	Type
fields?	Partial<ModelParams> & AsyncCallerParams & { batchSize?: number ; openAIApiKey?: string ; stripNewLines?: boolean ; verbose?: boolean }
configuration?	ConfigurationParameters

Overrides

Embeddings.constructor

Defined in

langchain/src/embeddings/openai.ts:42

Properties

batchSize

• batchSize: number = 512

The maximum number of documents to embed in a single request. This is limited by the OpenAI API to a maximum of 2048.

Defined in

langchain/src/embeddings/openai.ts:28

---

caller

• Protected 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.

Inherited from

Embeddings.caller

Defined in

langchain/src/embeddings/base.ts:10

---

modelName

• modelName: string = "text-embedding-ada-002"

Implementation of

ModelParams.modelName

Defined in

langchain/src/embeddings/openai.ts:22

---

stripNewLines

• stripNewLines: boolean = true

Whether to strip new lines from the input text. This is recommended by OpenAI, but may not be suitable for all use cases.

Defined in

langchain/src/embeddings/openai.ts:34

---

timeout

• Optional timeout: number

Implementation of

ModelParams.timeout

Defined in

langchain/src/embeddings/openai.ts:36

Methods

embedDocuments

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

Parameters

Name	Type
texts	string[]

Returns

Promise<number[][]>

Overrides

Embeddings.embedDocuments

Defined in

langchain/src/embeddings/openai.ts:73

---

embedQuery

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

Parameters

Name	Type
text	string

Returns

Promise<number[]>

Overrides

Embeddings.embedQuery

Defined in

langchain/src/embeddings/openai.ts:95