OpenAIToolingConfiguration class

الحزمة:: @microsoft/agents-a365-tooling-extensions-openai

تكوين حزمة ملحق أدوات OpenAI. يرث كافة إعدادات الأدوات ووقت التشغيل.

سبب وجود هذه الفئة

على الرغم من أن هذه الفئة لا تضيف حاليا أي إعدادات جديدة تتجاوز ما توفره ToolingConfiguration، إلا أنها موجودة لعدة أسباب مهمة:

أمان النوع: يسمح للخدمات الخاصة ب OpenAI بالإعلان عن اعتمادها على IConfigurationProvider<OpenAIToolingConfiguration>، مما يجعل عقد التكوين صريحا وتمكين التحقق من وقت التحويل البرمجي.
نقطة الملحق: يوفر مكانا واضحا لإضافة إعدادات OpenAI الخاصة (على سبيل المثال، مهلات Agents SDK، وفواصل التحقق من مؤشر الترابط، وحدود التشغيل) دون كسر التعليمات البرمجية الموجودة عند ظهور هذه الاحتياجات.
نمط متسق: يحافظ على التماثل مع حزم الملحقات الأخرى (كلود، LangChain)، ما يجعل SDK أسهل في الفهم والتنقل.
إدخال التبعية: يمكن تصميم الخدمات لقبول نوع التكوين المحدد هذا، مما يتيح أنماط IoC المناسبة وقابلية الاختبار.

مثال

// Service declares explicit dependency on OpenAI configuration
class OpenAIService {
  constructor(private configProvider: IConfigurationProvider<OpenAIToolingConfiguration>) {}
}

// Future: Add OpenAI-specific settings without breaking changes
class OpenAIToolingConfiguration extends ToolingConfiguration {
  get threadPollingInterval(): number { ... }
}

يمتد: ToolingConfiguration

المنشئون

OpenAIToolingConfiguration(ToolingConfigurationOptions)

الخصائص

clusterCategory
isDevelopmentEnvironment	ما إذا كان نظام المجموعة بيئة تطوير (محلية أو تطويرية). استنادا إلى clusterCategory.
isNodeEnvDevelopment	ما إذا كان NODE_ENV يشير إلى وضع التطوير. إرجاع القيمة true عندما يكون NODE_ENV "تطوير" (غير حساس لحالة الأحرف). هذه هي الطريقة Node.js القياسية للإشارة إلى وضع التطوير.
mcpPlatformAuthenticationScope	الحصول على نطاق مصادقة النظام الأساسي MCP. يستخدم بواسطة AgenticAuthenticationService لتبادل الرمز المميز. اقتطاع المسافة البيضاء لمنع فشل تبادل الرمز المميز.
mcpPlatformEndpoint
useToolingManifest	ما إذا كنت تريد استخدام ملف ToolingManifest.json بدلا من اكتشاف البوابة. إرجاع القيمة true عند تعيين NODE_ENV إلى "تطوير" (غير حساس لحالة الأحرف)، أو عند تجاوزها صراحة عبر التكوين.

الأساليب المتوارثة

getBearerTokenForServer(string)	إرجاع الرمز المميز لحامل وضع التطوير لخادم MCP بالاسم. يتحقق BEARER_TOKEN_<SERVERNAME_UPPER> أولا، ثم يعود إلى BEARER_TOKEN. إرجاع غير معرف عند عدم تعيين المتغير (لن يتم إرفاق عنوان التخويل).
hasPerServerBearerToken(string)	إرجاع القيمة true عندما يتم تعيين env var للرمز المميز لكل خادم (BEARER_TOKEN_<SERVERNAME_UPPER>) بشكل صريح للخادم المحدد، خطأ عند استخدام BEARER_TOKEN الاحتياطية المشتركة فقط. يستخدم للكشف عن خوادم V2 التي تعود بصمت إلى رمز جمهور غير صحيح في وضع التطوير.
parseEnvBoolean(undefined \| string)	تحليل متغير بيئة كقيمة منطقية. يتعرف على "true" و"1" و"yes" و"on" (غير حساس لحالة الأحرف) على أنه صحيح؛ كافة القيم الأخرى كخطأ.
parseEnvInt(undefined \| string, number)	تحليل متغير بيئة كعدد صحيح، مع إرجاع احتياطي إذا كان غير صالح أو لم يتم تعيينه.

تفاصيل المنشئ

OpenAIToolingConfiguration(ToolingConfigurationOptions)

new OpenAIToolingConfiguration(overrides?: ToolingConfigurationOptions)

المعلمات

overrides: ToolingConfigurationOptions

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

clusterCategory

ClusterCategory clusterCategory

قيمة الخاصية

ClusterCategory

isDevelopmentEnvironment

ما إذا كان نظام المجموعة بيئة تطوير (محلية أو تطويرية). استنادا إلى clusterCategory.

boolean isDevelopmentEnvironment

قيمة الخاصية

boolean

isNodeEnvDevelopment

ما إذا كان NODE_ENV يشير إلى وضع التطوير. إرجاع القيمة true عندما يكون NODE_ENV "تطوير" (غير حساس لحالة الأحرف). هذه هي الطريقة Node.js القياسية للإشارة إلى وضع التطوير.

boolean isNodeEnvDevelopment

قيمة الخاصية

boolean

mcpPlatformAuthenticationScope

الحصول على نطاق مصادقة النظام الأساسي MCP. يستخدم بواسطة AgenticAuthenticationService لتبادل الرمز المميز. اقتطاع المسافة البيضاء لمنع فشل تبادل الرمز المميز.

string mcpPlatformAuthenticationScope

قيمة الخاصية

string

mcpPlatformEndpoint

string mcpPlatformEndpoint

قيمة الخاصية

string

useToolingManifest

ما إذا كنت تريد استخدام ملف ToolingManifest.json بدلا من اكتشاف البوابة. إرجاع القيمة true عند تعيين NODE_ENV إلى "تطوير" (غير حساس لحالة الأحرف)، أو عند تجاوزها صراحة عبر التكوين.

boolean useToolingManifest

قيمة الخاصية

boolean

تفاصيل الأساليب المتوارثة

getBearerTokenForServer(string)

إرجاع الرمز المميز لحامل وضع التطوير لخادم MCP بالاسم. يتحقق BEARER_TOKEN_<SERVERNAME_UPPER> أولا، ثم يعود إلى BEARER_TOKEN. إرجاع غير معرف عند عدم تعيين المتغير (لن يتم إرفاق عنوان التخويل).

function getBearerTokenForServer(mcpServerName: string): undefined | string

المعلمات

mcpServerName: string

المرتجعات

undefined | string

موروث من ToolingConfiguration.getBearerTokenForServer

hasPerServerBearerToken(string)

إرجاع القيمة true عندما يتم تعيين env var للرمز المميز لكل خادم (BEARER_TOKEN_<SERVERNAME_UPPER>) بشكل صريح للخادم المحدد، خطأ عند استخدام BEARER_TOKEN الاحتياطية المشتركة فقط. يستخدم للكشف عن خوادم V2 التي تعود بصمت إلى رمز جمهور غير صحيح في وضع التطوير.

function hasPerServerBearerToken(mcpServerName: string): boolean

المعلمات

mcpServerName: string

المرتجعات

boolean

موروث من ToolingConfiguration.hasPerServerBearerToken

parseEnvBoolean(undefined | string)

تحليل متغير بيئة كقيمة منطقية. يتعرف على "true" و"1" و"yes" و"on" (غير حساس لحالة الأحرف) على أنه صحيح؛ كافة القيم الأخرى كخطأ.

static function parseEnvBoolean(envValue: undefined | string): boolean

المعلمات

envValue: undefined | string

المرتجعات

boolean

موروث من ToolingConfiguration.parseEnvBoolean

parseEnvInt(undefined | string, number)

تحليل متغير بيئة كعدد صحيح، مع إرجاع احتياطي إذا كان غير صالح أو لم يتم تعيينه.

static function parseEnvInt(envValue: undefined | string, fallback: number): number

المعلمات

envValue: undefined | string

fallback: number

المرتجعات

number

موروث من ToolingConfiguration.parseEnvInt