OpenAIClientOptionsWithAzureAgent interface

Pakiet:

@azure/ai-projects

Rozszerzone opcje klienta OpenAI o konfigurację endpoint Azure Agent.

Rozszerzenie

ClientOptions

Właściwości

azureConfig

Azure Agent endpoint configuration.

Właściwości dziedziczone

adminAPIKey	Domyślnie używa process.env['OPENAI_ADMIN_KEY'].
apiKey	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 przed każdym żądaniem, aby można było obracać lub odświeżać poświadczenia w czasie działania. 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.
baseURL	Nadpisz domyślny bazowy URL API, np. "https://api.example.com/v2/" Domyślnie przyjmuje process.env['OPENAI_BASE_URL'].
dangerouslyAllowBrowser	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.
defaultHeaders	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.
defaultQuery	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.
fetch	Określ fetch niestandardową implementację funkcji. Jeśli nie zostanie to podano, spodziewamy się, że jest to fetch definiowane globalnie.
fetchOptions	Dodatkowe RequestInit opcje do przekazania na fetch wezwania. Właściwości będą nadpisane na każde żądanie fetchOptions.
logger	Ustaw drwala. Domyślnie ustawia się na globalThis.console.
logLevel	Ustaw poziom kłody. Domyślnie przyjmuje process.env['OPENAI_LOG'] lub 'ostrzeżenie', jeśli nie jest ustawione.
maxRetries	Maksymalna liczba powtórzeń żądania przez klienta w przypadku tymczasowej awarii, takiej jak błąd sieciowy lub błąd 5XX ze strony serwera.
organization	Domyślnie przyjmuje process.env['OPENAI_ORG_ID'].
project	Domyślnie przyjmuje process.env['OPENAI_PROJECT_ID'].
timeout	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.
webhookSecret	Domyślnie wybiera process.env['OPENAI_WEBHOOK_SECRET'].
workloadIdentity	Konfiguracja tożsamości obciążenia dla uwierzytelniania wymiany tokenów OAuth2. Wzajemnie wykluczające się z apiKey.

Szczegóły właściwości

azureConfig

Azure Agent endpoint configuration.

azureConfig?: AzureAgentConfig

Wartość właściwości

AzureAgentConfig

Szczegóły właściwości dziedziczonej

adminAPIKey

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

adminAPIKey?: null | string

Wartość właściwości

null | string

Dziedziczone od OpenAIClientOptions.adminAPIKey

apiKey

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 przed każdym żądaniem, aby można było obracać lub odświeżać poświadczenia w czasie działania.
• 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?: null | string | ApiKeySetter

Wartość właściwości

null | string | ApiKeySetter

Dziedziczone od OpenAIClientOptions.apiKey

baseURL

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

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

baseURL?: null | string

Wartość właściwości

null | string

Dziedziczone od OpenAIClientOptions.baseURL

dangerouslyAllowBrowser

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

boolean

Dziedziczone od OpenAIClientOptions.dangerouslyAllowBrowser

defaultHeaders

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

HeadersLike

Dziedziczone od OpenAIClientOptions.defaultHeaders

defaultQuery

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

Wartość właściwości

Record<string, undefined | string>

Dziedziczone od OpenAIClientOptions.defaultQuery

fetch

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

Fetch

Dziedziczone od OpenAIClientOptions.fetch

fetchOptions

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

MergedRequestInit

Dziedziczone od OpenAIClientOptions.fetchOptions

logger

Ustaw drwala.

Domyślnie ustawia się na globalThis.console.

logger?: Logger

Wartość właściwości

Logger

Dziedziczone od OpenAIClientOptions.logger

logLevel

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

LogLevel

Dziedziczone od OpenAIClientOptions.logLevel

maxRetries

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

number

Dziedziczone od OpenAIClientOptions.maxRetries

organization

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

organization?: null | string

Wartość właściwości

null | string

Dziedziczone od OpenAIClientOptions.organization

project

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

project?: null | string

Wartość właściwości

null | string

Dziedziczone od OpenAIClientOptions.project

timeout

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.

timeout?: number

Wartość właściwości

number

Dziedziczone od OpenAIClientOptions.timeout

webhookSecret

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

webhookSecret?: null | string

Wartość właściwości

null | string

Dziedziczone od OpenAIClientOptions.webhookSecret

workloadIdentity

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

workloadIdentity?: WorkloadIdentity

Wartość właściwości

WorkloadIdentity

Dziedziczone od OpenAIClientOptions.workloadIdentity