Indexers - Reset Docs

Usługa:
Search Service
Wersja interfejsu API:
2025-11-01-preview

Resetuje określone dokumenty w źródle danych, aby były selektywnie ponownie pozyskiwane przez indeksator.

POST {endpoint}/indexers('{indexerName}')/search.resetdocs?api-version=2025-11-01-preview
Z parametrami opcjonalnymi: 
POST {endpoint}/indexers('{indexerName}')/search.resetdocs?api-version=2025-11-01-preview&overwrite={overwrite}

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
endpoint
 path True

string (uri)

Adres URL punktu końcowego usługi wyszukiwania.
indexerName
 path True

string

Nazwa indeksatora.
api-version
 query True

string

minLength: 1

Wersja interfejsu API do użycia dla tej operacji.
overwrite
 query

boolean

Jeśli wartość jest fałszywa, klucze lub identyfikatory zostaną dołączone do istniejących. Jeśli wartość true, tylko klucze lub identyfikatory w tym ładunku zostaną umieszczone w kolejce do ponownego pozyskania.

Nagłówek żądania

Nazwa Wymagane Typ Opis
Accept

Accept

Nagłówek Accept.
x-ms-client-request-id

string (uuid)

Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania.

Treść żądania

Nazwa Typ Opis
datasourceDocumentIds

string[]

Identyfikatory dokumentów źródła danych do zresetowania
documentKeys

string[]

Klucze dokumentów do zresetowania

Odpowiedzi

Nazwa Typ Opis
204 No Content

Brak zawartości do wysłania dla tego żądania, ale nagłówki mogą być przydatne.
Other Status Codes

ErrorResponse

Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

api-key

Typ: apiKey
W: header

OAuth2Auth

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Zakresy

Nazwa Opis
https://search.azure.com/.default

Przykłady

SearchServiceResetDocs

Przykładowe żądanie

POST https://previewexampleservice.search.windows.net/indexers('myindexer')/search.resetdocs?api-version=2025-11-01-preview&overwrite=True


{
  "documentKeys": [
    "1",
    "2",
    "3"
  ]
}

Przykładowa odpowiedź

Kod stanu:
204

Definicje

Nazwa Opis
Accept

Nagłówek Accept.
DocumentKeysOrIds

Typ kluczy lub identyfikatorów.
ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail

Szczegóły błędu.
ErrorResponse

Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).

Accept

Wyliczenie

Nagłówek Accept.

Wartość Opis
application/json;odata.metadata=minimal

DocumentKeysOrIds

Objekt

Typ kluczy lub identyfikatorów.

Nazwa Typ Opis
datasourceDocumentIds

string[]

Identyfikatory dokumentów źródła danych do zresetowania
documentKeys

string[]

Klucze dokumentów do zresetowania

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa Typ Opis
info

Dodatkowe informacje.
type

string

Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa Typ Opis
additionalInfo

ErrorAdditionalInfo[]

Dodatkowe informacje o błędzie.
code

string

Kod błędu.
details

ErrorDetail[]

Szczegóły błędu.
message

string

Komunikat o błędzie.
target

string

Element docelowy błędu.

ErrorResponse

Objekt

Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).

Nazwa Typ Opis
error

ErrorDetail

Obiekt błędu.