Utility class

Balíček:

@microsoft/agents-a365-runtime

Utility třída poskytující pomocné metody pro operace modulu runtime agenta.

Metody

getAgentIdFromToken(string)	UPOZORNĚNÍ: BEZ OVĚŘENÍ PODPISU - Tato metoda používá jwt.decode(), který neověřuje podpis tokenu. Deklarace identity tokenu můžou zneškodnět zlými úmysly. Tato metoda je vhodná pouze pro účely protokolování, analýzy a diagnostiky. Nepoužívejte vrácenou hodnotu pro rozhodnutí o autorizaci, řízení přístupu nebo zabezpečení. Dekóduje token a načte nejlepší dostupný identifikátor agenta. Kontroluje deklarace identity v pořadí priority: xms_par_app_azp (ID podrobného plánu agenta) > appid > azp. Poznámka: Vrátí prázdný řetězec pro prázdné nebo chybějící tokeny (na rozdíl od GetAppIdFromToken , který vrátí výchozí identifikátor GUID). To umožňuje volajícím vynechat hlavičky, pokud není k dispozici žádný identifikátor.
GetAppIdFromToken(string)	UPOZORNĚNÍ: BEZ OVĚŘENÍ PODPISU - Tato metoda používá jwt.decode(), který neověřuje podpis tokenu. Deklarace identity tokenu můžou zneškodnět zlými úmysly. Tato metoda je vhodná pouze pro účely protokolování, analýzy a diagnostiky. Nepoužívejte vrácenou hodnotu pro rozhodnutí o autorizaci, řízení přístupu nebo zabezpečení. Dekóduje aktuální token a načte ID aplikace (id aplikace nebo deklarace identity azp). Poznámka: Vrátí výchozí identifikátor GUID ('00000000-0000-0000-0000-00000000000') prázdných tokenů pro zpětnou kompatibilitu s volajícími, kteří očekávají platný identifikátor GUID. Pro identifikaci agenta, kde je upřednostňovaný prázdný řetězec, použijte getAgentIdFromToken.
getApplicationName()	Získá název aplikace z npm_package_name proměnné prostředí nebo package.json. Výsledek package.json se ukládá do mezipaměti při načítání modulu, aby se zabránilo synchronizaci vstupně-výstupních operací během požadavků.
GetUserAgentHeader(string)	Vygeneruje řetězec hlavičky User-Agent obsahující verzi sady SDK, typ operačního systému, Node.js verzi a orchestrátor.
ResolveAgentIdentity(TurnContext, string)	Vyřeší identitu agenta z kontextu turnu nebo ověřovacího tokenu.

Podrobnosti metody

getAgentIdFromToken(string)

UPOZORNĚNÍ: BEZ OVĚŘENÍ PODPISU - Tato metoda používá jwt.decode(), který neověřuje podpis tokenu. Deklarace identity tokenu můžou zneškodnět zlými úmysly. Tato metoda je vhodná pouze pro účely protokolování, analýzy a diagnostiky. Nepoužívejte vrácenou hodnotu pro rozhodnutí o autorizaci, řízení přístupu nebo zabezpečení.

Dekóduje token a načte nejlepší dostupný identifikátor agenta. Kontroluje deklarace identity v pořadí priority: xms_par_app_azp (ID podrobného plánu agenta) > appid > azp.

Poznámka: Vrátí prázdný řetězec pro prázdné nebo chybějící tokeny (na rozdíl od GetAppIdFromToken , který vrátí výchozí identifikátor GUID). To umožňuje volajícím vynechat hlavičky, pokud není k dispozici žádný identifikátor.

static function getAgentIdFromToken(token: string): string

Parametry

token

string

Token JWT pro dekódování

Návraty

string

ID agenta (GUID) nebo prázdný řetězec, pokud nebyl nalezen nebo token je prázdný.

GetAppIdFromToken(string)

UPOZORNĚNÍ: BEZ OVĚŘENÍ PODPISU - Tato metoda používá jwt.decode(), který neověřuje podpis tokenu. Deklarace identity tokenu můžou zneškodnět zlými úmysly. Tato metoda je vhodná pouze pro účely protokolování, analýzy a diagnostiky. Nepoužívejte vrácenou hodnotu pro rozhodnutí o autorizaci, řízení přístupu nebo zabezpečení.

Dekóduje aktuální token a načte ID aplikace (id aplikace nebo deklarace identity azp).

Poznámka: Vrátí výchozí identifikátor GUID ('00000000-0000-0000-0000-00000000000') prázdných tokenů pro zpětnou kompatibilitu s volajícími, kteří očekávají platný identifikátor GUID. Pro identifikaci agenta, kde je upřednostňovaný prázdný řetězec, použijte getAgentIdFromToken.

static function GetAppIdFromToken(token: string): string

Parametry

token

string

Dekódování tokenu

Návraty

string

AppId nebo výchozí identifikátor GUID pro prázdný token nebo prázdný řetězec, pokud se dekódování nezdaří

getApplicationName()

Získá název aplikace z npm_package_name proměnné prostředí nebo package.json. Výsledek package.json se ukládá do mezipaměti při načítání modulu, aby se zabránilo synchronizaci vstupně-výstupních operací během požadavků.

static function getApplicationName(): undefined | string

Návraty

undefined | string

Název aplikace nebo nedefinovaný, pokud není k dispozici.

GetUserAgentHeader(string)

Vygeneruje řetězec hlavičky User-Agent obsahující verzi sady SDK, typ operačního systému, Node.js verzi a orchestrátor.

static function GetUserAgentHeader(orchestrator?: string): string

Parametry

orchestrator

string

Volitelný identifikátor orchestrátoru, který se má zahrnout do řetězce User-Agent.

Návraty

string

Formátovaný User-Agent řetězec záhlaví.

ResolveAgentIdentity(TurnContext, string)

Vyřeší identitu agenta z kontextu turnu nebo ověřovacího tokenu.

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

Parametry

context

TurnContext

Otočte kontext otáčení.

authToken

string

Ověřovací token, pokud je k dispozici.

Návraty

string

Identita agenta (ID aplikace)