Resetování dokumentů (Preview REST API)

  • Článek

Platí pro: 2023-07-01-Preview, 2021-04-30-Preview, 2020-06-30-Preview, 2019-05-06-Preview

Důležité

2023-07-01-Preview (beze změn)

2021-04-30-Preview (beze změn)

2020-06-30-Preview (beze změn)

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

Resetovat dokumenty 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ů. Jedná se o klíče dokumentů (klíče, které jednoznačně identifikují dokumenty v indexu vyhledávání) a identifikátory dokumentů zdroje dat (klíče, které jedinečně identifikují dokumenty ve zdroji dat). Vyvoláním rozhraní API přidáte klíče dokumentů nebo identifikátory dokumentu zdroje dat, které se mají resetovat na metadata indexeru. Při dalším naplánovaném spuštění indexeru nebo na vyžádání indexer zpracuje pouze resetované dokumenty.

  • U indexerů 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í jenom pro zadané dokumenty.
  • U indexerů bez sady dovedností rozhraní API načte zdrojový dokument ze zdroje dat a aktualizuje nebo vloží obsah do indexu.

Pokud k resetování dokumentů použijete klíče dokumentů a na klíče dokumentu se odkazuje 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ě, zobrazí se odpověď 204 NoContent. Zadejte název indexeru, který se má aktualizovat v 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 Povinná hodnota. Nastavte ho na jedinečný uživatelsky definovaný název vaší vyhledávací služby.
název indexeru Povinná hodnota. Identifikátor URI požadavku určuje název indexeru, který se má aktualizovat.
verze-api Povinná hodnota. Aktuální verze Preview je 2023-07-01-Preview. Další verze najdete v tématu Verze rozhraní API .
Přepsat Nepovinný parametr. Tento parametr určuje, jestli se po sobě jdoucí operace resetování dokumentu kombinují nebo přepisují. Výchozí hodnota je false. Pokud je hodnota false, datová část volání klíčů dokumentů nebo identifikátorů dokumentu zdroje dat se přidá do seznamu klíčů, které jsou již zařazeny do fronty pro opětovné zpracování. Pokud je hodnota true, datová část volání klíčů dokumentů nebo identifikátorů dokumentů zdroje dat přepíše existující seznam, včetně vymazání seznamu resetovaných dokumentů, pokud nastavíte klíče na hodnotu null.

Hlavičky požadavku

Následující tabulka popisuje požadované a volitelné hlavičky požadavků.

Pole Description
Typ obsahu Povinná hodnota. Nastavte tuto možnost 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íč. Klíč api-key je jedinečný systémově vygenerovaný řetězec, který ověřuje požadavek pro vaši vyhledávací službu. Žádosti o resetování musí obsahovat hlavičku nastavenou api-key na klíč správce (na rozdíl od klíče dotazu). Podrobnosti najdete v tématu Připojení ke službě Azure AI Search pomocí ověřování pomocí klíče .

Text požadavku

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

Následující kód 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 mějte na paměti, že by měly být poskytnuty pouze jedna z "documentKeys" a "datasourceDocumentIds":

Vlastnost Popis
documentKeys Jedná se o sadu klíčů dokumentu, které indexer selektivně znovu zpracuje ze svého zdroje dat. Volání této akce ve výchozím nastavení několikrát připojí sady klíčů dokumentu. Toto chování je možné změnit tak, aby přepsal místo připojení pomocí parametru identifikátoru URI přepsání (viz výše). Pokud chcete, aby se indexer přestal pokoušet o resetování dokumentů, můžete nastavit documentKeys na prázdný seznam []. Výsledkem je, že indexer bude znovu pravidelně indexovat na základě horního vodoznaku. Neplatné klíče dokumentu nebo klíče dokumentu, které neexistují, se ignorují.
datasourceDocumentIds Jedná se o sadu identifikátorů dokumentu zdroje dat, které indexer selektivně znovu zpracuje ze svého zdroje dat. Volání této akce ve výchozím nastavení několikrát připojí sady identifikátorů dokumentu zdroje dat. Toto chování je možné změnit tak, aby přepsal místo připojení pomocí parametru identifikátoru 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, že indexer bude znovu pravidelně indexovat na základě horního vodoznaku. Neplatné identifikátory dokumentu zdroje dat nebo neexistující identifikátory dokumentu zdroje dat se ignorují.

Odpověď

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

Viz také