Réinitialiser les documents (API REST en préversion)
S’applique à : 2023-07-01-Preview, 2021-04-30-Preview, 2020-06-30-Preview, 2019-05-06-Preview
Important
2023-07-01-Preview (aucune modification).
2021-04-30-Preview (aucune modification).
2020-06-30-Preview (aucune modification).
2019-05-06-Preview ajoute la prise en charge des scénarios de réinitialisation.
Réinitialiser les documents est une API asynchrone. Il vous permet de retraiter de manière sélective des documents à partir de votre source de données.
L’API accepte deux types d’identificateurs de document comme entrée. Il s’agit de clés de document (clés qui identifient de manière unique les documents dans un index de recherche) et d’identificateurs de document de source de données (clés qui identifient de manière unique les documents dans une source de données). L’appel de l’API ajoute les clés de document ou les identificateurs de document de source de données à réinitialiser aux métadonnées de l’indexeur. Lors de la prochaine exécution planifiée ou à la demande de l’indexeur, l’indexeur traite uniquement les documents de réinitialisation.
- Pour les indexeurs avec un ensemble de compétences et un enrichissement incrémentiel activés, l’API efface le cache et réexécute l’ensemble de compétences complet pour uniquement les documents spécifiés.
- Pour les indexeurs sans ensemble de compétences, l’API lit le document source à partir de la source de données et met à jour/insère le contenu dans l’index.
Si vous utilisez des clés de document pour réinitialiser des documents et que vos clés de document sont référencées dans un mappage de champ d’indexeur, l’indexeur utilise le mappage de champs pour localiser le champ approprié dans la source de données sous-jacente.
L’API fonctionne pour tous les indexeurs (avec ou sans ensemble de compétences). Vous pouvez l’appeler à l’aide d’une requête HTTP POST. Si l’appel réussit, vous obtenez une réponse NoContent 204. Spécifiez le nom de l’indexeur à mettre à jour sur l’URI de demande :
POST https://[service name].search.windows.net/indexers/[indexer name]/resetdocs?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
Paramètres URI
| Paramètre | Description |
|---|---|
| nom du service | Obligatoire. Définissez cette valeur sur le nom unique défini par l’utilisateur de votre service de recherche. |
| nom de l’indexeur | Obligatoire. L’URI de requête spécifie le nom de l’indexeur à mettre à jour. |
| api-version | Obligatoire. La version d’évaluation actuelle est 2023-07-01-Preview. Pour plus d’informations, consultez Versions de l’API . |
| overwrite | facultatif. Ce paramètre détermine si les opérations de réinitialisation de document consécutives sont combinées ou remplacées. La valeur par défaut est false. Lorsque la valeur est false, la charge utile de l’appel de clés de document ou d’identificateurs de document de source de données est ajoutée à la liste des clés déjà mises en file d’attente pour retraitement. Si la valeur est true, la charge utile de l’appel de clés de document ou d’identificateurs de document de source de données remplace la liste existante, notamment l’effacement de la liste des documents de réinitialisation si vous définissez les clés sur null. |
En-têtes de requête
Le tableau suivant décrit les en-têtes de demande obligatoires et facultatifs.
| Champs | Description |
|---|---|
| Content-Type | Obligatoire. À définir avec la valeur application/json |
| api-key | Facultatif si vous utilisez des rôles Azure et qu’un jeton de porteur est fourni sur la demande, sinon une clé est requise. Une clé API est une chaîne unique générée par le système qui authentifie la demande auprès de votre service de recherche. Les demandes de réinitialisation doivent inclure un api-key en-tête défini sur votre clé d’administration (par opposition à une clé de requête). Pour plus d’informations, consultez Se connecter à Azure AI Search à l’aide de l’authentification par clé . |
Corps de la demande
Le corps doit contenir une liste de clés de document ou une liste d’identificateurs de document de source de données que l’indexeur recherche dans la source de données.
Le code JSON suivant est une représentation de haut niveau des parties main de la définition.
{
"documentKeys" : [
"key1",
"key2",
"key3"
],
"datasourceDocumentIds" : [
"key1",
"key2",
"key3"
],
}
Request contient les propriétés suivantes et notez qu’une seule des « documentKeys » et « datasourceDocumentIds » doit être fournie :
| Propriété | Description |
|---|---|
| documentKeys | Il s’agit de l’ensemble de clés de document que l’indexeur retraite sélectivement à partir de sa source de données. Par défaut, l’appel de cette action plusieurs fois ajoute les jeux de clés de document. Ce comportement peut être modifié pour remplacer plutôt qu’ajouter via le paramètre URI de remplacement (voir ci-dessus). Si vous souhaitez que l’indexeur cesse d’essayer de traiter les documents réinitialisés, vous pouvez définir « documentKeys » sur une liste vide « [] ». Cela entraîne la reprise de l’indexation régulière par l’indexeur en fonction du point d’eau élevé. Les clés de document non valides ou les clés de document qui n’existent pas sont ignorées. |
| datasourceDocumentIds | Il s’agit de l’ensemble d’identificateurs de document de source de données que l’indexeur retraite de manière sélective à partir de sa source de données. Par défaut, l’appel de cette action plusieurs fois ajoute les ensembles d’identificateurs de document de source de données. Ce comportement peut être modifié pour remplacer plutôt qu’ajouter via le paramètre URI de remplacement (voir ci-dessus). Si vous souhaitez que l’indexeur cesse d’essayer de traiter les documents de réinitialisation, vous pouvez définir « datasourceDocumentIds » sur une liste vide « [] ». Cela entraîne la reprise de l’indexation régulière par l’indexeur en fonction du point d’eau élevé. Les identificateurs de document de source de données non valides ou les identificateurs de document de source de données qui n’existent pas sont ignorés. |
response
204 Aucun contenu pour une demande réussie.