OpenAIClientOptionsWithAzureAgent interface

Azure Agent endpoint configuration.

azureConfig?: AzureAgentConfig

Valor de propiedad

Por defecto es proces.env['OPENAI_ADMIN_KEY'].

adminAPIKey?: string | null

Valor de propiedad

Heredado de OpenAIClientOptions.adminAPIKey

Clave API usada para autenticación.

• Acepta una cadena estática o una función asíncrona que se resuelve a una cadena.
• Por defecto es proces.env['OPENAI_API_KEY'].
• Cuando se proporciona una función, se invoca al construir cabeceras de autenticación de portadores para cada intento, incluyendo reintentos y llamadas directas buildRequest() . El resultado de cada invocación se utiliza para su propia petición.
• La función debe devolver una cadena no vacía; de lo contrario, se lanza un OpenAIErrr.
• Si la función se lanza, el error se envuelve en un OpenAIError con el error original disponible como cause.
• Mutuamente excluyente con workloadIdentity.

apiKey?: string | ApiKeySetter | null

Valor de propiedad

Heredado de OpenAIClientOptions.apiKey

Anular la URL base predeterminada de la API, por ejemplo, "https://api.example.com/v2/"

Por defecto es proces.env['OPENAI_BASE_URL'].

baseURL?: string | null

Valor de propiedad

Heredado de OpenAIClientOptions.baseURL

Credencial de certificado de primera clase creada con fromX509 .openai/auth/x509-transport

credential?: X509Credential

Valor de propiedad

Heredado de OpenAIClientOptions.credential

Por defecto, no se permite el uso de esta biblioteca en el lado del cliente, ya que corre el riesgo de exponer tus credenciales secretas de la API a los atacantes. Solo configura esta opción true si entiendes los riesgos y tienes las medidas adecuadas de mitigación.

dangerouslyAllowBrowser?: boolean

Valor de propiedad

Heredado de OpenAIClientOptions.dangerouslyAllowBrowser

Selecciona un endpoint regional de OpenAI. Esto anula una URL heredada o de la base del entorno y es mutuamente excluyente con una URL explícita baseURL o provider. La disponibilidad depende de tu proyecto y modelo; no se realiza ningún respaldo. null y undefined dejar sin cambios la resolución de URL base ordinaria.

dataResidency?: DataResidency | null

Valor de propiedad

Heredado de OpenAIClientOptions.dataResidency

Cabeceras predeterminadas para incluir en cada petición a la API.

Estos pueden eliminarse en solicitudes individuales estableciendo explícitamente la cabecera en null opciones de solicitud.

defaultHeaders?: HeadersLike

Valor de propiedad

Heredado de OpenAIClientOptions.defaultHeaders

Parámetros de consulta predeterminados para incluir en cada solicitud a la API.

Estos pueden eliminarse en solicitudes individuales estableciendo explícitamente el parámetro en undefined las opciones de solicitud.

defaultQuery?: Record<string, string | undefined>

Valor de propiedad

Heredado de OpenAIClientOptions.defaultQuery

Especifica una implementación de función personalizada fetch .

Si no se proporciona, esperamos que se fetch defina globalmente.

fetch?: Fetch

Valor de propiedad

Heredado de OpenAIClientOptions.fetch

Opciones adicionales RequestInit que se pasarán a fetch las llamadas. Las propiedades serán anuladas por solicitud fetchOptions.

fetchOptions?: MergedRequestInit

Valor de propiedad

Heredado de OpenAIClientOptions.fetchOptions

Pon el leñador.

Por defecto es globalThis.console.

logger?: Logger

Valor de propiedad

Heredado de OpenAIClientOptions.logger

Establece el nivel del log.

Por defecto se pone en process.env['OPENAI_LOG'] o 'warn' si no está activado.

logLevel?: LogLevel

Valor de propiedad

Heredado de OpenAIClientOptions.logLevel

El número máximo de veces que el cliente intentará una solicitud en caso de fallo temporal, como un error de red o un error 5XX del servidor.

maxRetries?: number

Valor de propiedad

Heredado de OpenAIClientOptions.maxRetries

Por defecto es proces.env['OPENAI_ORG_ID'].

organization?: string | null

Valor de propiedad

Heredado de OpenAIClientOptions.organization

Por defecto es proces.env['OPENAI_PROJECT_ID'].

project?: string | null

Valor de propiedad

Heredado de OpenAIClientOptions.project

Configura este cliente para que utilice un proveedor de API de terceros. Mutuamente excluyentes con autenticación y baseURL opciones de alto nivel.

provider?: Provider

Valor de propiedad

Heredado de OpenAIClientOptions.provider

El tiempo máximo (en milisegundos) que el cliente debe esperar a una respuesta del servidor antes de expirar una sola petición.

Ten en cuenta que los tiempos de espera de las solicitudes se vuelven a intentar por defecto, así que en el peor de los casos puedes esperar mucho más tiempo antes de que la promesa tenga éxito o falle.

Node.js fetch aplica tiempos de espera independientes de respuesta y inactividad en el cuerpo, normalmente siendo de cinco minutos, incluso cuando este tiempo de espera es más largo. Para aumentarlos, instala undici y configura un Agente con la implementación de fetch correspondiente:

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

Valor de propiedad

Heredado de OpenAIClientOptions.timeout

Por defecto es proces.env['OPENAI_WEBHOOK_SECRET'].

webhookSecret?: string | null

Valor de propiedad

Heredado de OpenAIClientOptions.webhookSecret

Configuración de identidad de carga de trabajo para autenticación de intercambio de tokens OAuth2. Mutuamente excluyente con apiKey.

workloadIdentity?: WorkloadIdentity | X509WorkloadIdentity

Valor de propiedad

Heredado de OpenAIClientOptions.workloadIdentity

Aprobado, Node.js congelado transporte de certificado solo necesario para la identidad de carga de trabajo X.509.

x509Transport?: X509Transport

Valor de propiedad

Heredado de OpenAIClientOptions.x509Transport