OpenAIClientOptionsWithAzureAgent interface
擴展 OpenAI 客戶端選項可包含 Azure Agent 端點配置。
- Extends
-
ClientOptions
屬性
| azure |
Azure Agent endpoint configuration. |
繼承的屬性
| admin |
預設為 process.env['OPENAI_ADMIN_KEY']。 |
| api |
API 金鑰用於認證。
|
| baseURL | 覆寫 API 的預設基礎 URL，例如「https://api.example.com/v2/" 預設為 process.env['OPENAI_BASE_URL']。 |
| dangerously |
預設情況下，客戶端不允許使用此函式庫，因為這有可能暴露你的秘密 API 憑證給攻擊者。
只有當你了解風險並有適當的緩解措施時，才可設定此選項 |
| default |
每次向 API 請求時都要包含預設標頭。 這些可透過在請求選項中明確設定標頭為 來 |
| default |
每次請求 API 時都要包含預設的查詢參數。 這些參數可在個別請求中移除，方法是在請求選項中明確設定參數為 。 |
| fetch | 指定一個自訂 若未提供，我們預期該定義 |
| fetch |
通話時還會提供 |
| logger | 設定木樁。 預設為 globalThis.console。 |
| log |
設定原木水平。 預設為 process.env['OPENAI_LOG']，若未設定則為「warn」。 |
| max |
客戶端在暫時性故障（如網路錯誤或伺服器 5XX 錯誤）時，最多可重試請求的次數。 |
| organization | 預設為 process.env['OPENAI_ORG_ID']。 |
| project | 預設為 process.env['OPENAI_PROJECT_ID']。 |
| provider | 將此用戶端設定為使用第三方 API 提供者。
互斥，具備頂層驗證與 |
| timeout | 客戶端在逾時前應等待伺服器回應的最大時間（以毫秒為單位）。 請注意，請求逾時預設會重試，因此在最壞情況下，你可能會等比這個逾時更久，承諾才會成功或失敗。 |
| webhook |
預設為 process.env['OPENAI_WEBHOOK_SECRET']。 |
| workload |
OAuth2 令牌交換驗證的工作負載身份設定。
與 |
屬性詳細資料
azureConfig
繼承的屬性詳細資料
adminAPIKey
預設為 process.env['OPENAI_ADMIN_KEY']。
adminAPIKey?: null | string屬性值
null | string
繼承自 OpenAIClientOptions.adminAPIKey
apiKey
API 金鑰用於認證。
- 接受靜態字串或非同步函式，後者解析為字串。
- 預設為 process.env['OPENAI_API_KEY']。
- 當函式被提供時，會在每次請求前被呼叫，讓你能在執行時輪換或刷新憑證。
- 函式必須回傳非空字串;否則會拋出 OpenAIError。
- 若函式拋出，錯誤會被包裹在 OpenAIError，原始錯誤為
cause。 - 與
workloadIdentity互斥。
apiKey?: null | string | ApiKeySetter屬性值
null | string | ApiKeySetter
繼承自 OpenAIClientOptions.apiKey
baseURL
覆寫 API 的預設基礎 URL，例如「https://api.example.com/v2/"
預設為 process.env['OPENAI_BASE_URL']。
baseURL?: null | string屬性值
null | string
繼承自 OpenAIClientOptions.baseURL
dangerouslyAllowBrowser
預設情況下，客戶端不允許使用此函式庫，因為這有可能暴露你的秘密 API 憑證給攻擊者。
只有當你了解風險並有適當的緩解措施時，才可設定此選項 true 。
dangerouslyAllowBrowser?: boolean屬性值
boolean
繼承自 OpenAIClientOptions.dangerouslyAllowBrowser（開放AIClientOptions.dangerouslyAllowBrowser）
defaultHeaders
每次向 API 請求時都要包含預設標頭。
這些可透過在請求選項中明確設定標頭為 來 null 移除。
defaultHeaders?: HeadersLike屬性值
HeadersLike
繼承自 OpenAIClientOptions.defaultHeaders
defaultQuery
每次請求 API 時都要包含預設的查詢參數。
這些參數可在個別請求中移除，方法是在請求選項中明確設定參數為 。undefined
defaultQuery?: Record<string, undefined | string>屬性值
Record<string, undefined | string>
繼承自 OpenAIClientOptions.defaultQuery
fetch
指定一個自訂 fetch 函式實作。
若未提供，我們預期該定義 fetch 為全域。
fetch?: Fetch屬性值
Fetch
繼承自 OpenAIClientOptions.fetch
fetchOptions
通話時還會提供RequestInit額外fetch選項。
屬性將被每個請求 fetchOptions覆蓋。
fetchOptions?: MergedRequestInit屬性值
MergedRequestInit
繼承自 OpenAIClientOptions.fetchOptions
logger
設定木樁。
預設為 globalThis.console。
logger?: Logger屬性值
Logger
繼承自 OpenAIClientOptions.logger
logLevel
設定原木水平。
預設為 process.env['OPENAI_LOG']，若未設定則為「warn」。
logLevel?: LogLevel屬性值
LogLevel
繼承自 OpenAIClientOptions.logLevel
maxRetries
客戶端在暫時性故障（如網路錯誤或伺服器 5XX 錯誤）時，最多可重試請求的次數。
maxRetries?: number屬性值
number
繼承自 OpenAIClientOptions.maxRetries
organization
預設為 process.env['OPENAI_ORG_ID']。
organization?: null | string屬性值
null | string
繼承自 OpenAIClientOptions.organization
project
預設為 process.env['OPENAI_PROJECT_ID']。
project?: null | string屬性值
null | string
繼承自 OpenAIClientOptions.project
provider
將此用戶端設定為使用第三方 API 提供者。
互斥，具備頂層驗證與 baseURL 選項。
provider?: Provider屬性值
Provider
繼承自 OpenAIClientOptions.provider
timeout
客戶端在逾時前應等待伺服器回應的最大時間（以毫秒為單位）。
請注意，請求逾時預設會重試，因此在最壞情況下，你可能會等比這個逾時更久，承諾才會成功或失敗。
timeout?: number屬性值
number
繼承自 OpenAIClientOptions.timeout
webhookSecret
預設為 process.env['OPENAI_WEBHOOK_SECRET']。
webhookSecret?: null | string屬性值
null | string
繼承自 OpenAIClientOptions.webhookSecret
workloadIdentity
OAuth2 令牌交換驗證的工作負載身份設定。
與 apiKey互斥。
workloadIdentity?: WorkloadIdentity屬性值
WorkloadIdentity
繼承自 OpenAIClientOptions.workloadIdentity