OpenAIClientOptionsWithAzureAgent interface
扩展 OpenAI 客户端选项,包含 Azure Agent 端点配置。
- 扩展
-
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']。 |
| credential | 一 |
| dangerously |
默认情况下,客户端不允许使用该库,因为这有可能暴露你的秘密API凭证给攻击者。
只有在你了解风险并采取了相应的缓解措施时,才将此选项 |
| data |
选择一个 OpenAI 区域端点。 该 URL 覆盖继承或环境基 URL,且与显式 |
| 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 | 客户端在超时前应等待服务器响应的最大时间(以毫秒为单位)。 请注意,请求超时默认会重试,因此在最坏情况下,你可能会等待比这个超时更长时间,才能确定承诺是否成功。 Node.js 取物强制执行独立的响应头和身体非活动超时,通常默认为五分钟,即使超时时间更长。 要增加它们,安装
|
| webhook |
默认为 process.env['OPENAI_WEBHOOK_SECRET']。 |
| workload |
OAuth2令牌交换认证的工作载荷身份配置。
与 |
| x509Transport | 批准且冻结的 Node.js 证书传输仅用于X.509工作负载身份。 |
属性详细信息
azureConfig
继承属性详细信息
adminAPIKey
默认为 process.env['OPENAI_ADMIN_KEY']。
adminAPIKey?: string | null
属性值
string | null
继承自 OpenAIClientOptions.adminAPIKey
apiKey
用于认证的API密钥。
- 接受静态字符串或异步函数,后者解析为字符串。
- 默认为 process.env['OPENAI_API_KEY']。
- 当函数被提供时,在为每次尝试构建承载认证头部时调用,包括重试和直接
buildRequest()调用。 每个调用的结果都用于其自身的请求。 - 函数必须返回非空字符串;否则会抛出OpenAIError。
- 如果函数抛出,错误会被包裹在OpenAIError中,原始错误可
cause作为。 - 与
workloadIdentity互斥。
apiKey?: string | ApiKeySetter | null
属性值
string | ApiKeySetter | null
继承自 OpenAIClientOptions.apiKey
baseURL
覆盖API的默认基础URL,例如,“https://api.example.com/v2/"
默认为 process.env['OPENAI_BASE_URL']。
baseURL?: string | null
属性值
string | null
继承自 OpenAIClientOptions.baseURL
credential
一 fromX509 类证书凭证由 创建 openai/auth/x509-transport。
credential?: X509Credential
属性值
X509Credential
继承自 OpenAIClientOptions.credential
dangerouslyAllowBrowser
默认情况下,客户端不允许使用该库,因为这有可能暴露你的秘密API凭证给攻击者。
只有在你了解风险并采取了相应的缓解措施时,才将此选项 true 设置为合适的。
dangerouslyAllowBrowser?: boolean
属性值
boolean
继承自 OpenAIClientOptions.dangerouslyAllowBrowser(开放AIClientOptions.dangerouslyAllowBrowser)
dataResidency
选择一个 OpenAI 区域端点。 该 URL 覆盖继承或环境基 URL,且与显式 baseURL 或 provider.( ) 互斥。
可用性取决于你的项目和型号;不进行任何后备。
null 并 undefined 保持普通的基础URL分辨率不变。
dataResidency?: DataResidency | null
属性值
DataResidency | null
继承自 OpenAIClientOptions.dataResidency
defaultHeaders
每个请求API都包含默认的头部。
通过在请求选项中明确将头设置为 来 null 移除这些请求。
defaultHeaders?: HeadersLike
属性值
HeadersLike
继承自 OpenAIClientOptions.defaultHeaders
defaultQuery
每个请求API都包含默认查询参数。
通过在请求选项中明确将参数设置为 来 undefined 移除这些请求。
defaultQuery?: Record<string, string | undefined>
属性值
Record<string, string | undefined>
继承自 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?: string | null
属性值
string | null
继承自 OpenAIClientOptions.organization
project
默认为 process.env['OPENAI_PROJECT_ID']。
project?: string | null
属性值
string | null
继承自 OpenAIClientOptions.project
provider
将该客户端配置为使用第三方API提供者。
互斥,支持顶级认证和 baseURL 选项。
provider?: Provider
属性值
Provider
继承自 OpenAIClientOptions.provider
timeout
客户端在超时前应等待服务器响应的最大时间(以毫秒为单位)。
请注意,请求超时默认会重试,因此在最坏情况下,你可能会等待比这个超时更长时间,才能确定承诺是否成功。
Node.js 取物强制执行独立的响应头和身体非活动超时,通常默认为五分钟,即使超时时间更长。 要增加它们,安装 undici 并配置一个与匹配取指实现的代理:
import { Agent, fetch } from 'undici';
const timeout = 20 * 60 * 1000;
const client = new OpenAI({
timeout,
fetch,
fetchOptions: {
dispatcher: new Agent({ headersTimeout: timeout, bodyTimeout: timeout }),
},
});
timeout?: number
属性值
number
继承自 OpenAIClientOptions.timeout
webhookSecret
默认为 process.env['OPENAI_WEBHOOK_SECRET']。
webhookSecret?: string | null
属性值
string | null
继承自 OpenAIClientOptions.webhookSecret
workloadIdentity
OAuth2令牌交换认证的工作载荷身份配置。
与 apiKey 互斥。
workloadIdentity?: WorkloadIdentity | X509WorkloadIdentity
属性值
WorkloadIdentity | X509WorkloadIdentity
继承自 OpenAIClientOptions.workloadIdentity
x509Transport
批准且冻结的 Node.js 证书传输仅用于X.509工作负载身份。
x509Transport?: X509Transport
属性值
X509Transport
继承自 OpenAIClientOptions.x509Transport