OpenAIClientOptionsWithAzureAgent interface

Paket:
@azure/ai-projects

Erweiterte OpenAI-Client-Optionen, um die Azure Agent-Endpunktkonfiguration einzubeziehen.

Extends

ClientOptions

Eigenschaften

azureConfig

Azure Agent endpoint configuration.

Geerbte Eigenschaften

adminAPIKey

Standardmäßig wird process.env['OPENAI_ADMIN_KEY'] verwendet.
apiKey

API-Schlüssel zur Authentifizierung verwendet.

  • Akzeptiert entweder eine statische Zeichenkette oder eine asynchrone Funktion, die sich zu einer Zeichenkette auflöst.
  • Standardmäßig steht process.env['OPENAI_API_KEY'].
  • Wenn eine Funktion bereitgestellt wird, wird sie vor jeder Anfrage aufgerufen, sodass Sie die Zugangsdaten zur Laufzeit rotieren oder aktualisieren können.
  • Die Funktion muss eine nicht-leere Zeichenkette zurückgeben; ansonsten wird ein OpenAIError geworfen.
  • Wenn die Funktion geworfen wird, wird der Fehler in einen OpenAIError eingewickelt, wobei der ursprüngliche Fehler als verfügbar ist cause.
  • Gegenseitiger Ausschluss mit workloadIdentity
baseURL

Überschreiben Sie die Standard-Basis-URL für die API, z. B. "https://api.example.com/v2/"

Standardmäßig steht process.env['OPENAI_BASE_URL'].
dangerouslyAllowBrowser

Standardmäßig ist die clientseitige Nutzung dieser Bibliothek nicht erlaubt, da dies das Risiko birgt, dass Ihre geheimen API-Zugangsdaten Angreifern offengelegt werden. Setzen Sie diese Option nur auf, true wenn Sie die Risiken verstehen und entsprechende Maßnahmen getroffen haben.
defaultHeaders

Standard-Header, die mit jeder Anfrage an die API aufgenommen werden.

Diese können in einzelnen Anfragen entfernt werden, indem der Header explizit auf null Einstellungen in Anfragen gesetzt wird.
defaultQuery

Standard-Abfrageparameter, die bei jeder Anfrage an die API enthalten sind.

Diese können in einzelnen Anfragen entfernt werden, indem der Param explizit in undefined Anfrageoptionen gesetzt wird.
fetch

Spezifizieren Sie eine benutzerdefinierte fetch Funktionsimplementierung.

Wenn nicht angegeben, erwarten wir, dass dies fetch global definiert ist.
fetchOptions

Zusätzliche RequestInit Optionen, die an fetch Anrufe weitergegeben werden. Immobilien werden per Anfrage fetchOptionsüberschrieben.
logger

Stell den Holzfäller ein.

Standardeinstellung ist globalThis.console.
logLevel

Setze das Log-Level ein.

Standardmäßig steht auf process.env['OPENAI_LOG'] oder 'warn', wenn es nicht gesetzt ist.
maxRetries

Die maximale Anzahl der Male, in denen der Client eine Anfrage im Falle eines temporären Ausfalls erneut versucht, wie etwa ein Netzwerkfehler oder ein 5XX-Fehler vom Server.
organization

Standardmäßig steht process.env['OPENAI_ORG_ID'].
project

Standardeinstellung lautet process.env['OPENAI_PROJECT_ID'].
provider

Konfigurieren Sie diesen Client so, dass er einen Drittanbieter-API-Anbieter verwendet. Gegenseitig ausgeschlossen mit oberster Authentifizierung und Optionen baseURL .
timeout

Die maximale Zeit (in Millisekunden), in der der Client auf eine Antwort vom Server warten sollte, bevor er eine einzelne Anfrage absetzt.

Beachten Sie, dass Anfrage-Timeouts standardmäßig erneut versucht werden, sodass Sie im schlimmsten Fall viel länger warten können, bis das Versprechen erfolgreich oder fehlschlägt.
webhookSecret

Standardmäßig steht process.env['OPENAI_WEBHOOK_SECRET'].
workloadIdentity

Workload-Identitätskonfiguration für OAuth2-Token-Austausch-Authentifizierung. Gegenseitiger Ausschluss mit apiKey

Details zur Eigenschaft

azureConfig

Azure Agent endpoint configuration.

azureConfig?: AzureAgentConfig

Eigenschaftswert

AzureAgentConfig

Geerbte Eigenschaftsdetails

adminAPIKey

Standardmäßig wird process.env['OPENAI_ADMIN_KEY'] verwendet.

adminAPIKey?: null | string

Eigenschaftswert

null | string

Geerbt von OpenAIClientOptions.adminAPIKey

apiKey

API-Schlüssel zur Authentifizierung verwendet.

  • Akzeptiert entweder eine statische Zeichenkette oder eine asynchrone Funktion, die sich zu einer Zeichenkette auflöst.
  • Standardmäßig steht process.env['OPENAI_API_KEY'].
  • Wenn eine Funktion bereitgestellt wird, wird sie vor jeder Anfrage aufgerufen, sodass Sie die Zugangsdaten zur Laufzeit rotieren oder aktualisieren können.
  • Die Funktion muss eine nicht-leere Zeichenkette zurückgeben; ansonsten wird ein OpenAIError geworfen.
  • Wenn die Funktion geworfen wird, wird der Fehler in einen OpenAIError eingewickelt, wobei der ursprüngliche Fehler als verfügbar ist cause.
  • Gegenseitiger Ausschluss mit workloadIdentity
apiKey?: null | string | ApiKeySetter

Eigenschaftswert

null | string | ApiKeySetter

Geerbt von OpenAIClientOptions.apiKey

baseURL

Überschreiben Sie die Standard-Basis-URL für die API, z. B. "https://api.example.com/v2/"

Standardmäßig steht process.env['OPENAI_BASE_URL'].

baseURL?: null | string

Eigenschaftswert

null | string

Geerbt von OpenAIClientOptions.baseURL

dangerouslyAllowBrowser

Standardmäßig ist die clientseitige Nutzung dieser Bibliothek nicht erlaubt, da dies das Risiko birgt, dass Ihre geheimen API-Zugangsdaten Angreifern offengelegt werden. Setzen Sie diese Option nur auf, true wenn Sie die Risiken verstehen und entsprechende Maßnahmen getroffen haben.

dangerouslyAllowBrowser?: boolean

Eigenschaftswert

boolean

Geerbt von OpenAIClientOptions.dangerouslyAllowBrowser

defaultHeaders

Standard-Header, die mit jeder Anfrage an die API aufgenommen werden.

Diese können in einzelnen Anfragen entfernt werden, indem der Header explizit auf null Einstellungen in Anfragen gesetzt wird.

defaultHeaders?: HeadersLike

Eigenschaftswert

HeadersLike

Geerbt von OpenAIClientOptions.defaultHeaders

defaultQuery

Standard-Abfrageparameter, die bei jeder Anfrage an die API enthalten sind.

Diese können in einzelnen Anfragen entfernt werden, indem der Param explizit in undefined Anfrageoptionen gesetzt wird.

defaultQuery?: Record<string, undefined | string>

Eigenschaftswert

Record<string, undefined | string>

Geerbt von OpenAIClientOptions.defaultQuery

fetch

Spezifizieren Sie eine benutzerdefinierte fetch Funktionsimplementierung.

Wenn nicht angegeben, erwarten wir, dass dies fetch global definiert ist.

fetch?: Fetch

Eigenschaftswert

Fetch

Geerbt von OpenAIClientOptions.fetch

fetchOptions

Zusätzliche RequestInit Optionen, die an fetch Anrufe weitergegeben werden. Immobilien werden per Anfrage fetchOptionsüberschrieben.

fetchOptions?: MergedRequestInit

Eigenschaftswert

MergedRequestInit

Geerbt von OpenAIClientOptions.fetchOptions

logger

Stell den Holzfäller ein.

Standardeinstellung ist globalThis.console.

logger?: Logger

Eigenschaftswert

Logger

Geerbt von OpenAIClientOptions.logger

logLevel

Setze das Log-Level ein.

Standardmäßig steht auf process.env['OPENAI_LOG'] oder 'warn', wenn es nicht gesetzt ist.

logLevel?: LogLevel

Eigenschaftswert

LogLevel

Geerbt von OpenAIClientOptions.logLevel

maxRetries

Die maximale Anzahl der Male, in denen der Client eine Anfrage im Falle eines temporären Ausfalls erneut versucht, wie etwa ein Netzwerkfehler oder ein 5XX-Fehler vom Server.

maxRetries?: number

Eigenschaftswert

number

Geerbt von OpenAIClientOptions.maxRetries

organization

Standardmäßig steht process.env['OPENAI_ORG_ID'].

organization?: null | string

Eigenschaftswert

null | string

Geerbt von OpenAIClientOptions.organization

project

Standardeinstellung lautet process.env['OPENAI_PROJECT_ID'].

project?: null | string

Eigenschaftswert

null | string

Geerbt von OpenAIClientOptions.project

provider

Konfigurieren Sie diesen Client so, dass er einen Drittanbieter-API-Anbieter verwendet. Gegenseitig ausgeschlossen mit oberster Authentifizierung und Optionen baseURL .

provider?: Provider

Eigenschaftswert

Provider

Geerbt von OpenAIClientOptions.provider

timeout

Die maximale Zeit (in Millisekunden), in der der Client auf eine Antwort vom Server warten sollte, bevor er eine einzelne Anfrage absetzt.

Beachten Sie, dass Anfrage-Timeouts standardmäßig erneut versucht werden, sodass Sie im schlimmsten Fall viel länger warten können, bis das Versprechen erfolgreich oder fehlschlägt.

timeout?: number

Eigenschaftswert

number

Geerbt von OpenAIClientOptions.timeout

webhookSecret

Standardmäßig steht process.env['OPENAI_WEBHOOK_SECRET'].

webhookSecret?: null | string

Eigenschaftswert

null | string

Geerbt von OpenAIClientOptions.webhookSecret

workloadIdentity

Workload-Identitätskonfiguration für OAuth2-Token-Austausch-Authentifizierung. Gegenseitiger Ausschluss mit apiKey

workloadIdentity?: WorkloadIdentity

Eigenschaftswert

WorkloadIdentity

Geerbt von OpenAIClientOptions.workloadIdentity