Class: OpenAIEmbedding

Hierarchy

• BaseEmbedding

  ↳ OpenAIEmbedding

Constructors

constructor

• new OpenAIEmbedding(init?)

Parameters

Name	Type
init?	Partial<OpenAIEmbedding> & { azure?: AzureOpenAIConfig }

Overrides

BaseEmbedding.constructor

Defined in

Embedding.ts:236

Properties

additionalSessionOptions

• Optional additionalSessionOptions: Omit<Partial<ClientOptions>, "apiKey" | "timeout" | "maxRetries">

Defined in

Embedding.ts:229

---

apiKey

• Optional apiKey: string = undefined

Defined in

Embedding.ts:226

---

maxRetries

• maxRetries: number

Defined in

Embedding.ts:227

---

model

• model: TEXT_EMBED_ADA_002

Defined in

Embedding.ts:223

---

session

• session: OpenAISession

Defined in

Embedding.ts:234

---

timeout

• Optional timeout: number

Defined in

Embedding.ts:228

Methods

getOpenAIEmbedding

▸ Private getOpenAIEmbedding(input): Promise<number[]>

Parameters

Name	Type
input	string

Returns

Promise<number[]>

Defined in

Embedding.ts:282

---

getQueryEmbedding

▸ getQueryEmbedding(query): Promise<number[]>

Parameters

Name	Type
query	string

Returns

Promise<number[]>

Overrides

BaseEmbedding.getQueryEmbedding

Defined in

Embedding.ts:295

---

getTextEmbedding

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

Parameters

Name	Type
text	string

Returns

Promise<number[]>

Overrides

BaseEmbedding.getTextEmbedding

Defined in

Embedding.ts:291

---

similarity

▸ similarity(embedding1, embedding2, mode?): number

Parameters

Name	Type	Default value
embedding1	number[]	undefined
embedding2	number[]	undefined
mode	SimilarityType	SimilarityType.DEFAULT

Returns

number

Inherited from

BaseEmbedding.similarity

Defined in

Embedding.ts:206