Class: OpenAIEmbedding
Hierarchy
↳
OpenAIEmbedding
Constructors
constructor
• new OpenAIEmbedding(init?)
Parameters
| Name | Type |
|---|---|
init? | Partial<OpenAIEmbedding> |
Overrides
Defined in
Embedding.ts:222
Properties
apiKey
• Optional apiKey: string = undefined
Defined in
Embedding.ts:217
maxRetries
• maxRetries: number
Defined in
Embedding.ts:218
model
• model: TEXT_EMBED_ADA_002
Defined in
Embedding.ts:214
session
• session: OpenAISession
Defined in
Embedding.ts:220
timeout
• Optional timeout: number
Defined in
Embedding.ts:219
Methods
getOpenAIEmbedding
▸ Private getOpenAIEmbedding(input): Promise<number[]>
Parameters
| Name | Type |
|---|---|
input | string |
Returns
Promise<number[]>
Defined in
Embedding.ts:237
getQueryEmbedding
▸ getQueryEmbedding(query): Promise<number[]>
Parameters
| Name | Type |
|---|---|
query | string |
Returns
Promise<number[]>
Overrides
BaseEmbedding.getQueryEmbedding
Defined in
Embedding.ts:253
getTextEmbedding
▸ getTextEmbedding(text): Promise<number[]>
Parameters
| Name | Type |
|---|---|
text | string |
Returns
Promise<number[]>
Overrides
BaseEmbedding.getTextEmbedding
Defined in
Embedding.ts:249
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
Defined in
Embedding.ts:197