OpenAIClientOptionsWithAzureAgent interface

Paket:
@azure/ai-projects

Utökade OpenAI-klientalternativ för att inkludera Azure Agents endpoint-konfiguration.

Extends

ClientOptions

Egenskaper

azureConfig

Azure Agent endpoint configuration.

Ärvda egenskaper

adminAPIKey

Standardinställningen är process.env['OPENAI_ADMIN_KEY'].
apiKey

API-nyckel används för autentisering.

  • Accepterar antingen en statisk sträng eller en asynkron funktion som löses till en sträng.
  • Standardinställningen är process.env['OPENAI_API_KEY'].
  • När en funktion tillhandahålls anropas den före varje förfrågan så att du kan rotera eller uppdatera inloggningsuppgifter vid körning.
  • Funktionen måste returnera en icke-tom sträng; annars kastas en OpenAIError.
  • Om funktionen kastar omsluts felet i en OpenAIError med det ursprungliga felet tillgängligt som cause.
  • Ömsesidigt uteslutande med workloadIdentity.
baseURL

Överskriv standardbas-URL:en för API:et, t.ex. "https://api.example.com/v2/"

Defaulten är process.env['OPENAI_BASE_URL'].
dangerouslyAllowBrowser

Som standard är användning av detta bibliotek på klientsidan inte tillåten, eftersom det riskerar att exponera dina hemliga API-uppgifter för angripare. Ställ bara in detta alternativ om true du förstår riskerna och har lämpliga åtgärder på plats.
defaultHeaders

Standardheaders att inkludera med varje förfrågan till API:et.

Dessa kan tas bort i individuella förfrågningar genom att uttryckligen ställa in headern till null alternativ i förfrågningar.
defaultQuery

Standardfrågeparametrar att inkludera med varje förfrågan till API:et.

Dessa kan tas bort i individuella förfrågningar genom att uttryckligen ställa in param till undefined i förfrågningsalternativ.
fetch

Specificera en anpassad fetch funktionsimplementation.

Om det inte tillhandahålls förväntar vi oss att det fetch definieras globalt.
fetchOptions

Ytterligare RequestInit alternativ kan överföras till fetch samtal. Fastigheter kommer att åsidosättas per request fetchOptions.
logger

Ställ in skogshuggern.

Standardinställningen är globalThis.console.
logLevel

Ställ in loggnivån.

Standardinställningen är process.env['OPENAI_LOG'] eller 'warn' om den inte är inställd.
maxRetries

Det maximala antalet gånger klienten försöker om en begäran vid tillfälligt fel, som ett nätverksfel eller ett 5XX-fel från servern.
organization

Standardinställningen är process.env['OPENAI_ORG_ID'].
project

Standardinställningen är process.env['OPENAI_PROJECT_ID'].
provider

Konfigurera denna klient att använda en tredjeparts API-leverantör. Ömsesidigt uteslutande med toppnivåautentisering och baseURL alternativ.
timeout

Den maximala tiden (i millisekunder) som klienten bör vänta på svar från servern innan en enskild förfrågan tajmas ut.

Observera att timeouts för förfrågningar som standard försöks igen, så i värsta fall kan du vänta mycket längre än denna timeout innan löftet lyckas eller misslyckas.
webhookSecret

Standardinställningen är process.env['OPENAI_WEBHOOK_SECRET'].
workloadIdentity

Konfiguration av arbetsbelastningsidentitet för OAuth2-tokenutbytesautentisering. Ömsesidigt uteslutande med apiKey.

Egenskapsinformation

azureConfig

Azure Agent endpoint configuration.

azureConfig?: AzureAgentConfig

Egenskapsvärde

AzureAgentConfig

Information om ärvda egenskaper

adminAPIKey

Standardinställningen är process.env['OPENAI_ADMIN_KEY'].

adminAPIKey?: null | string

Egenskapsvärde

null | string

Ärvt från OpenAIClientOptions.adminAPIKey

apiKey

API-nyckel används för autentisering.

  • Accepterar antingen en statisk sträng eller en asynkron funktion som löses till en sträng.
  • Standardinställningen är process.env['OPENAI_API_KEY'].
  • När en funktion tillhandahålls anropas den före varje förfrågan så att du kan rotera eller uppdatera inloggningsuppgifter vid körning.
  • Funktionen måste returnera en icke-tom sträng; annars kastas en OpenAIError.
  • Om funktionen kastar omsluts felet i en OpenAIError med det ursprungliga felet tillgängligt som cause.
  • Ömsesidigt uteslutande med workloadIdentity.
apiKey?: null | string | ApiKeySetter

Egenskapsvärde

null | string | ApiKeySetter

Ärvt från OpenAIClientOptions.apiKey

baseURL

Överskriv standardbas-URL:en för API:et, t.ex. "https://api.example.com/v2/"

Defaulten är process.env['OPENAI_BASE_URL'].

baseURL?: null | string

Egenskapsvärde

null | string

Ärvt från OpenAIClientOptions.baseURL

dangerouslyAllowBrowser

Som standard är användning av detta bibliotek på klientsidan inte tillåten, eftersom det riskerar att exponera dina hemliga API-uppgifter för angripare. Ställ bara in detta alternativ om true du förstår riskerna och har lämpliga åtgärder på plats.

dangerouslyAllowBrowser?: boolean

Egenskapsvärde

boolean

Ärvt från OpenAIClientOptions.dangerouslyAllowBrowser

defaultHeaders

Standardheaders att inkludera med varje förfrågan till API:et.

Dessa kan tas bort i individuella förfrågningar genom att uttryckligen ställa in headern till null alternativ i förfrågningar.

defaultHeaders?: HeadersLike

Egenskapsvärde

HeadersLike

Ärvt från OpenAIClientOptions.defaultHeaders

defaultQuery

Standardfrågeparametrar att inkludera med varje förfrågan till API:et.

Dessa kan tas bort i individuella förfrågningar genom att uttryckligen ställa in param till undefined i förfrågningsalternativ.

defaultQuery?: Record<string, undefined | string>

Egenskapsvärde

Record<string, undefined | string>

Ärvt från OpenAIClientOptions.defaultQuery

fetch

Specificera en anpassad fetch funktionsimplementation.

Om det inte tillhandahålls förväntar vi oss att det fetch definieras globalt.

fetch?: Fetch

Egenskapsvärde

Fetch

Ärvt från OpenAIClientOptions.fetch

fetchOptions

Ytterligare RequestInit alternativ kan överföras till fetch samtal. Fastigheter kommer att åsidosättas per request fetchOptions.

fetchOptions?: MergedRequestInit

Egenskapsvärde

MergedRequestInit

Ärvt från OpenAIClientOptions.fetchOptions

logger

Ställ in skogshuggern.

Standardinställningen är globalThis.console.

logger?: Logger

Egenskapsvärde

Logger

Ärvt från OpenAIClientOptions.logger

logLevel

Ställ in loggnivån.

Standardinställningen är process.env['OPENAI_LOG'] eller 'warn' om den inte är inställd.

logLevel?: LogLevel

Egenskapsvärde

LogLevel

Ärvt från OpenAIClientOptions.logLevel

maxRetries

Det maximala antalet gånger klienten försöker om en begäran vid tillfälligt fel, som ett nätverksfel eller ett 5XX-fel från servern.

maxRetries?: number

Egenskapsvärde

number

Ärvt från OpenAIClientOptions.maxRetries

organization

Standardinställningen är process.env['OPENAI_ORG_ID'].

organization?: null | string

Egenskapsvärde

null | string

Ärvt från OpenAIClientOptions.organization

project

Standardinställningen är process.env['OPENAI_PROJECT_ID'].

project?: null | string

Egenskapsvärde

null | string

Ärvt från OpenAIClientOptions.project

provider

Konfigurera denna klient att använda en tredjeparts API-leverantör. Ömsesidigt uteslutande med toppnivåautentisering och baseURL alternativ.

provider?: Provider

Egenskapsvärde

Provider

Ärvt från OpenAIClientOptions.provider

timeout

Den maximala tiden (i millisekunder) som klienten bör vänta på svar från servern innan en enskild förfrågan tajmas ut.

Observera att timeouts för förfrågningar som standard försöks igen, så i värsta fall kan du vänta mycket längre än denna timeout innan löftet lyckas eller misslyckas.

timeout?: number

Egenskapsvärde

number

Ärvt från OpenAIClientOptions.timeout

webhookSecret

Standardinställningen är process.env['OPENAI_WEBHOOK_SECRET'].

webhookSecret?: null | string

Egenskapsvärde

null | string

Ärvt från OpenAIClientOptions.webhookSecret

workloadIdentity

Konfiguration av arbetsbelastningsidentitet för OAuth2-tokenutbytesautentisering. Ömsesidigt uteslutande med apiKey.

workloadIdentity?: WorkloadIdentity

Egenskapsvärde

WorkloadIdentity

Ärvt från OpenAIClientOptions.workloadIdentity