Documents - Index

Reference

Service:: Search Service

API Version:: 2023-11-01

Odešle do indexu dávku akcí zápisu do dokumentu.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string	Adresa URL koncového bodu vyhledávací služby.
indexName	path	True	string	Název indexu.
api-version	query	True	string	Verze rozhraní API klienta.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
x-ms-client-request-id		string uuid	ID sledování odeslané spolu s požadavkem na pomoc s laděním.

Text požadavku

Name	Vyžadováno	Typ	Description
value	True	IndexAction[]	Akce v dávce.

Odpovědi

Name	Typ	Description
200 OK	IndexDocumentsResult	Odpověď obsahující stav operací pro všechny akce v dávce.
Other Status Codes	IndexDocumentsResult	Odpověď obsahující stav operací pro všechny akce v dávce.
Other Status Codes	SearchError	Odpověď na chybu.

Příklady

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

Definice

Name	Description
IndexAction	Představuje akci indexu, která pracuje s dokumentem.
IndexActionType	Operace, která se má provést s dokumentem v dávce indexování.
IndexBatch	Obsahuje dávku akcí zápisu do dokumentu, které se mají odeslat do indexu.
IndexDocumentsResult	Odpověď obsahující stav operací pro všechny dokumenty v požadavku indexování.
IndexingResult	Stav operace indexování pro jeden dokument
SearchError	Popisuje chybový stav rozhraní API.

IndexAction

Představuje akci indexu, která pracuje s dokumentem.

Name	Typ	Description
@search.action	IndexActionType	Operace, která se má provést s dokumentem v dávce indexování.

IndexActionType

Operace, která se má provést s dokumentem v dávce indexování.

Name	Typ	Description
delete	string	Odebere z indexu zadaný dokument. Jakékoli pole, které zadáte v operaci odstranění jiné než pole s klíčem, bude ignorováno. Pokud chcete z dokumentu odebrat jednotlivá pole, použijte místo toho sloučení a nastavte pole explicitně na hodnotu null.
merge	string	Sloučí zadané hodnoty polí s existujícím dokumentem. Pokud dokument neexistuje, sloučení selže. Každé pole zadané ve sloučení nahradí stávající pole v dokumentu. To platí i pro kolekce primitivních a složitých typů.
mergeOrUpload	string	Chová se jako sloučení, pokud dokument s daným klíčem již v indexu existuje. Pokud dokument neexistuje, chová se jako nahrání s novým dokumentem.
upload	string	Vloží dokument do indexu, pokud je nový, a aktualizuje ho, pokud existuje. Všechna pole jsou v případě aktualizace nahrazena.

IndexBatch

Obsahuje dávku akcí zápisu do dokumentu, které se mají odeslat do indexu.

Name	Typ	Description
value	IndexAction[]	Akce v dávce.

IndexDocumentsResult

Odpověď obsahující stav operací pro všechny dokumenty v požadavku indexování.

Name	Typ	Description
value	IndexingResult[]	Seznam informací o stavu pro každý dokument v žádosti o indexování.

IndexingResult

Stav operace indexování pro jeden dokument

Name	Typ	Description
errorMessage	string	Chybová zpráva vysvětlující, proč operace indexování selhala pro dokument identifikovaný klíčem; null, pokud bylo indexování úspěšné.
key	string	Klíč dokumentu, který byl v žádosti o indexování.
status	boolean	Hodnota označující, zda byla operace indexování pro dokument identifikovaný klíčem úspěšná.
statusCode	integer	Stavový kód operace indexování. Mezi možné hodnoty patří: 200 pro úspěšnou aktualizaci nebo odstranění, 201 pro úspěšné vytvoření dokumentu, 400 pro poškozený vstupní dokument, 404 pro dokument nebyl nalezen, 409 pro konflikt verze, 422, pokud je index dočasně nedostupný nebo 503 pro případ, že je služba příliš zaneprázdněná.

SearchError

Popisuje chybový stav rozhraní API.

Name	Typ	Description
code	string	Jeden ze serverem definované sady kódů chyb.
details	SearchError[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
message	string	Lidsky čitelná reprezentace chyby.

Share via