Documents - Index

Služba:: Search Service

Verze rozhraní API:: 2024-03-01-Preview

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

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

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é s požadavkem, které vám pomůže 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	ErrorResponse	Chybová odpověď.

Příklady

SearchIndexIndexDocuments

Ukázkový požadavek

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.index?api-version=2024-03-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"
    }
  ]
}

Ukázková odpověď

Stavový kó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
    }
  ]
}

Stavový kó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
    }
  ]
}

Definice

Name	Description
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
IndexAction	Představuje akci indexu, která pracuje s dokumentem.
IndexActionType	Operace, která se má provést u dokumentu v dávce indexování.
IndexBatch	Obsahuje dávku akcí zápisu 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

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

IndexAction

Objekt

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

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

IndexActionType

Výčet

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

Hodnota	Description
upload	Vloží dokument do indexu, pokud je nový, a aktualizuje ho, pokud existuje. Všechna pole se nahradí v případě aktualizace.
merge	Sloučí zadané hodnoty polí s existujícím dokumentem. Pokud dokument neexistuje, sloučení selže. Všechna pole, která zadáte ve sloučení, nahradí stávající pole v dokumentu. To platí také pro kolekce primitivních a složitých typů.
mergeOrUpload	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.
delete	Odebere zadaný dokument z indexu. Jakékoli pole, které zadáte v jiné operaci odstranění, než je pole klíče, bude ignorováno. Pokud chcete odebrat jednotlivá pole z dokumentu, použijte místo toho sloučení a nastavte pole explicitně na hodnotu null.

IndexBatch

Objekt

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

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

IndexDocumentsResult

Objekt

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

Objekt

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 indexování proběhlo úspěšně.
key	string	Klíč dokumentu, který byl v požadavku indexování.
status	boolean	Hodnota označující, jestli operace indexování pro dokument identifikovaná klíčem proběhla úspěšně.
statusCode	integer (int32)	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 dobu, kdy je služba příliš zaneprázdněna.