Documents - Index

Referenz

Dienst:: Search Service

API-Version:: 2024-05-01-preview

Sendet einen Batch von Dokumentschreibaktionen an den Index.

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

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 Tracking-ID, die mit der Anforderung gesendet wurde, beim Debuggen zu helfen.

Anforderungstext

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

Antworten

Name	Typ	Beschreibung
200 OK	IndexDocumentsResult	Antwort, die die status von Vorgängen für alle Aktionen im Batch enthält.
Other Status Codes	IndexDocumentsResult	Antwort, die die status von Vorgängen für alle Aktionen im Batch enthält.
Other Status Codes	ErrorResponse	Fehlerantwort.

Beispiele

SearchIndexIndexDocuments

Beispielanforderung

HTTP

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

{
  "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"
    }
  ]
}

Beispiel für eine Antwort

Statuscode:: 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
    }
  ]
}

Statuscode:: 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
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
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 mit Dokumentschreibaktionen, die an den Index gesendet werden sollen.
IndexDocumentsResult	Antwort, die die status von Vorgängen für alle Dokumente in der Indizierungsanforderung enthält.
IndexingResult	Status eines Indizierungsvorgangs für ein einzelnes Dokument.

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

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 anderen Löschvorgang als das Schlüsselfeld angeben, 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, tritt beim Zusammenführen ein Fehler auf. Jedes Feld, das Sie in einer Zusammenführung angeben, ersetzt das vorhandene Feld im Dokument. Dies gilt auch für Sammlungen 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 das Hochladen mit einem neuen Dokument.
upload	string	Fügt das Dokument in den Index ein, wenn es neu ist, und aktualisiert es, wenn es vorhanden ist. Alle Felder werden im Updatefall ersetzt.

IndexBatch

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

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

IndexDocumentsResult

Antwort, die die status von Vorgängen für alle Dokumente in der Indizierungsanforderung enthält.

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 gefunden, 409 für einen Versionskonflikt, 422 bei vorübergehender Nichtverfügbarkeit des Indexes oder 503 für den Zeitpunkt, wenn der Dienst zu ausgelastet ist.

Freigeben über