Indexers - Reset Docs

Service:: Search Service

Version d’API:: 2025-11-01-preview

Réinitialise des documents spécifiques dans la source de données pour qu’ils soient réingérés de manière sélective par l’indexeur.

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string (uri)	URL du point de terminaison du service de recherche.
indexerName	path	True	string	Nom de l’indexeur.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.
overwrite	query		boolean	Si la valeur est false, les clés ou les identifiants seront ajoutés aux clés existantes. Si la valeur est true, seules les clés ou les identifiants de cette charge utile seront mis en file d’attente pour être réingérés.

En-tête de la demande

Nom	Obligatoire	Type	Description
Accept		Accept	L’en-tête Accept.
x-ms-client-request-id		string (uuid)	Identificateur de chaîne opaque, globalement unique et généré par le client pour la requête.

Corps de la demande

Nom	Type	Description
datasourceDocumentIds	string[]	Identificateurs de documents de source de données à réinitialiser
documentKeys	string[]	clés de document à réinitialiser

Réponses

Nom	Type	Description
204 No Content		Il n’existe aucun contenu à envoyer pour cette demande, mais les en-têtes peuvent être utiles.
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Sécurité

api-key

Type: apiKey
Dans: header

OAuth2Auth

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Étendues

Nom	Description
https://search.azure.com/.default

Exemples

SearchServiceResetDocs

Exemple de requête

HTTP

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


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

Exemple de réponse

Code d’état:: 204

Définitions

Nom	Description
Accept	L’en-tête Accept.
DocumentKeysOrIds	Le type des touches ou des S.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur courante pour toutes les API Azure Resource Manager afin de retourner les détails de l’erreur pour les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.).

Accept

Énumération

L’en-tête Accept.

Valeur	Description
application/json;odata.metadata=minimal

DocumentKeysOrIds

Objet

Le type des touches ou des S.

Nom	Type	Description
datasourceDocumentIds	string[]	Identificateurs de documents de source de données à réinitialiser
documentKeys	string[]	clés de document à réinitialiser

ErrorAdditionalInfo

Objet

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info		Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Objet

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d'erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Objet

Réponse d’erreur courante pour toutes les API Azure Resource Manager afin de retourner les détails de l’erreur pour les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.).

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.