Sdílet prostřednictvím

Resetování dokumentů (Preview REST API)

  • Článek

platí pro: 2023-07-01-Preview. Tato verze se už nepodporuje. okamžitě upgradovat na novější verzi.

Důležitý

2023-07-01-Preview (žádné změny).

2021-04-30-Preview (žádné změny).

2020-06-30-Preview (žádné změny).

2019-05-06-Preview přidává podporu pro scénáře resetování.

Resetování dokumentů je asynchronní rozhraní API. Umožňuje selektivně znovu zpracovat dokumenty ze zdroje dat.

Rozhraní API přijímá jako vstup dva typy identifikátorů dokumentů. Jsou to klíče dokumentů (klíče, které jednoznačně identifikují dokumenty v indexu vyhledávání) a identifikátory dokumentů zdroje dat (klíče, které jednoznačně identifikují dokumenty ve zdroji dat). Vyvolání rozhraní API přidá klíče dokumentu nebo identifikátory dokumentu zdroje dat, které se mají resetovat do metadat indexeru. Při dalším naplánovaném spuštění indexeru nebo na vyžádání indexer zpracovává pouze resetované dokumenty.

  • Pro indexery s povolenou sadou dovedností a přírůstkovým rozšiřováním rozhraní API vymaže mezipaměť a znovu spustí úplnou sadu dovedností pouze pro zadané dokumenty.
  • Pro indexery bez sady dovedností rozhraní API čte zdrojový dokument ze zdroje dat a aktualizuje nebo vloží obsah do indexu.

Pokud k resetování dokumentů používáte klíče dokumentu a klíče dokumentu se odkazují v mapování polí indexeru, indexer použije mapování polí k vyhledání příslušného pole v podkladovém zdroji dat.

Rozhraní API funguje pro všechny indexery (se sadou dovedností nebo bez). Můžete ho vyvolat pomocí požadavku HTTP POST. Pokud volání proběhne úspěšně, získáte odpověď NoContent 204. Zadejte název indexeru, který se má aktualizovat na identifikátoru URI požadavku:

POST https://[service name].search.windows.net/indexers/[indexer name]/resetdocs?api-version=[api-version]
    Content-Type: application/json
    api-key: [admin key]

Parametry identifikátoru URI

Parametr Popis
název služby Požadovaný. Nastavte ho na jedinečný uživatelsky definovaný název vyhledávací služby.
název indexeru Požadovaný. Identifikátor URI požadavku určuje název indexeru, který se má aktualizovat.
api-version Požadovaný. Další verze najdete v verzích rozhraní API.
přepsat Volitelný. Tento parametr určuje, zda se operace po sobě jdoucího resetování dokumentu kombinují nebo přepíšou. Výchozí hodnota je false. Pokud je hodnota false, datová část volání klíčů dokumentů nebo identifikátorů dokumentů zdroje dat se přidá do seznamu klíčů, které jsou již zařazeny do fronty pro opětovné zpracování. Pokud je pravda, datová část volání klíčů dokumentů nebo identifikátorů dokumentů zdroje dat přepíše existující seznam, včetně vymazání seznamu resetovacích dokumentů, pokud nastavíte klíče na hodnotu null.

Hlavičky požadavku

Následující tabulka popisuje povinnou a volitelnou hlavičku požadavku.

Pole Popis
Typ obsahu Požadovaný. Nastavit na application/json
api-key Volitelné, pokud používáte role Azure a v požadavku je k dispozici nosný token, jinak se vyžaduje klíč. Api-key je jedinečný systémový vygenerovaný řetězec, který ověřuje požadavek ve vaší vyhledávací službě. Žádosti o obnovení musí obsahovat hlavičku api-key nastavenou na klíč správce (na rozdíl od klíče dotazu). Podrobnosti najdete v tématu Připojení k Azure AI Search pomocí ověřování klíčů.

Text požadavku

Tělo by mělo obsahovat buď seznam klíčů dokumentu, nebo seznam identifikátorů dokumentu zdroje dat, které indexer hledá ve zdroji dat.

Následující JSON představuje základní reprezentaci hlavních částí definice.

{
    "documentKeys" : [
        "key1",
        "key2",
        "key3"
    ],
    "datasourceDocumentIds" : [
        "key1",
        "key2",
        "key3"
    ],
}

Požadavek obsahuje následující vlastnosti a všimněte si, že je třeba zadat pouze jeden z "documentKeys" a "datasourceDocumentIds":

Vlastnost Popis
documentKeys Toto je sada klíčů dokumentu, které indexer selektivně znovu zpracuje ze zdroje dat. Ve výchozím nastavení se při volání této akce několikrát připojí k sobě klíč dokumentu. Toto chování lze změnit tak, aby přepsalo místo připojení prostřednictvím parametru URI přepsání (viz výše). Pokud chcete, aby indexer přestal zpracovávat resetování dokumentů, můžete nastavit "documentKeys" na prázdný seznam []. Výsledkem je obnovení pravidelného indexování na základě horní meze indexeru. Neplatné klíče dokumentu nebo klíče dokumentu, které neexistují, se ignorují.
datasourceDocumentIds Toto je sada identifikátorů dokumentu zdroje dat, které indexer selektivně znovu zpracuje ze svého zdroje dat. Ve výchozím nastavení volání této akce několikrát připojí identifikátory dokumentu zdroje dat dohromady. Toto chování lze změnit tak, aby přepsalo místo připojení prostřednictvím parametru URI přepsání (viz výše). Pokud chcete, aby indexer přestal zpracovávat resetování dokumentů, můžete nastavit datasourceDocumentIds na prázdný seznam []. Výsledkem je obnovení pravidelného indexování na základě horní meze indexeru. Neplatné identifikátory dokumentu zdroje dat nebo identifikátory dokumentu zdroje dat, které neexistují, se ignorují.

Odpověď

204 Žádný obsah pro úspěšnou žádost.

Viz také