OpenAIToolingConfiguration class

Paket:

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

OpenAI araç uzantısı paketi için yapılandırma. Tüm araç ve çalışma zamanı ayarlarını devralır.

Bu Sınıfın Neden Var Olduğu

Bu sınıf şu anda ToolingConfiguration'ın sağladığının ötesinde yeni ayar eklemese de, birkaç önemli nedenden dolayı mevcuttur:

1. Tür Güvenliği: OpenAI'ye özgü hizmetlerin bağımlılıklarını IConfigurationProvider<OpenAIToolingConfiguration>bildirmesine izin verir ve yapılandırma sözleşmesini açık hale getirir ve derleme zamanı denetimini etkinleştirir.

2. Uzantı Noktası: Bu gereksinimler ortaya çıktığında mevcut kodu bozmadan OpenAI'ye özgü ayarları (örneğin Aracılar SDK zaman aşımları, iş parçacığı yoklama aralıkları, çalıştırma sınırları) eklemek için net bir yer sağlar.

3. Tutarlı Desen: Diğer uzantı paketleriyle (Claude, LangChain) simetriyi korur ve SDK'nın anlaşılmasını ve gezinmesini kolaylaştırır.

4. Bağımlılık Ekleme: Hizmetler bu özel yapılandırma türünü kabul etmek için tasarlanabilir ve uygun IoC desenleri ve test edilebilirliği sağlar.

Örnek

// 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 { ... }
}

Extends

ToolingConfiguration

Oluşturucular

OpenAIToolingConfiguration(ToolingConfigurationOptions)

Özellikler

clusterCategory
isDevelopmentEnvironment	Kümenin bir geliştirme ortamı (yerel veya geliştirme) olup olmadığı. clusterCategory'ye göre.
isNodeEnvDevelopment	NODE_ENV geliştirme modunu gösterir. NODE_ENV 'geliştirme' (büyük/küçük harfe duyarsız) olduğunda true döndürür. Bu, geliştirme modunu göstermenin standart Node.js yoludur.
mcpPlatformAuthenticationScope	MCP platformu kimlik doğrulama kapsamını alır. AgenticAuthenticationService tarafından belirteç değişimi için kullanılır. Belirteç değişimi hatalarını önlemek için boşluğu kırpıyor.
mcpPlatformEndpoint
useToolingManifest	Ağ geçidi bulma yerine ToolingManifest.json dosyasının kullanılıp kullanılmaymayacağı. NODE_ENV 'geliştirme' (büyük/küçük harfe duyarsız) olarak ayarlandığında veya yapılandırma aracılığıyla açıkça geçersiz kılındığında true döndürür.

Devralınan Yöntemler

getBearerTokenForServer(string)	Bir MCP sunucusu için ada göre geliştirme modu taşıyıcı belirtecini döndürür. önce BEARER_TOKEN_< denetler SERVERNAME_UPPER> sonra BEARER_TOKEN geri döner. Değişken ayarlanmadığında tanımsız döndürür (Yetkilendirme üst bilgisi eklenmez).
hasPerServerBearerToken(string)	Sunucu başına taşıyıcı belirteci env var (BEARER_TOKEN_<SERVERNAME_UPPER>) belirtilen sunucu için açıkça ayarlandığında true, yalnızca paylaşılan BEARER_TOKEN geri dönüş kullanılırken false döndürür. Geliştirme modunda sessizce yanlış hedef kitle belirtecine geri dönen V2 sunucularını algılamak için kullanılır.
parseEnvBoolean(undefined | string)	Ortam değişkenlerini boole olarak ayrıştırma. 'true', '1', 'yes', 'on' (büyük/küçük harfe duyarsız) değerini true olarak tanır; diğer tüm değerler false olarak ayarlanır.
parseEnvInt(undefined | string, number)	Ortam değişkenini tamsayı olarak ayrıştırarak geçersizse veya ayarlanmadıysa geri dönüş döndürün.

Oluşturucu Ayrıntıları

OpenAIToolingConfiguration(ToolingConfigurationOptions)

new OpenAIToolingConfiguration(overrides?: ToolingConfigurationOptions)

Parametreler

overrides

ToolingConfigurationOptions

Özellik Ayrıntıları

clusterCategory

ClusterCategory clusterCategory

Özellik Değeri

ClusterCategory

isDevelopmentEnvironment

Kümenin bir geliştirme ortamı (yerel veya geliştirme) olup olmadığı. clusterCategory'ye göre.

boolean isDevelopmentEnvironment

Özellik Değeri

boolean

isNodeEnvDevelopment

NODE_ENV geliştirme modunu gösterir. NODE_ENV 'geliştirme' (büyük/küçük harfe duyarsız) olduğunda true döndürür. Bu, geliştirme modunu göstermenin standart Node.js yoludur.

boolean isNodeEnvDevelopment

Özellik Değeri

boolean

mcpPlatformAuthenticationScope

MCP platformu kimlik doğrulama kapsamını alır. AgenticAuthenticationService tarafından belirteç değişimi için kullanılır. Belirteç değişimi hatalarını önlemek için boşluğu kırpıyor.

string mcpPlatformAuthenticationScope

Özellik Değeri

string

mcpPlatformEndpoint

string mcpPlatformEndpoint

Özellik Değeri

string

useToolingManifest

Ağ geçidi bulma yerine ToolingManifest.json dosyasının kullanılıp kullanılmaymayacağı. NODE_ENV 'geliştirme' (büyük/küçük harfe duyarsız) olarak ayarlandığında veya yapılandırma aracılığıyla açıkça geçersiz kılındığında true döndürür.

boolean useToolingManifest

Özellik Değeri

boolean

Devralınan Yöntemin Ayrıntıları

getBearerTokenForServer(string)

Bir MCP sunucusu için ada göre geliştirme modu taşıyıcı belirtecini döndürür. önce BEARER_TOKEN_< denetler SERVERNAME_UPPER> sonra BEARER_TOKEN geri döner. Değişken ayarlanmadığında tanımsız döndürür (Yetkilendirme üst bilgisi eklenmez).

function getBearerTokenForServer(mcpServerName: string): undefined | string

Parametreler

mcpServerName

string

Döndürülenler

undefined | string

Devralınan ToolingConfiguration.getBearerTokenForServer

hasPerServerBearerToken(string)

Sunucu başına taşıyıcı belirteci env var (BEARER_TOKEN_<SERVERNAME_UPPER>) belirtilen sunucu için açıkça ayarlandığında true, yalnızca paylaşılan BEARER_TOKEN geri dönüş kullanılırken false döndürür. Geliştirme modunda sessizce yanlış hedef kitle belirtecine geri dönen V2 sunucularını algılamak için kullanılır.

function hasPerServerBearerToken(mcpServerName: string): boolean

Parametreler

mcpServerName

string

Döndürülenler

boolean

Devralınan ToolingConfiguration.hasPerServerBearerToken

parseEnvBoolean(undefined | string)

Ortam değişkenlerini boole olarak ayrıştırma. 'true', '1', 'yes', 'on' (büyük/küçük harfe duyarsız) değerini true olarak tanır; diğer tüm değerler false olarak ayarlanır.

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

Parametreler

envValue

undefined | string

Döndürülenler

boolean

Devralınan ToolingConfiguration.parseEnvBoolean

parseEnvInt(undefined | string, number)

Ortam değişkenini tamsayı olarak ayrıştırarak geçersizse veya ayarlanmadıysa geri dönüş döndürün.

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

Parametreler

envValue

undefined | string

fallback

number

Döndürülenler

number

Devralınan ToolingConfiguration.parseEnvInt