OpenAIToolingConfiguration class

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

Konfiguracja pakietu rozszerzenia narzędzi OpenAI. Dziedziczy wszystkie ustawienia narzędzi i środowiska uruchomieniowego.

Dlaczego ta klasa istnieje

Mimo że ta klasa obecnie nie dodaje nowych ustawień poza tym, co zapewnia narzędzie ToolingConfiguration, istnieje z kilku ważnych powodów:

  1. Bezpieczeństwo typu: umożliwia usługom specyficznym dla interfejsu OpenAI deklarowanie zależności od IConfigurationProvider<OpenAIToolingConfiguration>programu , dzięki czemu kontrakt konfiguracji jest jawny i włącza sprawdzanie czasu kompilacji.

  2. Punkt rozszerzenia: zapewnia jasne miejsce do dodawania ustawień specyficznych dla interfejsu OpenAI (np. limitów czasu zestawu SDK agentów, interwałów sondowania wątków, limitów uruchamiania) bez przerywania istniejącego kodu w razie wystąpienia tych potrzeb.

  3. Spójny wzorzec: utrzymuje symetrię z innymi pakietami rozszerzeń (Claude, LangChain), co ułatwia zrozumienie i nawigowanie po zestawie SDK.

  4. Wstrzykiwanie zależności: usługi można zaprojektować tak, aby akceptowały ten konkretny typ konfiguracji, umożliwiając prawidłowe wzorce IoC i możliwość testowania.

Przykład

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

Konstruktory

OpenAIToolingConfiguration(ToolingConfigurationOptions)

Właściwości

clusterCategory
isDevelopmentEnvironment

Niezależnie od tego, czy klaster jest środowiskiem deweloperskim (lokalnym lub deweloperem). Na podstawie klastraCategory.
isNodeEnvDevelopment

Czy NODE_ENV wskazuje tryb programowania. Zwraca wartość true, gdy NODE_ENV to "programowanie" (bez uwzględniania wielkości liter). Jest to standardowy Node.js sposób wskazywania trybu programowania.
mcpPlatformAuthenticationScope

Pobiera zakres uwierzytelniania platformy MCP. Używany przez agenticAuthenticationService do wymiany tokenów. Przycina białe znaki, aby zapobiec niepowodzeniu wymiany tokenów.
mcpPlatformEndpoint
useToolingManifest

Czy należy używać pliku ToolingManifest.json zamiast odnajdywania bramy. Zwraca wartość true, gdy NODE_ENV jest ustawiona na wartość "programowanie" (bez uwzględniania wielkości liter) lub w przypadku jawnego zastąpienia za pomocą konfiguracji.

Metody dziedziczone

getBearerTokenForServer(string)

Zwraca token elementu nośnego trybu deweloperskiego dla serwera MCP według nazwy. Najpierw sprawdza BEARER_TOKEN_<SERVERNAME_UPPER> , a następnie wraca do BEARER_TOKEN. Zwraca wartość niezdefiniowaną, gdy zmienna nie jest ustawiona (nie zostanie dołączony nagłówek autoryzacji).
hasPerServerBearerToken(string)

Zwraca wartość true, gdy dla danego serwera jest jawnie ustawiana wartość wariancja tokenu elementu nośnego serwera (BEARER_TOKEN_<SERVERNAME_UPPER>), wartość false, gdy będzie używany tylko udostępniony BEARER_TOKEN rezerwowy. Służy do wykrywania serwerów w wersji 2, które dyskretnie wracają do nieprawidłowego tokenu odbiorców w trybie deweloperskim.
parseEnvBoolean(undefined | string)

Przeanalizuj zmienną środowiskową jako wartość logiczną. Rozpoznaje wartość "true", "1", "yes", "on" (bez uwzględniania wielkości liter) jako true; wszystkie inne wartości jako false.
parseEnvInt(undefined | string, number)

Przeanalizuj zmienną środowiskową jako liczbę całkowitą, zwracając rezerwową, jeśli jest ona nieprawidłowa lub nie jest ustawiona.

Szczegóły konstruktora

OpenAIToolingConfiguration(ToolingConfigurationOptions) 

new OpenAIToolingConfiguration(overrides?: ToolingConfigurationOptions)

Parametry

overrides
ToolingConfigurationOptions

Szczegóły właściwości

clusterCategory 

ClusterCategory clusterCategory

Wartość właściwości

ClusterCategory

isDevelopmentEnvironment

Niezależnie od tego, czy klaster jest środowiskiem deweloperskim (lokalnym lub deweloperem). Na podstawie klastraCategory.

boolean isDevelopmentEnvironment

Wartość właściwości

boolean

isNodeEnvDevelopment

Czy NODE_ENV wskazuje tryb programowania. Zwraca wartość true, gdy NODE_ENV to "programowanie" (bez uwzględniania wielkości liter). Jest to standardowy Node.js sposób wskazywania trybu programowania.

boolean isNodeEnvDevelopment

Wartość właściwości

boolean

mcpPlatformAuthenticationScope

Pobiera zakres uwierzytelniania platformy MCP. Używany przez agenticAuthenticationService do wymiany tokenów. Przycina białe znaki, aby zapobiec niepowodzeniu wymiany tokenów.

string mcpPlatformAuthenticationScope

Wartość właściwości

string

mcpPlatformEndpoint 

string mcpPlatformEndpoint

Wartość właściwości

string

useToolingManifest

Czy należy używać pliku ToolingManifest.json zamiast odnajdywania bramy. Zwraca wartość true, gdy NODE_ENV jest ustawiona na wartość "programowanie" (bez uwzględniania wielkości liter) lub w przypadku jawnego zastąpienia za pomocą konfiguracji.

boolean useToolingManifest

Wartość właściwości

boolean

Szczegóły metody dziedziczonej

getBearerTokenForServer(string)

Zwraca token elementu nośnego trybu deweloperskiego dla serwera MCP według nazwy. Najpierw sprawdza BEARER_TOKEN_<SERVERNAME_UPPER> , a następnie wraca do BEARER_TOKEN. Zwraca wartość niezdefiniowaną, gdy zmienna nie jest ustawiona (nie zostanie dołączony nagłówek autoryzacji).

function getBearerTokenForServer(mcpServerName: string): undefined | string

Parametry

mcpServerName

string

Zwraca

undefined | string

Dziedziczone z ToolingConfiguration.getBearerTokenForServer

hasPerServerBearerToken(string)

Zwraca wartość true, gdy dla danego serwera jest jawnie ustawiana wartość wariancja tokenu elementu nośnego serwera (BEARER_TOKEN_<SERVERNAME_UPPER>), wartość false, gdy będzie używany tylko udostępniony BEARER_TOKEN rezerwowy. Służy do wykrywania serwerów w wersji 2, które dyskretnie wracają do nieprawidłowego tokenu odbiorców w trybie deweloperskim.

function hasPerServerBearerToken(mcpServerName: string): boolean

Parametry

mcpServerName

string

Zwraca

boolean

Dziedziczone z ToolingConfiguration.hasPerServerBearerToken

parseEnvBoolean(undefined | string)

Przeanalizuj zmienną środowiskową jako wartość logiczną. Rozpoznaje wartość "true", "1", "yes", "on" (bez uwzględniania wielkości liter) jako true; wszystkie inne wartości jako false.

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

Parametry

envValue

undefined | string

Zwraca

boolean

Dziedziczone z ToolingConfiguration.parseEnvBoolean

parseEnvInt(undefined | string, number)

Przeanalizuj zmienną środowiskową jako liczbę całkowitą, zwracając rezerwową, jeśli jest ona nieprawidłowa lub nie jest ustawiona.

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

Parametry

envValue

undefined | string

fallback

number

Zwraca

number

Dziedziczone z ToolingConfiguration.parseEnvInt