OpenAIClientOptionsWithAzureAgent interface

Azure Agent endpoint configuration.

azureConfig?: AzureAgentConfig

Wartość właściwości

Domyślnie używa process.env['OPENAI_ADMIN_KEY'].

adminAPIKey?: string | null

Wartość właściwości

Dziedziczone od OpenAIClientOptions.adminAPIKey

Klucz API używany do uwierzytelniania.

• Akceptuje albo statyczny ciąg znaków, albo funkcję asynchroniczną, która rozwiązuje się do ciągu znaków.
• Domyślnie przyjmuje process.env['OPENAI_API_KEY'].
• Gdy funkcja jest dostarczana, jest wywoływana przy tworzeniu nagłówków uwierzytelniania nosiciela dla każdej próby, w tym powtórek i wywołań bezpośrednich buildRequest() . Wynik każdego wywołania jest używany do własnego żądania.
• Funkcja musi zwrócić ciąg niepusty; w przeciwnym razie rzucany jest OpenAIError.
• Jeśli funkcja wyrzuci, błąd jest opakowany w OpenAIError, a oryginalny błąd dostępny jest jako .cause
• Wzajemnie wykluczające się z workloadIdentity.

apiKey?: string | ApiKeySetter | null

Wartość właściwości

Dziedziczone od OpenAIClientOptions.apiKey

Nadpisz domyślny bazowy URL API, np. "https://api.example.com/v2/"

Domyślnie przyjmuje process.env['OPENAI_BASE_URL'].

baseURL?: string | null

Wartość właściwości

Dziedziczone od OpenAIClientOptions.baseURL

Certyfikat pierwszej klasy utworzony z fromX509 .openai/auth/x509-transport

credential?: X509Credential

Wartość właściwości

Dziedziczone z OpenAIClientOptions.credential

Domyślnie korzystanie z tej biblioteki po stronie klienta nie jest dozwolone, ponieważ grozi ujawnieniem twoich tajnych poświadczeń API dla atakujących. Ustaw tę opcję true tylko wtedy, gdy rozumiesz ryzyko i masz odpowiednie środki łagodzące.

dangerouslyAllowBrowser?: boolean

Wartość właściwości

Dziedziczone od OpenAIClientOptions.dangerouslyAllowBrowser

Wybierz regionalny punkt końcowy OpenAI. To nadpisuje dziedziczony lub bazowy adres URL środowiskowy i jest wzajemnie wyłączny z jawnym baseURL lub provider. Dostępność zależy od Twojego projektu i modelu; nie ma żadnego planu awaryjnego. null i pozostawić undefined zwykłą rozdzielczość bazowych URL bez zmian.

dataResidency?: DataResidency | null

Wartość właściwości

Dziedziczone z OpenAIClientOptions.dataResidency

Domyślne nagłówki do każdego żądania do API.

Można je usunąć w pojedynczych żądaniach, ustawiając nagłówek na null opcjach żądania.

defaultHeaders?: HeadersLike

Wartość właściwości

Dziedziczone od OpenAIClientOptions.defaultHeaders

Domyślne parametry zapytania do każdego żądania do API.

Można je usunąć w pojedynczych żądaniach, wyraźnie ustawiając parametr na undefined w opcjach żądania.

defaultQuery?: Record<string, string | undefined>

Wartość właściwości

Dziedziczone od OpenAIClientOptions.defaultQuery

Określ fetch niestandardową implementację funkcji.

Jeśli nie zostanie to podano, spodziewamy się, że jest to fetch definiowane globalnie.

fetch?: Fetch

Wartość właściwości

Dziedziczone od OpenAIClientOptions.fetch

Dodatkowe RequestInit opcje do przekazania na fetch wezwania. Właściwości będą nadpisane na każde żądanie fetchOptions.

fetchOptions?: MergedRequestInit

Wartość właściwości

Dziedziczone od OpenAIClientOptions.fetchOptions

Ustaw drwala.

Domyślnie ustawia się na globalThis.console.

logger?: Logger

Wartość właściwości

Dziedziczone od OpenAIClientOptions.logger

Ustaw poziom kłody.

Domyślnie przyjmuje process.env['OPENAI_LOG'] lub 'ostrzeżenie', jeśli nie jest ustawione.

logLevel?: LogLevel

Wartość właściwości

Dziedziczone od OpenAIClientOptions.logLevel

Maksymalna liczba powtórzeń żądania przez klienta w przypadku tymczasowej awarii, takiej jak błąd sieciowy lub błąd 5XX ze strony serwera.

maxRetries?: number

Wartość właściwości

Dziedziczone od OpenAIClientOptions.maxRetries

Domyślnie przyjmuje process.env['OPENAI_ORG_ID'].

organization?: string | null

Wartość właściwości

Dziedziczone od OpenAIClientOptions.organization

Domyślnie przyjmuje process.env['OPENAI_PROJECT_ID'].

project?: string | null

Wartość właściwości

Dziedziczone od OpenAIClientOptions.project

Skonfiguruj tego klienta do korzystania z zewnętrznego dostawcy API. Wzajemnie wykluczające się z najwyższym poziomem uwierzytelniania i baseURL opcjami.

provider?: Provider

Wartość właściwości

Dziedziczone od OpenAIClientOptions.provider

Maksymalny czas (w milisekundach), jaki klient powinien oczekiwać na odpowiedź od serwera, zanim wymierzy czas wykonania pojedynczego żądania.

Należy pamiętać, że timeouty żądań są domyślnie powtarzane, więc w najgorszym przypadku możesz czekać znacznie dłużej niż ten czas, zanim obietnica się powiedzie lub nie powiod.

Node.js pobieranie wymusza niezależne limity czasu na nagłówek odpowiedzi i bezczynności ciała, zazwyczaj domyślnie wynosząc pięć minut, nawet jeśli ten limit jest dłuższy. Aby je zwiększyć, zainstaluj undici i skonfiguruj Agenta z odpowiednią implementacją pobierania:

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

Wartość właściwości

Dziedziczone od OpenAIClientOptions.timeout

Domyślnie wybiera process.env['OPENAI_WEBHOOK_SECRET'].

webhookSecret?: string | null

Wartość właściwości

Dziedziczone od OpenAIClientOptions.webhookSecret

Konfiguracja tożsamości obciążenia dla uwierzytelniania wymiany tokenów OAuth2. Wzajemnie wykluczające się z apiKey.

workloadIdentity?: WorkloadIdentity | X509WorkloadIdentity

Wartość właściwości

Dziedziczone od OpenAIClientOptions.workloadIdentity

Zatwierdzone, zamrożone Node.js transfer certyfikatów wymagany tylko dla tożsamości obciążenia X.509.

x509Transport?: X509Transport

Wartość właściwości

Dziedziczone z OpenAIClientOptions.x509Transport