Indexers - Reset Docs

Servizio:: Search Service

Versione API:: 2025-11-01-preview

Reimposta documenti specifici nell'origine dati in modo che vengano reinseriti in modo selettivo dall'indicizzatore.

POST {endpoint}/indexers('{indexerName}')/search.resetdocs?api-version=2025-11-01-preview

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string (uri)	URL dell'endpoint del servizio di ricerca.
indexerName	path	True	string	Nome dell'indicizzatore.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.
overwrite	query		boolean	Se false, le chiavi o gli id verranno aggiunti a quelli esistenti. Se true, solo le chiavi o gli ID in questo payload verranno accodati per essere reinseriti.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
Accept		Accept	L'intestazione Accetta.
x-ms-client-request-id		string (uuid)	Identificatore di stringa opaco, univoco a livello globale e generato dal client per la richiesta.

Corpo della richiesta

Nome	Tipo	Descrizione
datasourceDocumentIds	string[]	Identificatori del documento dell'origine dati da reimpostare
documentKeys	string[]	Tasti del documento da resettare

Risposte

Nome	Tipo	Descrizione
204 No Content		Non è disponibile alcun contenuto da inviare per questa richiesta, ma le intestazioni possono essere utili.
Other Status Codes	ErrorResponse	Risposta di errore imprevista.

Sicurezza

api-key

Tipo: apiKey
In: header

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Ambiti

Nome	Descrizione
https://search.azure.com/.default

Esempio

SearchServiceResetDocs

Esempio di richiesta

HTTP

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


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

Risposta di esempio

Codice di stato:: 204

Definizioni

Nome	Descrizione
Accept	L'intestazione Accetta.
DocumentKeysOrIds	Il tipo delle chiavi o degli Id.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore comune per tutte le API di Azure Resource Manager per restituire i dettagli dell'errore per le operazioni non riuscite. Questo segue anche il formato di risposta di errore OData.

Accept

Enumerazione

L'intestazione Accetta.

Valore	Descrizione
application/json;odata.metadata=minimal

DocumentKeysOrIds

Oggetto

Il tipo delle chiavi o degli Id.

Nome	Tipo	Descrizione
datasourceDocumentIds	string[]	Identificatori del documento dell'origine dati da reimpostare
documentKeys	string[]	Tasti del documento da resettare

ErrorAdditionalInfo

Oggetto

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info		Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Oggetto

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Oggetto

Risposta di errore comune per tutte le API di Azure Resource Manager per restituire i dettagli dell'errore per le operazioni non riuscite. Questo segue anche il formato di risposta di errore OData.

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.