OpenAIEmbedding

OpenAIEmbedding = object

Defined in: packages/cloud/src/client/types.gen.ts:3752

Properties

model_name?

optional model_name: string

Defined in: packages/cloud/src/client/types.gen.ts:3756

The name of the OpenAI embedding model.

---

embed_batch_size?

optional embed_batch_size: number

Defined in: packages/cloud/src/client/types.gen.ts:3760

The batch size for embedding calls.

---

num_workers?

optional num_workers: number | null

Defined in: packages/cloud/src/client/types.gen.ts:3764

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:3768

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:3774

The OpenAI API key.

---

api_base?

optional api_base: string | null

Defined in: packages/cloud/src/client/types.gen.ts:3778

The base URL for OpenAI API.

---

api_version?

optional api_version: string | null

Defined in: packages/cloud/src/client/types.gen.ts:3782

The version for OpenAI API.

---

max_retries?

optional max_retries: number

Defined in: packages/cloud/src/client/types.gen.ts:3786

Maximum number of retries.

---

timeout?

optional timeout: number

Defined in: packages/cloud/src/client/types.gen.ts:3790

Timeout for each request.

---

default_headers?

optional default_headers: {[key: string]: string; } | null

Defined in: packages/cloud/src/client/types.gen.ts:3794

The default headers for API requests.

---

reuse_client?

optional reuse_client: boolean

Defined in: packages/cloud/src/client/types.gen.ts:3800

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:3804

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:3805