OpenAIClientOptionsWithAzureAgent interface

包:

@azure/ai-projects

扩展 OpenAI 客户端选项，包含 Azure Agent 端点配置。

扩展

ClientOptions

属性

azureConfig

Azure Agent endpoint configuration.

继承属性

adminAPIKey	默认为 process.env['OPENAI_ADMIN_KEY']。
apiKey	用于认证的API密钥。 接受静态字符串或异步函数，后者解析为字符串。 默认为 process.env['OPENAI_API_KEY']。 当函数被提供时，会在每次请求前调用，这样你可以在运行时轮换或刷新凭证。 函数必须返回非空字符串;否则会抛出OpenAIError。 如果函数抛出，错误会被包裹在OpenAIError中，原始错误可 cause作为。 与 workloadIdentity 互斥。
baseURL	覆盖API的默认基础URL，例如，“https://api.example.com/v2/" 默认为 process.env['OPENAI_BASE_URL']。
dangerouslyAllowBrowser	默认情况下，客户端不允许使用该库，因为这有可能暴露你的秘密API凭证给攻击者。 只有在你了解风险并采取了相应的缓解措施时，才将此选项 true 设置为合适的。
defaultHeaders	每个请求API都包含默认的头部。 通过在请求选项中明确将头设置为 来 null 移除这些请求。
defaultQuery	每个请求API都包含默认查询参数。 通过在请求选项中明确将参数设置为 来 undefined 移除这些请求。
fetch	指定自定义 fetch 函数实现。 如果没有提供，我们期望该信息 fetch 是全球定义的。
fetchOptions	电话中还会有RequestInit额外fetch选项。 属性将被每个请求 fetchOptions覆盖。
logger	设置记录仪。 默认为globalThis.console。
logLevel	把原木调平。 如果未设置，默认为 process.env['OPENAI_LOG']，或为“warn”。
maxRetries	客户端在暂时故障（如网络错误或服务器5XX错误）时，最多可重试请求的次数。
organization	默认为 process.env['OPENAI_ORG_ID']。
project	默认为 process.env['OPENAI_PROJECT_ID']。
provider	将该客户端配置为使用第三方API提供者。 互斥，支持顶级认证和 baseURL 选项。
timeout	客户端在超时前应等待服务器响应的最大时间（以毫秒为单位）。 请注意，请求超时默认会重试，因此在最坏情况下，你可能会等待比这个超时更长时间，才能确定承诺是否成功。
webhookSecret	默认为 process.env['OPENAI_WEBHOOK_SECRET']。
workloadIdentity	OAuth2令牌交换认证的工作载荷身份配置。 与 apiKey 互斥。

属性详细信息

azureConfig

Azure Agent endpoint configuration.

azureConfig?: AzureAgentConfig

属性值

AzureAgentConfig

继承属性详细信息

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