Zurücksetzen von Dokumenten (Vorschau-REST-API)

  • Artikel
  • 3 Minuten Lesedauer

API-Version: 2021-04-30-Preview, 2020-06-30-Preview, 2019-05-06-Preview

Wichtig

Diese gesamte API ist ein Vorschaufeature, das in 2019-05-06-Preview eingeführt wurde. Es unterstützt Zurücksetzungsszenarien.

Dokumente zurücksetzen ist eine asynchrone API. Damit können Sie Dokumente aus Ihrer Datenquelle selektiv erneut verarbeiten.

Die API akzeptiert zwei Arten von Dokumentbezeichnern als Eingabe. Dabei handelt es sich um Dokumentschlüssel (Schlüssel, die Dokumente in einem Suchindex eindeutig identifizieren) und Datenquellendokumentbezeichner (Schlüssel, die Dokumente in einer Datenquelle eindeutig identifizieren). Beim Aufrufen der API werden die Dokumentschlüssel oder Datenquellendokumentbezeichner hinzugefügt, die den Indexermetadaten zurückgesetzt werden sollen. Bei der nächsten geplanten oder bedarfsgesteuerten Ausführung des Indexers verarbeitet der Indexer nur die Zurücksetzungsdokumente.

  • Für Indexer mit aktiviertem Skillset und inkrementeller Anreicherung löscht die API den Cache und führt das vollständige Skillset nur für die angegebenen Dokumente erneut aus.
  • Bei Indexern ohne Skillset liest die API einfach das Quelldokument aus der Datenquelle und aktualisiert/fügt den Inhalt in den Index ein.

Wenn Sie Dokumentschlüssel zum Zurücksetzen von Dokumenten verwenden und auf Ihre Dokumentschlüssel in einer Indexerfeldzuordnung verwiesen wird, verwendet der Indexer die Feldzuordnung, um das entsprechende Feld in der zugrunde liegenden Datenquelle zu suchen.

Die API funktioniert für alle Indexer (mit oder ohne Skillset). Sie können ihn mithilfe einer HTTP POST-Anforderung aufrufen. Wenn der Aufruf erfolgreich ist, erhalten Sie immer die Antwort 204 NoContent. Geben Sie den Namen des Indexers an, der für den Anforderungs-URI aktualisiert werden soll:

POST https://[service name].search.windows.net/indexers/[indexer name]/resetdocs?api-version=[api-version]
    Content-Type: application/json
    api-key: [admin key]

URI-Parameter

Parameter BESCHREIBUNG
Dienstname Erforderlich. Legen Sie dies auf den eindeutigen, benutzerdefinierten Namen Ihres Suchdiensts fest.
Indexername Erforderlich. Der Anforderungs-URI gibt den Namen des zu aktualisierenden Indexers an.
api-version Erforderlich. Die aktuelle Version ist api-version=2021-04-30-Preview. Weitere Versionen finden Sie unter API-Versionen .
overwrite Optional. Dieser Parameter bestimmt, ob aufeinanderfolgende Vorgänge zum Zurücksetzen von Dokumenten kombiniert oder überschrieben werden. Der Standardwert ist "false". Bei false wird die Nutzlast des Aufrufs von Dokumentschlüsseln oder Datenquellendokumentbezeichnern der Liste der Schlüssel hinzugefügt, die bereits zur erneuten Verarbeitung in die Warteschlange eingereiht wurden. Wenn true, überschreibt die Nutzlast des Aufrufs von Dokumentschlüsseln oder Datenquellendokumentbezeichnern die vorhandene Liste, einschließlich des Löschens der Liste der Zurücksetzungsdokumente, wenn Sie die Schlüssel auf NULL festlegen.

Anforderungsheader

Die folgende Tabelle beschreibt die erforderlichen und optionalen Anforderungsheader.

Felder BESCHREIBUNG
Content-Type Erforderlich. Auf application/json
api-key Erforderlich. api-key wird zum Authentifizieren der Anforderung beim Search-Dienst verwendet. Es handelt sich um einen für Ihren Dienst eindeutigen Zeichenfolgewert. Zurücksetzungsanforderungen müssen einen api-key Header enthalten, der auf Ihren Administratorschlüssel (im Gegensatz zu einem Abfrageschlüssel) festgelegt ist. Sie finden den API-Schlüssel in Ihrem Suchdienstdashboard im Azure-Portal.

Anforderungstext

Der Text sollte entweder eine Liste von Dokumentschlüsseln oder eine Liste von Datenquellendokumentbezeichnern enthalten, nach denen der Indexer in der Datenquelle sucht.

Der folgende JSON-Code ist eine allgemeine Darstellung der Hauptteile der Definition.

{
    "documentKeys" : [
        "key1",
        "key2",
        "key3"
    ],
    "datasourceDocumentIds" : [
        "key1",
        "key2",
        "key3"
    ],
}

Die Anforderung enthält die folgenden Eigenschaften, und beachten Sie, dass nur eine der "documentKeys" und "datasourceDocumentIds" bereitgestellt werden sollte:

Eigenschaft BESCHREIBUNG
documentKeys Dies ist der Satz von Dokumentschlüsseln, die der Indexer selektiv aus seiner Datenquelle verarbeitet. Wenn Sie diese Aktion mehrmals aufrufen, werden Dokumentschlüsselsätze standardmäßig aneinander angefügt. Dieses Verhalten kann geändert werden, um zu überschreiben, anstatt über den Überschreibungs-URI-Parameter anzufügen (siehe oben). Wenn der Indexer nicht mehr versucht, Zurücksetzungsdokumente zu verarbeiten, können Sie "documentKeys" auf eine leere Liste "[]" festlegen. Dies führt dazu, dass der Indexer die reguläre Indizierung basierend auf der Obergrenze wieder aufgibt. Ungültige Dokumentschlüssel oder Dokumentschlüssel, die nicht vorhanden sind, werden ignoriert.
datasourceDocumentIds Dies ist der Satz von Datenquellendokumentbezeichnern, die der Indexer selektiv aus seiner Datenquelle verarbeitet. Standardmäßig werden beim mehrfachen Aufrufen dieser Aktion Datenquellendokumentbezeichner aneinander angefügt. Dieses Verhalten kann geändert werden, um zu überschreiben, anstatt über den Überschreibungs-URI-Parameter anzufügen (siehe oben). Wenn der Indexer nicht mehr versucht, Zurücksetzungsdokumente zu verarbeiten, können Sie "datasourceDocumentIds" auf eine leere Liste "[]" festlegen. Dies führt dazu, dass der Indexer die reguläre Indizierung basierend auf der Obergrenze wieder aufgibt. Ungültige Datenquellendokumentbezeichner oder Datenquellendokumentbezeichner, die nicht vorhanden sind, werden ignoriert.

Antwort

204 Kein Inhalt für eine erfolgreiche Anforderung.

Weitere Informationen