Documents - Index

Služba:: Search Service

Verze rozhraní API:: 2026-04-01

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

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string (uri)	Adresa URL koncového bodu vyhledávací služby.
indexName	path	True	string	Název indexu.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Accept		Accept	Hlavička Accept.
x-ms-client-request-id		string (uuid)	Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek.

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 dokumenty v požadavku indexování
Other Status Codes	IndexDocumentsResult	Odpověď obsahující stav operací pro všechny dokumenty v požadavku indexování
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď

Zabezpečení

api-key

Typ: apiKey
V: header

OAuth2Auth

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Rozsahy

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

Příklady

SearchIndexIndexDocuments

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 200

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

Stavový kód:: 207

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

Definice

Name	Description
Accept	Hlavička Accept.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)
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 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

Accept

Výčet

Hlavička Accept.

Hodnota	Description
application/json;odata.metadata=none

ErrorAdditionalInfo

Objekt

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

Name	Typ	Description
info		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

Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)

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 s dokumentem v dávce indexování.

IndexActionType

Výčet

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

Hodnota	Description
upload	Vloží dokument do rejstříku, pokud je nový, a aktualizuje ho, pokud existuje. Všechna pole budou nahrazena v případě aktualizace
merge	Sloučí zadané hodnoty polí s existujícím dokumentem. Pokud dokument neexistuje, sloučení se nezdaří. Jakékoli pole, které určíte při sloučení, nahradí stávající pole v dokumentu. To platí také pro kolekce primitivních a komplexní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 odeslání s novým dokumentem.
delete	Odstraní určený dokument z rejstříku. Jakékoli pole, které zadáte v operaci odstranění jiné než klíčové pole, bude ignorováno. Pokud chcete z dokumentu odebrat jednotlivé pole, 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.