OpenAIClientOptionsWithAzureAgent interface

パッケージ:

@azure/ai-projects

Azure Agentエンドポイント構成を含む拡張されたOpenAIクライアントオプション。

Extends

ClientOptions

プロパティ

azureConfig

Azure Agent endpoint configuration.

継承されたプロパティ

adminAPIKey	デフォルトはprocess.env['OPENAI_ADMIN_KEY']です。
apiKey	認証に使われるAPIキー。 静的文字列または文字列に解決される非同期関数のいずれかを受け入れます。 デフォルトはprocess.env['OPENAI_API_KEY']です。 関数が提供されると、各試みのベアラー認証ヘッダーを構築する際に呼び出し、リトライや直接 buildRequest() 呼び出しも含まれます。 各呼び出しの結果は、それぞれのリクエストに使われます。 関数は空でない文字列を返さなければなりません。そうでなければOpenAIErrorが投げられます。 関数がスローした場合、そのエラーは元のエラーを causeとして利用可能なOpenAIErrorでラップされます。 workloadIdentity と相互に排他的です。
baseURL	APIのデフォルトのベースURLを上書きします。例:「https://api.example.com/v2/" デフォルトはprocess.env['OPENAI_BASE_URL']です。
credential	openai/auth/x509-transportのfromX509で作成されたファーストクラス証明書資格。
dangerouslyAllowBrowser	デフォルトでは、このライブラリのクライアント側での使用は許可されていません。なぜなら、秘密のAPI認証情報が攻撃者に露出するリスクがあるからです。 リスクを理解し、適切な対策を講じている場合にのみ、このオプションを true に設定してください。
dataResidency	OpenAIの地域エンドポイントを選択してください。 これは継承されたURLや環境ベースのURLを上書きし、明示的な baseURL や providerと相互排他的です。 可用性はプロジェクトやモデルによって異なります。フォールバックは一切行われません。 null 通常の基本URL解像度は変更 undefined ません。
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	クライアントが単一のリクエストをタイムアウトする前にサーバーからの応答を待つ最大時間(ミリ秒単位)です。 リクエストのタイムアウトはデフォルトで再試されるため、最悪の場合はこのタイムアウトよりずっと長く待って約束が成功または失敗する可能性があることに注意してください。 Node.js fetchは独立したレスポンスヘッダーとボディ非活動タイムアウトを強制し、通常はこのタイムアウトが長くてもデフォルトで5分となります。 増加するには、 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 }), }, });
webhookSecret	デフォルトはprocess.env['OPENAI_WEBHOOK_SECRET']です。
workloadIdentity	OAuth2トークン交換認証のためのワークロードアイデンティティ設定。 apiKey と相互に排他的です。
x509Transport	承認済みで凍結された Node.js 証明書の転送はX.509ワークロードの識別にのみ必要です。

プロパティの詳細

azureConfig

Azure Agent endpoint configuration.

azureConfig?: AzureAgentConfig

プロパティ値

AzureAgentConfig

継承されたプロパティの詳細

adminAPIKey

デフォルトはprocess.env['OPENAI_ADMIN_KEY']です。

adminAPIKey?: string | null

プロパティ値

string | null

継承者 OpenAIClientOptions.adminAPIKey

apiKey

認証に使われるAPIキー。

• 静的文字列または文字列に解決される非同期関数のいずれかを受け入れます。
• デフォルトはprocess.env['OPENAI_API_KEY']です。
• 関数が提供されると、各試みのベアラー認証ヘッダーを構築する際に呼び出し、リトライや直接 buildRequest() 呼び出しも含まれます。 各呼び出しの結果は、それぞれのリクエストに使われます。
• 関数は空でない文字列を返さなければなりません。そうでなければOpenAIErrorが投げられます。
• 関数がスローした場合、そのエラーは元のエラーを causeとして利用可能なOpenAIErrorでラップされます。
• 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

openai/auth/x509-transportのfromX509で作成されたファーストクラス証明書資格。

credential?: X509Credential

プロパティ値

X509Credential

継承元 OpenAIClientOptions.credential

dangerouslyAllowBrowser

デフォルトでは、このライブラリのクライアント側での使用は許可されていません。なぜなら、秘密のAPI認証情報が攻撃者に露出するリスクがあるからです。 リスクを理解し、適切な対策を講じている場合にのみ、このオプションを true に設定してください。

dangerouslyAllowBrowser?: boolean

プロパティ値

boolean

継承者 OpenAIClientOptions.dangerouslyAllowBrowser(オープンAIClientOptions.dangerouslyAllowBrowser)

dataResidency

OpenAIの地域エンドポイントを選択してください。 これは継承されたURLや環境ベースのURLを上書きし、明示的な baseURL や providerと相互排他的です。 可用性はプロジェクトやモデルによって異なります。フォールバックは一切行われません。 null 通常の基本URL解像度は変更 undefined ません。

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 fetchは独立したレスポンスヘッダーとボディ非活動タイムアウトを強制し、通常はこのタイムアウトが長くてもデフォルトで5分となります。 増加するには、 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