Class: OpenAIEmbedding
Hierarchy
-
↳
OpenAIEmbedding
Constructors
constructor
• new OpenAIEmbedding(init?): OpenAIEmbedding
OpenAI Embedding
Parameters
| Name | Type | Description |
|---|---|---|
init? | Partial<OpenAIEmbedding> & { azure?: AzureOpenAIConfig } | initial parameters |
Returns
Overrides
Defined in
packages/core/src/embeddings/OpenAIEmbedding.ts:56
Properties
additionalSessionOptions
• Optional additionalSessionOptions: Omit<Partial<ClientOptions>, "apiKey" | "timeout" | "maxRetries">
other session options for OpenAI
Defined in
packages/core/src/embeddings/OpenAIEmbedding.ts:44
apiKey
• Optional apiKey: string = undefined
api key
Defined in
packages/core/src/embeddings/OpenAIEmbedding.ts:38
dimensions
• dimensions: undefined | number
number of dimensions of the resulting vector, for models that support choosing fewer dimensions. undefined will default to model default
Defined in
packages/core/src/embeddings/OpenAIEmbedding.ts:33
maxRetries
• maxRetries: number
maximum number of retries, default 10
Defined in
packages/core/src/embeddings/OpenAIEmbedding.ts:40
model
• model: string
embeddding model. defaults to "text-embedding-ada-002"
Defined in
packages/core/src/embeddings/OpenAIEmbedding.ts:31
session
• session: OpenAISession
session object
Defined in
packages/core/src/embeddings/OpenAIEmbedding.ts:50
timeout
• Optional timeout: number
timeout in ms, default 60 seconds
Defined in
packages/core/src/embeddings/OpenAIEmbedding.ts:42
Methods
getOpenAIEmbedding
▸ getOpenAIEmbedding(input): Promise<number[]>
Parameters
| Name | Type |
|---|---|
input | string |
Returns
Promise<number[]>
Defined in
packages/core/src/embeddings/OpenAIEmbedding.ts:103
getQueryEmbedding
▸ getQueryEmbedding(query): Promise<number[]>
Parameters
| Name | Type |
|---|---|
query | string |
Returns
Promise<number[]>
Overrides
BaseEmbedding.getQueryEmbedding
Defined in
packages/core/src/embeddings/OpenAIEmbedding.ts:117
getTextEmbedding
▸ getTextEmbedding(text): Promise<number[]>
Parameters
| Name | Type |
|---|---|
text | string |
Returns
Promise<number[]>
Overrides
BaseEmbedding.getTextEmbedding
Defined in
packages/core/src/embeddings/OpenAIEmbedding.ts:113
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
packages/core/src/embeddings/types.ts:6
transform
▸ transform(nodes, _options?): Promise<BaseNode<Metadata>[]>
Parameters
| Name | Type |
|---|---|
nodes | BaseNode<Metadata>[] |
_options? | any |