OpenAIToolingConfiguration class

Pakket:

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

Configuratie voor openAI-extensiepakket. Neemt alle hulpprogramma's en runtime-instellingen over.

Waarom deze klasse bestaat

Hoewel deze klasse momenteel geen nieuwe instellingen toevoegt buiten wat ToolingConfiguration biedt, bestaat deze om verschillende belangrijke redenen:

1. Type Veiligheid: Hiermee kunnen OpenAI-specifieke services hun afhankelijkheid IConfigurationProvider<OpenAIToolingConfiguration>declareren, waardoor het configuratiecontract expliciet is en compileertijdcontrole mogelijk maakt.

2. Uitbreidingspunt: Biedt een duidelijke plaats om openAI-specifieke instellingen toe te voegen (bijvoorbeeld time-outs voor agents-SDK's, pollingintervallen voor threads, uitvoeringslimieten) zonder dat bestaande code wordt onderbroken wanneer deze nodig zijn.

3. Consistent patroon: onderhoudt symmetrie met andere extensiepakketten (Claude, LangChain), waardoor de SDK gemakkelijker te begrijpen en navigeren.

4. Afhankelijkheidsinjectie: Services kunnen worden ontworpen om dit specifieke configuratietype te accepteren, waardoor de juiste IoC-patronen en testbaarheid mogelijk zijn.

Voorbeeld

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

Uitbreiding

ToolingConfiguration

Constructors

OpenAIToolingConfiguration(ToolingConfigurationOptions)

Eigenschappen

clusterCategory
isDevelopmentEnvironment	Of het cluster nu een ontwikkelomgeving is (lokaal of dev). Op basis van clusterCategory.
isNodeEnvDevelopment	Of NODE_ENV de ontwikkelingsmodus aangeeft. Retourneert waar wanneer NODE_ENV 'ontwikkeling' is (hoofdlettergevoelig). Dit is de standaard-Node.js manier om de ontwikkelingsmodus aan te geven.
mcpPlatformAuthenticationScope	Hiermee haalt u het verificatiebereik van het MCP-platform op. Wordt gebruikt door AgenticAuthenticationService voor tokenuitwisseling. Trimt witruimte om te voorkomen dat tokenuitwisselingsfouten optreden.
mcpPlatformEndpoint
useToolingManifest	Of u het ToolingManifest.json-bestand wilt gebruiken in plaats van gatewaydetectie. Retourneert waar wanneer NODE_ENV is ingesteld op 'ontwikkeling' (hoofdlettergevoelig) of wanneer deze expliciet wordt overschreven via de configuratie.

Overgenomen methoden

getBearerTokenForServer(string)	Retourneert het bearer-token in de dev-modus voor een MCP-server op naam. Controleert eerst BEARER_TOKEN_<SERVERNAME_UPPER> en valt vervolgens terug op BEARER_TOKEN. Retourneert niet-gedefinieerd wanneer de variabele niet is ingesteld (er wordt geen autorisatieheader gekoppeld).
hasPerServerBearerToken(string)	Retourneert waar wanneer een bearer-token per server (BEARER_TOKEN_<SERVERNAME_UPPER>) expliciet is ingesteld voor de opgegeven server, onwaar wanneer alleen de gedeelde BEARER_TOKEN terugval zou worden gebruikt. Wordt gebruikt om V2-servers te detecteren die op de achtergrond terugvallen op een token met een verkeerde doelgroep in de ontwikkelmodus.
parseEnvBoolean(undefined | string)	Parseert een omgevingsvariabele als een Booleaanse waarde. Herkent 'true', '1', 'yes', 'on' (hoofdlettergevoelig) als waar; alle andere waarden als onwaar.
parseEnvInt(undefined | string, number)	Parseer een omgevingsvariabele als geheel getal en retourneert terugval als deze ongeldig is of niet is ingesteld.

Constructordetails

OpenAIToolingConfiguration(ToolingConfigurationOptions)

new OpenAIToolingConfiguration(overrides?: ToolingConfigurationOptions)

Parameters

overrides

ToolingConfigurationOptions

Eigenschapdetails

clusterCategory

ClusterCategory clusterCategory

Waarde van eigenschap

ClusterCategory

isDevelopmentEnvironment

Of het cluster nu een ontwikkelomgeving is (lokaal of dev). Op basis van clusterCategory.

boolean isDevelopmentEnvironment

Waarde van eigenschap

boolean

isNodeEnvDevelopment

Of NODE_ENV de ontwikkelingsmodus aangeeft. Retourneert waar wanneer NODE_ENV 'ontwikkeling' is (hoofdlettergevoelig). Dit is de standaard-Node.js manier om de ontwikkelingsmodus aan te geven.

boolean isNodeEnvDevelopment

Waarde van eigenschap

boolean

mcpPlatformAuthenticationScope

Hiermee haalt u het verificatiebereik van het MCP-platform op. Wordt gebruikt door AgenticAuthenticationService voor tokenuitwisseling. Trimt witruimte om te voorkomen dat tokenuitwisselingsfouten optreden.

string mcpPlatformAuthenticationScope

Waarde van eigenschap

string

mcpPlatformEndpoint

string mcpPlatformEndpoint

Waarde van eigenschap

string

useToolingManifest

Of u het ToolingManifest.json-bestand wilt gebruiken in plaats van gatewaydetectie. Retourneert waar wanneer NODE_ENV is ingesteld op 'ontwikkeling' (hoofdlettergevoelig) of wanneer deze expliciet wordt overschreven via de configuratie.

boolean useToolingManifest

Waarde van eigenschap

boolean

Details overgenomen methode

getBearerTokenForServer(string)

Retourneert het bearer-token in de dev-modus voor een MCP-server op naam. Controleert eerst BEARER_TOKEN_<SERVERNAME_UPPER> en valt vervolgens terug op BEARER_TOKEN. Retourneert niet-gedefinieerd wanneer de variabele niet is ingesteld (er wordt geen autorisatieheader gekoppeld).

function getBearerTokenForServer(mcpServerName: string): undefined | string

Parameters

mcpServerName

string

Retouren

undefined | string

Overgenomen van ToolingConfiguration.getBearerTokenForServer

hasPerServerBearerToken(string)

Retourneert waar wanneer een bearer-token per server (BEARER_TOKEN_<SERVERNAME_UPPER>) expliciet is ingesteld voor de opgegeven server, onwaar wanneer alleen de gedeelde BEARER_TOKEN terugval zou worden gebruikt. Wordt gebruikt om V2-servers te detecteren die op de achtergrond terugvallen op een token met een verkeerde doelgroep in de ontwikkelmodus.

function hasPerServerBearerToken(mcpServerName: string): boolean

Parameters

mcpServerName

string

Retouren

boolean

Overgenomen van ToolingConfiguration.hasPerServerBearerToken

parseEnvBoolean(undefined | string)

Parseert een omgevingsvariabele als een Booleaanse waarde. Herkent 'true', '1', 'yes', 'on' (hoofdlettergevoelig) als waar; alle andere waarden als onwaar.

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

Parameters

envValue

undefined | string

Retouren

boolean

Overgenomen van ToolingConfiguration.parseEnvBoolean

parseEnvInt(undefined | string, number)

Parseer een omgevingsvariabele als geheel getal en retourneert terugval als deze ongeldig is of niet is ingesteld.

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

Parameters

envValue

undefined | string

fallback

number

Retouren

number

Overgenomen van ToolingConfiguration.parseEnvInt