Utility class

Paketti:

@microsoft/agents-a365-runtime

Utility-luokka, joka tarjoaa apumenetelmiä agentin suorituksenaikaisia toimintoja varten.

Menetelmät

getAgentIdFromToken(string)	VAROITUS: EI ALLEKIRJOITUSVAHVISTUSTA - Tässä menetelmässä käytetään jwt.decode()-tunnusta, joka ei vahvista tunnuksen allekirjoitusta. Pahantahtoiset näyttelijät voivat väärentää tunnuksen väitteet. Tämä menetelmä soveltuu vain kirjaamiseen, analysointiin ja diagnostiikkaan. ÄLÄ käytä palautettua arvoa valtuutusta, käyttöoikeuksien hallintaa tai suojauspäätöksiä varten. Purkaa tunnuksen ja hakee parhaan käytettävissä olevan agentin tunnuksen. Tarkistaa vaatimukset prioriteettijärjestyksessä: xms_par_app_azp (agent blueprint ID) > appid > azp. Huomautus: palauttaa tyhjän merkkijonon tyhjille tai puuttuville tunnuksille (toisin kuin GetAppIdFromToken , joka palauttaa oletusarvoisen GUID-tunnuksen). Näin soittajat voivat jättää otsikoita pois, kun tunnistetta ei ole käytettävissä.
GetAppIdFromToken(string)	VAROITUS: EI ALLEKIRJOITUSVAHVISTUSTA - Tässä menetelmässä käytetään jwt.decode()-tunnusta, joka ei vahvista tunnuksen allekirjoitusta. Pahantahtoiset näyttelijät voivat väärentää tunnuksen väitteet. Tämä menetelmä soveltuu vain kirjaamiseen, analysointiin ja diagnostiikkaan. ÄLÄ käytä palautettua arvoa valtuutusta, käyttöoikeuksien hallintaa tai suojauspäätöksiä varten. Purkaa nykyisen tunnuksen ja noutaa sovellustunnuksen (appid- tai azp-vaatimus). Huomautus: Palauttaa oletusarvoisen GUID-tunnuksen ('000000000-0000-0000-00000000000') tyhjille tunnuksille, jotka edellyttävät kelvollisen näköistä GUID-tunnusta. Käytä agentin tunnistamisessa, jossa suositellaan tyhjää merkkijonoa, getAgentIdFromToken-tunnuksen avulla.
getApplicationName()	Hakee sovelluksen nimen npm_package_name ympäristömuuttujasta tai package.json. package.json tulos tallennetaan välimuistiin moduulin lataamisen aikana, jotta I/O-synkronointi vältetään pyyntöjen aikana.
GetUserAgentHeader(string)	Muodostaa User-Agent otsikkomerkkijonon, joka sisältää SDK-version, käyttöjärjestelmän tyypin, Node.js version ja ohjaimen.
ResolveAgentIdentity(TurnContext, string)	Korjaa agentin käyttäjätiedot kääntyvän kontekstin tai todennustunnuksen avulla.

Menetelmän tiedot

getAgentIdFromToken(string)

VAROITUS: EI ALLEKIRJOITUSVAHVISTUSTA - Tässä menetelmässä käytetään jwt.decode()-tunnusta, joka ei vahvista tunnuksen allekirjoitusta. Pahantahtoiset näyttelijät voivat väärentää tunnuksen väitteet. Tämä menetelmä soveltuu vain kirjaamiseen, analysointiin ja diagnostiikkaan. ÄLÄ käytä palautettua arvoa valtuutusta, käyttöoikeuksien hallintaa tai suojauspäätöksiä varten.

Purkaa tunnuksen ja hakee parhaan käytettävissä olevan agentin tunnuksen. Tarkistaa vaatimukset prioriteettijärjestyksessä: xms_par_app_azp (agent blueprint ID) > appid > azp.

Huomautus: palauttaa tyhjän merkkijonon tyhjille tai puuttuville tunnuksille (toisin kuin GetAppIdFromToken , joka palauttaa oletusarvoisen GUID-tunnuksen). Näin soittajat voivat jättää otsikoita pois, kun tunnistetta ei ole käytettävissä.

static function getAgentIdFromToken(token: string): string

Parametrit

token

string

JWT-tunnuksen koodi purettava

Palautukset

string

Agentin tunnus (GUID) tai tyhjä merkkijono, jos sitä ei löydy tai tunnus on tyhjä

GetAppIdFromToken(string)

VAROITUS: EI ALLEKIRJOITUSVAHVISTUSTA - Tässä menetelmässä käytetään jwt.decode()-tunnusta, joka ei vahvista tunnuksen allekirjoitusta. Pahantahtoiset näyttelijät voivat väärentää tunnuksen väitteet. Tämä menetelmä soveltuu vain kirjaamiseen, analysointiin ja diagnostiikkaan. ÄLÄ käytä palautettua arvoa valtuutusta, käyttöoikeuksien hallintaa tai suojauspäätöksiä varten.

Purkaa nykyisen tunnuksen ja noutaa sovellustunnuksen (appid- tai azp-vaatimus).

Huomautus: Palauttaa oletusarvoisen GUID-tunnuksen ('000000000-0000-0000-00000000000') tyhjille tunnuksille, jotka edellyttävät kelvollisen näköistä GUID-tunnusta. Käytä agentin tunnistamisessa, jossa suositellaan tyhjää merkkijonoa, getAgentIdFromToken-tunnuksen avulla.

static function GetAppIdFromToken(token: string): string

Parametrit

token

string

Tunnus koodauksen purkamiseen

Palautukset

string

AppId tai tyhjän tunnuksen oletusarvoinen GUID-tunnus tai tyhjä merkkijono, jos koodin purku epäonnistuu

getApplicationName()

Hakee sovelluksen nimen npm_package_name ympäristömuuttujasta tai package.json. package.json tulos tallennetaan välimuistiin moduulin lataamisen aikana, jotta I/O-synkronointi vältetään pyyntöjen aikana.

static function getApplicationName(): undefined | string

Palautukset

undefined | string

Sovelluksen nimi tai määrittämätön, jos se ei ole käytettävissä.

GetUserAgentHeader(string)

Muodostaa User-Agent otsikkomerkkijonon, joka sisältää SDK-version, käyttöjärjestelmän tyypin, Node.js version ja ohjaimen.

static function GetUserAgentHeader(orchestrator?: string): string

Parametrit

orchestrator

string

User-Agent merkkijonoon sisällytettävä valinnainen orkestraattorin tunnus.

Palautukset

string

Muotoiltu User-Agent otsikkomerkkijonosta.

ResolveAgentIdentity(TurnContext, string)

Korjaa agentin käyttäjätiedot kääntyvän kontekstin tai todennustunnuksen avulla.

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

Parametrit

context

TurnContext

Käännä käännöksen konteksti.

authToken

string

Todennustunnus, jos se on käytettävissä.

Palautukset

string

Agentin käyttäjätiedot (sovellustunnus)