Documents - Index

Service:

Search Service

API Version:

2023-11-01

Hiermee wordt een batch met documentschrijfacties naar de index verzonden.

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string	De eindpunt-URL van de zoekservice.
indexName	path	True	string	De naam van de index.
api-version	query	True	string	Client-API-versie.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-request-id		string uuid	De tracerings-id die met de aanvraag wordt verzonden om te helpen bij foutopsporing.

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 acties in de batch.
Other Status Codes	IndexDocumentsResult	Antwoord met de status van bewerkingen voor alle acties in de batch.
Other Status Codes	SearchError	Foutreactie.

Voorbeelden

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

Definities

Name	Description
IndexAction	Vertegenwoordigt een indexactie die op een document wordt uitgevoerd.
IndexActionType	De bewerking die moet worden uitgevoerd op een document in een indexeringsbatch.
IndexBatch	Bevat een batch 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.
SearchError	Beschrijft een foutvoorwaarde voor de API.

IndexAction

Vertegenwoordigt een indexactie die op een document wordt uitgevoerd.

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

IndexActionType

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

Name	Type	Description
delete	string	Het opgegeven document wordt uit de index verwijderd. 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.
merge	string	Hiermee worden de opgegeven veldwaarden samengevoegd met een bestaand document. Als het document niet bestaat, mislukt de samenvoeging. Alle velden die u in een samenvoeging opgeeft, vervangen de bestaande velden in het document, Dit geldt ook voor verzamelingen van primitieve en complexe typen.
mergeOrUpload	string	Gedraagt zich als samenvoegen als een document met de opgegeven sleutel al in de index bestaat. Als het document niet bestaat, gedraagt het zich als uploaden met een nieuw document.
upload	string	Het document wordt in de index ingevoegd als het nieuw is en werkt het bij als het bestaat. Alle velden worden vervangen in de updatecase.

IndexBatch

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

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

IndexDocumentsResult

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

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 het indexeren 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 wordt geïdentificeerd door de sleutel.
statusCode	integer	De statuscode van de indexeringsbewerking. Mogelijke waarden zijn: 200 voor een geslaagde update of verwijdering, 201 voor geslaagde documentcreatie, 400 voor een onjuist ingedeeld 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.

SearchError

Beschrijft een foutvoorwaarde voor de API.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
details	SearchError[]	Een matrix met details over specifieke fouten die tot deze gerapporteerde fout hebben geleid.
message	string	Een door mensen leesbare weergave van de fout.