OpenAIClientOptionsWithAzureAgent interface

Azure Agent endpoint configuration.

azureConfig?: AzureAgentConfig

Valore della proprietà

Predefinito su process.env['OPENAI_ADMIN_KEY'].

adminAPIKey?: string | null

Valore della proprietà

Ereditato da OpenAIClientOptions.adminAPIKey

La chiave API viene usata per l'autenticazione.

• Accetta sia una stringa statica che una funzione asincrona che si risolve in una stringa.
• Predefinito su process.env['OPENAI_API_KEY'].
• Quando viene fornita una funzione, viene invocata durante la costruzione delle header di autenticazione dei portatori per ogni tentativo, inclusi ritentativi e chiamate dirette buildRequest() . Il risultato di ogni invocazione viene utilizzato per una propria richiesta.
• La funzione deve restituire una stringa non vuota; altrimenti viene lanciato un OpenAIErrr.
• Se la funzione viene lanciata, l'errore viene avvolto in un OpenAIError con l'errore originale disponibile come cause.
• Si escludono con workloadIdentity a vicenda.

apiKey?: string | ApiKeySetter | null

Valore della proprietà

Ereditato da OpenAIClientOptions.apiKey

Sovrascrivere l'URL base predefinito per l'API, ad esempio, "https://api.example.com/v2/"

Predefinito process.env['OPENAI_BASE_URL'].

baseURL?: string | null

Valore della proprietà

Ereditato da OpenAIClientOptions.baseURL

Certificato di prima classe creato con fromX509 .openai/auth/x509-transport

credential?: X509Credential

Valore della proprietà

Ereditato da OpenAIClientOptions.credential

Per impostazione predefinita, l'uso lato client di questa libreria non è consentito, poiché rischia di esporre le tue credenziali API segrete agli attaccanti. Imposta questa opzione solo true se comprendi i rischi e hai adeguate misure di mitigazione.

dangerouslyAllowBrowser?: boolean

Valore della proprietà

Ereditato da OpenAIClientOptions.dangerouslyAllowBrowser

Seleziona un endpoint regionale OpenAI. Questo sovrascrive un URL ereditato o di base dell'ambiente ed è mutuamente esclusivo con un URL esplicito baseURL o provider. La disponibilità dipende dal tuo progetto e dal modello; non viene effettuato alcun fallback. null e undefined lasciare invariata la risoluzione degli URL base ordinaria.

dataResidency?: DataResidency | null

Valore della proprietà

Ereditato da OpenAIClientOptions.dataResidency

Intestazioni predefinite da includere con ogni richiesta all'API.

Questi possono essere rimossi nelle singole richieste impostando esplicitamente l'intestazione su null in opzioni di richiesta.

defaultHeaders?: HeadersLike

Valore della proprietà

Ereditato da OpenAIClientOptions.defaultHeaders

Parametri predefiniti di query da includere con ogni richiesta all'API.

Questi possono essere rimossi nelle singole richieste impostando esplicitamente il param su undefined in nelle opzioni di richiesta.

defaultQuery?: Record<string, string | undefined>

Valore della proprietà

Ereditato da OpenAIClientOptions.defaultQuery

Specifica un'implementazione di una funzione personalizzata fetch .

Se non è fornito, ci aspettiamo che venga fetch definito a livello globale.

fetch?: Fetch

Valore della proprietà

Ereditato da OpenAIClientOptions.fetch

Ulteriori RequestInit opzioni da passare alle fetch chiamate. Le proprietà saranno sovrascritte da ogni richiesta fetchOptions.

fetchOptions?: MergedRequestInit

Valore della proprietà

Ereditato da OpenAIClientOptions.fetchOptions

Imposta il logger.

Predefinito su globalThis.console.

logger?: Logger

Valore della proprietà

Ereditato da OpenAIClientOptions.logger

Imposta il livello del log.

Di default usa process.env['OPENAI_LOG'] o 'warn' se non è impostato.

logLevel?: LogLevel

Valore della proprietà

Ereditato da OpenAIClientOptions.logLevel

Il numero massimo di volte in cui il client ritenterà una richiesta in caso di fallimento temporaneo, come un errore di rete o un errore 5XX dal server.

maxRetries?: number

Valore della proprietà

Ereditato da OpenAIClientOptions.maxRetries

Predefinito su process.env['OPENAI_ORG_ID'].

organization?: string | null

Valore della proprietà

Ereditato da OpenAIClientOptions.organization

Predefinito process.env['OPENAI_PROJECT_ID'].

project?: string | null

Valore della proprietà

Ereditato da OpenAIClientOptions.project

Configura questo client per utilizzare un provider API di terze parti. Mutuamente esclusivi con autenticazione di alto livello e baseURL opzioni.

provider?: Provider

Valore della proprietà

Ereditato da OpenAIClientOptions.provider

Il tempo massimo (in millisecondi) che il client dovrebbe aspettare una risposta dal server prima di spegnere una singola richiesta.

Nota che i timeout delle richieste vengono riprovati di default, quindi nel peggiore dei casi potresti aspettare molto più a lungo prima che la promessa abbia successo o fallisca.

Node.js fetch impone timeout indipendenti di header di risposta e di inattività corporea, tipicamente di cinque minuti, anche quando questo timeout è più lungo. Per aumentarle, installa undici e configura un Agent con l'implementazione fetch corrispondente:

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

Valore della proprietà

Ereditato da OpenAIClientOptions.timeout

Predefinito su process.env['OPENAI_WEBHOOK_SECRET'].

webhookSecret?: string | null

Valore della proprietà

Ereditato da OpenAIClientOptions.webhookSecret

Configurazione dell'identità del carico di lavoro per l'autenticazione OAuth2 token exchange. Si escludono con apiKey a vicenda.

workloadIdentity?: WorkloadIdentity | X509WorkloadIdentity

Valore della proprietà

Ereditato da OpenAIClientOptions.workloadIdentity

Approvato, blocco Node.js trasporto certificato richiesto solo per l'identità del carico di lavoro X.509.

x509Transport?: X509Transport

Valore della proprietà

Ereditato da OpenAIClientOptions.x509Transport