Documents - Index

Dienst:: Search Service

API-Version:: 2026-04-01

Sendet einen Stapel von Dokumentschreibaktionen an den Index.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string (uri)	Die Endpunkt-URL des Suchdiensts.
indexName	path	True	string	Der Name des Indexes.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Accept		Accept	Die Überschrift "Annehmen".
x-ms-client-request-id		string (uuid)	Ein undurchsichtiger, global eindeutiger, clientgenerierter Zeichenfolgenbezeichner für die Anforderung.

Anforderungstext

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

Antworten

Name	Typ	Beschreibung
200 OK	IndexDocumentsResult	Antwort, die den Status der Vorgänge für alle Dokumente in der Indizierungsanforderung enthält.
Other Status Codes	IndexDocumentsResult	Antwort, die den Status der Vorgänge für alle Dokumente in der Indizierungsanforderung enthält.
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

api-key

Typ: apiKey
In: header

OAuth2Auth

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiche

Name	Beschreibung
https://search.azure.com/.default

Beispiele

SearchIndexIndexDocuments

Beispielanforderung

HTTP

POST https://exampleservice.search.windows.net/indexes('example-index')/docs/search.index?api-version=2026-04-01


{
  "value": [
    {
      "@search.action": "mergeOrUpload",
      "id": "0",
      "name": "test",
      "description": "test0 hello",
      "vector1": [
        0,
        1,
        2,
        3,
        4,
        5,
        6,
        7,
        8,
        9,
        10,
        11,
        12,
        13,
        14,
        15,
        16,
        17,
        18,
        19
      ],
      "vector1b": [
        10,
        11,
        12,
        13,
        14,
        15,
        16,
        17,
        18,
        19
      ],
      "vector2": [
        0,
        1,
        2,
        3,
        4
      ],
      "vector3": [
        0,
        1,
        2,
        3,
        4
      ],
      "vector22": [
        20,
        21,
        22,
        23,
        24,
        25,
        26,
        27,
        28,
        29
      ],
      "ownerId": "benny",
      "category": "purple",
      "price": 0
    },
    {
      "@search.action": "mergeOrUpload",
      "id": "1",
      "name": "test",
      "description": "test1 hello",
      "vector1": [
        1,
        2,
        3,
        4,
        5,
        6,
        7,
        8,
        9,
        10,
        11,
        12,
        13,
        14,
        15,
        16,
        17,
        18,
        19,
        20
      ],
      "vector1b": [
        11,
        12,
        13,
        14,
        15,
        16,
        17,
        18,
        19,
        20
      ],
      "vector2": [
        1,
        2,
        3,
        4,
        5
      ],
      "vector3": [
        1,
        2,
        3,
        4,
        5
      ],
      "vector22": [
        21,
        22,
        23,
        24,
        25,
        26,
        27,
        28,
        29,
        30
      ],
      "ownerId": "sam",
      "category": "purple",
      "price": 1
    },
    {
      "@search.action": "mergeOrUpload",
      "id": "2",
      "name": "test",
      "description": "test2 hello",
      "vector1": [
        2,
        3,
        4,
        5,
        6,
        7,
        8,
        9,
        10,
        11,
        12,
        13,
        14,
        15,
        16,
        17,
        18,
        19,
        20,
        21
      ],
      "vector1b": [
        12,
        13,
        14,
        15,
        16,
        17,
        18,
        19,
        20,
        21
      ],
      "vector2": [
        2,
        3,
        4,
        5,
        6
      ],
      "vector3": [
        2,
        3,
        4,
        5,
        6
      ],
      "vector22": [
        22,
        23,
        24,
        25,
        26,
        27,
        28,
        29,
        30,
        31
      ],
      "ownerId": "sam",
      "category": "purple",
      "price": 2
    }
  ]
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "value": [
    {
      "key": "0",
      "status": true,
      "statusCode": 201
    },
    {
      "key": "1",
      "status": true,
      "statusCode": 201
    },
    {
      "key": "2",
      "status": true,
      "statusCode": 201
    }
  ]
}

Statuscode:: 207

{
  "value": [
    {
      "key": "0",
      "status": true,
      "statusCode": 201
    },
    {
      "key": "1",
      "status": true,
      "statusCode": 201
    },
    {
      "key": "2",
      "status": true,
      "statusCode": 201
    }
  ]
}

Definitionen

Name	Beschreibung
Accept	Die Überschrift "Annehmen".
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Übliche Fehlerantwort für alle Azure Resource Manager APIs, um Fehlerdetails bei fehlgeschlagenen Operationen zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)
IndexAction	Stellt eine Indexaktion dar, die auf einem Dokument ausgeführt wird.
IndexActionType	Der Vorgang, der für ein Dokument in einem Indizierungsbatch ausgeführt werden soll.
IndexBatch	Enthält einen Stapel von Dokumentschreibaktionen, die an den Index gesendet werden sollen.
IndexDocumentsResult	Antwort, die den Status der Vorgänge für alle Dokumente in der Indizierungsanforderung enthält.
IndexingResult	Status eines Indizierungsvorgangs für ein einzelnes Dokument.

Accept

Enumeration

Die Überschrift "Annehmen".

Wert	Beschreibung
application/json;odata.metadata=none

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info		Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

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

ErrorResponse

Objekt

Übliche Fehlerantwort für alle Azure Resource Manager APIs, um Fehlerdetails bei fehlgeschlagenen Operationen zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

IndexAction

Objekt

Stellt eine Indexaktion dar, die auf einem 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

Enumeration

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

Wert	Beschreibung
upload	Fügt das Dokument in den Index ein, wenn es neu ist, und aktualisiert es, wenn es vorhanden ist. Alle Felder werden im Verbuchungsfall ersetzt.
merge	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 einem Seriendruck angeben, ersetzt das vorhandene Feld im Dokument. Dies gilt auch für Auflistungen von primitiven und komplexen Typen.
mergeOrUpload	Verhält sich wie merge, wenn ein Dokument mit dem angegebenen Schlüssel bereits im Index vorhanden ist. Wenn das Dokument nicht existiert, verhält es sich wie das Hochladen mit einem neuen Dokument.
delete	Entfernt das angegebene Dokument aus dem Index. Alle Felder, die Sie in einem Löschvorgang angeben, mit Ausnahme des Schlüsselfelds, werden ignoriert. Wenn Sie ein einzelnes Feld aus einem Dokument entfernen möchten, verwenden Sie stattdessen "merge" (Zusammenführung), und setzen Sie das Feld explizit auf null.

IndexBatch

Objekt

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

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

IndexDocumentsResult

Objekt

Antwort, die den Status der Vorgänge für alle Dokumente in der Indizierungsanforderung enthält.

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

IndexingResult

Objekt

Status eines Indizierungsvorgangs für ein einzelnes Dokument.

Name	Typ	Beschreibung
errorMessage	string	Die Fehlermeldung, in der erläutert wird, warum der Indizierungsvorgang für das vom 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 vom Schlüssel identifizierte Dokument erfolgreich war.
statusCode	integer (int32)	Der Statuscode des Indizierungsvorgangs. Mögliche Werte sind: 200 für eine erfolgreiche Aktualisierung oder Löschung, 201 für eine erfolgreiche Dokumenterstellung, 400 für ein falsch formatiertes Eingabedokument, 404 für das Dokument nicht gefunden, 409 für einen Versionskonflikt, 422, wenn der Index vorübergehend nicht verfügbar ist, oder 503 für den Zeitpunkt, zu dem der Dienst zu ausgelastet ist.