OpenAIToolingConfiguration class

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

Configuração para o pacote de extensão de ferramentas OpenAI. Herda todas as ferramentas e definições de tempo de execução.

Porque Existe Esta Classe

Embora esta classe atualmente não adicione novas definições para além do que o ToolingConfiguration fornece, existe por várias razões importantes:

  1. Segurança de Tipos: Permite que serviços específicos da OpenAI declarem a sua dependência em IConfigurationProvider<OpenAIToolingConfiguration>, tornando o contrato de configuração explícito e permitindo a verificação em tempo de compilação.

  2. Ponto de Extensão: Fornece um local claro para adicionar definições específicas do OpenAI (por exemplo, timeouts do SDK dos Agentes, intervalos de sondagem de threads, limites de execução) sem quebrar código existente quando essas necessidades surgem.

  3. Padrão Consistente: Mantém simetria com outros pacotes de extensão (Claude, LangChain), tornando o SDK mais fácil de compreender e navegar.

  4. Injeção de Dependências: Os serviços podem ser concebidos para aceitar este tipo de configuração específico, permitindo padrões adequados de IoC e testabilidade.

Exemplo

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

Construtores

OpenAIToolingConfiguration(ToolingConfigurationOptions)

Propriedades

clusterCategory
isDevelopmentEnvironment

Se o cluster é um ambiente de desenvolvimento (local ou de desenvolvimento). Baseado no clusterCategory.
isNodeEnvDevelopment

Se NODE_ENV indica modo de desenvolvimento. Retorna verdadeiro quando NODE_ENV é 'desenvolvimento' (indistinto a maiúsculas minúsculas). Esta é a forma padrão Node.js de indicar o modo de desenvolvimento.
mcpPlatformAuthenticationScope

Recebe o âmbito de autenticação da plataforma MCP. Usado pelo AgenticAuthenticationService para troca de tokens. Corta o espaço em branco para evitar falhas na troca de tokens.
mcpPlatformEndpoint
useToolingManifest

Se devo usar o ficheiro ToolingManifest.json em vez da descoberta do gateway. Retorna verdadeiro quando NODE_ENV está definido como 'desenvolvimento' (indistinto a maiúsculas), ou quando é explicitamente sobreposto via configuração.

Métodos Herdados

getBearerTokenForServer(string)

Devolve o token portador do modo de desenvolvimento para um servidor MCP pelo nome. Verifica BEARER_TOKEN_<SERVERNAME_UPPER> primeiro, depois volta a BEARER_TOKEN. Devolve indefinido quando a variável não está definida (não será anexado cabeçalho de Autorização).
hasPerServerBearerToken(string)

Retorna verdadeiro quando um token portador por servidor env var (BEARER_TOKEN_<SERVERNAME_UPPER>) está explicitamente definido para o servidor dado, sendo falso quando apenas o recurso de BEARER_TOKEN partilhado seria usado. Usado para detetar servidores V2 que estão silenciosamente a recuar para um token de audiência errada no modo dev.
parseEnvBoolean(undefined | string)

Analisa uma variável de ambiente como uma booleana. Reconhece 'verdadeiro', '1', 'sim', 'on' (indistinto a maiúsculas) como verdadeiro; todos os outros valores são falsos.
parseEnvInt(undefined | string, number)

Analise uma variável de ambiente como um inteiro, retornando o fallback se for inválido ou não definido.

Detalhes do Construtor

OpenAIToolingConfiguration(ToolingConfigurationOptions) 

new OpenAIToolingConfiguration(overrides?: ToolingConfigurationOptions)

Parâmetros

overrides
ToolingConfigurationOptions

Detalhes de Propriedade

clusterCategory 

ClusterCategory clusterCategory

Valor de Propriedade

ClusterCategory

isDevelopmentEnvironment

Se o cluster é um ambiente de desenvolvimento (local ou de desenvolvimento). Baseado no clusterCategory.

boolean isDevelopmentEnvironment

Valor de Propriedade

boolean

isNodeEnvDevelopment

Se NODE_ENV indica modo de desenvolvimento. Retorna verdadeiro quando NODE_ENV é 'desenvolvimento' (indistinto a maiúsculas minúsculas). Esta é a forma padrão Node.js de indicar o modo de desenvolvimento.

boolean isNodeEnvDevelopment

Valor de Propriedade

boolean

mcpPlatformAuthenticationScope

Recebe o âmbito de autenticação da plataforma MCP. Usado pelo AgenticAuthenticationService para troca de tokens. Corta o espaço em branco para evitar falhas na troca de tokens.

string mcpPlatformAuthenticationScope

Valor de Propriedade

string

mcpPlatformEndpoint 

string mcpPlatformEndpoint

Valor de Propriedade

string

useToolingManifest

Se devo usar o ficheiro ToolingManifest.json em vez da descoberta do gateway. Retorna verdadeiro quando NODE_ENV está definido como 'desenvolvimento' (indistinto a maiúsculas), ou quando é explicitamente sobreposto via configuração.

boolean useToolingManifest

Valor de Propriedade

boolean

Detalhes do Método Herdado

getBearerTokenForServer(string)

Devolve o token portador do modo de desenvolvimento para um servidor MCP pelo nome. Verifica BEARER_TOKEN_<SERVERNAME_UPPER> primeiro, depois volta a BEARER_TOKEN. Devolve indefinido quando a variável não está definida (não será anexado cabeçalho de Autorização).

function getBearerTokenForServer(mcpServerName: string): undefined | string

Parâmetros

mcpServerName

string

Devoluções

undefined | string

Herdado de ToolingConfiguration.getBearerTokenForServer

hasPerServerBearerToken(string)

Retorna verdadeiro quando um token portador por servidor env var (BEARER_TOKEN_<SERVERNAME_UPPER>) está explicitamente definido para o servidor dado, sendo falso quando apenas o recurso de BEARER_TOKEN partilhado seria usado. Usado para detetar servidores V2 que estão silenciosamente a recuar para um token de audiência errada no modo dev.

function hasPerServerBearerToken(mcpServerName: string): boolean

Parâmetros

mcpServerName

string

Devoluções

boolean

Herdado de ToolingConfiguration.hasPerServerBearerToken

parseEnvBoolean(undefined | string)

Analisa uma variável de ambiente como uma booleana. Reconhece 'verdadeiro', '1', 'sim', 'on' (indistinto a maiúsculas) como verdadeiro; todos os outros valores são falsos.

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

Parâmetros

envValue

undefined | string

Devoluções

boolean

Herdado de ToolingConfiguration.parseEnvBoolean

parseEnvInt(undefined | string, number)

Analise uma variável de ambiente como um inteiro, retornando o fallback se for inválido ou não definido.

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

Parâmetros

envValue

undefined | string

fallback

number

Devoluções

number

Herdado de ToolingConfiguration.parseEnvInt