Documents - Index

Referens

Service:: Search Service

API Version:: 2023-11-01

Skickar en batch med dokumentskrivningsåtgärder till indexet.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string	Slutpunkts-URL:en för söktjänsten.
indexName	path	True	string	Namnet på indexet.
api-version	query	True	string	Klient-API-version.

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-request-id		string uuid	Spårnings-ID:t som skickas med begäran för att hjälpa till med felsökning.

Begärandetext

Name	Obligatorisk	Typ	Description
value	True	IndexAction[]	Åtgärderna i batchen.

Svar

Name	Typ	Description
200 OK	IndexDocumentsResult	Svar som innehåller status för åtgärder för alla åtgärder i batchen.
Other Status Codes	IndexDocumentsResult	Svar som innehåller status för åtgärder för alla åtgärder i batchen.
Other Status Codes	SearchError	Felsvar.

Exempel

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

Definitioner

Name	Description
IndexAction	Representerar en indexåtgärd som körs på ett dokument.
IndexActionType	Åtgärden som ska utföras på ett dokument i en indexeringsbatch.
IndexBatch	Innehåller en batch med dokumentskrivningsåtgärder som ska skickas till indexet.
IndexDocumentsResult	Svar som innehåller status för åtgärder för alla dokument i indexeringsbegäran.
IndexingResult	Status för en indexeringsåtgärd för ett enskilt dokument.
SearchError	Beskriver ett felvillkor för API:et.

IndexAction

Representerar en indexåtgärd som körs på ett dokument.

Name	Typ	Description
@search.action	IndexActionType	Åtgärden som ska utföras på ett dokument i en indexeringsbatch.

IndexActionType

Åtgärden som ska utföras på ett dokument i en indexeringsbatch.

Name	Typ	Description
delete	string	Tar bort det angivna dokumentet från indexet. Alla fält som du anger i en borttagningsåtgärd förutom nyckelfältet ignoreras. Om du vill ta bort ett enskilt fält från ett dokument använder du merge i stället och anger fältet explicit till null.
merge	string	Sammanfogar de angivna fältvärdena med ett befintligt dokument. Om dokumentet inte finns misslyckas kopplingen. Alla fält som du anger i en sammanfogning ersätter det befintliga fältet i dokumentet. Detta gäller även för samlingar av primitiva och komplexa typer.
mergeOrUpload	string	Fungerar som sammanslagning om det redan finns ett dokument med den angivna nyckeln i indexet. Om dokumentet inte finns fungerar det som att ladda upp med ett nytt dokument.
upload	string	Infogar dokumentet i indexet om det är nytt och uppdaterar det om det finns. Alla fält ersätts i uppdateringsfallet.

IndexBatch

Innehåller en batch med dokumentskrivningsåtgärder som ska skickas till indexet.

Name	Typ	Description
value	IndexAction[]	Åtgärderna i batchen.

IndexDocumentsResult

Svar som innehåller status för åtgärder för alla dokument i indexeringsbegäran.

Name	Typ	Description
value	IndexingResult[]	Listan över statusinformation för varje dokument i indexeringsbegäran.

IndexingResult

Status för en indexeringsåtgärd för ett enskilt dokument.

Name	Typ	Description
errorMessage	string	Felmeddelandet som förklarar varför indexeringsåtgärden misslyckades för dokumentet som identifieras av nyckeln. null om indexeringen lyckades.
key	string	Nyckeln för ett dokument som fanns i indexeringsbegäran.
status	boolean	Ett värde som anger om indexeringsåtgärden lyckades för dokumentet som identifieras av nyckeln.
statusCode	integer	Statuskoden för indexeringsåtgärden. Möjliga värden är: 200 för en lyckad uppdatering eller borttagning, 201 för lyckat dokumentskapande, 400 för ett felaktigt indatadokument, 404 för dokumentet hittades inte, 409 för en versionskonflikt, 422 när indexet är tillfälligt otillgängligt eller 503 för när tjänsten är för upptagen.

SearchError

Beskriver ett felvillkor för API:et.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
details	SearchError[]	En matris med information om specifika fel som ledde till det rapporterade felet.
message	string	En mänsklig läsbar representation av felet.

Share via