Feedback Bearbeiten

searchRequest-Ressourcentyp

  • Artikel
  • 3 Minuten Lesedauer

Namespace: microsoft.graph

Wichtig

APIs unter der /beta Version in Microsoft Graph können geändert werden. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in Version 1.0 verfügbar ist, verwenden Sie die Versionsauswahl .

Achtung

Bei Ressourcen, die in einer Microsoft Search API-Anfrage und -Antwort verwendet werden, wurden Eigenschaften umbenannt oder entfernt, oder sie sind veraltet. Hier finden Sie weitere Einzelheiten über das Ende der Unterstützung. Aktualisieren Sie Such-API-Abfragen in allen früheren Apps entsprechend.

Eine Suchanforderung, die in einem JSON-Blob formatiert ist.

Das JSON-Blob enthält die Typen von Ressourcen, die in der Antwort erwartet werden, die zugrunde liegenden Quellen, Pagingparameter, Sortieroptionen, angeforderte Aggregationen und Felder und die tatsächliche Suchabfrage. Sehen Sie sich Beispiele für Suchanfragen für verschiedene Ressourcen an.

Hinweis

Beachten Sie bekannte Einschränkungen bei der Suche nach bestimmten Kombinationen von Entitätstypen und beim Sortieren oder Aggregieren von Suchergebnissen.

Eigenschaften

Eigenschaft Typ Beschreibung
aggregations aggregationOption-Auflistung Gibt Aggregationen (auch als Einschränkungen bezeichnet) an, die zusammen mit suchergebnissen zurückgegeben werden sollen. Optional.
aggregationFilters String collection Enthält einen oder mehrere Filter, um Suchergebnisse zu erhalten, die aggregiert und nach einem bestimmten Wert eines Felds gefiltert werden. Optional.
Erstellen Sie diesen Filter basierend auf einer vorherigen Suche, die nach demselben Feld aggregiert. Identifizieren Sie aus der Antwort der vorherigen Suche den searchBucket, der 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 gibt das Suchen und Aggregieren von Laufwerkselementen nach Dateityp einen searchBucket für den Dateityp docx in der Antwort zurück. You can conveniently use the aggregationFilterToken returned for this searchBucket in a subsequent search query and filter matches down to drive items of the docx file type. Beispiel 1 und Beispiel 2 zeigen die tatsächlichen Anforderungen und Antworten.
contentSources Zeichenfolgensammlung Enthält die zu verwendende Verbindung.
Berücksichtigt das folgende Format: /external/connections/connectionid gibt an, wo connectionid die ConnectionId in der Connectors-Verwaltung definiert ist.
Hinweis: contentSource ist nur anwendbar, wenn entityType=externalItem. Optional.
enableTopResults Boolean Dadurch wird die Hybridsortierung für Nachrichten ausgelöst: Die ersten drei Nachrichten sind die relevantesten Nachrichten. Diese Eigenschaft gilt nur für entityType=message. Optional.
entityTypes entityType-Auflistung Mindestens ein Ressourcentyp, der in der Antwort erwartet wird. Mögliche Werte: list, site, listItem, message, event, drive, driveItem, person, externalItem. Sehen Sie sich bekannte Einschränkungen für kombinationen von zwei oder mehr Entitätstypen an, die in derselben Suchanforderung unterstützt werden. Erforderlich.
fields String collection 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, einschließlich zusätzlicher Felder wie benutzerdefinierter verwalteter Eigenschaften aus SharePoint und OneDrive oder benutzerdefinierter Felder in externalItem aus Inhalten, die Microsoft Graph Connectors eingibt.
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 mit 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 Stellt Abfrageänderungsoptionen bereit, die als JSON-Blob formatiert sind und zwei optionale Flags im Zusammenhang mit der Rechtschreibkorrektur enthalten. Optional.
resultTemplateOptions resultTemplateOption-Auflistung Stellt die Optionen für Suchergebnisvorlagen zum Rendern von Connectors-Suchergebnissen bereit.
size Int32 Die Größe der abzurufenden Seite. Optional.
sortProperties sortProperty-Auflistung Enthält die sortierte Auflistung von Feldern und die Richtung zum Sortieren von Ergebnissen. Es können höchstens 5 Sortiereigenschaften in der Auflistung vorhanden sein. Optional.
trimDuplicates Boolescher Wert Gibt an, ob die duplizierten SharePoint Dateien aus den Suchergebnissen entfernt werden sollen. Der Standardwert ist false. Optional.
stored_fields (veraltet) Zeichenfolgensammlung Diese wird nun durch die Fields-Eigenschaft ersetzt.

JSON-Darstellung

Es folgt eine JSON-Darstellung der Ressource.

{
  "aggregationFilters": ["String"],
  "aggregations": [{"@odata.type": "microsoft.graph.aggregationOption"}],
  "contentSources": ["String"],
  "enableTopResults": true,
  "entityTypes": ["String"],
  "fields": ["String"],
  "from": 1024,
  "query": {"@odata.type": "microsoft.graph.searchQuery"},
  "queryAlterationOptions": {"@odata.type": "microsoft.graph.searchAlterationOptions"},
  "resultTemplateOptions": [{"@odata.type": "microsoft.graph.resultTemplateOption"}],
  "size": 1024,
  "sortProperties": [{"@odata.type": "microsoft.graph.sortProperty"}],
  "trimDuplicates": false
}

Siehe auch