Ressourcentyp searchRequest

Namespace: microsoft.graph

Wichtig

Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.

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.

Der JSON-BLOB enthält die in der Antwort erwarteten Ressourcentypen, die zugrunde liegenden Quellen, Auslagerungsparameter, Sortieroptionen, angeforderten Aggregationen und Felder sowie die eigentliche Suchabfrage. Sehen Sie sich Beispiele für Suchanforderungen für verschiedene Ressourcen an.

Hinweis

Beachte 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 aggregierte und nach einem bestimmten Wert eines Felds gefilterte Suchergebnisse zu erhalten. Optional.
Erstellen Sie diesen Filter auf der Grundlage einer vorherigen Suche, die nach demselben Feld aggregiert wird. Identifizieren Sie aus der Antwort der vorherigen Suche den searchBucket, der Ergebnisse nach dem 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 eingegeben werden müssen, verwenden Sie die Zeichenfolgen in der Eigenschaft aggregationFilterToken, und erstellen Sie eine Aggregationsfilterzeichenfolge im Format "{field}:or(\"{aggregationFilterToken1}\",\"{aggregationFilterToken2}\")".
Beispielsweise wird beim Suchen und Aggregieren von Laufwerkelementen nach Dateityp ein searchBucket für den Dateityp docx in der Antwort zurückgegeben. Sie können das für diesen searchBucket zurückgegebene aggregationFilterToken bequem in einer nachfolgenden Suchabfrage verwenden und Übereinstimmungen filtern, um Elemente des docx Dateityps zu steuern. Beispiel 1 und Beispiel 2 zeigen die tatsächlichen Anforderungen und Antworten.
collapseProperties collapseProperty-Sammlung Enthält die sortierte Auflistung der Felder und die Begrenzung zum Reduzieren von Ergebnissen. Optional.
contentSources String collection Enthält die zu adressierende Verbindung.
Respektiert das folgende Format: Dabei connectionid ist die ConnectionId, /external/connections/connectionid die in der Connectorsverwaltung definiert ist.
Hinweis: contentSource ist nur anwendbar, wenn entityType=externalItem. Optional.
enableTopResults Boolean Dadurch wird eine hybride Sortierung für Nachrichten ausgelöst: Die ersten 3 Nachrichten sind am relevantesten. Diese Eigenschaft gilt nur für entityType=message. Optional.
entityTypes entityType-Auflistung Mindestens ein Ressourcentyp, der in der Antwort erwartet wird. Die möglichen Werte sind: list, site, listItem, message, eventexternalItemdrivebookmarkdriveItemacronympersonchatMessage. Details zu Kombinationen aus zwei oder mehr Entitätstypen, die in derselben Suchanfrage unterstützt werden, finden Sie unter Bekannte Einschränkungen. Erforderlich.
fields String collection Enthält die Felder, die für jedes in entityTypes angegebene Ressourcenobjekt zurückgegeben werden sollen, sodass die Felder andernfalls standardmäßig angepasst werden können, einschließlich zusätzlicher Felder wie benutzerdefinierte verwaltete Eigenschaften von SharePoint und OneDrive oder benutzerdefinierte Felder in externalItem aus Inhalten, die von Microsoft 365 Copilot-Connectors eingebunden werden.
Die Fields-Eigenschaft kann die semantischen Bezeichnungen verwenden, die auf Eigenschaften angewendet werden. Wenn eine Eigenschaft beispielsweise als Titel bezeichnet ist, 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 allererste Ergebnis zurück. Optional.
Abfrage searchQuery Enthält die Abfragebegriffe. Erforderlich.
queryAlterationOptions searchAlterationOptions Bietet Abfrageänderungsoptionen, die als JSON-BLOB formatiert sind, das zwei optionale Flags für die Rechtschreibkorrektur enthält. Optional.
Region string Erforderlich für Suchvorgänge, die Anwendungsberechtigungen verwenden. Stellt den geografischen Standort für die Suche dar. Weitere Informationen finden Sie unter Abrufen des Regionswerts.
resultTemplateOptions resultTemplateOption-Sammlung Stellt in den Suchergebnisvorlagen Optionen zum Rendern von Connector-Suchergebnissen bereit.
sharePointOneDriveOptions sharePointOneDriveOptions Gibt die Art des Inhalts an, der durchsucht werden soll, wenn eine Suche mithilfe von Anwendungsberechtigungen ausgeführt wird. Optional.
size Int32 Die Größe der abzurufenden Seite. Der Höchstwert ist 500. Optional.
sortProperties sortProperty-Auflistung Enthält die sortierte Auflistung der Felder und die Richtung zum Sortieren der Ergebnisse. Die Auflistung kann höchstens 5 Sortiereigenschaften enthalten. Optional.
trimDuplicates Boolean Gibt an, ob die doppelten SharePoint-Dateien aus den Suchergebnissen entfernt werden sollen. Der Standardwert ist false. Optional.
stored_fields (veraltet) String collection Dies wird jetzt durch die fields-Eigenschaft ersetzt.

JSON-Darstellung

Die folgende JSON-Darstellung veranschaulicht den Ressourcentyp.

{
  "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"},
  "region": "63128164-cbbf-4db4-896c-a7038417019c",
  "resultTemplateOptions": [{"@odata.type": "microsoft.graph.resultTemplateOption"}],
  "sharePointOneDriveOptions": {"@odata.type": "microsoft.graph.sharePointOneDriveOptions"},
  "size": 1024,
  "sortProperties": [{"@odata.type": "microsoft.graph.sortProperty"}],
  "collapseProperties": [{"@odata.type": "microsoft.graph.collapseProperty"}],
  "trimDuplicates": false
}

Verwandte Inhalte

  • Zuletzt aktualisiert um