searchRequest-Ressourcentyp

  • Artikel

Namespace: microsoft.graph

Eine In einem JSON-Blob formatierte Suchanforderung.

Das JSON-Blob enthält die in der Antwort erwarteten Ressourcentypen, die zugrunde liegenden Quellen, Pagingparameter, Sortieroptionen, angeforderte Aggregationen und Felder sowie die tatsächliche Suchabfrage. Sehen Sie sich Beispiele für Suchanforderungen für verschiedene Ressourcen an.

Hinweis

Beachten Sie bekannte Einschränkungen beim Durchsuchen bestimmter Kombinationen von Entitätstypen und beim Sortieren oder Aggregieren von Suchergebnissen.

Eigenschaften

Eigenschaft Typ Beschreibung
aggregationFilters String collection Enthält einen oder mehrere Filter zum Abrufen von Suchergebnissen, die auf einen bestimmten Wert eines Felds aggregiert und gefiltert wurden. Optional.
Erstellen Sie diesen Filter basierend auf einer vorherigen Suche, die nach demselben Feld aggregiert wird. Identifizieren Sie aus der Antwort der vorherigen Suche das searchBucket , das Ergebnisse auf den spezifischen Wert des Felds filtert, verwenden Sie die Zeichenfolge in der aggregationFilterToken-Eigenschaft , und erstellen Sie eine Aggregationsfilterzeichenfolge im Format "{field}:\"{aggregationFilterToken}\".
Wenn mehrere Werte für dasselbe Feld angegeben werden müssen, verwenden Sie die Zeichenfolgen in der aggregationFilterToken-Eigenschaft , und erstellen Sie eine Aggregationsfilterzeichenfolge im Format "{field}:or(\"{aggregationFilterToken1}\",\"{aggregationFilterToken2}\")".
Beispielsweise wird beim Suchen und Aggregieren von Laufwerkselementen nach Dateityp ein searchBucket für den Dateityp docx in der Antwort zurückgegeben. Sie können das aggregationFilterToken , das für dieses searchBucket zurückgegeben wird, bequem in einer nachfolgenden Suchabfrage verwenden und Übereinstimmungen nach unten zu Laufwerkselementen des docx Dateityps filtern. In Beispiel 1 und Beispiel 2 werden die tatsächlichen Anforderungen und Antworten angezeigt.
aggregations aggregationOption-Sammlung Gibt Aggregationen (auch als Einschränkungen bezeichnet) an, die zusammen mit Suchergebnissen zurückgegeben werden sollen. Optional.
collapseProperties collapseProperty-Auflistung Enthält die sortierte Auflistung von Feldern und das Limit zum Reduzieren der Ergebnisse. Optional.
contentSources String collection Enthält die Verbindung, die als Ziel verwendet werden soll.
enableTopResults Boolesch Dadurch wird die Hybridsortierung für Nachrichten ausgelöst: Die ersten drei Nachrichten sind die relevantesten. Diese Eigenschaft gilt nur für entityType=message. Optional.
entityTypes entityType-Auflistung Mindestens ein Ressourcentyp, der in der Antwort erwartet wird. Mögliche Werte sind: event, message, driveItem, externalItem, site, list, listItem, drive, chatMessage, person, acronym und bookmark. Beachten Sie, dass Sie den Prefer: include-unknown-enum-members Anforderungsheader verwenden müssen, um die folgenden Werte in dieser verteilbaren Enumeration abzurufen: chatMessage, person, acronym, bookmark. Weitere Informationen finden Sie unter Bekannte Einschränkungen für die Kombinationen von zwei oder mehr Entitätstypen, die in derselben Suchanforderung unterstützt werden. Erforderlich.
fields Zeichenfolgensammlung Enthält die Felder, die für jedes in entityTypes angegebene Ressourcenobjekt zurückgegeben werden sollen, sodass die standardmäßig zurückgegebenen Felder angepasst werden können. andernfalls zusätzliche Felder wie benutzerdefinierte verwaltete Eigenschaften aus SharePoint und OneDrive oder benutzerdefinierte Felder in externalItem aus dem Inhalt, den Microsoft Graph-Connectors einbringen. Die Fields-Eigenschaft kann die semantischen Bezeichnungen verwenden, die auf Eigenschaften angewendet werden. Wenn eine Eigenschaft beispielsweise als Titel bezeichnet wird, können Sie sie mithilfe der folgenden Syntax abrufen: label_title. Optional.
von Int32 Gibt den Offset für die Suchergebnisse an. Offset 0 gibt das erste Ergebnis zurück. Optional.
Abfrage searchQuery Enthält die Abfragebegriffe. Erforderlich.
queryAlterationOptions searchAlterationOptions Abfrageänderungsoptionen, die in einem JSON-Blob formatiert sind und zwei optionale Flags für die Rechtschreibkorrektur enthalten. Optional.
Region String Der geografische Standort für die Suche. Erforderlich für Suchvorgänge, die Anwendungsberechtigungen verwenden. Weitere Informationen finden Sie unter Abrufen des Regionswerts.
resultTemplateOptions resultTemplateOption-Auflistung Stellt die Optionen für Suchergebnisvorlagen zum Rendern von Suchergebnissen aus Connectors bereit.
sharePointOneDriveOptions sharePointOneDriveOptions Gibt die Art von Inhalten an, die durchsucht werden sollen, wenn eine Suche mithilfe von Anwendungsberechtigungen durchgeführt wird. Optional.
size Int32 Die Größe der abzurufenden Seite. Der Maximalwert ist 500. Optional.
sortProperties sortProperty-Auflistung Enthält die sortierte Auflistung von Feldern und die Richtung zum Sortieren der Ergebnisse. Es können maximal 5 Sortiereigenschaften in der Auflistung vorhanden sein. Optional.

JSON-Darstellung

Es folgt eine JSON-Darstellung der Ressource.

{
  "aggregationFilters": ["String"],
  "aggregations": [{"@odata.type": "microsoft.graph.aggregationOption"}],
  "collapseProperties": [{"@odata.type": "microsoft.graph.collapseProperty"}],
  "enableTopResults": "Boolean",
  "entityTypes": ["String"],
  "contentSources": ["String"],
  "fields": ["String"],
  "from": "Int32",
  "query": {"@odata.type": "microsoft.graph.searchQuery"},
  "queryAlterationOptions": {"@odata.type": "microsoft.graph.searchAlterationOptions"},
  "region": "String",
  "resultTemplateOptions": [{"@odata.type": "microsoft.graph.resultTemplateOption"}],
  "sharePointOneDriveOptions": {"@odata.type": "microsoft.graph.sharePointOneDriveOptions"},
  "size": "Int32"
}

Verwandte Inhalte