Utility class

Paket:

@microsoft/agents-a365-runtime

Verktygsklass som tillhandahåller hjälpmetoder för agentkörningsåtgärder.

Metoder

getAgentIdFromToken(string)	VARNING! INGEN SIGNATURVERIFIERING – Den här metoden använder jwt.decode() som INTE verifierar tokensignaturen. Tokenanspråken kan förfalskas av skadliga aktörer. Den här metoden är ENDAST lämplig för loggning, analys och diagnostik. Använd INTE det returnerade värdet för auktorisering, åtkomstkontroll eller säkerhetsbeslut. Avkodar token och hämtar den bästa tillgängliga agentidentifieraren. Kontrollerar anspråk i prioritetsordning: xms_par_app_azp appid > azp (agentskiss-ID>). Obs! Returnerar tom sträng för tomma/saknade token (till skillnad från GetAppIdFromToken som returnerar ett standard-GUID). På så sätt kan anropare utelämna rubriker när ingen identifierare är tillgänglig.
GetAppIdFromToken(string)	VARNING! INGEN SIGNATURVERIFIERING – Den här metoden använder jwt.decode() som INTE verifierar tokensignaturen. Tokenanspråken kan förfalskas av skadliga aktörer. Den här metoden är ENDAST lämplig för loggning, analys och diagnostik. Använd INTE det returnerade värdet för auktorisering, åtkomstkontroll eller säkerhetsbeslut. Avkodar den aktuella token och hämtar app-ID :t (appid- eller azp-anspråket). Obs! Returnerar ett standard-GUID ('00000000-0000-0000-0000-000000000000') för tomma token för bakåtkompatibilitet med anropare som förväntar sig ett giltigt GUID. För agentidentifiering där tom sträng föredras använder du getAgentIdFromToken.
getApplicationName()	Hämtar programnamnet från npm_package_name miljövariabel eller package.json. Det package.json resultatet cachelagras vid modulens inläsningstid för att undvika synkroniserings-I/O under begäranden.
GetUserAgentHeader(string)	Genererar en User-Agent huvudsträng som innehåller SDK-version, OS-typ, Node.js version och orchestrator.
ResolveAgentIdentity(TurnContext, string)	Löser agentidentiteten från turn-kontexten eller autentiseringstoken.

Metodinformation

getAgentIdFromToken(string)

VARNING! INGEN SIGNATURVERIFIERING – Den här metoden använder jwt.decode() som INTE verifierar tokensignaturen. Tokenanspråken kan förfalskas av skadliga aktörer. Den här metoden är ENDAST lämplig för loggning, analys och diagnostik. Använd INTE det returnerade värdet för auktorisering, åtkomstkontroll eller säkerhetsbeslut.

Avkodar token och hämtar den bästa tillgängliga agentidentifieraren. Kontrollerar anspråk i prioritetsordning: xms_par_app_azp appid > azp (agentskiss-ID>).

Obs! Returnerar tom sträng för tomma/saknade token (till skillnad från GetAppIdFromToken som returnerar ett standard-GUID). På så sätt kan anropare utelämna rubriker när ingen identifierare är tillgänglig.

static function getAgentIdFromToken(token: string): string

Parametrar

token

string

JWT-token att avkoda

Returer

string

Agent-ID (GUID) eller tom sträng om den inte hittas eller token är tom

GetAppIdFromToken(string)

VARNING! INGEN SIGNATURVERIFIERING – Den här metoden använder jwt.decode() som INTE verifierar tokensignaturen. Tokenanspråken kan förfalskas av skadliga aktörer. Den här metoden är ENDAST lämplig för loggning, analys och diagnostik. Använd INTE det returnerade värdet för auktorisering, åtkomstkontroll eller säkerhetsbeslut.

Avkodar den aktuella token och hämtar app-ID :t (appid- eller azp-anspråket).

Obs! Returnerar ett standard-GUID ('00000000-0000-0000-0000-000000000000') för tomma token för bakåtkompatibilitet med anropare som förväntar sig ett giltigt GUID. För agentidentifiering där tom sträng föredras använder du getAgentIdFromToken.

static function GetAppIdFromToken(token: string): string

Parametrar

token

string

Token att avkoda

Returer

string

AppId, eller standard-GUID för tom token eller tom sträng om avkodning misslyckas

getApplicationName()

Hämtar programnamnet från npm_package_name miljövariabel eller package.json. Det package.json resultatet cachelagras vid modulens inläsningstid för att undvika synkroniserings-I/O under begäranden.

static function getApplicationName(): undefined | string

Returer

undefined | string

Programnamn eller odefinierat om det inte är tillgängligt.

GetUserAgentHeader(string)

Genererar en User-Agent huvudsträng som innehåller SDK-version, OS-typ, Node.js version och orchestrator.

static function GetUserAgentHeader(orchestrator?: string): string

Parametrar

orchestrator

string

Valfri orkestreringsidentifierare som ska ingå i User-Agent strängen.

Returer

string

Formaterad User-Agent huvudsträng.

ResolveAgentIdentity(TurnContext, string)

Löser agentidentiteten från turn-kontexten eller autentiseringstoken.

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

Parametrar

context

TurnContext

Aktivera kontext för svängen.

authToken

string

Autentiseringstoken om den är tillgänglig.

Returer

string

Agentidentitet (app-ID)