OpenAiEmbedding
OpenAiEmbedding =
object
Defined in: packages/cloud/src/client/types.gen.ts:4175
Properties
model_name?
optional
model_name:string
Defined in: packages/cloud/src/client/types.gen.ts:4179
The name of the OpenAI embedding model.
embed_batch_size?
optional
embed_batch_size:number
Defined in: packages/cloud/src/client/types.gen.ts:4183
The batch size for embedding calls.
num_workers?
optional
num_workers:number
|null
Defined in: packages/cloud/src/client/types.gen.ts:4187
The number of workers to use for async embedding calls.
additional_kwargs?
optional
additional_kwargs:object
Defined in: packages/cloud/src/client/types.gen.ts:4191
Additional kwargs for the OpenAI API.
Index Signature
[key
: string
]: unknown
api_key?
optional
api_key:string
|null
Defined in: packages/cloud/src/client/types.gen.ts:4197
The OpenAI API key.
api_base?
optional
api_base:string
|null
Defined in: packages/cloud/src/client/types.gen.ts:4201
The base URL for OpenAI API.
api_version?
optional
api_version:string
|null
Defined in: packages/cloud/src/client/types.gen.ts:4205
The version for OpenAI API.
max_retries?
optional
max_retries:number
Defined in: packages/cloud/src/client/types.gen.ts:4209
Maximum number of retries.
timeout?
optional
timeout:number
Defined in: packages/cloud/src/client/types.gen.ts:4213
Timeout for each request.
default_headers?
optional
default_headers: {[key
:string
]:string
; } |null
Defined in: packages/cloud/src/client/types.gen.ts:4217
The default headers for API requests.
reuse_client?
optional
reuse_client:boolean
Defined in: packages/cloud/src/client/types.gen.ts:4223
Reuse the OpenAI client between requests. When doing anything with large volumes of async API calls, setting this to false can improve stability.
dimensions?
optional
dimensions:number
|null
Defined in: packages/cloud/src/client/types.gen.ts:4227
The number of dimensions on the output embedding vectors. Works only with v3 embedding models.
class_name?
optional
class_name:string
Defined in: packages/cloud/src/client/types.gen.ts:4228