OpenAIClientOptionsWithAzureAgent interface

الحزمة:

@azure/ai-projects

خيارات عميل OpenAI موسعة لتشمل تكوين نقطة نهاية Azure Agent.

يمتد

ClientOptions

الخصائص

azureConfig

Azure Agent endpoint configuration.

الخصائص الموروثة

adminAPIKey	الافتراضية هي process.env['OPENAI_ADMIN_KEY'].
apiKey	مفتاح API المستخدم للمصادقة. يقبل إما سلسلة ثابتة أو دالة غير متزامنة تحل إلى وتر. الافتراضية هي process.env['OPENAI_API_KEY']. عند توفير دالة، يتم تفعيلها قبل كل طلب حتى تتمكن من تدوير أو تحديث بيانات الاعتماد أثناء وقت التشغيل. يجب أن تعيد الدالة سلسلة غير فارغة؛ وإلا يتم رمي OpenAIErrror. إذا كانت الدالة تعرض، يتم تغليف الخطأ في OpenAIError مع توفر الخطأ الأصلي ك cause. غير متعارضين مع workloadIdentity.
baseURL	تجاوز عنوان URL الأساسي الافتراضي لواجهة برمجة التطبيقات، مثل: "https://api.example.com/v2/" الافتراضية هي process.env['OPENAI_BASE_URL'].
dangerouslyAllowBrowser	افتراضيا، لا يسمح باستخدام هذه المكتبة على جانب العميل، لأنها تعرض بيانات اعتماد واجهة برمجة التطبيقات السرية الخاصة بك للمهاجمين. اضبط هذا الخيار فقط true إذا كنت تفهم المخاطر ولديك تدابير تخفيف مناسبة.
defaultHeaders	رؤوس افتراضية يجب تضمينها مع كل طلب إلى واجهة برمجة التطبيقات. يمكن إزالة هذه الطلبات في كل طلب عن طريق تعيين الرأس بشكل صريح إلى null خيارات الطلبات.
defaultQuery	معلمات استعلام افتراضية يجب تضمينها مع كل طلب إلى واجهة برمجة التطبيقات. يمكن إزالة هذه الرموز في الطلبات الفردية عن طريق تعيين الپارام بشكل صريح إلى undefined خيارات داخل الطلب.
fetch	حدد تنفيذ دالة مخصصة fetch . إذا لم يتم توفيره، نتوقع أن يتم تعريف ذلك fetch عالميا.
fetchOptions	خيارات إضافية RequestInit يمكن تمريرها إلى fetch المكالمات. سيتم تجاوز العقارات حسب كل طلب fetchOptions.
logger	اضبط الحطاب. الافتراضية تتحول إلى globalThis.console.
logLevel	اضبط مستوى الجذع. يغير الوضع الافتراضي إلى process.env['OPENAI_LOG'] أو 'warning' إذا لم يكن مضبوطا.
maxRetries	الحد الأقصى لعدد المرات التي يعيد فيها العميل محاولة طلب في حال حدوث فشل مؤقت، مثل خطأ في الشبكة أو خطأ 5XX من الخادم.
organization	الإعداد الافتراضي هو process.env['OPENAI_ORG_ID'].
project	الافتراضية هي process.env['OPENAI_PROJECT_ID'].
timeout	أقصى مدة زمنية (بالأجزاء من الثانية) يجب أن ينتظر العميل رد من الخادم قبل إلغاء وقت طلب واحد. لاحظ أن مهلات الانتظار تعاد تجربتها افتراضيا، لذا في أسوأ الحالات قد تنتظر لفترة أطول بكثير من هذه المهلة قبل أن ينجح أو يفشل.
webhookSecret	الإعدادات الافتراضية هي process.env['OPENAI_WEBHOOK_SECRET'].
workloadIdentity	تكوين هوية عبء العمل لمصادقة تبادل الرموز في OAuth2. غير متعارضين مع apiKey.

تفاصيل الخاصية

azureConfig

Azure Agent endpoint configuration.

azureConfig?: AzureAgentConfig

قيمة الخاصية

AzureAgentConfig

تفاصيل الخاصية الموروثة

adminAPIKey

الافتراضية هي process.env['OPENAI_ADMIN_KEY'].

adminAPIKey?: null | string

قيمة الخاصية

null | string

الموروث من OpenAIClientOptions.adminAPIKey

apiKey

مفتاح API المستخدم للمصادقة.

• يقبل إما سلسلة ثابتة أو دالة غير متزامنة تحل إلى وتر.
• الافتراضية هي process.env['OPENAI_API_KEY'].
• عند توفير دالة، يتم تفعيلها قبل كل طلب حتى تتمكن من تدوير أو تحديث بيانات الاعتماد أثناء وقت التشغيل.
• يجب أن تعيد الدالة سلسلة غير فارغة؛ وإلا يتم رمي OpenAIErrror.
• إذا كانت الدالة تعرض، يتم تغليف الخطأ في OpenAIError مع توفر الخطأ الأصلي ك cause.
• غير متعارضين مع workloadIdentity.

apiKey?: null | string | ApiKeySetter

قيمة الخاصية

null | string | ApiKeySetter

الموروث من OpenAIClientOptions.apiKey

baseURL

تجاوز عنوان URL الأساسي الافتراضي لواجهة برمجة التطبيقات، مثل: "https://api.example.com/v2/"

الافتراضية هي process.env['OPENAI_BASE_URL'].

baseURL?: null | string

قيمة الخاصية

null | string

الموروث من OpenAIClientOptions.baseURL

dangerouslyAllowBrowser

افتراضيا، لا يسمح باستخدام هذه المكتبة على جانب العميل، لأنها تعرض بيانات اعتماد واجهة برمجة التطبيقات السرية الخاصة بك للمهاجمين. اضبط هذا الخيار فقط true إذا كنت تفهم المخاطر ولديك تدابير تخفيف مناسبة.

dangerouslyAllowBrowser?: boolean

قيمة الخاصية

boolean

الموروث من OpenAIClientOptions.dangerouslyAllowBrowser

defaultHeaders

رؤوس افتراضية يجب تضمينها مع كل طلب إلى واجهة برمجة التطبيقات.

يمكن إزالة هذه الطلبات في كل طلب عن طريق تعيين الرأس بشكل صريح إلى null خيارات الطلبات.

defaultHeaders?: HeadersLike

قيمة الخاصية

HeadersLike

الموروث من OpenAIClientOptions.defaultHeaders

defaultQuery

معلمات استعلام افتراضية يجب تضمينها مع كل طلب إلى واجهة برمجة التطبيقات.

يمكن إزالة هذه الرموز في الطلبات الفردية عن طريق تعيين الپارام بشكل صريح إلى undefined خيارات داخل الطلب.

defaultQuery?: Record<string, undefined | string>

قيمة الخاصية

Record<string, undefined | string>

الموروث من OpenAIClientOptions.defaultQuery

fetch

حدد تنفيذ دالة مخصصة fetch .

إذا لم يتم توفيره، نتوقع أن يتم تعريف ذلك fetch عالميا.

fetch?: Fetch

قيمة الخاصية

Fetch

الموروث من OpenAIClientOptions.fetch

fetchOptions

خيارات إضافية RequestInit يمكن تمريرها إلى fetch المكالمات. سيتم تجاوز العقارات حسب كل طلب fetchOptions.

fetchOptions?: MergedRequestInit

قيمة الخاصية

MergedRequestInit

الموروث من OpenAIClientOptions.fetchOptions

logger

اضبط الحطاب.

الافتراضية تتحول إلى globalThis.console.

logger?: Logger

قيمة الخاصية

Logger

الموروث من OpenAIClientOptions.logger

logLevel

اضبط مستوى الجذع.

يغير الوضع الافتراضي إلى process.env['OPENAI_LOG'] أو 'warning' إذا لم يكن مضبوطا.

logLevel?: LogLevel

قيمة الخاصية

LogLevel

الموروث من OpenAIClientOptions.logLevel

maxRetries

الحد الأقصى لعدد المرات التي يعيد فيها العميل محاولة طلب في حال حدوث فشل مؤقت، مثل خطأ في الشبكة أو خطأ 5XX من الخادم.

maxRetries?: number

قيمة الخاصية

number

الموروث من OpenAIClientOptions.maxRetries

organization

الإعداد الافتراضي هو process.env['OPENAI_ORG_ID'].

organization?: null | string

قيمة الخاصية

null | string

الموروث من OpenAIClientOptions.organization

project

الافتراضية هي process.env['OPENAI_PROJECT_ID'].

project?: null | string

قيمة الخاصية

null | string

الموروث من OpenAIClientOptions.project

timeout

أقصى مدة زمنية (بالأجزاء من الثانية) يجب أن ينتظر العميل رد من الخادم قبل إلغاء وقت طلب واحد.

لاحظ أن مهلات الانتظار تعاد تجربتها افتراضيا، لذا في أسوأ الحالات قد تنتظر لفترة أطول بكثير من هذه المهلة قبل أن ينجح أو يفشل.

timeout?: number

قيمة الخاصية

number

الموروث من OpenAIClientOptions.timeout

webhookSecret

الإعدادات الافتراضية هي process.env['OPENAI_WEBHOOK_SECRET'].

webhookSecret?: null | string

قيمة الخاصية

null | string

الموروث من OpenAIClientOptions.webhookSecret

workloadIdentity

تكوين هوية عبء العمل لمصادقة تبادل الرموز في OAuth2. غير متعارضين مع apiKey.

workloadIdentity?: WorkloadIdentity

قيمة الخاصية

WorkloadIdentity

الموروث من OpenAIClientOptions.workloadIdentity