Utility class

Pakke:

@microsoft/agents-a365-runtime

Utility class, der leverer hjælpemetoder til agent runtime-handlinger.

Metoder

getAgentIdFromToken(string)	ADVARSEL! INGEN SIGNATURBEKRÆFTELSE – Denne metode bruger jwt.decode(), som IKKE bekræfter tokensignaturen. Tokenkravene kan forfalskes af ondsindede skuespillere. Denne metode er KUN egnet til logføring, analyse og diagnosticering. Brug IKKE den returnerede værdi til godkendelse, adgangskontrol eller sikkerhedsbeslutninger. Afkoder tokenet og henter det bedste tilgængelige agent-id. Kontrollerer krav i prioritetsrækkefølge: xms_par_app_azp (agent blueprint ID) > appid > azp. Bemærk! Returnerer en tom streng for tomme/manglende tokens (i modsætning til GetAppIdFromToken , der returnerer et standard-GUID). Dette gør det muligt for kaldere at udelade headere, når der ikke er noget id tilgængeligt.
GetAppIdFromToken(string)	ADVARSEL! INGEN SIGNATURBEKRÆFTELSE – Denne metode bruger jwt.decode(), som IKKE bekræfter tokensignaturen. Tokenkravene kan forfalskes af ondsindede skuespillere. Denne metode er KUN egnet til logføring, analyse og diagnosticering. Brug IKKE den returnerede værdi til godkendelse, adgangskontrol eller sikkerhedsbeslutninger. Afkoder det aktuelle token og henter app-id'et (appid eller azp-krav). Bemærk! Returnerer et standard-GUID ('00000000-0000-0000-0000-000000000') for tomme tokens for bagudkompatibilitet med kaldere, der forventer et gyldigt GUID. Brug getAgentIdFromToken til agentidentifikation, hvor en tom streng foretrækkes.
getApplicationName()	Henter programnavnet fra miljøvariablen npm_package_name eller package.json. Det package.json resultat cachelagres på indlæsningstidspunktet for modulet for at undgå synkronisering af I/O under anmodninger.
GetUserAgentHeader(string)	Genererer en User-Agent headerstreng, der indeholder SDK-version, operativsystemtype, Node.js version og orchestrator.
ResolveAgentIdentity(TurnContext, string)	Løser agent-id'et fra turn-konteksten eller godkendelsestokenet.

Oplysninger om metode

getAgentIdFromToken(string)

ADVARSEL! INGEN SIGNATURBEKRÆFTELSE – Denne metode bruger jwt.decode(), som IKKE bekræfter tokensignaturen. Tokenkravene kan forfalskes af ondsindede skuespillere. Denne metode er KUN egnet til logføring, analyse og diagnosticering. Brug IKKE den returnerede værdi til godkendelse, adgangskontrol eller sikkerhedsbeslutninger.

Afkoder tokenet og henter det bedste tilgængelige agent-id. Kontrollerer krav i prioritetsrækkefølge: xms_par_app_azp (agent blueprint ID) > appid > azp.

Bemærk! Returnerer en tom streng for tomme/manglende tokens (i modsætning til GetAppIdFromToken , der returnerer et standard-GUID). Dette gør det muligt for kaldere at udelade headere, når der ikke er noget id tilgængeligt.

static function getAgentIdFromToken(token: string): string

Parametre

token

string

JWT-token til afkodning

Returnerer

string

Agent-id (GUID) eller tom streng, hvis den ikke blev fundet, eller tokenet er tomt

GetAppIdFromToken(string)

ADVARSEL! INGEN SIGNATURBEKRÆFTELSE – Denne metode bruger jwt.decode(), som IKKE bekræfter tokensignaturen. Tokenkravene kan forfalskes af ondsindede skuespillere. Denne metode er KUN egnet til logføring, analyse og diagnosticering. Brug IKKE den returnerede værdi til godkendelse, adgangskontrol eller sikkerhedsbeslutninger.

Afkoder det aktuelle token og henter app-id'et (appid eller azp-krav).

Bemærk! Returnerer et standard-GUID ('00000000-0000-0000-0000-000000000') for tomme tokens for bagudkompatibilitet med kaldere, der forventer et gyldigt GUID. Brug getAgentIdFromToken til agentidentifikation, hvor en tom streng foretrækkes.

static function GetAppIdFromToken(token: string): string

Parametre

token

string

Token til afkodning

Returnerer

string

AppId eller standard-GUID for tomt token eller tom streng, hvis afkodningen mislykkes

getApplicationName()

Henter programnavnet fra miljøvariablen npm_package_name eller package.json. Det package.json resultat cachelagres på indlæsningstidspunktet for modulet for at undgå synkronisering af I/O under anmodninger.

static function getApplicationName(): undefined | string

Returnerer

undefined | string

Programnavn eller udefineret, hvis det ikke er tilgængeligt.

GetUserAgentHeader(string)

Genererer en User-Agent headerstreng, der indeholder SDK-version, operativsystemtype, Node.js version og orchestrator.

static function GetUserAgentHeader(orchestrator?: string): string

Parametre

orchestrator

string

Valgfrit orchestrator-id, der skal medtages i den User-Agent streng.

Returnerer

string

Formateret User-Agent headerstreng.

ResolveAgentIdentity(TurnContext, string)

Løser agent-id'et fra turn-konteksten eller godkendelsestokenet.

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

Parametre

context

TurnContext

Turn Kontekst for turn.

authToken

string

Godkendelsestoken, hvis det er tilgængeligt.

Returnerer

string

Agentidentitet (app-id)