OpenAIClientOptionsWithAzureAgent interface

Pacote:
@azure/ai-projects

Opções de cliente OpenAI estendidas para incluir a configuração do endpoint do Azure Agent.

Extends

ClientOptions

Propriedades

azureConfig

Azure Agent endpoint configuration.

Propriedades Herdadas

adminAPIKey

Por defeito, process.env['OPENAI_ADMIN_KEY'].
apiKey

Chave API usada para autenticação.

  • Aceita uma cadeia estática ou uma função assíncrona que resolve para uma cadeia.
  • Por defeito, process.env['OPENAI_API_KEY'].
  • Quando uma função é fornecida, ela é invocada antes de cada pedido para que possa rodar ou atualizar as credenciais em tempo de execução.
  • A função deve devolver uma cadeia não vazia; caso contrário, um OpenAIError é lançado.
  • Se a função lançar, o erro é encapsulado num 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/"

Por defeito, process.env['OPENAI_BASE_URL'].
dangerouslyAllowBrowser

Por defeito, o uso desta biblioteca do lado do cliente não é permitido, pois corre o risco de expor as suas credenciais secretas da API a atacantes. Define esta opção apenas true se compreenderes os riscos e tiveres medidas de mitigação adequadas.
defaultHeaders

Cabeçalhos predefinidos para incluir em cada pedido à API.

Estes podem ser removidos em pedidos individuais ao definir explicitamente o cabeçalho para null opções de pedido.
defaultQuery

Parâmetros padrão de consulta a incluir em cada pedido à API.

Estes podem ser removidos em pedidos individuais ao definir explicitamente o parâmetro para undefined opções de pedido.
fetch

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

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

Opções adicionais RequestInit para serem passadas às fetch chamadas. As propriedades serão anuladas por pedido fetchOptions.
logger

Coloca o logger.

Por defeito é globalThis.console.
logLevel

Define o nível do log.

Por defeito, process.env['OPENAI_LOG'] ou 'warn' se não estiver definido.
maxRetries

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

Por defeito, process.env['OPENAI_ORG_ID'].
project

Por defeito, process.env['OPENAI_PROJECT_ID'].
provider

Configure este cliente para usar um fornecedor de API de terceiros. Mutuamente exclusivo com autenticação e baseURL opções de topo.
timeout

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

Note que os timeouts dos pedidos são tentados novamente por defeito, por isso, no pior dos casos, pode esperar muito mais tempo do que esse timeout até que a promessa seja bem-sucedida ou falhada.
webhookSecret

Por defeito, process.env['OPENAI_WEBHOOK_SECRET'].
workloadIdentity

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

Detalhes de Propriedade

azureConfig

Azure Agent endpoint configuration.

azureConfig?: AzureAgentConfig

Valor de Propriedade

AzureAgentConfig

Detalhes da Propriedade Herdada

adminAPIKey

Por defeito, process.env['OPENAI_ADMIN_KEY'].

adminAPIKey?: null | string

Valor de Propriedade

null | string

Herdado de OpenAIClientOptions.adminAPIKey

apiKey

Chave API usada para autenticação.

  • Aceita uma cadeia estática ou uma função assíncrona que resolve para uma cadeia.
  • Por defeito, process.env['OPENAI_API_KEY'].
  • Quando uma função é fornecida, ela é invocada antes de cada pedido para que possa rodar ou atualizar as credenciais em tempo de execução.
  • A função deve devolver uma cadeia não vazia; caso contrário, um OpenAIError é lançado.
  • Se a função lançar, o erro é encapsulado num OpenAIError com o erro original disponível como cause.
  • Mutuamente exclusivo com workloadIdentity.
apiKey?: null | string | ApiKeySetter

Valor de Propriedade

null | string | ApiKeySetter

Herdado de OpenAIClientOptions.apiKey

baseURL

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

Por defeito, process.env['OPENAI_BASE_URL'].

baseURL?: null | string

Valor de Propriedade

null | string

Herdado de OpenAIClientOptions.baseURL

dangerouslyAllowBrowser

Por defeito, o uso desta biblioteca do lado do cliente não é permitido, pois corre o risco de expor as suas credenciais secretas da API a atacantes. Define esta opção apenas true se compreenderes os riscos e tiveres medidas de mitigação adequadas.

dangerouslyAllowBrowser?: boolean

Valor de Propriedade

boolean

Herdado de OpenAIClientOptions.dangerouslyAllowBrowser

defaultHeaders

Cabeçalhos predefinidos para incluir em cada pedido à API.

Estes podem ser removidos em pedidos individuais ao definir explicitamente o cabeçalho para null opções de pedido.

defaultHeaders?: HeadersLike

Valor de Propriedade

HeadersLike

Herdado de OpenAIClientOptions.defaultHeaders

defaultQuery

Parâmetros padrão de consulta a incluir em cada pedido à API.

Estes podem ser removidos em pedidos individuais ao definir explicitamente o parâmetro para undefined opções de pedido.

defaultQuery?: Record<string, undefined | string>

Valor de Propriedade

Record<string, undefined | string>

Herdado de OpenAIClientOptions.defaultQuery

fetch

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

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

fetch?: Fetch

Valor de Propriedade

Fetch

Herdado de OpenAIClientOptions.fetch

fetchOptions

Opções adicionais RequestInit para serem passadas às fetch chamadas. As propriedades serão anuladas por pedido fetchOptions.

fetchOptions?: MergedRequestInit

Valor de Propriedade

MergedRequestInit

Herdado de OpenAIClientOptions.fetchOptions

logger

Coloca o logger.

Por defeito é globalThis.console.

logger?: Logger

Valor de Propriedade

Logger

Herdado de OpenAIClientOptions.logger

logLevel

Define o nível do log.

Por defeito, process.env['OPENAI_LOG'] ou 'warn' se não estiver definido.

logLevel?: LogLevel

Valor de Propriedade

LogLevel

Herdado de OpenAIClientOptions.logLevel

maxRetries

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

maxRetries?: number

Valor de Propriedade

number

Herdado de OpenAIClientOptions.maxRetries

organization

Por defeito, process.env['OPENAI_ORG_ID'].

organization?: null | string

Valor de Propriedade

null | string

Herdado de OpenAIClientOptions.organization

project

Por defeito, process.env['OPENAI_PROJECT_ID'].

project?: null | string

Valor de Propriedade

null | string

Herdado de OpenAIClientOptions.project

provider

Configure este cliente para usar um fornecedor de API de terceiros. Mutuamente exclusivo com autenticação e baseURL opções de topo.

provider?: Provider

Valor de 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 esgotar um único pedido.

Note que os timeouts dos pedidos são tentados novamente por defeito, por isso, no pior dos casos, pode esperar muito mais tempo do que esse timeout até que a promessa seja bem-sucedida ou falhada.

timeout?: number

Valor de Propriedade

number

Herdado de OpenAIClientOptions.timeout

webhookSecret

Por defeito, process.env['OPENAI_WEBHOOK_SECRET'].

webhookSecret?: null | string

Valor de Propriedade

null | string

Herdado de OpenAIClientOptions.webhookSecret

workloadIdentity

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

workloadIdentity?: WorkloadIdentity

Valor de Propriedade

WorkloadIdentity

Herdado de OpenAIClientOptions.workloadIdentity