OpenAIClientOptionsWithAzureAgent interface

Balíček:

@azure/ai-projects

Rozšířené možnosti klienta OpenAI o konfiguraci endpointu Azure Agent.

Extends

ClientOptions

Vlastnosti

azureConfig

Azure Agent endpoint configuration.

Zděděné vlastnosti

adminAPIKey	Výchozí nastavení je process.env['OPENAI_ADMIN_KEY'].
apiKey	API klíč používaný pro autentizaci. Přijímá buď statický řetězec, nebo asynchronní funkci, která se rozliší do řetězce. Výchozí nastavení je process.env['OPENAI_API_KEY']. Když je funkce poskytnuta, je vyvolána před každým požadavkem, takže můžete přihlašovací údaje za běhu otáčet nebo obnovovat. Funkce musí vrátit neprázdný řetězec; jinak je vyhozen OpenAIError. Pokud funkce hodí, chyba je zabalena do OpenAIError s původní chybou dostupnou jako cause. Vzájemně se vylučuje s workloadIdentity.
baseURL	Přepisujte výchozí základní URL API, např. "https://api.example.com/v2/" Výchozí nastavení je process.env['OPENAI_BASE_URL'].
dangerouslyAllowBrowser	Ve výchozím nastavení není klientské použití této knihovny povoleno, protože hrozí, že vaše tajné API přihlašovací údaje budou vystaveny útočníkům. Tuto možnost true nastavte pouze tehdy, pokud rozumíte rizikům a máte připravená vhodná opatření.
defaultHeaders	Výchozí hlavičky se přidávají ke každému požadavku na API. Tyto lze odstranit v jednotlivých požadavcích explicitním nastavením hlavičky na null v možnostech požadavku.
defaultQuery	Výchozí parametry dotazu, které se přidávají ke každému požadavku na API. Tyto lze odstranit v jednotlivých požadavcích explicitním nastavením parametru na v undefined možnostech požadavků.
fetch	Specifikujte fetch vlastní implementaci funkce. Pokud není poskytnuto, očekáváme, že je definováno fetch globálně.
fetchOptions	Další RequestInit možnosti lze předat fetch hovorům. Vlastnosti budou přepsány na základě žádosti fetchOptions.
logger	Nastav dřevorubec. Výchozí nastavení je globalThis.console.
logLevel	Nastavte úroveň klády. Výchozí nastavení je process.env['OPENAI_LOG'] nebo 'warn', pokud není nastaveno.
maxRetries	Maximální počet opakování požadavku klient v případě dočasného selhání, například síťové chyby nebo chyby 5XX ze serveru.
organization	Výchozí nastavení je process.env['OPENAI_ORG_ID'].
project	Výchozí nastavení je process.env['OPENAI_PROJECT_ID'].
provider	Nakonfigurujte tohoto klienta tak, aby používal poskytovatele API od třetí strany. Vzájemně se vylučují s nejvyšší úrovní autentizace a baseURL možnostmi.
timeout	Maximální doba (v milisekundách), kterou by klient měl čekat na odpověď od serveru, než vyčasuje jeden požadavek. Všimněte si, že časové limity požadavků se automaticky opakují, takže v nejhorším případě můžete čekat mnohem déle, než slib uspěje nebo selže.
webhookSecret	Výchozí nastavení je process.env['OPENAI_WEBHOOK_SECRET'].
workloadIdentity	Konfigurace identity zátěže pro autentizaci výměny tokenů OAuth2. Vzájemně se vylučuje s apiKey.

Podrobnosti vlastnosti

azureConfig

Azure Agent endpoint configuration.

azureConfig?: AzureAgentConfig

Hodnota vlastnosti

AzureAgentConfig

Podrobnosti zděděných vlastností

adminAPIKey

Výchozí nastavení je process.env['OPENAI_ADMIN_KEY'].

adminAPIKey?: string | null

Hodnota vlastnosti

string | null

Děděno od OpenAIClientOptions.adminAPIKey

apiKey

API klíč používaný pro autentizaci.

• Přijímá buď statický řetězec, nebo asynchronní funkci, která se rozliší do řetězce.
• Výchozí nastavení je process.env['OPENAI_API_KEY'].
• Když je funkce poskytnuta, je vyvolána před každým požadavkem, takže můžete přihlašovací údaje za běhu otáčet nebo obnovovat.
• Funkce musí vrátit neprázdný řetězec; jinak je vyhozen OpenAIError.
• Pokud funkce hodí, chyba je zabalena do OpenAIError s původní chybou dostupnou jako cause.
• Vzájemně se vylučuje s workloadIdentity.

apiKey?: string | ApiKeySetter | null

Hodnota vlastnosti

string | ApiKeySetter | null

Děděno od OpenAIClientOptions.apiKey

baseURL

Přepisujte výchozí základní URL API, např. "https://api.example.com/v2/"

Výchozí nastavení je process.env['OPENAI_BASE_URL'].

baseURL?: string | null

Hodnota vlastnosti

string | null

Děděno od OpenAIClientOptions.baseURL

dangerouslyAllowBrowser

Ve výchozím nastavení není klientské použití této knihovny povoleno, protože hrozí, že vaše tajné API přihlašovací údaje budou vystaveny útočníkům. Tuto možnost true nastavte pouze tehdy, pokud rozumíte rizikům a máte připravená vhodná opatření.

dangerouslyAllowBrowser?: boolean

Hodnota vlastnosti

boolean

Děděno od OpenAIClientOptions.dangerouslyAllowBrowser

defaultHeaders

Výchozí hlavičky se přidávají ke každému požadavku na API.

Tyto lze odstranit v jednotlivých požadavcích explicitním nastavením hlavičky na null v možnostech požadavku.

defaultHeaders?: HeadersLike

Hodnota vlastnosti

HeadersLike

Děděno od OpenAIClientOptions.defaultHeaders

defaultQuery

Výchozí parametry dotazu, které se přidávají ke každému požadavku na API.

Tyto lze odstranit v jednotlivých požadavcích explicitním nastavením parametru na v undefined možnostech požadavků.

defaultQuery?: Record<string, string | undefined>

Hodnota vlastnosti

Record<string, string | undefined>

Děděno od OpenAIClientOptions.defaultQuery

fetch

Specifikujte fetch vlastní implementaci funkce.

Pokud není poskytnuto, očekáváme, že je definováno fetch globálně.

fetch?: Fetch

Hodnota vlastnosti

Fetch

Děděno od OpenAIClientOptions.fetch

fetchOptions

Další RequestInit možnosti lze předat fetch hovorům. Vlastnosti budou přepsány na základě žádosti fetchOptions.

fetchOptions?: MergedRequestInit

Hodnota vlastnosti

MergedRequestInit

Děděno od OpenAIClientOptions.fetchOptions

logger

Nastav dřevorubec.

Výchozí nastavení je globalThis.console.

logger?: Logger

Hodnota vlastnosti

Logger

Děděno od OpenAIClientOptions.logger

logLevel

Nastavte úroveň klády.

Výchozí nastavení je process.env['OPENAI_LOG'] nebo 'warn', pokud není nastaveno.

logLevel?: LogLevel

Hodnota vlastnosti

LogLevel

Děděno od OpenAIClientOptions.logLevel

maxRetries

Maximální počet opakování požadavku klient v případě dočasného selhání, například síťové chyby nebo chyby 5XX ze serveru.

maxRetries?: number

Hodnota vlastnosti

number

Děděno od OpenAIClientOptions.maxRetries

organization

Výchozí nastavení je process.env['OPENAI_ORG_ID'].

organization?: string | null

Hodnota vlastnosti

string | null

Děděno od OpenAIClientOptions.organization

project

Výchozí nastavení je process.env['OPENAI_PROJECT_ID'].

project?: string | null

Hodnota vlastnosti

string | null

Děděno od OpenAIClientOptions.project

provider

Nakonfigurujte tohoto klienta tak, aby používal poskytovatele API od třetí strany. Vzájemně se vylučují s nejvyšší úrovní autentizace a baseURL možnostmi.

provider?: Provider

Hodnota vlastnosti

Provider

Děděno od OpenAIClientOptions.provider

timeout

Maximální doba (v milisekundách), kterou by klient měl čekat na odpověď od serveru, než vyčasuje jeden požadavek.

Všimněte si, že časové limity požadavků se automaticky opakují, takže v nejhorším případě můžete čekat mnohem déle, než slib uspěje nebo selže.

timeout?: number

Hodnota vlastnosti

number

Děděno od OpenAIClientOptions.timeout

webhookSecret

Výchozí nastavení je process.env['OPENAI_WEBHOOK_SECRET'].

webhookSecret?: string | null

Hodnota vlastnosti

string | null

Děděno od OpenAIClientOptions.webhookSecret

workloadIdentity

Konfigurace identity zátěže pro autentizaci výměny tokenů OAuth2. Vzájemně se vylučuje s apiKey.

workloadIdentity?: WorkloadIdentity

Hodnota vlastnosti

WorkloadIdentity

Děděno od OpenAIClientOptions.workloadIdentity