Utility class

Paquete:
@microsoft/agents-a365-runtime

Clase de utilidad que proporciona métodos auxiliares para las operaciones en tiempo de ejecución del agente.

Métodos

getAgentIdFromToken(string)

ADVERTENCIA: NO SIGNATURE VERIFICATION: este método usa jwt.decode() que NO comprueba la firma del token. Los actores malintencionados pueden suplantar las notificaciones de token. Este método solo es adecuado para fines de registro, análisis y diagnóstico. No use el valor devuelto para las decisiones de autorización, control de acceso o seguridad.

Descodifica el token y recupera el mejor identificador de agente disponible. Comprueba las notificaciones en orden de prioridad: xms_par_app_azp (id. de plano técnico del agente) > appid > azp.

Nota: Devuelve una cadena vacía para tokens vacíos o que faltan (a diferencia de GetAppIdFromToken , que devuelve un GUID predeterminado). Esto permite que los autores de llamadas omitan encabezados cuando no haya ningún identificador disponible.
GetAppIdFromToken(string)

ADVERTENCIA: NO SIGNATURE VERIFICATION: este método usa jwt.decode() que NO comprueba la firma del token. Los actores malintencionados pueden suplantar las notificaciones de token. Este método solo es adecuado para fines de registro, análisis y diagnóstico. No use el valor devuelto para las decisiones de autorización, control de acceso o seguridad.

Descodifica el token actual y recupera el identificador de aplicación (appid o azp claim).

Nota: Devuelve un GUID predeterminado ('000000000-0000-0000-00000-00000000000') para tokens vacíos para la compatibilidad con versiones anteriores con los autores de llamadas que esperan un GUID de aspecto válido. Para la identificación del agente donde se prefiere la cadena vacía, use getAgentIdFromToken.
getApplicationName()

Obtiene el nombre de la aplicación de npm_package_name variable de entorno o package.json. El package.json resultado se almacena en caché en el tiempo de carga del módulo para evitar la E/S de sincronización durante las solicitudes.
GetUserAgentHeader(string)

Genera una cadena de encabezado User-Agent que contiene la versión del SDK, el tipo de sistema operativo, la versión de Node.js y el orquestador.
ResolveAgentIdentity(TurnContext, string)

Resuelve la identidad del agente desde el contexto de turno o el token de autenticación.

Detalles del método

getAgentIdFromToken(string)

ADVERTENCIA: NO SIGNATURE VERIFICATION: este método usa jwt.decode() que NO comprueba la firma del token. Los actores malintencionados pueden suplantar las notificaciones de token. Este método solo es adecuado para fines de registro, análisis y diagnóstico. No use el valor devuelto para las decisiones de autorización, control de acceso o seguridad.

Descodifica el token y recupera el mejor identificador de agente disponible. Comprueba las notificaciones en orden de prioridad: xms_par_app_azp (id. de plano técnico del agente) > appid > azp.

Nota: Devuelve una cadena vacía para tokens vacíos o que faltan (a diferencia de GetAppIdFromToken , que devuelve un GUID predeterminado). Esto permite que los autores de llamadas omitan encabezados cuando no haya ningún identificador disponible.

static function getAgentIdFromToken(token: string): string

Parámetros

token

string

Token JWT que se va a descodificar

Devoluciones

string

Id. de agente (GUID) o cadena vacía si no se encuentra o el token está vacío

GetAppIdFromToken(string)

ADVERTENCIA: NO SIGNATURE VERIFICATION: este método usa jwt.decode() que NO comprueba la firma del token. Los actores malintencionados pueden suplantar las notificaciones de token. Este método solo es adecuado para fines de registro, análisis y diagnóstico. No use el valor devuelto para las decisiones de autorización, control de acceso o seguridad.

Descodifica el token actual y recupera el identificador de aplicación (appid o azp claim).

Nota: Devuelve un GUID predeterminado ('000000000-0000-0000-00000-00000000000') para tokens vacíos para la compatibilidad con versiones anteriores con los autores de llamadas que esperan un GUID de aspecto válido. Para la identificación del agente donde se prefiere la cadena vacía, use getAgentIdFromToken.

static function GetAppIdFromToken(token: string): string

Parámetros

token

string

Token para descodificar

Devoluciones

string

AppId, o GUID predeterminado para el token vacío o cadena vacía si se produce un error en la descodificación

getApplicationName()

Obtiene el nombre de la aplicación de npm_package_name variable de entorno o package.json. El package.json resultado se almacena en caché en el tiempo de carga del módulo para evitar la E/S de sincronización durante las solicitudes.

static function getApplicationName(): undefined | string

Devoluciones

undefined | string

Nombre de aplicación o indefinido si no está disponible.

GetUserAgentHeader(string)

Genera una cadena de encabezado User-Agent que contiene la versión del SDK, el tipo de sistema operativo, la versión de Node.js y el orquestador.

static function GetUserAgentHeader(orchestrator?: string): string

Parámetros

orchestrator

string

Identificador de orquestador opcional que se va a incluir en la cadena de User-Agent.

Devoluciones

string

Cadena de encabezado User-Agent con formato.

ResolveAgentIdentity(TurnContext, string)

Resuelve la identidad del agente desde el contexto de turno o el token de autenticación.

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

Parámetros

context
TurnContext

Gire Contexto del turno.

authToken

string

Token de autenticación si está disponible.

Devoluciones

string

Identidad del agente (id. de aplicación)