Freigeben über


OpenAIToolingConfiguration class

Konfiguration für OpenAI-Toolerweiterungspaket. Erbt alle Tools und Laufzeiteinstellungen.

Warum diese Klasse vorhanden ist

Obwohl diese Klasse derzeit keine neuen Einstellungen hinzufügt, die über die von ToolingConfiguration bereitgestellt werden, gibt es aus mehreren wichtigen Gründen:

  1. Typsicherheit: Ermöglicht OpenAI-spezifischen Diensten, ihre Abhängigkeit IConfigurationProvider<OpenAIToolingConfiguration>zu deklarieren, wodurch der Konfigurationsvertrag explizit festgelegt und die Kompilierungszeitüberprüfung aktiviert wird.

  2. Erweiterungspunkt: Stellt einen klaren Ort zum Hinzufügen von OpenAI-spezifischen Einstellungen (z. B. Agents SDK-Timeouts, Threadabfragungsintervalle, Ausführungsgrenzwerte) bereit, ohne vorhandenen Code zu unterbrechen, wenn diese Anforderungen auftreten.

  3. Konsistentes Muster: Behält die Symmetrie mit anderen Erweiterungspaketen (Claude, LangChain) bei, wodurch das SDK einfacher zu verstehen und zu navigieren ist.

  4. Abhängigkeitsinjektion: Dienste können so konzipiert werden, dass sie diesen spezifischen Konfigurationstyp akzeptieren und die ordnungsgemäße IoC-Muster und Testbarkeit ermöglichen.

Beispiel

// 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

Eigenschaften

clusterCategory
isDevelopmentEnvironment

Ob es sich bei dem Cluster um eine Entwicklungsumgebung (lokal oder dev) handelt. Basierend auf clusterCategory.

isNodeEnvDevelopment

Gibt an, ob NODE_ENV den Entwicklungsmodus angibt. Gibt true zurück, wenn NODE_ENV "Development" ist (Groß-/Kleinschreibung wird nicht beachtet). Dies ist die Standard-Node.js Möglichkeit, den Entwicklungsmodus anzugeben.

mcpPlatformAuthenticationScope

Ruft den Authentifizierungsbereich der MCP-Plattform ab. Wird von AgenticAuthenticationService für den Tokenaustausch verwendet. Kürzet Leerzeichen, um Tokenaustauschfehler zu verhindern.

mcpPlatformEndpoint
useToolingManifest

Gibt an, ob die ToolingManifest.json-Datei anstelle der Gatewayermittlung verwendet werden soll. Gibt "true" zurück, wenn NODE_ENV auf "Development" (Groß-/Kleinschreibung) festgelegt ist oder wenn dies explizit über die Konfiguration außer Kraft gesetzt wird.

Geerbte Methoden

parseEnvBoolean(undefined | string)

Analysieren Sie eine Umgebungsvariable als booleschen Wert. Erkennt 'true', '1', 'yes', 'on' (Groß-/Kleinschreibung) als wahr; alle anderen Werte als "false".

parseEnvInt(undefined | string, number)

Analysieren Sie eine Umgebungsvariable als ganze Zahl, und geben Sie Fallback zurück, wenn ungültig oder nicht festgelegt.

Details zum Konstruktor

OpenAIToolingConfiguration(ToolingConfigurationOptions)

new OpenAIToolingConfiguration(overrides?: ToolingConfigurationOptions)

Parameter

Details zur Eigenschaft

clusterCategory

ClusterCategory clusterCategory

Eigenschaftswert

isDevelopmentEnvironment

Ob es sich bei dem Cluster um eine Entwicklungsumgebung (lokal oder dev) handelt. Basierend auf clusterCategory.

boolean isDevelopmentEnvironment

Eigenschaftswert

boolean

isNodeEnvDevelopment

Gibt an, ob NODE_ENV den Entwicklungsmodus angibt. Gibt true zurück, wenn NODE_ENV "Development" ist (Groß-/Kleinschreibung wird nicht beachtet). Dies ist die Standard-Node.js Möglichkeit, den Entwicklungsmodus anzugeben.

boolean isNodeEnvDevelopment

Eigenschaftswert

boolean

mcpPlatformAuthenticationScope

Ruft den Authentifizierungsbereich der MCP-Plattform ab. Wird von AgenticAuthenticationService für den Tokenaustausch verwendet. Kürzet Leerzeichen, um Tokenaustauschfehler zu verhindern.

string mcpPlatformAuthenticationScope

Eigenschaftswert

string

mcpPlatformEndpoint

string mcpPlatformEndpoint

Eigenschaftswert

string

useToolingManifest

Gibt an, ob die ToolingManifest.json-Datei anstelle der Gatewayermittlung verwendet werden soll. Gibt "true" zurück, wenn NODE_ENV auf "Development" (Groß-/Kleinschreibung) festgelegt ist oder wenn dies explizit über die Konfiguration außer Kraft gesetzt wird.

boolean useToolingManifest

Eigenschaftswert

boolean

Details zur geerbten Methode

parseEnvBoolean(undefined | string)

Analysieren Sie eine Umgebungsvariable als booleschen Wert. Erkennt 'true', '1', 'yes', 'on' (Groß-/Kleinschreibung) als wahr; alle anderen Werte als "false".

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

Parameter

envValue

undefined | string

Gibt zurück

boolean

Geerbt von ToolingConfiguration.parseEnvBoolean

parseEnvInt(undefined | string, number)

Analysieren Sie eine Umgebungsvariable als ganze Zahl, und geben Sie Fallback zurück, wenn ungültig oder nicht festgelegt.

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

Parameter

envValue

undefined | string

fallback

number

Gibt zurück

number

Geerbt von ToolingConfiguration.parseEnvInt