OpenAIToolingConfiguration class

חבילה:

@microsoft/agents-a365-tooling-extensions-openai

קביעת תצורה עבור חבילת הרחבה של כלי OpenAI. קבלת כל ההגדרות של כלי עבודה וריצה בירושה.

מדוע מחלקה זו קיימת

למרות שמחלקה זו אינה מוסיפה כעת הגדרות חדשות מעבר למה שמספק ToolingConfiguration, היא קיימת מכמה סיבות חשובות:

1. סוג בטיחות: מאפשר לשירותים ספציפיים ל- IConfigurationProvider<OpenAIToolingConfiguration>OpenAI להצהיר על התלות שלהם ב- , כך שחוזה התצורה יהיה מפורש ותאפשר בדיקת זמן הידור.

2. נקודת הרחבה: מספק מקום ברור להוספת הגדרות ספציפיות ל- OpenAI (לדוגמה, זמן קצוב ל- Agents SDK, מרווחי תשאול של שרשור, הפעל מגבלות) מבלי לשבור קוד קיים כאשר צרכים אלה מופיעים.

3. תבנית עקבית: שומרת על הסימטריה עם חבילות הרחבות אחרות (כותר ההרחבה קלה על הבנת ערכת ה- SDK ולנווט בה.

4. הזרקת תלות: ניתן לשפר את השירותים כך שיקבלו סוג תצורה ספציפי זה, דבר המאפשר דפוסים ויציבות נאותים של 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 כאשר var env של אסימון לכל שרת (BEARER_TOKEN_<SERVERNAME_UPPER>) מוגדר באופן מפורש עבור השרת הנתון, False כאשר נעשה שימוש רק בגיבוי BEARER_TOKEN המשותף. משמש לזיהוי שרתי V2 שבוחזרים בצורה שקטה לאסימון קהל שגוי במצב פיתוח.
parseEnvBoolean(undefined | string)	ניתוח מבנה טקסט של משתנה סביבה כ משתנה בוליאני. מזהה את הערך 'true', '1', 'yes', 'on' (לא תלוי רישיות) כ- True; כל שאר הערכים כ- False.
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 כאשר var env של אסימון לכל שרת (BEARER_TOKEN_<SERVERNAME_UPPER>) מוגדר באופן מפורש עבור השרת הנתון, False כאשר נעשה שימוש רק בגיבוי BEARER_TOKEN המשותף. משמש לזיהוי שרתי V2 שבוחזרים בצורה שקטה לאסימון קהל שגוי במצב פיתוח.

function hasPerServerBearerToken(mcpServerName: string): boolean

פרמטרים

mcpServerName

string

החזרות

boolean

עובר בירושה מ- ToolingConfiguration.hasPerServerBearerToken

parseEnvBoolean(undefined | string)

ניתוח מבנה טקסט של משתנה סביבה כ משתנה בוליאני. מזהה את הערך 'true', '1', 'yes', 'on' (לא תלוי רישיות) כ- True; כל שאר הערכים כ- False.

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