Utility class

Pacchetto:
@microsoft/agents-a365-runtime

Classe di utilità che fornisce metodi helper per le operazioni di runtime dell'agente.

Metodi

getAgentIdFromToken(string)

AVVISO: NESSUNA VERIFICA DELLA FIRMA: questo metodo usa jwt.decode() che NON verifica la firma del token. Le attestazioni del token possono essere spoofing da parte di attori malintenzionati. Questo metodo è adatto solo a scopi di registrazione, analisi e diagnostica. Non usare il valore restituito per le decisioni relative all'autorizzazione, al controllo di accesso o alla sicurezza.

Decodifica il token e recupera l'identificatore dell'agente migliore disponibile. Verifica le attestazioni nell'ordine di priorità: xms_par_app_azp (ID progetto agente) > appid > azp.

Nota: restituisce una stringa vuota per i token vuoti/mancanti ,a differenza di GetAppIdFromToken che restituisce un GUID predefinito. Ciò consente ai chiamanti di omettere le intestazioni quando non è disponibile alcun identificatore.
GetAppIdFromToken(string)

AVVISO: NESSUNA VERIFICA DELLA FIRMA: questo metodo usa jwt.decode() che NON verifica la firma del token. Le attestazioni del token possono essere spoofing da parte di attori malintenzionati. Questo metodo è adatto solo a scopi di registrazione, analisi e diagnostica. Non usare il valore restituito per le decisioni relative all'autorizzazione, al controllo di accesso o alla sicurezza.

Decodifica il token corrente e recupera l'ID app (appid o azp claim).

Nota: restituisce un GUID predefinito ('00000000-0000-0000-0000-0000000000000') per i token vuoti per la compatibilità con le versioni precedenti con i chiamanti che prevedono un GUID valido. Per l'identificazione dell'agente in cui è preferibile una stringa vuota, usare getAgentIdFromToken.
getApplicationName()

Ottiene il nome dell'applicazione da npm_package_name variabile di ambiente o package.json. Il risultato package.json viene memorizzato nella cache in fase di caricamento del modulo per evitare la sincronizzazione di I/O durante le richieste.
GetUserAgentHeader(string)

Genera una stringa di intestazione User-Agent contenente la versione dell'SDK, il tipo di sistema operativo, la versione Node.js e l'agente di orchestrazione.
ResolveAgentIdentity(TurnContext, string)

Risolve l'identità dell'agente dal contesto di turno o dal token di autenticazione.

Dettagli metodo

getAgentIdFromToken(string)

AVVISO: NESSUNA VERIFICA DELLA FIRMA: questo metodo usa jwt.decode() che NON verifica la firma del token. Le attestazioni del token possono essere spoofing da parte di attori malintenzionati. Questo metodo è adatto solo a scopi di registrazione, analisi e diagnostica. Non usare il valore restituito per le decisioni relative all'autorizzazione, al controllo di accesso o alla sicurezza.

Decodifica il token e recupera l'identificatore dell'agente migliore disponibile. Verifica le attestazioni nell'ordine di priorità: xms_par_app_azp (ID progetto agente) > appid > azp.

Nota: restituisce una stringa vuota per i token vuoti/mancanti ,a differenza di GetAppIdFromToken che restituisce un GUID predefinito. Ciò consente ai chiamanti di omettere le intestazioni quando non è disponibile alcun identificatore.

static function getAgentIdFromToken(token: string): string

Parametri

token

string

Token JWT da decodificare

Valori restituiti

string

ID agente (GUID) o stringa vuota se non trovato o token è vuoto

GetAppIdFromToken(string)

AVVISO: NESSUNA VERIFICA DELLA FIRMA: questo metodo usa jwt.decode() che NON verifica la firma del token. Le attestazioni del token possono essere spoofing da parte di attori malintenzionati. Questo metodo è adatto solo a scopi di registrazione, analisi e diagnostica. Non usare il valore restituito per le decisioni relative all'autorizzazione, al controllo di accesso o alla sicurezza.

Decodifica il token corrente e recupera l'ID app (appid o azp claim).

Nota: restituisce un GUID predefinito ('00000000-0000-0000-0000-0000000000000') per i token vuoti per la compatibilità con le versioni precedenti con i chiamanti che prevedono un GUID valido. Per l'identificazione dell'agente in cui è preferibile una stringa vuota, usare getAgentIdFromToken.

static function GetAppIdFromToken(token: string): string

Parametri

token

string

Token da decodificare

Valori restituiti

string

AppId o GUID predefinito per un token vuoto o stringa vuota se la decodifica ha esito negativo

getApplicationName()

Ottiene il nome dell'applicazione da npm_package_name variabile di ambiente o package.json. Il risultato package.json viene memorizzato nella cache in fase di caricamento del modulo per evitare la sincronizzazione di I/O durante le richieste.

static function getApplicationName(): undefined | string

Valori restituiti

undefined | string

Nome applicazione o non definito, se non disponibile.

GetUserAgentHeader(string)

Genera una stringa di intestazione User-Agent contenente la versione dell'SDK, il tipo di sistema operativo, la versione Node.js e l'agente di orchestrazione.

static function GetUserAgentHeader(orchestrator?: string): string

Parametri

orchestrator

string

Identificatore dell'agente di orchestrazione facoltativo da includere nella stringa User-Agent.

Valori restituiti

string

Stringa di intestazione User-Agent formattata.

ResolveAgentIdentity(TurnContext, string)

Risolve l'identità dell'agente dal contesto di turno o dal token di autenticazione.

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

Parametri

context
TurnContext

Girare Contesto del turno.

authToken

string

Token di autenticazione, se disponibile.

Valori restituiti

string

Identità agente (ID app)