Utility class

Pacote:
@microsoft/agents-a365-runtime

Classe utilitária que fornece métodos auxiliares para operações em tempo de execução do agente.

Métodos

getAgentIdFromToken(string)

AVISO: SEM VERIFICAÇÃO DE ASSINATURA - Este método usa jwt.decode(), que NÃO verifica a assinatura do token. As reivindicações do token podem ser falsificadas por agentes maliciosos. Este método é APENAS adequado para registos, análises e diagnósticos. NÃO utilize o valor devolvido para autorização, controlo de acesso ou decisões de segurança.

Descodifica o token e recupera o melhor identificador de agente disponível. Verifica as reclamações por ordem de prioridade: xms_par_app_azp (ID blueprint do agente) > appid > azp.

Nota: Devolve uma string vazia para tokens vazios/em falta (ao contrário do GetAppIdFromToken que devolve um GUID por defeito). Isto permite que os chamadores omitam cabeçalhos quando não há identificador disponível.
GetAppIdFromToken(string)

AVISO: SEM VERIFICAÇÃO DE ASSINATURA - Este método usa jwt.decode(), que NÃO verifica a assinatura do token. As reivindicações do token podem ser falsificadas por agentes maliciosos. Este método é APENAS adequado para registos, análises e diagnósticos. NÃO utilize o valor devolvido para autorização, controlo de acesso ou decisões de segurança.

Descodifica o token atual e recupera o ID da App (reivindicação appid ou azp).

Nota: Devolve um GUID predefinido ('00000000-0000-0000-00000-000000000000') para tokens vazios para compatibilidade retroativa com chamadores que esperam um GUID com aparência válida. Para identificação de agentes onde a string vazia é preferida, use getAgentIdFromToken.
getApplicationName()

Obtém o nome da aplicação de npm_package_name variável de ambiente ou package.json. O resultado package.json é armazenado em cache no momento de carregamento do módulo para evitar a sincronização de I/O durante os pedidos.
GetUserAgentHeader(string)

Gera uma cadeia de cabeçalhos User-Agent contendo a versão do SDK, o tipo de sistema operativo, Node.js versão e o orquestrador.
ResolveAgentIdentity(TurnContext, string)

Resolve a identidade do agente a partir do contexto do turno ou token de autenticação.

Detalhes de Método

getAgentIdFromToken(string)

AVISO: SEM VERIFICAÇÃO DE ASSINATURA - Este método usa jwt.decode(), que NÃO verifica a assinatura do token. As reivindicações do token podem ser falsificadas por agentes maliciosos. Este método é APENAS adequado para registos, análises e diagnósticos. NÃO utilize o valor devolvido para autorização, controlo de acesso ou decisões de segurança.

Descodifica o token e recupera o melhor identificador de agente disponível. Verifica as reclamações por ordem de prioridade: xms_par_app_azp (ID blueprint do agente) > appid > azp.

Nota: Devolve uma string vazia para tokens vazios/em falta (ao contrário do GetAppIdFromToken que devolve um GUID por defeito). Isto permite que os chamadores omitam cabeçalhos quando não há identificador disponível.

static function getAgentIdFromToken(token: string): string

Parâmetros

token

string

Token JWT para decodificação

Devoluções

string

ID do agente (GUID) ou string vazio se não for encontrado ou token estiver vazio

GetAppIdFromToken(string)

AVISO: SEM VERIFICAÇÃO DE ASSINATURA - Este método usa jwt.decode(), que NÃO verifica a assinatura do token. As reivindicações do token podem ser falsificadas por agentes maliciosos. Este método é APENAS adequado para registos, análises e diagnósticos. NÃO utilize o valor devolvido para autorização, controlo de acesso ou decisões de segurança.

Descodifica o token atual e recupera o ID da App (reivindicação appid ou azp).

Nota: Devolve um GUID predefinido ('00000000-0000-0000-00000-000000000000') para tokens vazios para compatibilidade retroativa com chamadores que esperam um GUID com aparência válida. Para identificação de agentes onde a string vazia é preferida, use getAgentIdFromToken.

static function GetAppIdFromToken(token: string): string

Parâmetros

token

string

Token para Decodificar

Devoluções

string

AppId, ou GUID por defeito para token vazio, ou string vazia se a decodificação falhar

getApplicationName()

Obtém o nome da aplicação de npm_package_name variável de ambiente ou package.json. O resultado package.json é armazenado em cache no momento de carregamento do módulo para evitar a sincronização de I/O durante os pedidos.

static function getApplicationName(): undefined | string

Devoluções

undefined | string

Nome da aplicação ou indefinido se não estiver disponível.

GetUserAgentHeader(string)

Gera uma cadeia de cabeçalhos User-Agent contendo a versão do SDK, o tipo de sistema operativo, Node.js versão e o orquestrador.

static function GetUserAgentHeader(orchestrator?: string): string

Parâmetros

orchestrator

string

Identificador de orquestrador opcional para incluir na User-Agent string.

Devoluções

string

String de cabeçalho User-Agent formatado.

ResolveAgentIdentity(TurnContext, string)

Resolve a identidade do agente a partir do contexto do turno ou token de autenticação.

static function ResolveAgentIdentity(context: TurnContext, authToken: string): string

Parâmetros

context
TurnContext

Contexto do turno do turno.

authToken

string

Token de autenticação se disponível.

Devoluções

string

Identidade do agente (ID da aplicação)