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 antes de cada solicitação para que você possa girar ou atualizar credenciais em tempo de execução. 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'].
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.
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'].
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.
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.

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?: null | string

Valor da propriedade

null | string

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 antes de cada solicitação para que você possa girar ou atualizar credenciais em tempo de execução.
• 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?: null | string | ApiKeySetter

Valor da propriedade

null | string | ApiKeySetter

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?: null | string

Valor da propriedade

null | string

Herdado de OpenAIClientOptions.baseURL

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

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, undefined | string>

Valor da propriedade

Record<string, undefined | string>

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?: null | string

Valor da propriedade

null | string

Herdado de OpenAIClientOptions.organization

project

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

project?: null | string

Valor da propriedade

null | string

Herdado de OpenAIClientOptions.project

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.

timeout?: number

Valor da propriedade

number

Herdado de OpenAIClientOptions.timeout

webhookSecret

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

webhookSecret?: null | string

Valor da propriedade

null | string

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

Valor da propriedade

WorkloadIdentity

Herdado de OpenAIClientOptions.workloadIdentity