OpenAIToolingConfiguration class
Configurazione per il pacchetto di estensione degli strumenti OpenAI. Eredita tutti gli strumenti e le impostazioni di runtime.
Perché questa classe esiste
Anche se questa classe attualmente non aggiunge nuove impostazioni oltre a quanto fornito da ToolingConfiguration, esiste per diversi motivi importanti:
Sicurezza dei tipi: consente ai servizi specifici di OpenAI di dichiarare la propria dipendenza da
IConfigurationProvider<OpenAIToolingConfiguration>, rendendo esplicito il contratto di configurazione e abilitando il controllo in fase di compilazione.Punto di estensione: fornisce una posizione chiara per aggiungere impostazioni specifiche di OpenAI (ad esempio, timeout di Agents SDK, intervalli di polling dei thread, limiti di esecuzione) senza interrompere il codice esistente quando si verificano tali esigenze.
Modello coerente: mantiene la simmetria con altri pacchetti di estensione (Claude, LangChain), semplificando la comprensione e l'esplorazione dell'SDK.
Inserimento delle dipendenze: i servizi possono essere progettati per accettare questo tipo di configurazione specifico, abilitando modelli IoC appropriati e testabilità.
Esempio
// 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
Proprietà
| cluster |
|
| is |
Indica se il cluster è un ambiente di sviluppo (locale o dev). Basato su clusterCategory. |
| is |
Indica se NODE_ENV indica la modalità di sviluppo. Restituisce true quando NODE_ENV è 'development' (senza distinzione tra maiuscole e minuscole). Questo è il modo standard Node.js di indicare la modalità di sviluppo. |
| mcp |
Ottiene l'ambito di autenticazione della piattaforma MCP. Usato da AgenticAuthenticationService per lo scambio di token. Taglia gli spazi vuoti per evitare errori di scambio di token. |
| mcp |
|
| use |
Indica se usare il file ToolingManifest.json anziché l'individuazione del gateway. Restituisce true quando NODE_ENV è impostato su "sviluppo" (senza distinzione tra maiuscole e minuscole) o quando viene eseguito l'override esplicito tramite la configurazione. |
Metodi ereditati
| get |
Restituisce il token di connessione in modalità dev per un server MCP in base al nome. Controlla prima BEARER_TOKEN_<SERVERNAME_UPPER> quindi esegue il fallback a BEARER_TOKEN. Restituisce undefined quando la variabile non è impostata (non verrà associata alcuna intestazione di autorizzazione). |
| has |
Restituisce true quando un token di connessione per server env var (BEARER_TOKEN_<SERVERNAME_UPPER>) viene impostato in modo esplicito per il server specificato, false quando viene usato solo il fallback condiviso BEARER_TOKEN. Usato per rilevare i server V2 che eseguono automaticamente il fallback a un token del gruppo di destinatari errato in modalità di sviluppo. |
| parse |
Analizzare una variabile di ambiente come valore booleano. Riconosce 'true', '1', 'sì', 'on' (senza distinzione tra maiuscole e minuscole) come true; tutti gli altri valori come false. |
| parse |
Analizzare una variabile di ambiente come numero intero, restituendo il fallback se non è valido o non è impostato. |
Dettagli costruttore
OpenAIToolingConfiguration(ToolingConfigurationOptions)
new OpenAIToolingConfiguration(overrides?: ToolingConfigurationOptions)Parametri
- overrides
- ToolingConfigurationOptions
Dettagli proprietà
clusterCategory
isDevelopmentEnvironment
Indica se il cluster è un ambiente di sviluppo (locale o dev). Basato su clusterCategory.
boolean isDevelopmentEnvironmentValore della proprietà
boolean
isNodeEnvDevelopment
Indica se NODE_ENV indica la modalità di sviluppo. Restituisce true quando NODE_ENV è 'development' (senza distinzione tra maiuscole e minuscole). Questo è il modo standard Node.js di indicare la modalità di sviluppo.
boolean isNodeEnvDevelopmentValore della proprietà
boolean
mcpPlatformAuthenticationScope
Ottiene l'ambito di autenticazione della piattaforma MCP. Usato da AgenticAuthenticationService per lo scambio di token. Taglia gli spazi vuoti per evitare errori di scambio di token.
string mcpPlatformAuthenticationScopeValore della proprietà
string
mcpPlatformEndpoint
string mcpPlatformEndpointValore della proprietà
string
useToolingManifest
Indica se usare il file ToolingManifest.json anziché l'individuazione del gateway. Restituisce true quando NODE_ENV è impostato su "sviluppo" (senza distinzione tra maiuscole e minuscole) o quando viene eseguito l'override esplicito tramite la configurazione.
boolean useToolingManifestValore della proprietà
boolean
Dettagli dei metodi ereditati
getBearerTokenForServer(string)
Restituisce il token di connessione in modalità dev per un server MCP in base al nome. Controlla prima BEARER_TOKEN_<SERVERNAME_UPPER> quindi esegue il fallback a BEARER_TOKEN. Restituisce undefined quando la variabile non è impostata (non verrà associata alcuna intestazione di autorizzazione).
function getBearerTokenForServer(mcpServerName: string): undefined | stringParametri
- mcpServerName
-
string
Valori restituiti
undefined | string
Ereditato da ToolingConfiguration.getBearerTokenForServer
hasPerServerBearerToken(string)
Restituisce true quando un token di connessione per server env var (BEARER_TOKEN_<SERVERNAME_UPPER>) viene impostato in modo esplicito per il server specificato, false quando viene usato solo il fallback condiviso BEARER_TOKEN. Usato per rilevare i server V2 che eseguono automaticamente il fallback a un token del gruppo di destinatari errato in modalità di sviluppo.
function hasPerServerBearerToken(mcpServerName: string): booleanParametri
- mcpServerName
-
string
Valori restituiti
boolean
Ereditato da ToolingConfiguration.hasPerServerBearerToken
parseEnvBoolean(undefined | string)
Analizzare una variabile di ambiente come valore booleano. Riconosce 'true', '1', 'sì', 'on' (senza distinzione tra maiuscole e minuscole) come true; tutti gli altri valori come false.
static function parseEnvBoolean(envValue: undefined | string): booleanParametri
- envValue
-
undefined | string
Valori restituiti
boolean
Ereditato da ToolingConfiguration.parseEnvBoolean
parseEnvInt(undefined | string, number)
Analizzare una variabile di ambiente come numero intero, restituendo il fallback se non è valido o non è impostato.
static function parseEnvInt(envValue: undefined | string, fallback: number): numberParametri
- envValue
-
undefined | string
- fallback
-
number
Valori restituiti
number
Ereditato da ToolingConfiguration.parseEnvInt