Documents - Index

Tjänst:: Search Service

API-version:: 2026-04-01

Skickar en batch med skrivåtgärder för dokument till indexet.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string (uri)	Slutpunkts-URL:en för söktjänsten.
indexName	path	True	string	Namnet på indexet.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Accept		Accept	Acceptera-rubriken.
x-ms-client-request-id		string (uuid)	En ogenomskinlig, globalt unik, klientgenererad strängidentifierare för begäran.

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 dokument i indexeringsbegäran.
Other Status Codes	IndexDocumentsResult	Svar som innehåller status för åtgärder för alla dokument i indexeringsbegäran.
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Säkerhet

api-key

Typ: apiKey
I: header

OAuth2Auth

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Omfattningar

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

Exempel

SearchIndexIndexDocuments

Exempelbegäran

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

Exempelsvar

Statuskod:: 200

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

Statuskod:: 207

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

Definitioner

Name	Description
Accept	Acceptera-rubriken.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.).
IndexAction	Representerar en indexåtgärd som fungerar i ett dokument.
IndexActionType	Den åtgärd som ska utföras på ett dokument i en indexeringsbatch.
IndexBatch	Innehåller en batch med åtgärder för att skriva dokument 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.

Accept

Uppräkning

Acceptera-rubriken.

Värde	Description
application/json;odata.metadata=none

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info		Den ytterligare informationen.
type	string	Typen av ytterligare information.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Felet ytterligare information.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.).

Name	Typ	Description
error	ErrorDetail	Felet objektet.

IndexAction

Objekt

Representerar en indexåtgärd som fungerar i ett dokument.

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

IndexActionType

Uppräkning

Den åtgärd som ska utföras på ett dokument i en indexeringsbatch.

Värde	Description
upload	Infogar dokumentet i indexet om det är nytt och uppdaterar det om det finns. Alla fält ersätts i uppdateringsfallet.
merge	Sammanfogar de angivna fältvärdena med ett befintligt dokument. Om dokumentet inte finns misslyckas sammanfogningen. Alla fält som du anger i en sammanslagning kommer att ersätta det befintliga fältet i dokumentet. Detta gäller även för samlingar av primitiva och komplexa typer.
mergeOrUpload	Beter sig som sammanfogning om det redan finns ett dokument med den angivna nyckeln i indexet. Om dokumentet inte finns beter det sig som om det laddades upp med ett nytt dokument.
delete	Tar bort det angivna dokumentet från indexet. Alla fält som du anger i en borttagningsåtgärd, förutom nyckelfältet, kommer att 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.

IndexBatch

Objekt

Innehåller en batch med åtgärder för att skriva dokument som ska skickas till indexet.

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

IndexDocumentsResult

Objekt

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

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

IndexingResult

Objekt

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 (int32)	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.