Zum Hauptinhalt springen

Wie du Meeting-Zusammenfassungen über die Sally API abrufst

Zusammenfassungen abzurufen ist der häufigste Grund, die Sally API zu nutzen: Du bringst das, was Sally vom Meeting verstanden hat, dorthin, wo dein Team ohnehin arbeitet. Diese Anleitung zeigt, wie eine Zusammenfassung aufgebaut ist, wie du sie abrufst oder durchsuchst und an welchen Statusfeldern du erkennst, ob es etwas zu lesen gibt.

Vorher lesen

Lies zuerst den Schnellstart und Termine, Aufnahmen und Zusammenfassungen.

Schnellnavigation

  1. Was eine Zusammenfassung enthält
  2. Die Zusammenfassungen einer Aufnahme abrufen
  3. Zusammenfassungen durchsuchen
  4. Prüfen, ob es etwas zu lesen gibt

1. Was eine Zusammenfassung enthält​

Eine Zusammenfassung gehört zu genau einer Aufnahme. Sie besteht aus einem Zusammenfassungstext (summary) und einer Liste von Abschnittseinträgen (sectionItems). Die Abschnitte stammen aus dem angewendeten Meetingtemplate, ein Vertriebsgespräch liefert also andere Abschnitte als ein technisches Review.

Jeder Abschnittseintrag trägt seinen sectionType (summary, tasks, topics, decisions, customList, freeText) und seinen Inhalt in content. Das Feld outputFormat sagt dir, ob dieser Inhalt html oder markdown ist. Aufgabenartige Einträge tragen zusätzlich subject, description, responsibleUserName, responsibleUserEmail und dueDate.

2. Die Zusammenfassungen einer Aufnahme abrufen​

Wenn du die Aufnahme kennst, frag sie nach ihren Zusammenfassungen. Hänge includeDetails=true an, sonst ist sectionItems gleich null:

GET /v1.0/directories/{directoryId}/recordings/{recordingId}/summaries?includeDetails=true

Die Antwort ist eine Liste mit einem Eintrag je Sprache. Eine einzelne Zusammenfassung kannst du auch direkt über ihre Id abrufen.

3. Zusammenfassungen durchsuchen​

Die Suche deckt den Zusammenfassungstext und die erzeugten Abschnittseinträge (Titel, Inhalt, Betreff und Beschreibung) in einem Rutsch ab. Der Suchbegriff braucht mindestens 3 Zeichen und steht im Request-Body:

POST /v1.0/directories/{directoryId}/summaries/search

{ "search": "Preisgestaltung", "pageSize": 25 }

Jeder Treffer liefert einen kurzen snippet und die Ids, mit denen du die vollständige Zusammenfassung abrufst. Warum die Suche ihre Parameter im Body erwartet, erklärt Paginierung und Suche.

Referenz: POST/v1.0/directories/{directoryId}/summaries/search

4. Prüfen, ob es etwas zu lesen gibt​

  • isSummarizationCompleted sagt, dass der Lauf beendet ist, auch wenn er nichts ergeben hat.
  • isSummarizationSucceeded sagt, dass es etwas zu lesen gibt: einen Zusammenfassungstext oder mindestens einen Abschnittseintrag. Dieses Feld solltest du prüfen.
  • summarizationCompletionReason sagt, warum der Lauf endete: succeeded, noTranscript, emptyResult, error oder unknown (läuft noch). noTranscript ist ein erwartetes Ergebnis, kein Fehler.
Beispiel

Ein nächtlicher Import listet mit createdAfter die seit dem letzten Lauf entstandenen Aufnahmen, holt zu jeder die Zusammenfassung in der Unternehmenssprache und überspringt jeden Eintrag, bei dem isSummarizationSucceeded gleich false ist. Als Schlüssel speichert er die recordingId zusammen mit dem languageCode, nie den Termin.

Empfehlung

Abschnittseinträge machen den Großteil der Antwort aus. Wenn du nur den Zusammenfassungstext brauchst, lass includeDetails weg. Wie du Antworten noch weiter verkleinerst, zeigt Feldauswahl.