Resetowanie dokumentów (interfejs API REST w wersji zapoznawczej)
Dotyczy: 2023-07-01-Preview, 2021-04-30-Preview, 2020-06-30-Preview, 2019-05-06-Preview
Ważne
2023-07-01-Preview (bez zmian).
2021-04-30-Preview (brak zmian).
2020-06-30-Preview (brak zmian).
2019-05-06-Preview dodaje obsługę scenariuszy resetowania.
Resetuj dokumenty to asynchroniczny interfejs API. Umożliwia selektywne ponowne przetwarzanie dokumentów ze źródła danych.
Interfejs API akceptuje dwa typy identyfikatorów dokumentów jako dane wejściowe. Są to klucze dokumentów (klucze, które jednoznacznie identyfikują dokumenty w indeksie wyszukiwania) i identyfikatory dokumentów źródła danych (klucze, które jednoznacznie identyfikują dokumenty w źródle danych). Wywołanie interfejsu API powoduje dodanie kluczy dokumentów lub identyfikatorów dokumentów źródła danych do zresetowania do metadanych indeksatora. W następnym zaplanowanym lub na żądanie uruchomieniu indeksatora indeksator przetwarza tylko dokumenty resetowania.
- W przypadku indeksatorów z włączonym zestawem umiejętności i wzbogacaniem przyrostowym interfejs API czyści pamięć podręczną i ponownie uruchom pełny zestaw umiejętności tylko dla określonych dokumentów.
- W przypadku indeksatorów bez zestawu umiejętności interfejs API odczytuje dokument źródłowy ze źródła danych i aktualizuje/wstawia zawartość do indeksu.
Jeśli używasz kluczy dokumentów do resetowania dokumentów, a klucze dokumentów są przywołyne w mapowaniu pól indeksatora, indeksator używa mapowania pól w celu zlokalizowania odpowiedniego pola w bazowym źródle danych.
Interfejs API działa dla wszystkich indeksatorów (z zestawem umiejętności lub bez zestawu umiejętności). Można go wywołać przy użyciu żądania HTTP POST. Jeśli wywołanie zakończy się pomyślnie, otrzymasz odpowiedź NoContent z 204 r. Określ nazwę indeksatora do zaktualizowania identyfikatora URI żądania:
POST https://[service name].search.windows.net/indexers/[indexer name]/resetdocs?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
Parametry identyfikatora URI
| Parametr | Opis |
|---|---|
| nazwa usługi | Wymagane. Ustaw tę wartość na unikatową, zdefiniowaną przez użytkownika nazwę usługi wyszukiwania. |
| nazwa indeksatora | Wymagane. Identyfikator URI żądania określa nazwę indeksatora do zaktualizowania. |
| api-version | Wymagane. Bieżąca wersja zapoznawcza to 2023-07-01-Preview. Zobacz Wersje interfejsu API , aby uzyskać więcej wersji. |
| Zastąpić | Opcjonalny. Ten parametr określa, czy kolejne operacje resetowania dokumentu są łączone lub zastępowane. Wartość domyślna to false. W przypadku wartości false ładunek wywołania kluczy dokumentów lub identyfikatorów dokumentów źródła danych są dodawane do listy kluczy już w kolejce do ponownego przetwarzania. Jeśli to prawda, ładunek wywołania kluczy dokumentów lub identyfikatorów dokumentów źródła danych zastępuje istniejącą listę, w tym wyczyszczenie listy dokumentów resetowania, jeśli klucze mają wartość null. |
Nagłówki żądań
W poniższej tabeli opisano wymagane i opcjonalne nagłówki żądań.
| Pola | Opis |
|---|---|
| Content-Type | Wymagane. Ustaw tę wartość na application/json |
| api-key | Opcjonalnie, jeśli używasz ról platformy Azure , a token elementu nośnego jest udostępniany w żądaniu, w przeciwnym razie wymagany jest klucz. Klucz api-key to unikatowy, generowany przez system ciąg, który uwierzytelnia żądanie w usłudze wyszukiwania. Żądania resetowania muszą zawierać api-key nagłówek ustawiony na klucz administratora (w przeciwieństwie do klucza zapytania). Aby uzyskać szczegółowe informacje, zobacz Nawiązywanie połączenia z usługą Azure AI Search przy użyciu uwierzytelniania klucza . |
Treść żądania
Treść powinna zawierać listę kluczy dokumentów lub listę identyfikatorów dokumentów źródła danych, które indeksator szuka w źródle danych.
Poniższy kod JSON jest wysoką reprezentacją głównych części definicji.
{
"documentKeys" : [
"key1",
"key2",
"key3"
],
"datasourceDocumentIds" : [
"key1",
"key2",
"key3"
],
}
Żądanie zawiera następujące właściwości i należy pamiętać, że należy podać tylko jeden element "documentKeys" i "datasourceDocumentIds":
| Właściwość | Opis |
|---|---|
| documentKeys | Jest to zestaw kluczy dokumentów, które indeksator selektywnie przetwarza z jego źródła danych. Domyślnie wywołanie tej akcji wiele razy dołącza zestawy kluczy dokumentu. To zachowanie można zmienić, aby zastąpić, a nie dołączać za pośrednictwem parametru URI zastąpienia (zobacz powyżej). Jeśli chcesz, aby indeksator przestał przetwarzać dokumenty resetowania, możesz ustawić wartość "documentKeys" na pustą listę "[]". Powoduje to wznowienie indeksatora regularnego indeksowania na podstawie wysokiego znaku wodnego. Nieprawidłowe klucze dokumentów lub klucze dokumentów, które nie istnieją, są ignorowane. |
| datasourceDocumentIds | Jest to zestaw identyfikatorów dokumentów źródła danych, które indeksator selektywnie przetwarza z jego źródła danych. Domyślnie wywołanie tej akcji wiele razy dołącza identyfikatory dokumentów źródła danych razem. To zachowanie można zmienić, aby zastąpić, a nie dołączać za pośrednictwem parametru URI zastąpienia (zobacz powyżej). Jeśli indeksator ma przestać przetwarzać dokumenty resetowania, możesz ustawić wartość "datasourceDocumentIds" na pustą listę "[]". Powoduje to wznowienie indeksatora regularnego indeksowania na podstawie wysokiego znaku wodnego. Nieprawidłowe identyfikatory dokumentów źródła danych lub identyfikatory dokumentów źródła danych, które nie istnieją, są ignorowane. |
Reakcja
204 Brak zawartości dla pomyślnego żądania.