Arbeits-IQ - copilotKonversation: chat

Wichtig

APIs unter der /beta Version können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt.

Mit der Work IQ Chat-API können Sie mehrteilige Unterhaltungen mit Microsoft 365 Copilot erstellen und fortsetzen und dabei die definierten Zugriffskontrollen innerhalb der organization einhalten. Verwenden Sie die Chat-API, um synchrone Unterhaltungen mit Microsoft 365 Copilot fortzusetzen.

In dieser Dokumentation werden fortgesetzte synchrone Copilot-Unterhaltungen mithilfe der Chat-API behandelt. Erfahren Sie, wie Sie Copilot-Unterhaltungen erstellen oder gestreamte Unterhaltungen mit der Chat-API fortsetzen.

Berechtigungen

Wählen Sie die Berechtigungen aus, die für diese API als am wenigsten privilegiert markiert sind. Verwenden Sie eine höhere Berechtigung oder Berechtigungen nur, wenn Ihre App dies erfordert. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

Berechtigungstyp	Berechtigungen mit den geringsten Berechtigungen	Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto)	WorkIQAgent.Ask	Nicht verfügbar.
Delegiert (persönliches Microsoft-Konto)	Nicht unterstützt	Nicht unterstützt
Application	Nicht unterstützt	Nicht unterstützt

HTTP-Anforderung

POST https://workiq.svc.cloud.microsoft/rest/conversations/{conversationId}/chat

POST https://workiq.svc.cloud.microsoft/rest/beta/conversations/{conversationId}/chat

Anforderungsheader

Name	Beschreibung
`Authorization`	`Bearer {token}`. Erforderlich. Erfahren Sie mehr über Authentifizierung und Autorisierung.
`Content-Type`	`application/json.` Erforderlich.

Anforderungstext

Geben Sie im Anforderungstext eine JSON-Darstellung der Parameter an.

In der folgenden Tabelle sind die optionalen und erforderlichen Parameter aufgeführt, die Sie beim Aufrufen dieser Aktion verwenden können.

Parameter	Typ	Beschreibung
`message`	copilotConversationRequestMessageParameter	Die Chatnachricht, die in die Copilot-Unterhaltung gesendet wird. Erforderlich.
`additionalContext`	copilotContextMessage-Sammlung	Zusätzlicher Kontext für das Copilot-Gespräch. Dies sollte zur zusätzlichen Erdung verwendet werden. Optional.
`locationHint`	copilotConversationLocation	Informationen zum Standort des Benutzers. Erforderlich.
`contextualResources`	copilotContextualResources	Stellt OneDrive- und SharePoint-Dateien bereit, die als Kontext verwendet werden sollen, und/oder schaltet die Grundlage für die Websuche um. Optional.

Antwort

Bei erfolgreicher Ausführung gibt diese Aktion einen 200 OK Antwortcode und eine copilotConversation im Antworttext zurück.

Beispiele

Beispiel 1: Senden einer Chatnachricht

Im folgenden Beispiel wird gezeigt, wie Sie mithilfe des synchronen Endpunkts eine Eingabeaufforderung an die Chat-API senden.

Anforderung

Das folgende Beispiel zeigt die Antwort. ▶ Öffnen Sie diesen vorausgefüllten Prompt in der interaktiven Demo.

POST https://workiq.svc.cloud.microsoft/rest/conversations/0d110e7e-2b7e-4270-a899-fd2af6fde333/chat
Content-Type: application/json

{
  "message": {
    "text": "What meeting do I have at 9 AM tomorrow morning?"
  },
  "locationHint": {
    "timeZone": "America/New_York"
  }
}

POST https://workiq.svc.cloud.microsoft/rest/beta/conversations/0d110e7e-2b7e-4270-a899-fd2af6fde333/chat
Content-Type: application/json

{
  "message": {
    "text": "What meeting do I have at 9 AM tomorrow morning?"
  },
  "locationHint": {
    "timeZone": "America/New_York"
  }
}