Erkennen bestimmter Zeichenfolgen in einem Outlook-Element als bekannte Entitäten

  • Artikel

Vor dem Senden einer Nachricht oder eines Besprechungsanfrageelements analysiert Exchange Server den Inhalt des Elements, identifiziert und stempelt bestimmte Zeichenfolgen im Betreff und Textkörper, die Exchange bekannten Entitäten ähneln, z. B. E-Mail-Adressen, Telefonnummern und URLs. Nachrichten und Besprechungsanfragen werden von Exchange Server in einem Outlook-Posteingang mit bekannten Entitäten übermittelt.

Wichtig

Entitätsbasierte kontextbezogene Outlook-Add-Ins werden im 2. Quartal 2024 eingestellt. Die Arbeiten zur Einstellung dieses Features beginnen im Mai und werden bis Ende Juni fortgesetzt. Nach Juni können Kontext-Add-Ins keine Entitäten mehr in E-Mail-Elementen erkennen, um Aufgaben für sie auszuführen. Die folgenden APIs werden ebenfalls eingestellt.

Um potenzielle Unterbrechungen zu minimieren, werden die folgenden Elemente weiterhin unterstützt, nachdem entitätsbasierte Kontext-Add-Ins eingestellt wurden.

  • Eine alternative Implementierung der Schaltfläche " An Besprechung teilnehmen ", die von Onlinebesprechungs-Add-Ins aktiviert wird, wird entwickelt. Sobald die Unterstützung für entitätsbasierte Kontext-Add-Ins endet, werden Onlinebesprechungs-Add-Ins automatisch zur alternativen Implementierung übergehen, um die Schaltfläche An Besprechung teilnehmen zu aktivieren.
  • Regeln für reguläre Ausdrücke werden weiterhin unterstützt, nachdem entitätsbasierte Kontext-Add-Ins eingestellt wurden. Es wird empfohlen, Ihr Kontext-Add-In zu aktualisieren, um Regeln für reguläre Ausdrücke als alternative Lösung zu verwenden. Anleitungen zum Implementieren dieser Regeln finden Sie unter Verwenden von Aktivierungsregeln für reguläre Ausdrücke zum Anzeigen eines Outlook-Add-Ins.

Weitere Informationen finden Sie unter Außerbetriebnahme entitätsbasierter kontextbezogener Outlook-Add-Ins.

Mithilfe der Office JavaScript-API können Sie diese Zeichenfolgen abrufen, die bestimmten bekannten Entitäten zur weiteren Verarbeitung entsprechen. Sie können im Add-in-Manifest mithilfe einer Regel auch eine bekannte Entität festlegen, sodass Outlook Ihr Add-In aktivieren kann, wenn der Benutzer ein Element anzeigt, das Übereinstimmungen mit dieser Entität enthält. Sie können Übereinstimmungen mit der Entität extrahieren und Aktionen daran ausführen.

Hinweis

Outlook-Add-In-Features, die von Aktivierungsregeln abhängen, werden nicht unterstützt, wenn das Add-In ein einheitliches Manifest für Microsoft 365 (Vorschau) verwendet.

Es ist hilfreich, solche Instanzen in einer ausgewählten Nachricht oder einem Termin erkennen oder extrahieren zu können. Beispielsweise können Sie einen reversen Telefon-Lookup-Dienst als Outlook-Add-In erstellen. Das Add-In kann Zeichenfolgen im Betreff oder Text extrahieren, die einer Telefonnummer ähneln, und ein reverses Lookup ausführen, um den registrierten Besitzer jeder Telefonnummer anzuzeigen.

In diesem Thema werden diese bekannten Entitäten vorgestellt und Beispiele für Aktivierungsregeln gegeben, die auf bekannten Entitäten basieren. Außerdem erfahren Sie, wie Entitäten mit und ohne derartige Aktivierungsregeln extrahiert werden.

Unterstützung für bekannte Entitäten

Exchange Server stempelt bekannte Entitäten in einer Nachricht oder Besprechungsanfrage, nachdem der Absender das Element gesendet hat und bevor Exchange das Element an den Empfänger liefert. Daher werden nur Elemente gestempelt, die von Exchange transportiert wurden, und Outlook kann Add-Ins auf Basis dieser Stempel aktivieren, wenn der Benutzer diese Elemente anzeigt. Wenn der Benutzer allerdings ein Element verfasst oder ein Element im Ordner „Gesendete Objekte" anzeigt, kann Outlook Add-Ins nicht auf Basis bekannter Entitäten aktivieren, da das Element nicht von Exchange transportiert wurde.

Entsprechend können Sie bekannte Entitäten nicht in Elementen extrahieren, die verfasst werden oder sich im Ordner „Gesendete Objekte“ befinden, da diese Elemente nicht von Exchange transportiert und nicht gestempelt wurden. Weitere Informationen zu den Arten von Elementen, die Aktivierung unterstützen, finden Sie unter Aktivierungsregeln für Outlook-Add-Ins.

In der folgenden Liste werden die Entitäten aufgeführt, die Exchange Server und Outlook unterstützen und erkennen (daher der Name "bekannte Entitäten") sowie auch den Objekttyp der Instanz einer jeden Entität. Die natürliche Spracherkennung einer Zeichenfolge einer dieser Entitäten basiert auf einem Lernmodell, das mit einer großen Datenmenge verbessert wurde. Deshalb ist die Erkennung nicht deterministisch. Weitere Informationen zu den Erkennungsbedingungen finden Sie unter Tipps zur Verwendung bekannter Entitäten.

Entitätstyp Bedingung für die Erkennung Objekttyp
Adresse Adressen in den USA. Beispiel: "1234 Main Street, Redmond, WA 07722". Im Allgemeinen gilt für die Erkennung einer Adresse, dass sie sich an die Struktur einer US-Postanschrift halten sollte und die meisten Elemente wie Hausnummer, Straßenname, Ort, Bundesstaat und PLZ vorhanden sein sollten. Die Adresse kann in einer oder mehreren Zeilen angegeben werden. Java-Objekt des Typs String
Contact Ein Verweis auf die Informationen einer Person, die in natürlicher Sprache erkannt werden. Die Erkennung eines Kontakts hängt vom Kontext ab. Beispielsweise einer Signatur am Ende einer Nachricht, oder dem Namen einer Person in der Nähe der folgenden Informationen: Telefonnummer, Adresse, E-Mail-Adresse und URL. Contact-Objekt
EmailAddress SMTP-E-Mail-Adressen JavaScript-Objekt String
MeetingSuggestion Ein Verweis auf ein Ereignis oder eine Besprechung. Exchange würde z. B. den folgenden Text als Besprechungsvorschlag erkennen: "Lassen Sie uns morgen zum Mittagessen treffen." MeetingSuggestion-Objekt
PhoneNumber Telefonnummern in den USA. Beispiel: (235) 555-0110. PhoneNumber-Objekt
TaskSuggestion Sätze in einer E-Mail, die zu Aktionen auffordern. Beispiel: "Bitte aktualisieren Sie das Arbeitsblatt." TaskSuggestion-Objekt
Url Eine Webadresse, die den neuen Speicherort des Netzwerks sowie die ID einer Webressource explizit angibt. Exchange Server erfordert nicht das Zugriffsprotokoll in der Webadresse und erkennt keine URLs, die als Instanzen der Url Entität in Linktext eingebettet sind. Exchange Server können mit den folgenden Beispielen übereinstimmen:www.youtube.com/user/officevideoshttps://www.youtube.com/user/officevideos JavaScript-Objekt String

In der folgenden Abbildung wird beschrieben, wie Exchange Server und Outlook bekannte Entitäten für Add-Ins unterstützen und was Add-Ins mit bekannten Entitäten tun können. Weitere Informationen zur Verwendung dieser Entitäten finden Sie unter Abrufen von Entitäten in Ihrem Add-In und Aktivieren eines Add-Ins basierend auf dem Vorhandensein einer Entität.

Unterstützung und Verwendung bekannter Entitäten in einem Outlook-Add-In.

Berechtigungen zum Extrahieren von Entitäten

Fordern Sie unbedingt im Add-In-Manifest die entsprechenden Berechtigungen an, um Entitäten in Ihrem JavaScript-Code extrahieren zu können oder damit Ihr Add-In basierend auf dem Vorhandensein bestimmter bekannter Entitäten aktiviert wird.

Wenn Sie die standardmäßige eingeschränkte Berechtigung angeben, kann Ihr Add-In die AddressEntität , MeetingSuggestionoder TaskSuggestion extrahieren. Um eine der anderen Entitäten zu extrahieren, geben Sie im Manifest die Berechtigung Element lesen, Lesen/Schreiben oder Postfach lesen/schreiben an.

Im folgenden Beispiel wird die Berechtigung zum Lesen von Elementen im Manifest angefordert.

<Permissions>ReadItem</Permissions>

Weitere Informationen zu Outlook-Add-In-Berechtigungen finden Sie unter Grundlegendes zu Outlook-Add-In-Berechtigungen.

Abrufen von Entitäten in Ihrem Add-In

Solange der Betreff oder text des Elements, das vom Benutzer angezeigt wird, Zeichenfolgen enthält, die Exchange und Outlook als bekannte Entitäten erkennen können, sind diese Instanzen für Add-Ins verfügbar. Sie sind auch dann verfügbar, wenn ein Add-In nicht basierend auf bekannten Entitäten aktiviert wird. Mit der entsprechenden Berechtigung können Sie die getEntities - oder getEntitiesByType -Methode verwenden, um bekannte Entitäten abzurufen, die in der aktuellen Nachricht oder dem aktuellen Termin vorhanden sind.

Die getEntities Methode gibt ein Array von Entities-Objekten zurück, das alle bekannten Entitäten im Element enthält.

Wenn Sie an einem bestimmten Entitätstyp interessiert sind, verwenden Sie die getEntitiesByType-Methode, die ein Array nur der gewünschten Entitäten zurückgibt. Die EntityType-Enumeration stellt alle Arten bekannter Entitäten dar, die Sie extrahieren können.

Nach dem Aufrufen getEntitiesvon können Sie dann die entsprechende -Eigenschaft des Entities -Objekts verwenden, um ein Array von Instanzen eines Entitätstyps abzurufen. Abhängig vom Typ der Entität können die Instanzen im Array Zeichenfolgen sein oder bestimmten Objekten zugeordnet sein.

Zum Abrufen von Adressen im Element greifen Sie wie im Beispiel in der vorherigen Abbildung gezeigt auf das von getEntities().addresses[] zurückgegebene Array zu. Die Entities.addresses -Eigenschaft gibt ein Array von Zeichenfolgen zurück, die Outlook als Postadressen erkennt. Ebenso gibt die Entities.contacts Eigenschaft ein Array von Contact Objekten zurück, die Outlook als Kontaktinformationen erkennt. In Tabelle 1 ist der Objekttyp einer Instanz jeder unterstützten Entität aufgeführt.

Im folgenden Beispiel wird gezeigt, wie Sie in einer Nachricht gefundene Adressen abrufen.

// Get the address entities from the item.
const entities = Office.context.mailbox.item.getEntities();
// Check to make sure that address entities are present.
if (null != entities && null != entities.addresses && undefined != entities.addresses) {
   //Addresses are present, so use them here.
}

Aktivieren eines Add-Ins basierend auf dem Vorhandensein einer Entität

Eine andere Möglichkeit für die Verwendung von bekannten Entitäten ist, dass Outlook Ihr Add-In basierend auf dem Vorhandensein eines oder mehrerer Typen von Entitäten im Betreff oder im Nachrichtentext des aktuell angezeigten Elements aktiviert. Dazu geben Sie eine ItemHasKnownEntity Regel im Add-In-Manifest an. Der einfache EntityType-Typ stellt die verschiedenen Typen bekannter Entitäten dar, die von Regeln unterstützt werden ItemHasKnownEntity . Nachdem das Add-In aktiviert wurde, können Sie die Instanzen dieser Entitäten auch für Ihre Zwecke abrufen, wie im vorherigen Abschnitt Abrufen von Entitäten in Ihrem Add-In beschrieben.

Sie können optional einen regulären Ausdruck in einer ItemHasKnownEntity Regel anwenden, um Instanzen einer Entität weiter zu filtern und Outlook ein Add-In nur für eine Teilmenge der Instanzen der Entität zu aktivieren. Beispielsweise können Sie einen Filter für die Postanschriftenentität in einer Nachricht angeben, die eine Postleitzahl für den Bundesstaat Washington enthält und mit "98" beginnt. Um einen Filter auf die Entitätsinstanzen anzuwenden, verwenden Sie die RegExFilter Attribute und FilterName im Rule Element des ItemHasKnownEntity-Typs .

Ähnlich wie bei anderen Aktivierungsregeln können Sie mehrere Regeln angeben, um eine Regelsammlung für Ihr Add-In zu bilden. Im folgenden Beispiel wird ein "AND"-Vorgang auf zwei Regeln angewendet: eine ItemIs Regel und eine ItemHasKnownEntity Regel. Diese Regelsammlung aktiviert das Add-In immer dann, wenn das aktuelle Element eine Nachricht ist und Outlook eine Adresse im Betreff oder im Textkörper des Elements erkennt.

<Rule xsi:type="RuleCollection" Mode="And">
   <Rule xsi:type="ItemIs" ItemType="Message" />
   <Rule xsi:type="ItemHasKnownEntity" EntityType="Address" />
</Rule>

Im folgenden Beispiel wird das aktuelle Element verwendet getEntitiesByType , um eine Variable addresses auf die Ergebnisse der vorherigen Regelauflistung festzulegen.

const addresses = Office.context.mailbox.item.getEntitiesByType(Office.MailboxEnums.EntityType.Address);

Im folgenden ItemHasKnownEntity Regelbeispiel wird das Add-In aktiviert, wenn eine URL im Betreff oder Textkörper des aktuellen Elements vorhanden ist und die URL die Zeichenfolge "youtube" enthält, unabhängig vom Groß-/Kleinschreibung der Zeichenfolge.

<Rule xsi:type="ItemHasKnownEntity" 
    EntityType="Url" 
    RegExFilter="youtube"
    FilterName="youtube"
    IgnoreCase="true"/>

Im folgenden Beispiel wird das aktuelle Element verwendet getFilteredEntitiesByName(name) , um eine Variable videos festzulegen, um ein Array von Ergebnissen abzurufen, die dem regulären Ausdruck in der vorherigen ItemHasKnownEntity Regel entsprechen.

const videos = Office.context.mailbox.item.getFilteredEntitiesByName(youtube);

Tipps zur Verwendung bekannter Entitäten

Es gibt einige wenige Aspekte und Beschränkungen, die Sie beachten sollten, wenn Sie bekannte Entitäten in Ihrem Add-In verwenden. Folgendes gilt, solange Das Add-In aktiviert wird, wenn der Benutzer ein Element liest, das Übereinstimmungen bekannter Entitäten enthält, unabhängig davon, ob Sie eine ItemHasKnownEntity Regel verwenden.

  • Sie können Zeichenfolgen, bei denen es sich um bekannte Entitäten handelt, nur dann extrahieren, wenn die Zeichenfolgen in Englisch vorliegen.

  • Sie können bekannte Entitäten aus den ersten 2.000 Zeichen im Elementtext extrahieren, aber nicht über diesen Grenzwert hinaus. Diese Größenbeschränkung trägt dazu bei, den Bedarf an Funktionalität und Leistung auszugleichen, sodass Exchange Server und Outlook nicht durch das Analysieren und Identifizieren von Instanzen bekannter Entitäten in großen Nachrichten und Terminen beeinträchtigt werden. Beachten Sie, dass dieser Grenzwert unabhängig davon ist, ob das Add-In eine ItemHasKnownEntity Regel angibt. Wenn das Add-In eine solche Regel verwendet, beachten Sie auch den Grenzwert für die Regelverarbeitung für Outlook unter Windows und auf Mac weiter unten in diesem Abschnitt.

  • Sie können Entitäten aus Terminen extrahieren, bei denen es sich um Besprechungen handelt, die von einer anderen Person als dem Besitzer des Postfachs organisiert wurden. Sie können keine Entitäten aus Kalenderelementen extrahieren, bei denen es sich nicht um Besprechungen oder Besprechungen handelt, die vom Postfachbesitzer organisiert werden.

  • Sie können Entitäten des MeetingSuggestion Typs nur aus Nachrichten extrahieren, aber nicht aus Terminen.

  • Sie können URLs extrahieren, die explizit im Elementtextkörper vorhanden sind, jedoch keine URLs, die in Hyperlinktext im HTML-Elementtextköper eingebettet sind. Erwägen Sie stattdessen die Verwendung einer ItemHasRegularExpressionMatch Regel, um sowohl explizite als auch eingebettete URLs abzurufen. Geben Sie BodyAsHTML als PropertyName und einen regulären Ausdruck an, der URLs als RegExValue entspricht.

  • Sie können keine Entitäten aus Elementen im Ordner Gesendete Elemente extrahieren.

Darüber hinaus gilt Folgendes, wenn Sie eine ItemHasKnownEntity-Regel verwenden, und kann sich auf die Szenarien auswirken, in denen Sie andernfalls erwarten würden, dass Ihr Add-In aktiviert wird.

  • Wenn Sie die ItemHasKnownEntity Regel verwenden, erwarten Sie, dass Outlook Entitätszeichenfolgen nur in Englisch abgleicht, unabhängig vom im Manifest angegebenen Standardgebietsschema.

  • Wenn Ihr Add-In in Outlook unter Windows oder auf Mac ausgeführt wird, wird erwartet, dass Outlook die ItemHasKnownEntity Regel auf das erste Megabyte des Elementtexts und nicht auf den Rest des Textkörpers über diesen Grenzwert anwendet.

  • Sie können eine ItemHasKnownEntity Regel nicht verwenden, um ein Add-In für Elemente im Ordner Gesendete Elemente zu aktivieren.

Siehe auch