Utility class

Pakke:

@microsoft/agents-a365-runtime

Utility-klassen tilbyr hjelpemetoder for operasjoner for agentkjøring.

Metoder

getAgentIdFromToken(string)	ADVARSEL: INGEN SIGNATURBEKREFTELSE – Denne metoden bruker jwt.decode() som IKKE bekrefter tokensignaturen. Tokenkravene kan forfalskes av ondsinnede aktører. Denne metoden er BARE egnet for logging, analyse og diagnoseformål. IKKE bruk den returnerte verdien for godkjenning, tilgangskontroll eller sikkerhetsbeslutninger. Dekoder tokenet og henter den beste tilgjengelige agentidentifikatoren. Kontrollerer krav i prioritert rekkefølge: xms_par_app_azp (agent blueprint ID) > appid > azp. Obs! Returnerer tom streng for tomme/manglende tokener (i motsetning til GetAppIdFromToken som returnerer en standard GUID). Dette gjør det mulig for innringere å utelate topptekster når ingen identifikator er tilgjengelig.
GetAppIdFromToken(string)	ADVARSEL: INGEN SIGNATURBEKREFTELSE – Denne metoden bruker jwt.decode() som IKKE bekrefter tokensignaturen. Tokenkravene kan forfalskes av ondsinnede aktører. Denne metoden er BARE egnet for logging, analyse og diagnoseformål. IKKE bruk den returnerte verdien for godkjenning, tilgangskontroll eller sikkerhetsbeslutninger. Dekoder gjeldende token og henter app-ID-en (appid- eller azp-krav). Obs! Returnerer en standard GUID ('00000000-0000-0000-0000-000000000000') for tomme tokener for bakoverkompatibilitet med innringere som forventer en gyldig GUID. Bruk getAgentIdFromToken for agentidentifikasjon der tom streng foretrekkes.
getApplicationName()	Henter programnavnet fra npm_package_name miljøvariabel eller package.json. Resultatet av package.json bufres ved innlasting av modulen for å unngå synkronisering av I/U under forespørsler.
GetUserAgentHeader(string)	Genererer en User-Agent topptekststreng som inneholder SDK-versjon, OS-type, Node.js versjon og orchestrator.
ResolveAgentIdentity(TurnContext, string)	Løser agentidentiteten fra svingkonteksten eller godkjenningstokenet.

Metodedetaljer

getAgentIdFromToken(string)

ADVARSEL: INGEN SIGNATURBEKREFTELSE – Denne metoden bruker jwt.decode() som IKKE bekrefter tokensignaturen. Tokenkravene kan forfalskes av ondsinnede aktører. Denne metoden er BARE egnet for logging, analyse og diagnoseformål. IKKE bruk den returnerte verdien for godkjenning, tilgangskontroll eller sikkerhetsbeslutninger.

Dekoder tokenet og henter den beste tilgjengelige agentidentifikatoren. Kontrollerer krav i prioritert rekkefølge: xms_par_app_azp (agent blueprint ID) > appid > azp.

Obs! Returnerer tom streng for tomme/manglende tokener (i motsetning til GetAppIdFromToken som returnerer en standard GUID). Dette gjør det mulig for innringere å utelate topptekster når ingen identifikator er tilgjengelig.

static function getAgentIdFromToken(token: string): string

Parametere

token

string

JWT-token for å dekode

Returnerer

string

Agent-ID (GUID) eller tom streng hvis ikke funnet eller tokenet er tomt

GetAppIdFromToken(string)

ADVARSEL: INGEN SIGNATURBEKREFTELSE – Denne metoden bruker jwt.decode() som IKKE bekrefter tokensignaturen. Tokenkravene kan forfalskes av ondsinnede aktører. Denne metoden er BARE egnet for logging, analyse og diagnoseformål. IKKE bruk den returnerte verdien for godkjenning, tilgangskontroll eller sikkerhetsbeslutninger.

Dekoder gjeldende token og henter app-ID-en (appid- eller azp-krav).

Obs! Returnerer en standard GUID ('00000000-0000-0000-0000-000000000000') for tomme tokener for bakoverkompatibilitet med innringere som forventer en gyldig GUID. Bruk getAgentIdFromToken for agentidentifikasjon der tom streng foretrekkes.

static function GetAppIdFromToken(token: string): string

Parametere

token

string

Token til dekode

Returnerer

string

AppId eller standard GUID for tomt token eller tom streng hvis dekode mislykkes

getApplicationName()

Henter programnavnet fra npm_package_name miljøvariabel eller package.json. Resultatet av package.json bufres ved innlasting av modulen for å unngå synkronisering av I/U under forespørsler.

static function getApplicationName(): undefined | string

Returnerer

undefined | string

Programnavn eller udefinert hvis det ikke er tilgjengelig.

GetUserAgentHeader(string)

Genererer en User-Agent topptekststreng som inneholder SDK-versjon, OS-type, Node.js versjon og orchestrator.

static function GetUserAgentHeader(orchestrator?: string): string

Parametere

orchestrator

string

Valgfri orchestrator-identifikator som skal inkluderes i User-Agent strengen.

Returnerer

string

Formatert User-Agent topptekststreng.

ResolveAgentIdentity(TurnContext, string)

Løser agentidentiteten fra svingkonteksten eller godkjenningstokenet.

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

Parametere

context

TurnContext

Snu konteksten for svingen.

authToken

string

Godkjenningstoken hvis tilgjengelig.

Returnerer

string

Agentidentitet (app-ID)