OpenAIClientOptionsWithAzureAgent interface

Package:
@azure/ai-projects

Extension des options client OpenAI pour inclure la configuration des terminaux Azure Agent.

Extends

ClientOptions

Propriétés

azureConfig

Azure Agent endpoint configuration.

Propriétés héritées

adminAPIKey

Par défaut, process.env['OPENAI_ADMIN_KEY'].
apiKey

La clé API est utilisée pour l’authentification.

  • Accepte soit une chaîne statique, soit une fonction asynchrone qui se résout en chaîne.
  • Par défaut, process.env['OPENAI_API_KEY'].
  • Lorsqu’une fonction est fournie, elle est invoquée lors de la création des en-têtes d’authentification porteuse pour chaque tentative, y compris les retentatives et les appels directs buildRequest() . Le résultat de chaque invocation est utilisé pour sa propre demande.
  • La fonction doit retourner une chaîne non vide ; sinon, un OpenAIError est lancé.
  • Si la fonction se lance, l’erreur est encapsulée dans un OpenAIError avec l’erreur originale disponible sous causela forme .
  • Mutuellement exclusif avec workloadIdentity.
baseURL

Écraser l’URL de base par défaut de l’API, par exemple, «https://api.example.com/v2/" ;

Par défaut, process.env['OPENAI_BASE_URL'].
credential

Certificat de première classe créé avec fromX509 .openai/auth/x509-transport
dangerouslyAllowBrowser

Par défaut, l’utilisation de cette bibliothèque côté client n’est pas autorisée, car cela risque d’exposer vos identifiants API secrets aux attaquants. Configurez cette option true uniquement si vous comprenez les risques et disposez de mesures d’atténuation appropriées.
dataResidency

Sélectionnez un point de terminaison régional OpenAI. Cela supprime une URL héritée ou de la base de l’environnement et est mutuellement exclusif avec une URL explicite baseURL ou provider. La disponibilité dépend de votre projet et de votre modèle ; aucun plan de secours n’est effectué. null et undefined laisser la résolution de l’URL de base ordinaire inchangée.
defaultHeaders

Des en-têtes par défaut à inclure avec chaque requête à l’API.

Celles-ci peuvent être supprimées dans les requêtes individuelles en définissant explicitement l’en-tête sur null dans les options de requête.
defaultQuery

Paramètres de requête par défaut à inclure avec chaque requête à l’API.

Celles-ci peuvent être supprimées dans les requêtes individuelles en définissant explicitement le param sur undefined dans les options de requête.
fetch

Spécifiez une implémentation de fonction personnalisée fetch .

Si cela n’est pas fourni, nous attendons que cela fetch soit défini globalement.
fetchOptions

Des options supplémentaires RequestInit à passer aux fetch appels. Les propriétés seront écrasées par demande fetchOptions.
logger

Installe le bûcheron.

Par défaut, globalThis.console.
logLevel

Réglez le niveau du log.

Par défaut, il utilise process.env['OPENAI_LOG'] ou 'warn' si ce n’est pas défini.
maxRetries

Le nombre maximal de fois où le client réessaiera une requête en cas de défaillance temporaire, comme une erreur réseau ou une erreur 5XX du serveur.
organization

Par défaut, process.env['OPENAI_ORG_ID'].
project

Par défaut, process.env['OPENAI_PROJECT_ID'].
provider

Configurez ce client pour qu’il utilise un fournisseur d’API tiers. Mutuellement exclusifs avec une authentification et baseURL des options de haut niveau.
timeout

Le temps maximal (en millisecondes) pendant lequel le client doit attendre une réponse du serveur avant de timer une seule requête.

Notez que les délais de demande sont réessayés par défaut, donc dans le pire des cas, vous pouvez attendre beaucoup plus longtemps que ce délai avant que la promesse réussisse ou échoue.

Node.js récupération impose des délais indépendants pour la tête de réponse et l’inactivité du corps, généralement à cinq minutes par défaut, même lorsque ce délai est plus long. Pour les augmenter, installez undici et configurez un agent avec l’implémentation de récupération correspondante :

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

Par défaut, process.env['OPENAI_WEBHOOK_SECRET'].
workloadIdentity

Configuration de l’identité de charge de travail pour l’authentification d’échange de jetons OAuth2. Mutuellement exclusif avec apiKey.
x509Transport

Transport de certificat Node.js approuvé, congelé, uniquement nécessaire pour l’identité de la charge de travail X.509.

Détails de la propriété

azureConfig

Azure Agent endpoint configuration.

azureConfig?: AzureAgentConfig

Valeur de propriété

AzureAgentConfig

Détails de la propriété héritée

adminAPIKey

Par défaut, process.env['OPENAI_ADMIN_KEY'].

adminAPIKey?: string | null

Valeur de propriété

string | null

Hérité de OpenAIClientOptions.adminAPIKey

apiKey

La clé API est utilisée pour l’authentification.

  • Accepte soit une chaîne statique, soit une fonction asynchrone qui se résout en chaîne.
  • Par défaut, process.env['OPENAI_API_KEY'].
  • Lorsqu’une fonction est fournie, elle est invoquée lors de la création des en-têtes d’authentification porteuse pour chaque tentative, y compris les retentatives et les appels directs buildRequest() . Le résultat de chaque invocation est utilisé pour sa propre demande.
  • La fonction doit retourner une chaîne non vide ; sinon, un OpenAIError est lancé.
  • Si la fonction se lance, l’erreur est encapsulée dans un OpenAIError avec l’erreur originale disponible sous causela forme .
  • Mutuellement exclusif avec workloadIdentity.
apiKey?: string | ApiKeySetter | null

Valeur de propriété

string | ApiKeySetter | null

Hérité de OpenAIClientOptions.apiKey

baseURL

Écraser l’URL de base par défaut de l’API, par exemple, «https://api.example.com/v2/" ;

Par défaut, process.env['OPENAI_BASE_URL'].

baseURL?: string | null

Valeur de propriété

string | null

Hérité de OpenAIClientOptions.baseURL

credential

Certificat de première classe créé avec fromX509 .openai/auth/x509-transport

credential?: X509Credential

Valeur de propriété

X509Credential

Hérité de OpenAIClientOptions.credential

dangerouslyAllowBrowser

Par défaut, l’utilisation de cette bibliothèque côté client n’est pas autorisée, car cela risque d’exposer vos identifiants API secrets aux attaquants. Configurez cette option true uniquement si vous comprenez les risques et disposez de mesures d’atténuation appropriées.

dangerouslyAllowBrowser?: boolean

Valeur de propriété

boolean

Hérité de OpenAIClientOptions.dangerouslyAllowBrowser

dataResidency

Sélectionnez un point de terminaison régional OpenAI. Cela supprime une URL héritée ou de la base de l’environnement et est mutuellement exclusif avec une URL explicite baseURL ou provider. La disponibilité dépend de votre projet et de votre modèle ; aucun plan de secours n’est effectué. null et undefined laisser la résolution de l’URL de base ordinaire inchangée.

dataResidency?: DataResidency | null

Valeur de propriété

DataResidency | null

Hérité de OpenAIClientOptions.dataResidency

defaultHeaders

Des en-têtes par défaut à inclure avec chaque requête à l’API.

Celles-ci peuvent être supprimées dans les requêtes individuelles en définissant explicitement l’en-tête sur null dans les options de requête.

defaultHeaders?: HeadersLike

Valeur de propriété

HeadersLike

Hérité de OpenAIClientOptions.defaultHeaders

defaultQuery

Paramètres de requête par défaut à inclure avec chaque requête à l’API.

Celles-ci peuvent être supprimées dans les requêtes individuelles en définissant explicitement le param sur undefined dans les options de requête.

defaultQuery?: Record<string, string | undefined>

Valeur de propriété

Record<string, string | undefined>

Hérité de OpenAIClientOptions.defaultQuery

fetch

Spécifiez une implémentation de fonction personnalisée fetch .

Si cela n’est pas fourni, nous attendons que cela fetch soit défini globalement.

fetch?: Fetch

Valeur de propriété

Fetch

Hérité de OpenAIClientOptions.fetch

fetchOptions

Des options supplémentaires RequestInit à passer aux fetch appels. Les propriétés seront écrasées par demande fetchOptions.

fetchOptions?: MergedRequestInit

Valeur de propriété

MergedRequestInit

Hérité de OpenAIClientOptions.fetchOptions

logger

Installe le bûcheron.

Par défaut, globalThis.console.

logger?: Logger

Valeur de propriété

Logger

Hérité de OpenAIClientOptions.logger

logLevel

Réglez le niveau du log.

Par défaut, il utilise process.env['OPENAI_LOG'] ou 'warn' si ce n’est pas défini.

logLevel?: LogLevel

Valeur de propriété

LogLevel

Hérité de OpenAIClientOptions.logLevel

maxRetries

Le nombre maximal de fois où le client réessaiera une requête en cas de défaillance temporaire, comme une erreur réseau ou une erreur 5XX du serveur.

maxRetries?: number

Valeur de propriété

number

Hérité de OpenAIClientOptions.maxRetries

organization

Par défaut, process.env['OPENAI_ORG_ID'].

organization?: string | null

Valeur de propriété

string | null

Hérité de OpenAIClientOptions.organization

project

Par défaut, process.env['OPENAI_PROJECT_ID'].

project?: string | null

Valeur de propriété

string | null

Hérité de OpenAIClientOptions.project

provider

Configurez ce client pour qu’il utilise un fournisseur d’API tiers. Mutuellement exclusifs avec une authentification et baseURL des options de haut niveau.

provider?: Provider

Valeur de propriété

Provider

Hérité de OpenAIClientOptions.provider

timeout

Le temps maximal (en millisecondes) pendant lequel le client doit attendre une réponse du serveur avant de timer une seule requête.

Notez que les délais de demande sont réessayés par défaut, donc dans le pire des cas, vous pouvez attendre beaucoup plus longtemps que ce délai avant que la promesse réussisse ou échoue.

Node.js récupération impose des délais indépendants pour la tête de réponse et l’inactivité du corps, généralement à cinq minutes par défaut, même lorsque ce délai est plus long. Pour les augmenter, installez undici et configurez un agent avec l’implémentation de récupération correspondante :

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

Valeur de propriété

number

Hérité de OpenAIClientOptions.timeout

webhookSecret

Par défaut, process.env['OPENAI_WEBHOOK_SECRET'].

webhookSecret?: string | null

Valeur de propriété

string | null

Hérité de OpenAIClientOptions.webhookSecret

workloadIdentity

Configuration de l’identité de charge de travail pour l’authentification d’échange de jetons OAuth2. Mutuellement exclusif avec apiKey.

workloadIdentity?: WorkloadIdentity | X509WorkloadIdentity

Valeur de propriété

WorkloadIdentity | X509WorkloadIdentity

Hérité de OpenAIClientOptions.workloadIdentity

x509Transport

Transport de certificat Node.js approuvé, congelé, uniquement nécessaire pour l’identité de la charge de travail X.509.

x509Transport?: X509Transport

Valeur de propriété

X509Transport

Hérité de OpenAIClientOptions.x509Transport