OpenAIClientOptionsWithAzureAgent interface

Pacote:
@azure/ai-projects

Ampliaram as opções do cliente OpenAI para incluir a configuração do endpoint do Azure Agent.

Extends

ClientOptions

Propriedades

azureConfig

Azure Agent endpoint configuration.

Propriedades herdadas

adminAPIKey

O padrão é process.env['OPENAI_ADMIN_KEY'].
apiKey

Chave API usada para autenticação.

  • Aceita uma string estática ou uma função assíncrona que resolve para uma string.
  • Padrão é process.env['OPENAI_API_KEY'].
  • Quando uma função é fornecida, ela é invocada ao construir cabeçalhos de autenticação de portadores para cada tentativa, incluindo retentativas e chamadas diretas buildRequest() . O resultado de cada invocação é usado para seu próprio pedido.
  • A função deve retornar uma cadeia não vazia; caso contrário, um OpenAIError é lançado.
  • Se a função for lançada, o erro é enrolado em um OpenAIError com o erro original disponível como cause.
  • Mutuamente exclusivo com workloadIdentity.
baseURL

Sobrescreva a URL base padrão da API, por exemplo, "https://api.example.com/v2/"

O padrão é process.env['OPENAI_BASE_URL'].
credential

Credencial de certificado de primeira classe criada com fromX509 .openai/auth/x509-transport
dangerouslyAllowBrowser

Por padrão, o uso dessa biblioteca no lado do cliente não é permitido, pois corre o risco de expor suas credenciais secretas da API para atacantes. Configure essa opção true apenas se você entender os riscos e tiver medidas adequadas para mitigação.
dataResidency

Selecione um endpoint regional da OpenAI. Isso sobrepõe uma URL herdada ou base de ambiente e é mutuamente exclusivo com um URL explícito baseURL ou provider. A disponibilidade depende do seu projeto e modelo; não há recurso de recurso. null e undefined deixar a resolução normal da URL base inalterada.
defaultHeaders

Cabeçalhos padrão para incluir em cada requisição para a API.

Esses podem ser removidos em requisições individuais ao definir explicitamente o cabeçalho como null opções de requisição.
defaultQuery

Parâmetros padrão de consulta para incluir em cada requisição para a API.

Esses podem ser removidos em requisições individuais ao definir explicitamente o parâmetro como undefined opções de requisição.
fetch

Especifique uma implementação de função personalizada fetch .

Se não for fornecido, esperamos que isso fetch seja definido globalmente.
fetchOptions

Opções adicionais RequestInit a serem passadas para fetch as chamadas. Propriedades serão anuladas por requisição fetchOptions.
logger

Coloque o logger.

O padrão é globalThis.console.
logLevel

Defina o nível do log.

O padrão é process.env['OPENAI_LOG'] ou 'warn' se não estiver ativado.
maxRetries

O número máximo de vezes que o cliente tentará novamente uma solicitação em caso de falha temporária, como erro de rede ou erro 5XX do servidor.
organization

O padrão é process.env['OPENAI_ORG_ID'].
project

Padrão é process.env['OPENAI_PROJECT_ID'].
provider

Configure esse cliente para usar um provedor de API de terceiros. Mutuamente exclusivo com autenticação e baseURL opções de alto nível.
timeout

O tempo máximo (em milissegundos) que o cliente deve esperar por uma resposta do servidor antes de descontar um único pedido.

Note que os timeouts dos pedidos são tentados novamente por padrão, então, no pior dos casos, você pode esperar muito mais tempo antes que a promessa seja bem-sucedida ou fracasse.

Node.js fetch impõe timeouts independentes de cabeçalho de resposta e inatividade no corpo, normalmente sendo de cinco minutos, mesmo quando esse tempo é maior. Para aumentá-las, instale undici e configure um Agente com a implementação de fetch correspondente:

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

O padrão é process.env['OPENAI_WEBHOOK_SECRET'].
workloadIdentity

Configuração da identidade da carga de trabalho para autenticação de troca de tokens OAuth2. Mutuamente exclusivo com apiKey.
x509Transport

Aprovado, Node.js congelado transporte de certificado necessário apenas para a identidade da carga de trabalho X.509.

Detalhes da propriedade

azureConfig

Azure Agent endpoint configuration.

azureConfig?: AzureAgentConfig

Valor da propriedade

AzureAgentConfig

Detalhes das propriedades herdadas

adminAPIKey

O padrão é process.env['OPENAI_ADMIN_KEY'].

adminAPIKey?: string | null

Valor da propriedade

string | null

Herdado de OpenAIClientOptions.adminAPIKey

apiKey

Chave API usada para autenticação.

  • Aceita uma string estática ou uma função assíncrona que resolve para uma string.
  • Padrão é process.env['OPENAI_API_KEY'].
  • Quando uma função é fornecida, ela é invocada ao construir cabeçalhos de autenticação de portadores para cada tentativa, incluindo retentativas e chamadas diretas buildRequest() . O resultado de cada invocação é usado para seu próprio pedido.
  • A função deve retornar uma cadeia não vazia; caso contrário, um OpenAIError é lançado.
  • Se a função for lançada, o erro é enrolado em um OpenAIError com o erro original disponível como cause.
  • Mutuamente exclusivo com workloadIdentity.
apiKey?: string | ApiKeySetter | null

Valor da propriedade

string | ApiKeySetter | null

Herdado de OpenAIClientOptions.apiKey

baseURL

Sobrescreva a URL base padrão da API, por exemplo, "https://api.example.com/v2/"

O padrão é process.env['OPENAI_BASE_URL'].

baseURL?: string | null

Valor da propriedade

string | null

Herdado de OpenAIClientOptions.baseURL

credential

Credencial de certificado de primeira classe criada com fromX509 .openai/auth/x509-transport

credential?: X509Credential

Valor da propriedade

X509Credential

Herdado de OpenAIClientOptions.credential

dangerouslyAllowBrowser

Por padrão, o uso dessa biblioteca no lado do cliente não é permitido, pois corre o risco de expor suas credenciais secretas da API para atacantes. Configure essa opção true apenas se você entender os riscos e tiver medidas adequadas para mitigação.

dangerouslyAllowBrowser?: boolean

Valor da propriedade

boolean

Herdado de OpenAIClientOptions.dangerouslyAllowBrowser

dataResidency

Selecione um endpoint regional da OpenAI. Isso sobrepõe uma URL herdada ou base de ambiente e é mutuamente exclusivo com um URL explícito baseURL ou provider. A disponibilidade depende do seu projeto e modelo; não há recurso de recurso. null e undefined deixar a resolução normal da URL base inalterada.

dataResidency?: DataResidency | null

Valor da propriedade

DataResidency | null

Herdado de OpenAIClientOptions.dataResidency

defaultHeaders

Cabeçalhos padrão para incluir em cada requisição para a API.

Esses podem ser removidos em requisições individuais ao definir explicitamente o cabeçalho como null opções de requisição.

defaultHeaders?: HeadersLike

Valor da propriedade

HeadersLike

Herdado de OpenAIClientOptions.defaultHeaders

defaultQuery

Parâmetros padrão de consulta para incluir em cada requisição para a API.

Esses podem ser removidos em requisições individuais ao definir explicitamente o parâmetro como undefined opções de requisição.

defaultQuery?: Record<string, string | undefined>

Valor da propriedade

Record<string, string | undefined>

Herdado de OpenAIClientOptions.defaultQuery

fetch

Especifique uma implementação de função personalizada fetch .

Se não for fornecido, esperamos que isso fetch seja definido globalmente.

fetch?: Fetch

Valor da propriedade

Fetch

Herdado de OpenAIClientOptions.fetch

fetchOptions

Opções adicionais RequestInit a serem passadas para fetch as chamadas. Propriedades serão anuladas por requisição fetchOptions.

fetchOptions?: MergedRequestInit

Valor da propriedade

MergedRequestInit

Herdado de OpenAIClientOptions.fetchOptions

logger

Coloque o logger.

O padrão é globalThis.console.

logger?: Logger

Valor da propriedade

Logger

Herdado de OpenAIClientOptions.logger

logLevel

Defina o nível do log.

O padrão é process.env['OPENAI_LOG'] ou 'warn' se não estiver ativado.

logLevel?: LogLevel

Valor da propriedade

LogLevel

Herdado de OpenAIClientOptions.logLevel

maxRetries

O número máximo de vezes que o cliente tentará novamente uma solicitação em caso de falha temporária, como erro de rede ou erro 5XX do servidor.

maxRetries?: number

Valor da propriedade

number

Herdado de OpenAIClientOptions.maxRetries

organization

O padrão é process.env['OPENAI_ORG_ID'].

organization?: string | null

Valor da propriedade

string | null

Herdado de OpenAIClientOptions.organization

project

Padrão é process.env['OPENAI_PROJECT_ID'].

project?: string | null

Valor da propriedade

string | null

Herdado de OpenAIClientOptions.project

provider

Configure esse cliente para usar um provedor de API de terceiros. Mutuamente exclusivo com autenticação e baseURL opções de alto nível.

provider?: Provider

Valor da propriedade

Provider

Herdado de OpenAIClientOptions.provider

timeout

O tempo máximo (em milissegundos) que o cliente deve esperar por uma resposta do servidor antes de descontar um único pedido.

Note que os timeouts dos pedidos são tentados novamente por padrão, então, no pior dos casos, você pode esperar muito mais tempo antes que a promessa seja bem-sucedida ou fracasse.

Node.js fetch impõe timeouts independentes de cabeçalho de resposta e inatividade no corpo, normalmente sendo de cinco minutos, mesmo quando esse tempo é maior. Para aumentá-las, instale undici e configure um Agente com a implementação de fetch correspondente:

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 da propriedade

number

Herdado de OpenAIClientOptions.timeout

webhookSecret

O padrão é process.env['OPENAI_WEBHOOK_SECRET'].

webhookSecret?: string | null

Valor da propriedade

string | null

Herdado de OpenAIClientOptions.webhookSecret

workloadIdentity

Configuração da identidade da carga de trabalho para autenticação de troca de tokens OAuth2. Mutuamente exclusivo com apiKey.

workloadIdentity?: WorkloadIdentity | X509WorkloadIdentity

Valor da propriedade

WorkloadIdentity | X509WorkloadIdentity

Herdado de OpenAIClientOptions.workloadIdentity

x509Transport

Aprovado, Node.js congelado transporte de certificado necessário apenas para a identidade da carga de trabalho X.509.

x509Transport?: X509Transport

Valor da propriedade

X509Transport

Herdado de OpenAIClientOptions.x509Transport