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:57
Properties
additionalSessionOptions
• Optional
additionalSessionOptions: Omit
<Partial
<ClientOptions
>, "apiKey"
| "timeout"
| "maxRetries"
>
other session options for OpenAI
Defined in
packages/core/src/embeddings/OpenAIEmbedding.ts:45
apiKey
• Optional
apiKey: string
= undefined
api key
Defined in
packages/core/src/embeddings/OpenAIEmbedding.ts:39
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:34
embedBatchSize
• embedBatchSize: number
= DEFAULT_EMBED_BATCH_SIZE
Inherited from
Defined in
packages/core/src/embeddings/types.ts:11
maxRetries
• maxRetries: number
maximum number of retries, default 10
Defined in
packages/core/src/embeddings/OpenAIEmbedding.ts:41
model
• model: string
embeddding model. defaults to "text-embedding-ada-002"
Defined in
packages/core/src/embeddings/OpenAIEmbedding.ts:32
session
• session: OpenAISession
session object
Defined in
packages/core/src/embeddings/OpenAIEmbedding.ts:51
timeout
• Optional
timeout: number
timeout in ms, default 60 seconds
Defined in
packages/core/src/embeddings/OpenAIEmbedding.ts:43
Methods
getOpenAIEmbedding
▸ getOpenAIEmbedding(input
): Promise
<number
[][]>
Get embeddings for a batch of texts
Parameters
Name | Type |
---|---|
input | string [] |