getCurrentAgent (dokumentacja interfejsu API klienta)

Zwraca obecnie aktywne agent funkcji Copilot microsoft lub niezdefiniowane, jeśli stan agenta nie jest jeszcze znany.

Składnia

Xrm.Copilot.getCurrentAgent().then(successCallback, errorCallback);

Parameters

Nazwa parametru Typ Required Description
successCallback Function Yes Funkcja do wywołania, gdy operacja zakończy się pomyślnie.
errorCallback Function Yes Funkcja wywoływana, gdy operacja zakończy się niepowodzeniem.

Wartość zwracana

Typ: Promise<M365CopilotAgent | undefined> — rozpoznaje obiekt M365CopilotAgent opisujący aktywnego agenta lub undefined jeśli stan agenta nie jest jeszcze określony.

Remarks

Nie wykonuje żadnych czynności, jeśli Microsoft Copilot nie jest włączona.

Zwrócone agentId właściwości obiektu i mode są sparowane:

  • agentId jest ciągiem innym niż null i mode jest "agentPage" lub "mentioned": agent jest aktywny.
  • agentIdis null i mode is null: użytkownik jest w Microsoft Copilot mainline (brak aktywnego agenta).

Example

const agent = await Xrm.Copilot.getCurrentAgent();
if (agent && agent.agentId) {
    console.log(`Active agent: ${agent.agentId}, mode: ${agent.mode}`);
} else if (agent) {
    console.log("User is on mainline M365 Copilot (no agent).");
} else {
    console.log("Agent state not yet determined.");
}

M365CopilotAgent, interfejs
Xrm.Copilot (dokumentacja interfejsu API klienta)