Documents - Index

Service:

Search Service

API Version:

2023-11-01

Sendet einen Batch von Dokumentschreibaktionen an den Index.

POST {endpoint}/indexes('{indexName}')/docs/search.index?api-version=2023-11-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string	Die Endpunkt-URL des Suchdiensts.
indexName	path	True	string	Der Name des Index.
api-version	query	True	string	Client-API-Version.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-request-id		string uuid	Die Verfolgungs-ID, die mit der Anforderung gesendet wurde, um beim Debuggen zu helfen.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
value	True	IndexAction[]	Die Aktionen im Batch.

Antworten

Name	Typ	Beschreibung
200 OK	IndexDocumentsResult	Antwort mit der status von Vorgängen für alle Aktionen im Batch.
Other Status Codes	IndexDocumentsResult	Antwort mit der status von Vorgängen für alle Aktionen im Batch.
Other Status Codes	SearchError	Fehlerantwort.

Beispiele

SearchIndexIndexDocuments

Sample Request

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.index?api-version=2023-11-01

{
  "value": [
    {
      "@search.action": "upload",
      "docId": "1",
      "title": "Fancy Stay",
      "description": "Best hotel in town"
    },
    {
      "@search.action": "merge",
      "docId": "2",
      "title": "Roach Motel"
    },
    {
      "@search.action": "mergeOrUpload",
      "docId": "3",
      "title": "Econo Motel"
    },
    {
      "@search.action": "delete",
      "docId": "4"
    }
  ]
}

Sample Response

Status code:

200

{
  "value": [
    {
      "key": "1",
      "status": true,
      "errorMessage": null,
      "statusCode": 201
    },
    {
      "key": "2",
      "status": true,
      "errorMessage": null,
      "statusCode": 200
    },
    {
      "key": "3",
      "status": true,
      "errorMessage": null,
      "statusCode": 200
    },
    {
      "key": "4",
      "status": true,
      "errorMessage": null,
      "statusCode": 200
    }
  ]
}

Status code:

207

{
  "value": [
    {
      "key": "1",
      "status": true,
      "errorMessage": null,
      "statusCode": 200
    },
    {
      "key": "2",
      "status": false,
      "errorMessage": "Document not found.",
      "statusCode": 404
    },
    {
      "key": "3",
      "status": true,
      "errorMessage": null,
      "statusCode": 200
    },
    {
      "key": "4",
      "status": true,
      "errorMessage": null,
      "statusCode": 200
    }
  ]
}

Definitionen

Name	Beschreibung
IndexAction	Stellt eine Indexaktion dar, die für ein Dokument ausgeführt wird.
IndexActionType	Der Vorgang, der für ein Dokument in einem Indizierungsbatch ausgeführt werden soll.
IndexBatch	Enthält einen Batch von Dokumentschreibaktionen, die an den Index gesendet werden sollen.
IndexDocumentsResult	Antwort mit der status von Vorgängen für alle Dokumente in der Indizierungsanforderung.
IndexingResult	Status eines Indizierungsvorgangs für ein einzelnes Dokument.
SearchError	Beschreibt eine Fehlerbedingung für die API.

IndexAction

Stellt eine Indexaktion dar, die für ein Dokument ausgeführt wird.

Name	Typ	Beschreibung
@search.action	IndexActionType	Der Vorgang, der für ein Dokument in einem Indizierungsbatch ausgeführt werden soll.

IndexActionType

Der Vorgang, der für ein Dokument in einem Indizierungsbatch ausgeführt werden soll.

Name	Typ	Beschreibung
delete	string	Hiermit wird das angegebene Dokument aus dem Index gelöscht. Alle Felder, die Sie in einem Löschvorgang angeben, außer dem Schlüsselfeld, werden ignoriert. Wenn Sie ein einzelnes Feld aus einem Dokument entfernen möchten, verwenden Sie stattdessen Merge, und legen Sie das Feld explizit auf NULL fest.
merge	string	Führt die angegebenen Feldwerte mit einem vorhandenen Dokument zusammen. Wenn das Dokument nicht vorhanden ist, schlägt die Zusammenführung fehl. Jedes Feld, das Sie in einer Zusammenführung angeben, ersetzt das vorhandene Feld im Dokument. Dies gilt auch für Auflistungen von primitiven und komplexen Typen.
mergeOrUpload	string	Verhält sich wie merge, wenn ein Dokument mit dem angegebenen Schlüssel bereits im Index vorhanden ist. Wenn das Dokument nicht vorhanden ist, verhält es sich wie beim Hochladen mit einem neuen Dokument.
upload	string	Fügt das Dokument in den Index ein, wenn es neu ist, und aktualisiert es, falls vorhanden. Alle Felder werden im Updatefall ersetzt.

IndexBatch

Enthält einen Batch von Dokumentschreibaktionen, die an den Index gesendet werden sollen.

Name	Typ	Beschreibung
value	IndexAction[]	Die Aktionen im Batch.

IndexDocumentsResult

Antwort mit der status von Vorgängen für alle Dokumente in der Indizierungsanforderung.

Name	Typ	Beschreibung
value	IndexingResult[]	Die Liste der status Informationen für jedes Dokument in der Indizierungsanforderung.

IndexingResult

Status eines Indizierungsvorgangs für ein einzelnes Dokument.

Name	Typ	Beschreibung
errorMessage	string	Die Fehlermeldung, die erklärt, warum der Indizierungsvorgang für das durch den Schlüssel identifizierte Dokument fehlgeschlagen ist; NULL, wenn die Indizierung erfolgreich war.
key	string	Der Schlüssel eines Dokuments, das sich in der Indizierungsanforderung befand.
status	boolean	Ein -Wert, der angibt, ob der Indizierungsvorgang für das durch den Schlüssel identifizierte Dokument erfolgreich war.
statusCode	integer	Der status Code des Indizierungsvorgangs. Mögliche Werte sind: 200 für ein erfolgreiches Aktualisieren oder Löschen, 201 für eine erfolgreiche Dokumenterstellung, 400 für ein falsch formatiertes Eingabedokument, 404 für dokument nicht gefundene Dokumente, 409 für einen Versionskonflikt, 422, wenn der Index vorübergehend nicht verfügbar ist, oder 503 bei zu viel Auslastung des Diensts.

SearchError

Beschreibt eine Fehlerbedingung für die API.

Name	Typ	Beschreibung
code	string	Einer von einem serverdefiniertem Satz von Fehlercodes.
details	SearchError[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
message	string	Eine lesbare Darstellung des Fehlers.