Compartilhar via

Utility class

Pacote:
@microsoft/agents-a365-runtime

Classe de utilitário que fornece métodos auxiliares para operações de runtime do agente.

Métodos

getAgentIdFromToken(string)

AVISO: SEM VERIFICAÇÃO DE ASSINATURA - Esse método usa jwt.decode() que NÃO verifica a assinatura do token. As declarações de token podem ser falsificadas por atores mal-intencionados. Esse método só é adequado para fins de log, análise e diagnóstico. NÃO use o valor retornado para decisões de autorização, controle de acesso ou segurança.

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

Observação: retorna uma cadeia de caracteres vazia para tokens vazios/ausentes (ao contrário de GetAppIdFromToken , que retorna um GUID padrão). Isso permite que os chamadores omitam cabeçalhos quando nenhum identificador está disponível.
GetAppIdFromToken(string)

AVISO: SEM VERIFICAÇÃO DE ASSINATURA - Esse método usa jwt.decode() que NÃO verifica a assinatura do token. As declarações de token podem ser falsificadas por atores mal-intencionados. Esse método só é adequado para fins de log, análise e diagnóstico. NÃO use o valor retornado para decisões de autorização, controle de acesso ou segurança.

Decodifica o token atual e recupera a ID do aplicativo (declaração appid ou azp).

Observação: retorna um GUID padrão ('00000000-0000-0000-00000-00000000000') para tokens vazios para compatibilidade com versões anteriores com chamadores que esperam um GUID de aparência válida. Para identificação do agente em que a cadeia de caracteres vazia é preferencial, use getAgentIdFromToken.
getApplicationName()

Obtém o nome do aplicativo de npm_package_name variável de ambiente ou package.json. O resultado package.json é armazenado em cache no tempo de carregamento do módulo para evitar a E/S de sincronização durante as solicitações.
GetUserAgentHeader(string)

Gera uma cadeia de caracteres de cabeçalho User-Agent que contém a versão do SDK, o tipo de sistema operacional, Node.js versão e o orquestrador.
ResolveAgentIdentity(TurnContext, string)

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

Detalhes do método

getAgentIdFromToken(string)

AVISO: SEM VERIFICAÇÃO DE ASSINATURA - Esse método usa jwt.decode() que NÃO verifica a assinatura do token. As declarações de token podem ser falsificadas por atores mal-intencionados. Esse método só é adequado para fins de log, análise e diagnóstico. NÃO use o valor retornado para decisões de autorização, controle de acesso ou segurança.

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

Observação: retorna uma cadeia de caracteres vazia para tokens vazios/ausentes (ao contrário de GetAppIdFromToken , que retorna um GUID padrão). Isso permite que os chamadores omitam cabeçalhos quando nenhum identificador está disponível.

static function getAgentIdFromToken(token: string): string

Parâmetros

token

string

Token JWT a ser decodificado

Retornos

string

ID do agente (GUID) ou cadeia de caracteres vazia se não for encontrada ou o token estiver vazio

GetAppIdFromToken(string)

AVISO: SEM VERIFICAÇÃO DE ASSINATURA - Esse método usa jwt.decode() que NÃO verifica a assinatura do token. As declarações de token podem ser falsificadas por atores mal-intencionados. Esse método só é adequado para fins de log, análise e diagnóstico. NÃO use o valor retornado para decisões de autorização, controle de acesso ou segurança.

Decodifica o token atual e recupera a ID do aplicativo (declaração appid ou azp).

Observação: retorna um GUID padrão ('00000000-0000-0000-00000-00000000000') para tokens vazios para compatibilidade com versões anteriores com chamadores que esperam um GUID de aparência válida. Para identificação do agente em que a cadeia de caracteres vazia é preferencial, use getAgentIdFromToken.

static function GetAppIdFromToken(token: string): string

Parâmetros

token

string

Token a ser decodificado

Retornos

string

AppId ou GUID padrão para token vazio ou cadeia de caracteres vazia se a decodificação falhar

getApplicationName()

Obtém o nome do aplicativo de npm_package_name variável de ambiente ou package.json. O resultado package.json é armazenado em cache no tempo de carregamento do módulo para evitar a E/S de sincronização durante as solicitações.

static function getApplicationName(): undefined | string

Retornos

undefined | string

Nome do aplicativo ou indefinido se não estiver disponível.

GetUserAgentHeader(string)

Gera uma cadeia de caracteres de cabeçalho User-Agent que contém a versão do SDK, o tipo de sistema operacional, Node.js versão e o orquestrador.

static function GetUserAgentHeader(orchestrator?: string): string

Parâmetros

orchestrator

string

Identificador de orquestrador opcional a ser incluído na cadeia de caracteres User-Agent.

Retornos

string

Cadeia de caracteres de cabeçalho User-Agent formatada.

ResolveAgentIdentity(TurnContext, string)

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

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

Parâmetros

context
TurnContext

Transforme o Contexto da curva.

authToken

string

Token de autenticação, se disponível.

Retornos

string

Identidade do agente (ID do aplicativo)