Documents - Index

Szolgáltatás:: Search Service

API-verzió:: 2023-10-01-Preview

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

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string	A keresési szolgáltatás végponti URL-címe.
indexName	path	True	string	Az index neve.
api-version	query	True	string	Ügyfél API-verziója.

Kérelem fejléce

Name	Kötelező	Típus	Description
x-ms-client-request-id		string (uuid)	A kéréssel együtt küldött nyomkövetési azonosító, amely segít a hibakeresésben.

Kérelem törzse

Name	Kötelező	Típus	Description
value	True	IndexAction[]	A köteg műveletei.

Válaszok

Name	Típus	Description
200 OK	IndexDocumentsResult	A köteg összes műveletének állapotát tartalmazó válasz.
Other Status Codes	IndexDocumentsResult	A köteg összes műveletének állapotát tartalmazó válasz.
Other Status Codes	SearchError	Hibaválasz.

Példák

SearchIndexIndexDocuments

Mintakérelem

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.index?api-version=2023-10-01-Preview

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

Mintaválasz

Állapotkód:: 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
    }
  ]
}

Állapotkód:: 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
    }
  ]
}

Definíciók

Name	Description
IndexAction	Egy dokumentumon működő indexműveletet jelöl.
IndexActionType	Az indexelő kötegben lévő dokumentumokon 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.
SearchError	Az API hibafeltételét ismerteti.

IndexAction

Tárgy

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

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

IndexActionType

Felsorolás

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

Érték	Description
upload	Beszúrja a dokumentumot az indexbe, ha új, és frissíti, ha létezik. A frissítési esetben minden 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 a primitív és összetett típusú gyűjteményekre is vonatkozik.
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, mint egy új dokumentum feltöltése.
delete	Eltávolítja a megadott dokumentumot az indexből. A rendszer figyelmen kívül hagyja a kulcsmezőn kívüli törlési műveletben megadott mezőket. Ha el szeretne távolítani egy egyéni mezőt egy dokumentumból, használja az egyesítést, é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.

Name	Típus	Description
value	IndexAction[]	A köteg műveletei.

IndexDocumentsResult

Tárgy

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

Name	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.

Name	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.

SearchError

Tárgy

Az API hibafeltételét ismerteti.

Name	Típus	Description
code	string	A kiszolgáló által definiált hibakódok egyike.
details	SearchError[]	A jelentett hibához vezető konkrét hibák részleteinek tömbje.
message	string	A hiba ember által olvasható ábrázolása.