getCurrentAgent (asiakkaan ohjelmointirajapinnan viittaus)

Palauttaa nykyisen aktiivisen Microsoft 365 -Copilot-agentti, tai määrittämättömän, jos agentin tilaa ei vielä tiedetä.

Syntax

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

Parametrit

Parametrin nimi	Type	Pakollinen	Description
successCallback	Function	Yes	Funktio, jota kutsutaan, kun toiminto onnistuu.
errorCallback	Function	Yes	Funktio, jota kutsutaan, kun toiminto epäonnistuu.

Palautusarvo

Tyyppi: Promise<M365CopilotAgent | undefined> – Ratkaistaan M365CopilotAgent-objekti, joka kuvaa aktiivista agenttia, tai undefined jos agentin tilaa ei ole vielä määritetty.

Huomautuksia

Ei tee mitään, jos Microsoft 365 Copilot ei ole käytössä.

Palautettujen objektien agentId ja mode ominaisuuksien parit ovat:

• agentId on muu kuin tyhjäarvoinen merkkijono ja mode on "agentPage" tai "mentioned": agentti on aktiivinen.
• agentId on null ja mode on null: käyttäjä on päälinjan Microsoft 365 Copilot (agenttia ei ole aktiivinen).

Esimerkki

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.");
}

Aiheeseen liittyviä artikkeleita

M365CopilotAgent-liittymä
Xrm.Copilot (asiakkaan ohjelmointirajapinnan viittaus)