Documents - Index

Szolgáltatás:: Search Service

API-verzió:: 2026-04-01

Dokumentumírási műveletek kötegét küldi az indexbe.

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

URI-paraméterek

Név	In	Kötelező	Típus	Description
endpoint	path	True	string (uri)	A keresési szolgáltatás végpontjának URL-címe.
indexName	path	True	string	Az index neve.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.

Kérelem fejléce

Név	Kötelező	Típus	Description
x-ms-client-request-id		string (uuid)	A kérés átlátszatlan, globálisan egyedi, ügyfél által generált sztringazonosítója.
Accept		Accept	Az Elfogadás fejléce.

Kérelem törzse

Név	Kötelező	Típus	Description
value	True	IndexAction[]	A kötegben lévő műveletek.

Válaszok

Név	Típus	Description
200 OK	IndexDocumentsResult	Az indexelési kérelemben szereplő összes dokumentum műveleteinek állapotát tartalmazó válasz.
Other Status Codes	IndexDocumentsResult	Az indexelési kérelemben szereplő összes dokumentum műveleteinek állapotát tartalmazó válasz.
Other Status Codes	ErrorResponse	Váratlan hibaválasz.

Biztonság

api-key

Típus: apiKey
In: header

OAuth2Auth

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Hatókörök

Név	Description
https://search.azure.com/.default

Példák

SearchIndexIndexDocuments

Mintakérelem

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

Mintaválasz

Állapotkód:: 200

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

Állapotkód:: 207

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

Definíciók

Név	Description
Accept	Az Elfogadás fejléce.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Az Összes Azure Resource Manager API gyakori hibaválasza a sikertelen műveletek hibaadatainak visszaadásához. (Ez az OData hibaválasz formátumát is követi.)
IndexAction	Egy dokumentumon működő indexműveletet jelöl.
IndexActionType	Az indexelési kötegben lévő dokumentumon végrehajtandó művelet.
IndexBatch	Az indexbe küldendő dokumentumírási műveletek kötegét tartalmazza.
IndexDocumentsResult	Az indexelési kérelemben szereplő összes dokumentum műveleteinek állapotát tartalmazó válasz.
IndexingResult	Egyetlen dokumentum indexelési műveletének állapota.

Accept

Felsorolás

Az Elfogadás fejléce.

Érték	Description
application/json;odata.metadata=none

ErrorAdditionalInfo

Tárgy

Az erőforrás-kezelési hiba további információi.

Név	Típus	Description
info		A további információk.
type	string	A további információtípus.

ErrorDetail

Tárgy

A hiba részletei.

Név	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hiba célpontja.

ErrorResponse

Tárgy

Az Összes Azure Resource Manager API gyakori hibaválasza a sikertelen műveletek hibaadatainak visszaadásához. (Ez az OData hibaválasz formátumát is követi.)

Név	Típus	Description
error	ErrorDetail	A hibaobjektum.

IndexAction

Tárgy

Egy dokumentumon működő indexműveletet jelöl.

Név	Típus	Description
@search.action	IndexActionType	Az indexelési kötegben lévő dokumentumon végrehajtandó művelet.

IndexActionType

Felsorolás

Az indexelési kötegben lévő dokumentumon végrehajtandó művelet.

Érték	Description
upload	Beszúrja a dokumentumot az indexbe, ha az új, és frissíti, ha létezik. A frissítési esetben az összes mező lecserélődik.
merge	Egyesíti a megadott mezőértékeket egy meglévő dokumentummal. Ha a dokumentum nem létezik, az egyesítés sikertelen lesz. Az egyesítésben megadott mezők lecserélik a dokumentum meglévő mezőjét. Ez vonatkozik a primitív és összetett típusú gyűjteményekre is.
mergeOrUpload	Úgy viselkedik, mint az egyesítés, ha egy adott kulccsal rendelkező dokumentum már létezik az indexben. Ha a dokumentum nem létezik, úgy viselkedik, mintha új dokumentumot töltene fel.
delete	Eltávolítja a megadott dokumentumot az indexből. A törlési műveletben megadott mezőket, kivéve a kulcsmezőt, a rendszer figyelmen kívül hagyja. Ha el szeretne távolítani egy mezőt egy dokumentumból, használja inkább a merge parancsot, és állítsa a mezőt explicit módon null értékre.

IndexBatch

Tárgy

Az indexbe küldendő dokumentumírási műveletek kötegét tartalmazza.

Név	Típus	Description
value	IndexAction[]	A kötegben lévő műveletek.

IndexDocumentsResult

Tárgy

Az indexelési kérelemben szereplő összes dokumentum műveleteinek állapotát tartalmazó válasz.

Név	Típus	Description
value	IndexingResult[]	Az indexelési kérelemben szereplő egyes dokumentumok állapotadatainak listája.

IndexingResult

Tárgy

Egyetlen dokumentum indexelési műveletének állapota.

Név	Típus	Description
errorMessage	string	A kulcs által azonosított dokumentum indexelési műveletének sikertelenségével kapcsolatos hibaüzenet; null értékű, ha az indexelés sikeres volt.
key	string	Az indexelési kérelemben szereplő dokumentum kulcsa.
status	boolean	Egy érték, amely jelzi, hogy az indexelési művelet sikeres volt-e a kulcs által azonosított dokumentum esetében.
statusCode	integer (int32)	Az indexelési művelet állapotkódja. Lehetséges értékek: 200 sikeres frissítés vagy törlés, 201 sikeres dokumentumlétrehozás, 400 helytelen formátumú bemeneti dokumentum esetén, 404 nem található dokumentum esetén, 409 verzióütközés esetén, 422, ha az index átmenetileg nem érhető el, vagy 503, ha a szolgáltatás túl elfoglalt.