OpenAIClientOptionsWithAzureAgent interface

Paket:

@azure/ai-projects

OpenAI istemci seçeneklerini Azure Agent uç nokta yapılandırmasını da dahil edecek şekilde genişletti.

Extends

ClientOptions

Özellikler

azureConfig

Azure Agent endpoint configuration.

Devralınan Özellikler

adminAPIKey	Varsayılan olarak process.env['OPENAI_ADMIN_KEY'].
apiKey	Kimlik doğrulama için kullanılan API anahtarı. Ya statik bir diziyi ya da bir dizeye çözümlenen asenkron bir fonksiyonu kabul eder. Varsayılan olarak process.env['OPENAI_API_KEY']. Bir fonksiyon sağlandığında, her istek öncesi çağrılır, böylece çalışma zamanında kimlik bilgilerini döndürebilir veya yenileyebilirsiniz. Fonksiyon boş olmayan bir diziyi geri getirmelidir; aksi takdirde bir OpenAIError atılır. Fonksiyon atıyorsa, hata bir OpenAIError içinde sarılır ve orijinal hata olarak mevcuttur cause. workloadIdentity ile birbirini dışlar.
baseURL	API için varsayılan temel URL'yi geçersiz kılın, örneğin, "https://api.example.com/v2/" Varsayılan olarak process.env['OPENAI_BASE_URL'].
dangerouslyAllowBrowser	Varsayılan olarak, bu kütüphanenin istemci tarafında kullanılmasına izin verilmez, çünkü gizli API kimlik bilgilerinizi saldırganlara açığa çıkarma riski vardır. Bu seçeneği sadece riskleri anlıyorsanız ve uygun önlemleriniz varsa ayarlayın true .
defaultHeaders	API'ye her istekle birlikte eklenecek varsayılan başlıklar. Bunlar, başlığı açıkça istek içinde olarak ayarlayarak null bireysel isteklerde kaldırılabilir.
defaultQuery	API'ye yapılan her istekle birlikte eklenecek varsayılan sorgu parametreleri. Bunlar, parametreyi açıkça istek seçeneklerinde undefined olarak ayarlayarak bireysel isteklerde kaldırılabilir.
fetch	Özel fetch bir fonksiyon uygulaması belirtin. Eğer sağlanmazsa, bunun fetch küresel olarak tanımlanmasını bekliyoruz.
fetchOptions	Ek RequestInit seçenekler çağrı çağrılarına fetch aktarılacak. Özellikler, isteğe fetchOptionsgöre geçersiz kalacaktır.
logger	Logger'ı kur. Varsayılan olarak globalThis.console olarak kalıyor.
logLevel	Log seviyesini ayarlayın. Varsayılan olarak process.env['OPENAI_LOG'] veya ayarlanmadıysa 'warn' olur.
maxRetries	Geçici bir arıza durumunda, örneğin ağ hatası veya sunucudan gelen 5XX hatası gibi, istemcinin bir talebi tekrar denesi maksimumum.
organization	Varsayılan olarak process.env['OPENAI_ORG_ID'].
project	Varsayılan olarak process.env['OPENAI_PROJECT_ID'].
timeout	İstemcinin tek bir talebi zamanlamadan önce sunucudan yanıt beklemesi gereken maksimum süre (milisaniyeler cinsinden). İstek zaman aşımlarının varsayılan olarak yeniden denendiğini unutmayın, bu yüzden en kötü senaryoda bu zaman aşımından çok daha uzun süre bekleyebilirsiniz ve vaadin başarısız olmasını sağlayabilirsiniz.
webhookSecret	Varsayılan olarak process.env['OPENAI_WEBHOOK_SECRET'].
workloadIdentity	OAuth2 token değişim kimlik doğrulaması için iş yükü kimliği yapılandırması. apiKey ile birbirini dışlar.

Özellik Ayrıntıları

azureConfig

Azure Agent endpoint configuration.

azureConfig?: AzureAgentConfig

Özellik Değeri

AzureAgentConfig

Devralınan Özellik Detayları

adminAPIKey

Varsayılan olarak process.env['OPENAI_ADMIN_KEY'].

adminAPIKey?: null | string

Özellik Değeri

null | string

Miras Olarak OpenAIClientOptions.adminAPIKey

apiKey

Kimlik doğrulama için kullanılan API anahtarı.

• Ya statik bir diziyi ya da bir dizeye çözümlenen asenkron bir fonksiyonu kabul eder.
• Varsayılan olarak process.env['OPENAI_API_KEY'].
• Bir fonksiyon sağlandığında, her istek öncesi çağrılır, böylece çalışma zamanında kimlik bilgilerini döndürebilir veya yenileyebilirsiniz.
• Fonksiyon boş olmayan bir diziyi geri getirmelidir; aksi takdirde bir OpenAIError atılır.
• Fonksiyon atıyorsa, hata bir OpenAIError içinde sarılır ve orijinal hata olarak mevcuttur cause.
• workloadIdentity ile birbirini dışlar.

apiKey?: null | string | ApiKeySetter

Özellik Değeri

null | string | ApiKeySetter

Miras Olarak OpenAIClientOptions.apiKey

baseURL

API için varsayılan temel URL'yi geçersiz kılın, örneğin, "https://api.example.com/v2/"

Varsayılan olarak process.env['OPENAI_BASE_URL'].

baseURL?: null | string

Özellik Değeri

null | string

Miras Olarak OpenAIClientOptions.baseURL

dangerouslyAllowBrowser

Varsayılan olarak, bu kütüphanenin istemci tarafında kullanılmasına izin verilmez, çünkü gizli API kimlik bilgilerinizi saldırganlara açığa çıkarma riski vardır. Bu seçeneği sadece riskleri anlıyorsanız ve uygun önlemleriniz varsa ayarlayın true .

dangerouslyAllowBrowser?: boolean

Özellik Değeri

boolean

Miras Olarak OpenAIlientOptions.dangerouslyAllowBrowser

defaultHeaders

API'ye her istekle birlikte eklenecek varsayılan başlıklar.

Bunlar, başlığı açıkça istek içinde olarak ayarlayarak null bireysel isteklerde kaldırılabilir.

defaultHeaders?: HeadersLike

Özellik Değeri

HeadersLike

Miras Olarak OpenAIClientOptions.defaultHeaders

defaultQuery

API'ye yapılan her istekle birlikte eklenecek varsayılan sorgu parametreleri.

Bunlar, parametreyi açıkça istek seçeneklerinde undefined olarak ayarlayarak bireysel isteklerde kaldırılabilir.

defaultQuery?: Record<string, undefined | string>

Özellik Değeri

Record<string, undefined | string>

Miras Olarak OpenAIClientOptions.defaultQuery

fetch

Özel fetch bir fonksiyon uygulaması belirtin.

Eğer sağlanmazsa, bunun fetch küresel olarak tanımlanmasını bekliyoruz.

fetch?: Fetch

Özellik Değeri

Fetch

Miras Olarak OpenAIClientOptions.fetch

fetchOptions

Ek RequestInit seçenekler çağrı çağrılarına fetch aktarılacak. Özellikler, isteğe fetchOptionsgöre geçersiz kalacaktır.

fetchOptions?: MergedRequestInit

Özellik Değeri

MergedRequestInit

Miras Olarak OpenAIClientOptions.fetchOptions

logger

Logger'ı kur.

Varsayılan olarak globalThis.console olarak kalıyor.

logger?: Logger

Özellik Değeri

Logger

Miras Olarak OpenAIClientOptions.logger

logLevel

Log seviyesini ayarlayın.

Varsayılan olarak process.env['OPENAI_LOG'] veya ayarlanmadıysa 'warn' olur.

logLevel?: LogLevel

Özellik Değeri

LogLevel

Miras Olarak OpenAIClientOptions.logLevel

maxRetries

Geçici bir arıza durumunda, örneğin ağ hatası veya sunucudan gelen 5XX hatası gibi, istemcinin bir talebi tekrar denesi maksimumum.

maxRetries?: number

Özellik Değeri

number

Miras Olarak OpenAIClientOptions.maxRetries

organization

Varsayılan olarak process.env['OPENAI_ORG_ID'].

organization?: null | string

Özellik Değeri

null | string

Miras Olarak OpenAIClientOptions.organization

project

Varsayılan olarak process.env['OPENAI_PROJECT_ID'].

project?: null | string

Özellik Değeri

null | string

Miras Olarak OpenAIClientOptions.project

timeout

İstemcinin tek bir talebi zamanlamadan önce sunucudan yanıt beklemesi gereken maksimum süre (milisaniyeler cinsinden).

İstek zaman aşımlarının varsayılan olarak yeniden denendiğini unutmayın, bu yüzden en kötü senaryoda bu zaman aşımından çok daha uzun süre bekleyebilirsiniz ve vaadin başarısız olmasını sağlayabilirsiniz.

timeout?: number

Özellik Değeri

number

Miras Olarak OpenAIClientOptions.timeout

webhookSecret

Varsayılan olarak process.env['OPENAI_WEBHOOK_SECRET'].

webhookSecret?: null | string

Özellik Değeri

null | string

Miras Olarak OpenAIClientOptions.webhookSecret

workloadIdentity

OAuth2 token değişim kimlik doğrulaması için iş yükü kimliği yapılandırması. apiKey ile birbirini dışlar.

workloadIdentity?: WorkloadIdentity

Özellik Değeri

WorkloadIdentity

Miras Olarak OpenAIClientOptions.workloadIdentity