OpenAIToolingConfiguration class

แพคเกจ:

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

การกําหนดค่าสําหรับแพคเกจส่วนขยายของ OpenAI สืบทอดการตั้งค่าการใช้เครื่องมือและรันไทม์ทั้งหมด

ทําไมถึงมีคลาสนี้อยู่

แม้ว่าในขณะนี้คลาสนี้เพิ่มการตั้งค่าใหม่นอกเหนือจากค่าของ ToolingConfiguration ที่มีอยู่ด้วยเหตุผลที่สําคัญหลายประการ:

1. ประเภทความปลอดภัย: อนุญาตให้บริการเฉพาะ OpenAI เพื่อประกาศการขึ้นต่อกัน IConfigurationProvider<OpenAIToolingConfiguration>ของพวกเขาทําให้สัญญากําหนดค่าชัดเจนและเปิดใช้งานการตรวจสอบเวลาการคอมไพล์

2. จุดส่วนขยาย: ให้ตําแหน่งที่ชัดเจนในการเพิ่มการตั้งค่าเฉพาะ OpenAI (เช่น หมดเวลาการหมดเวลาของตัวแทนช่วงเวลาการโพลล์ของเธรดขีดจํากัดการเรียกใช้) โดยไม่ต้องแบ่งโค้ดที่มีอยู่เมื่อความต้องการเหล่านั้นเกิดขึ้น

3. รูปแบบที่สอดคล้องกัน: รักษาสมมาตรกับแพคเกจส่วนขยายอื่น ๆ (Claude, LangChain) ทําให้ 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 เมื่อโทเค็น env var (BEARER_TOKEN_<SERVERNAME_UPPER>) ต่อเซิร์ฟเวอร์ถูกตั้งค่าอย่างชัดเจนสําหรับเซิร์ฟเวอร์ที่ระบุ เท็จ เมื่อมีการใช้เฉพาะการแสดงแทน BEARER_TOKEN ที่ใช้ร่วมกันเท่านั้น ใช้เพื่อตรวจสอบเซิร์ฟเวอร์ V2 ที่ล้มอย่างเงียบ ๆ กลับไปยังโทเค็นผู้ชมที่ไม่ถูกต้องในโหมด dev
parseEnvBoolean(undefined | string)	แยกวิเคราะห์ตัวแปรสภาพแวดล้อมเป็นบูลีน รู้จัก 'true', '1', 'yes', 'on' (ไม่ตรงตามตัวพิมพ์ใหญ่-เล็ก) เป็น true แต่ไม่ตรงตามตัวพิมพ์ใหญ่-เล็ก ค่าอื่นๆ ทั้งหมดเป็น เท็จ
parseEnvInt(undefined | string, number)	แยกวิเคราะห์ตัวแปรสภาพแวดล้อมเป็นจํานวนเต็ม ส่งกลับ fallback ถ้าไม่ถูกต้องหรือไม่ได้ตั้งค่า

รายละเอียดคอนสตรักเตอร์

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 ที่ล้มอย่างเงียบ ๆ กลับไปยังโทเค็นผู้ชมที่ไม่ถูกต้องในโหมด dev

function hasPerServerBearerToken(mcpServerName: string): boolean

พารามิเตอร์

mcpServerName

string

การส่งคืน

boolean

สืบทอดมาจาก ToolingConfiguration.hasPerServerBearerToken

parseEnvBoolean(undefined | string)

แยกวิเคราะห์ตัวแปรสภาพแวดล้อมเป็นบูลีน รู้จัก 'true', '1', 'yes', 'on' (ไม่ตรงตามตัวพิมพ์ใหญ่-เล็ก) เป็น true แต่ไม่ตรงตามตัวพิมพ์ใหญ่-เล็ก ค่าอื่นๆ ทั้งหมดเป็น เท็จ

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

พารามิเตอร์

envValue

undefined | string

การส่งคืน

boolean

สืบทอดมาจาก ToolingConfiguration.parseEnvBoolean

parseEnvInt(undefined | string, number)

แยกวิเคราะห์ตัวแปรสภาพแวดล้อมเป็นจํานวนเต็ม ส่งกลับ fallback ถ้าไม่ถูกต้องหรือไม่ได้ตั้งค่า

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

พารามิเตอร์

envValue

undefined | string

fallback

number

การส่งคืน

number

สืบทอดมาจาก ToolingConfiguration.parseEnvInt