Freigeben über

Utility class

Paket:
@microsoft/agents-a365-runtime

Hilfsklasse, die Hilfsmethoden für Agent-Laufzeitvorgänge bereitstellt.

Methoden

getAgentIdFromToken(string)

WARNUNG: KEINE SIGNATURÜBERPRÜFUNG - Diese Methode verwendet jwt.decode(), wodurch die Tokensignatur NICHT überprüft wird. Die Tokenansprüche können von böswilligen Akteuren gespooft werden. Diese Methode eignet sich NUR für Protokollierungs-, Analyse- und Diagnosezwecke. Verwenden Sie nicht den zurückgegebenen Wert für Autorisierungs-, Zugriffssteuerungs- oder Sicherheitsentscheidungen.

Decodiert das Token und ruft den besten verfügbaren Agentbezeichner ab. Überprüft Ansprüche in der Prioritätsreihenfolge: xms_par_app_azp (Agent Blueprint ID) > appid > azp.

Hinweis: Gibt eine leere Zeichenfolge für leere/fehlende Token zurück (im Gegensatz zu GetAppIdFromToken , die eine Standard-GUID zurückgibt). Dadurch können Aufrufer Kopfzeilen weglassen, wenn kein Bezeichner verfügbar ist.
GetAppIdFromToken(string)

WARNUNG: KEINE SIGNATURÜBERPRÜFUNG - Diese Methode verwendet jwt.decode(), wodurch die Tokensignatur NICHT überprüft wird. Die Tokenansprüche können von böswilligen Akteuren gespooft werden. Diese Methode eignet sich NUR für Protokollierungs-, Analyse- und Diagnosezwecke. Verwenden Sie nicht den zurückgegebenen Wert für Autorisierungs-, Zugriffssteuerungs- oder Sicherheitsentscheidungen.

Decodiert das aktuelle Token und ruft die App-ID (appid- oder azp-Anspruch) ab.

Hinweis: Gibt eine Standard-GUID ('00000000-0000-0000-00000-00000000000') für leere Token für die Abwärtskompatibilität mit Aufrufern zurück, die eine gültige guiD erwarten. Verwenden Sie für die Agentidentifikation, bei der leere Zeichenfolge bevorzugt wird, getAgentIdFromToken.
getApplicationName()

Ruft den Anwendungsnamen aus npm_package_name Umgebungsvariable oder package.jsonab. Das package.json Ergebnis wird beim Laden des Moduls zwischengespeichert, um die Synchronisierungs-E/A bei Anforderungen zu vermeiden.
GetUserAgentHeader(string)

Generiert eine User-Agent Headerzeichenfolge mit SDK-Version, Betriebssystemtyp, Node.js Version und Orchestrator.
ResolveAgentIdentity(TurnContext, string)

Löst die Agentidentität aus dem Turnkontext- oder Authentifizierungstoken auf.

Details zur Methode

getAgentIdFromToken(string)

WARNUNG: KEINE SIGNATURÜBERPRÜFUNG - Diese Methode verwendet jwt.decode(), wodurch die Tokensignatur NICHT überprüft wird. Die Tokenansprüche können von böswilligen Akteuren gespooft werden. Diese Methode eignet sich NUR für Protokollierungs-, Analyse- und Diagnosezwecke. Verwenden Sie nicht den zurückgegebenen Wert für Autorisierungs-, Zugriffssteuerungs- oder Sicherheitsentscheidungen.

Decodiert das Token und ruft den besten verfügbaren Agentbezeichner ab. Überprüft Ansprüche in der Prioritätsreihenfolge: xms_par_app_azp (Agent Blueprint ID) > appid > azp.

Hinweis: Gibt eine leere Zeichenfolge für leere/fehlende Token zurück (im Gegensatz zu GetAppIdFromToken , die eine Standard-GUID zurückgibt). Dadurch können Aufrufer Kopfzeilen weglassen, wenn kein Bezeichner verfügbar ist.

static function getAgentIdFromToken(token: string): string

Parameter

token

string

JWT-Token zum Decodieren

Gibt zurück

string

Agent-ID (GUID) oder leere Zeichenfolge, wenn nicht gefunden oder Token leer ist

GetAppIdFromToken(string)

WARNUNG: KEINE SIGNATURÜBERPRÜFUNG - Diese Methode verwendet jwt.decode(), wodurch die Tokensignatur NICHT überprüft wird. Die Tokenansprüche können von böswilligen Akteuren gespooft werden. Diese Methode eignet sich NUR für Protokollierungs-, Analyse- und Diagnosezwecke. Verwenden Sie nicht den zurückgegebenen Wert für Autorisierungs-, Zugriffssteuerungs- oder Sicherheitsentscheidungen.

Decodiert das aktuelle Token und ruft die App-ID (appid- oder azp-Anspruch) ab.

Hinweis: Gibt eine Standard-GUID ('00000000-0000-0000-00000-00000000000') für leere Token für die Abwärtskompatibilität mit Aufrufern zurück, die eine gültige guiD erwarten. Verwenden Sie für die Agentidentifikation, bei der leere Zeichenfolge bevorzugt wird, getAgentIdFromToken.

static function GetAppIdFromToken(token: string): string

Parameter

token

string

Token zum Decodieren

Gibt zurück

string

AppId oder Standard-GUID für leeres Token oder leere Zeichenfolge, wenn die Decodierung fehlschlägt

getApplicationName()

Ruft den Anwendungsnamen aus npm_package_name Umgebungsvariable oder package.jsonab. Das package.json Ergebnis wird beim Laden des Moduls zwischengespeichert, um die Synchronisierungs-E/A bei Anforderungen zu vermeiden.

static function getApplicationName(): undefined | string

Gibt zurück

undefined | string

Anwendungsname oder nicht definiert, falls nicht verfügbar.

GetUserAgentHeader(string)

Generiert eine User-Agent Headerzeichenfolge mit SDK-Version, Betriebssystemtyp, Node.js Version und Orchestrator.

static function GetUserAgentHeader(orchestrator?: string): string

Parameter

orchestrator

string

Optionaler Orchestratorbezeichner, der in die User-Agent Zeichenfolge eingeschlossen werden soll.

Gibt zurück

string

Formatierte User-Agent Headerzeichenfolge.

ResolveAgentIdentity(TurnContext, string)

Löst die Agentidentität aus dem Turnkontext- oder Authentifizierungstoken auf.

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

Parameter

context
TurnContext

Turn Context of the turn.

authToken

string

Authentifizierungstoken, falls verfügbar.

Gibt zurück

string

Agentidentität (App-ID)