Documents - Index

Service:: Search Service

API-versie:: 2026-04-01

Hiermee verzendt u een batch met schrijfacties voor documenten naar de index.

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string (uri)	De eindpunt-URL van de zoekservice.
indexName	path	True	string	De naam van de index.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagkoptekst

Name	Vereist	Type	Description
Accept		Accept	De Accepteer kop.
x-ms-client-request-id		string (uuid)	Een ondoorzichtige, wereldwijd unieke, door de client gegenereerde tekenreeks-id voor de aanvraag.

Aanvraagbody

Name	Vereist	Type	Description
value	True	IndexAction[]	De acties in de batch.

Antwoorden

Name	Type	Description
200 OK	IndexDocumentsResult	Antwoord met de status van bewerkingen voor alle documenten in de indexeringsaanvraag.
Other Status Codes	IndexDocumentsResult	Antwoord met de status van bewerkingen voor alle documenten in de indexeringsaanvraag.
Other Status Codes	ErrorResponse	Een onverwachte foutreactie.

Beveiliging

api-key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiken

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

Voorbeelden

SearchIndexIndexDocuments

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name	Description
Accept	De Accepteer kop.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Veelvoorkomende foutrespons voor alle Azure Resource Manager API's om foutdetails terug te geven bij mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)
IndexAction	Vertegenwoordigt een indexactie die op een document werkt.
IndexActionType	De bewerking die moet worden uitgevoerd op een document in een indexeringsbatch.
IndexBatch	Bevat een batch met schrijfacties voor documenten die naar de index moeten worden verzonden.
IndexDocumentsResult	Antwoord met de status van bewerkingen voor alle documenten in de indexeringsaanvraag.
IndexingResult	Status van een indexeringsbewerking voor één document.

Accept

Opsomming

De Accepteer kop.

Waarde	Description
application/json;odata.metadata=none

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info		De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoelwit.

ErrorResponse

Object

Veelvoorkomende foutrespons voor alle Azure Resource Manager API's om foutdetails terug te geven bij mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)

Name	Type	Description
error	ErrorDetail	Het foutobject.

IndexAction

Object

Vertegenwoordigt een indexactie die op een document werkt.

Name	Type	Description
@search.action	IndexActionType	De bewerking die moet worden uitgevoerd op een document in een indexeringsbatch.

IndexActionType

Opsomming

De bewerking die moet worden uitgevoerd op een document in een indexeringsbatch.

Waarde	Description
upload	Hiermee wordt het document ingevoegd in de index als het nieuw is en wordt het bijgewerkt als het bestaat. Alle velden worden vervangen in het geval van de update.
merge	Hiermee worden de opgegeven veldwaarden samengevoegd met een bestaand document. Als het document niet bestaat, mislukt de samenvoeging. Elk veld dat u bij een samenvoegbewerking opgeeft, vervangt het bestaande veld in het document. Dit geldt ook voor verzamelingen van primitieve en complexe typen.
mergeOrUpload	Gedraagt zich als samenvoegen als er al een document met de opgegeven sleutel in de index bestaat. Als het document niet bestaat, gedraagt het zich als uploaden met een nieuw document.
delete	Hiermee verwijdert u het opgegeven document uit de index. Elk veld dat u opgeeft in een andere verwijderbewerking dan het sleutelveld, wordt genegeerd. Als u een afzonderlijk veld uit een document wilt verwijderen, gebruikt u in plaats daarvan samenvoegen en stelt u het veld expliciet in op null.

IndexBatch

Object

Bevat een batch met schrijfacties voor documenten die naar de index moeten worden verzonden.

Name	Type	Description
value	IndexAction[]	De acties in de batch.

IndexDocumentsResult

Object

Antwoord met de status van bewerkingen voor alle documenten in de indexeringsaanvraag.

Name	Type	Description
value	IndexingResult[]	De lijst met statusinformatie voor elk document in de indexeringsaanvraag.

IndexingResult

Object

Status van een indexeringsbewerking voor één document.

Name	Type	Description
errorMessage	string	Het foutbericht waarin wordt uitgelegd waarom de indexeringsbewerking is mislukt voor het document dat is geïdentificeerd door de sleutel; null als indexering is geslaagd.
key	string	De sleutel van een document dat zich in de indexeringsaanvraag bevond.
status	boolean	Een waarde die aangeeft of de indexeringsbewerking is geslaagd voor het document dat door de sleutel is geïdentificeerd.
statusCode	integer (int32)	De statuscode van de indexeringsbewerking. Mogelijke waarden zijn: 200 voor een geslaagde update of verwijdering, 201 voor het maken van documenten, 400 voor een ongeldig invoerdocument, 404 voor document niet gevonden, 409 voor een versieconflict, 422 wanneer de index tijdelijk niet beschikbaar is of 503 voor wanneer de service te druk is.