OpenAIClientOptionsWithAzureAgent interface

Pakket:

@azure/ai-projects

Uitgebreide OpenAI-clientopties om de configuratie van Azure Agent-endpoints op te nemen.

Uitbreiding

ClientOptions

Eigenschappen

azureConfig

Azure Agent endpoint configuration.

Overgenomen eigenschappen

adminAPIKey	Standaard is process.env['OPENAI_ADMIN_KEY'].
apiKey	API-sleutel gebruikt voor authenticatie. Accepteert ofwel een statische string of een asynchrone functie die wordt opgelost in een string. Standaard is process.env['OPENAI_API_KEY']. Wanneer een functie wordt geleverd, wordt deze aangeroepen bij het bouwen van bearer-authenticatieheaders voor elke poging, inclusief herpogingen en directe buildRequest() aanroepen. Het resultaat van elke aanroeping wordt gebruikt voor een eigen verzoek. De functie moet een niet-lege string teruggeven; anders wordt er een OpenAIError gegooid. Als de functie wordt gegooid, wordt de fout in een OpenAIError gewrapped met de oorspronkelijke fout beschikbaar als cause. Wederzijds uitsluiten met workloadIdentity.
baseURL	Overschrijf de standaard basis-URL voor de API, bijvoorbeeld "https://api.example.com/v2/" Standaard staat process.env['OPENAI_BASE_URL'].
credential	Eersteklas certificaat aangemaakt met fromX509 .openai/auth/x509-transport
dangerouslyAllowBrowser	Standaard is client-side gebruik van deze bibliotheek niet toegestaan, omdat dit het risico loopt je geheime API-inloggegevens bloot te stellen aan aanvallers. Stel deze optie alleen in als true je de risico's begrijpt en passende mitigatiemaatregelen hebt getroffen.
dataResidency	Selecteer een regionaal OpenAI-eindpunt. Dit overschrijft een geërfde of omgevingsgebaseerde URL en is wederzijds exclusief met een expliciete baseURL of provider. De beschikbaarheid hangt af van je project en model; er wordt geen fallback uitgevoerd. null en undefined laat de normale basisresolutie van URL's ongewijzigd.
defaultHeaders	Standaardheaders om bij elk verzoek naar de API toe te voegen. Deze kunnen in individuele verzoeken worden verwijderd door de header expliciet in te stellen op null opties in verzoeken.
defaultQuery	Standaard queryparameters om bij elk verzoek naar de API op te nemen. Deze kunnen worden verwijderd in individuele verzoeken door expliciet de param in te stellen op undefined de verzoekopties.
fetch	Specificeer een aangepaste fetch functie-implementatie. Als dat niet wordt opgegeven, verwachten we dat dat fetch globaal wordt gedefinieerd.
fetchOptions	Extra RequestInit opties die aan oproepen worden doorgegeven fetch . Eigendommen worden per verzoek fetchOptionsoverschreven.
logger	Zet de houthakker in. Standaard staat globalThis.console.
logLevel	Stel het logniveau in. Standaard staat process.env['OPENAI_LOG'] of 'warn' als het niet is ingesteld.
maxRetries	Het maximale aantal keren dat de client een verzoek opnieuw probeert in geval van een tijdelijke storing, zoals een netwerkfout of een 5XX-fout van de server.
organization	Standaard staat process.env['OPENAI_ORG_ID'].
project	Standaard staat process.env['OPENAI_PROJECT_ID'].
provider	Configureer deze client om een externe API-provider te gebruiken. Wederzijds exclusief met authenticatie en baseURL opties op het hoogste niveau.
timeout	De maximale tijd (in milliseconden) die de client moet wachten op een antwoord van de server voordat een enkel verzoek wordt getimed. Let op dat time-outs bij verzoeken standaard opnieuw worden geprobeerd, dus in het ergste geval wacht je veel langer dan deze timeout voordat de belofte slaagt of faalt. Node.js fetch dwingt onafhankelijke time-outs voor respons-header en lichaamsinactiviteit af, meestal vijf minuten, zelfs als deze timeout langer is. Om deze te vergroten, installeer undici en configureer je een Agent met de bijbehorende fetch-implementatie: 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	Standaard is process.env['OPENAI_WEBHOOK_SECRET'].
workloadIdentity	Workload-identiteitsconfiguratie voor OAuth2 tokenuitwisselingsauthenticatie. Wederzijds uitsluiten met apiKey.
x509Transport	Goedgekeurde, bevroren Node.js certificaattransport vereist alleen voor X.509 workload-identiteit.

Eigenschapdetails

azureConfig

Azure Agent endpoint configuration.

azureConfig?: AzureAgentConfig

Waarde van eigenschap

AzureAgentConfig

Details van overgenomen eigenschap

adminAPIKey

Standaard is process.env['OPENAI_ADMIN_KEY'].

adminAPIKey?: string | null

Waarde van eigenschap

string | null

Geërfd van OpenAIClientOptions.adminAPIKey

apiKey

API-sleutel gebruikt voor authenticatie.

• Accepteert ofwel een statische string of een asynchrone functie die wordt opgelost in een string.
• Standaard is process.env['OPENAI_API_KEY'].
• Wanneer een functie wordt geleverd, wordt deze aangeroepen bij het bouwen van bearer-authenticatieheaders voor elke poging, inclusief herpogingen en directe buildRequest() aanroepen. Het resultaat van elke aanroeping wordt gebruikt voor een eigen verzoek.
• De functie moet een niet-lege string teruggeven; anders wordt er een OpenAIError gegooid.
• Als de functie wordt gegooid, wordt de fout in een OpenAIError gewrapped met de oorspronkelijke fout beschikbaar als cause.
• Wederzijds uitsluiten met workloadIdentity.

apiKey?: string | ApiKeySetter | null

Waarde van eigenschap

string | ApiKeySetter | null

Geërfd van OpenAIClientOptions.apiKey

baseURL

Overschrijf de standaard basis-URL voor de API, bijvoorbeeld "https://api.example.com/v2/"

Standaard staat process.env['OPENAI_BASE_URL'].

baseURL?: string | null

Waarde van eigenschap

string | null

Geërfd van OpenAIClientOptions.baseURL

credential

Eersteklas certificaat aangemaakt met fromX509 .openai/auth/x509-transport

credential?: X509Credential

Waarde van eigenschap

X509Credential

Geërfd van OpenAIClientOptions.credential

dangerouslyAllowBrowser

Standaard is client-side gebruik van deze bibliotheek niet toegestaan, omdat dit het risico loopt je geheime API-inloggegevens bloot te stellen aan aanvallers. Stel deze optie alleen in als true je de risico's begrijpt en passende mitigatiemaatregelen hebt getroffen.

dangerouslyAllowBrowser?: boolean

Waarde van eigenschap

boolean

Geërfd van OpenAIClientOptions.dangerouslyAllowBrowser

dataResidency

Selecteer een regionaal OpenAI-eindpunt. Dit overschrijft een geërfde of omgevingsgebaseerde URL en is wederzijds exclusief met een expliciete baseURL of provider. De beschikbaarheid hangt af van je project en model; er wordt geen fallback uitgevoerd. null en undefined laat de normale basisresolutie van URL's ongewijzigd.

dataResidency?: DataResidency | null

Waarde van eigenschap

DataResidency | null

Geërfd van OpenAIClientOptions.dataResidency

defaultHeaders

Standaardheaders om bij elk verzoek naar de API toe te voegen.

Deze kunnen in individuele verzoeken worden verwijderd door de header expliciet in te stellen op null opties in verzoeken.

defaultHeaders?: HeadersLike

Waarde van eigenschap

HeadersLike

Geërfd van OpenAIClientOptions.defaultHeaders

defaultQuery

Standaard queryparameters om bij elk verzoek naar de API op te nemen.

Deze kunnen worden verwijderd in individuele verzoeken door expliciet de param in te stellen op undefined de verzoekopties.

defaultQuery?: Record<string, string | undefined>

Waarde van eigenschap

Record<string, string | undefined>

Geërfd van OpenAIClientOptions.defaultQuery

fetch

Specificeer een aangepaste fetch functie-implementatie.

Als dat niet wordt opgegeven, verwachten we dat dat fetch globaal wordt gedefinieerd.

fetch?: Fetch

Waarde van eigenschap

Fetch

Geërfd van OpenAIClientOptions.fetch

fetchOptions

Extra RequestInit opties die aan oproepen worden doorgegeven fetch . Eigendommen worden per verzoek fetchOptionsoverschreven.

fetchOptions?: MergedRequestInit

Waarde van eigenschap

MergedRequestInit

Geërfd van OpenAIClientOptions.fetchOptions

logger

Zet de houthakker in.

Standaard staat globalThis.console.

logger?: Logger

Waarde van eigenschap

Logger

Geërfd van OpenAIClientOptions.logger

logLevel

Stel het logniveau in.

Standaard staat process.env['OPENAI_LOG'] of 'warn' als het niet is ingesteld.

logLevel?: LogLevel

Waarde van eigenschap

LogLevel

Geërfd van OpenAIClientOptions.logLevel

maxRetries

Het maximale aantal keren dat de client een verzoek opnieuw probeert in geval van een tijdelijke storing, zoals een netwerkfout of een 5XX-fout van de server.

maxRetries?: number

Waarde van eigenschap

number

Geërfd van OpenAIClientOptions.maxRetries

organization

Standaard staat process.env['OPENAI_ORG_ID'].

organization?: string | null

Waarde van eigenschap

string | null

Geërfd van OpenAIClientOptions.organization

project

Standaard staat process.env['OPENAI_PROJECT_ID'].

project?: string | null

Waarde van eigenschap

string | null

Geërfd van OpenAIClientOptions.project

provider

Configureer deze client om een externe API-provider te gebruiken. Wederzijds exclusief met authenticatie en baseURL opties op het hoogste niveau.

provider?: Provider

Waarde van eigenschap

Provider

Geërfd van OpenAIClientOptions.provider

timeout

De maximale tijd (in milliseconden) die de client moet wachten op een antwoord van de server voordat een enkel verzoek wordt getimed.

Let op dat time-outs bij verzoeken standaard opnieuw worden geprobeerd, dus in het ergste geval wacht je veel langer dan deze timeout voordat de belofte slaagt of faalt.

Node.js fetch dwingt onafhankelijke time-outs voor respons-header en lichaamsinactiviteit af, meestal vijf minuten, zelfs als deze timeout langer is. Om deze te vergroten, installeer undici en configureer je een Agent met de bijbehorende fetch-implementatie:

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

Waarde van eigenschap

number

Geërfd van OpenAIClientOptions.timeout

webhookSecret

Standaard is process.env['OPENAI_WEBHOOK_SECRET'].

webhookSecret?: string | null

Waarde van eigenschap

string | null

Geërfd van OpenAIClientOptions.webhookSecret

workloadIdentity

Workload-identiteitsconfiguratie voor OAuth2 tokenuitwisselingsauthenticatie. Wederzijds uitsluiten met apiKey.

workloadIdentity?: WorkloadIdentity | X509WorkloadIdentity

Waarde van eigenschap

WorkloadIdentity | X509WorkloadIdentity

Geërfd van OpenAIClientOptions.workloadIdentity

x509Transport

Goedgekeurde, bevroren Node.js certificaattransport vereist alleen voor X.509 workload-identiteit.

x509Transport?: X509Transport

Waarde van eigenschap

X509Transport

Geërfd van OpenAIClientOptions.x509Transport