Documents - Index

Référence

Service:: Search Service

Version d'API:: 2024-05-01-preview

Envoie un lot d’actions d’écriture de document à l’index.

POST {endpoint}/indexes('{indexName}')/docs/search.index?api-version=2024-05-01-preview

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string	URL du point de terminaison du service de recherche.
indexName	path	True	string	Nom de l’index.
api-version	query	True	string	Version de l’API cliente.

En-tête de la demande

Nom	Obligatoire	Type	Description
x-ms-client-request-id		string uuid	ID de suivi envoyé avec la demande pour faciliter le débogage.

Corps de la demande

Nom	Obligatoire	Type	Description
value	True	IndexAction[]	Actions du lot.

Réponses

Nom	Type	Description
200 OK	IndexDocumentsResult	Réponse contenant la status d’opérations pour toutes les actions du lot.
Other Status Codes	IndexDocumentsResult	Réponse contenant la status d’opérations pour toutes les actions du lot.
Other Status Codes	ErrorResponse	Réponse d’erreur.

Exemples

SearchIndexIndexDocuments

Exemple de requête

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.index?api-version=2024-05-01-preview

{
  "value": [
    {
      "@search.action": "upload",
      "docId": "1",
      "title": "Fancy Stay",
      "description": "Best hotel in town"
    },
    {
      "@search.action": "merge",
      "docId": "2",
      "title": "Roach Motel"
    },
    {
      "@search.action": "mergeOrUpload",
      "docId": "3",
      "title": "Econo Motel"
    },
    {
      "@search.action": "delete",
      "docId": "4"
    }
  ]
}

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "key": "1",
      "status": true,
      "errorMessage": null,
      "statusCode": 201
    },
    {
      "key": "2",
      "status": true,
      "errorMessage": null,
      "statusCode": 200
    },
    {
      "key": "3",
      "status": true,
      "errorMessage": null,
      "statusCode": 200
    },
    {
      "key": "4",
      "status": true,
      "errorMessage": null,
      "statusCode": 200
    }
  ]
}

Code d’état:: 207

{
  "value": [
    {
      "key": "1",
      "status": true,
      "errorMessage": null,
      "statusCode": 200
    },
    {
      "key": "2",
      "status": false,
      "errorMessage": "Document not found.",
      "statusCode": 404
    },
    {
      "key": "3",
      "status": true,
      "errorMessage": null,
      "statusCode": 200
    },
    {
      "key": "4",
      "status": true,
      "errorMessage": null,
      "statusCode": 200
    }
  ]
}

Définitions

Nom	Description
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
IndexAction	Représente une action d’index qui opère sur un document.
IndexActionType	Opération à effectuer sur un document dans un lot d’indexation.
IndexBatch	Contient un lot d’actions d’écriture de document à envoyer à l’index.
IndexDocumentsResult	Réponse contenant le status d’opérations pour tous les documents de la demande d’indexation.
IndexingResult	État d’une opération d’indexation pour un document unique.

ErrorAdditionalInfo

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

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

ErrorDetail

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

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet error.

IndexAction

Représente une action d’index qui opère sur un document.

Nom	Type	Description
@search.action	IndexActionType	Opération à effectuer sur un document dans un lot d’indexation.

IndexActionType

Opération à effectuer sur un document dans un lot d’indexation.

Nom	Type	Description
delete	string	Cette action supprime de l’index le document spécifié. Tout champ que vous spécifiez dans une opération de suppression autre que le champ clé est ignoré. Si vous souhaitez supprimer un champ individuel d’un document, utilisez plutôt fusionner et définissez explicitement le champ sur null.
merge	string	Fusionne les valeurs de champ spécifiées avec un document existant. Si le document n’existe pas, la fusion échoue. N'importe quel champ que vous spécifiez dans une fusion remplace le champ existant dans le document. Cela s’applique également aux collections de types primitifs et complexes.
mergeOrUpload	string	Se comporte comme une fusion si un document avec la clé donnée existe déjà dans l’index. Si le document n’existe pas, il se comporte comme un chargement avec un nouveau document.
upload	string	Insère le document dans l’index s’il est nouveau et le met à jour s’il existe. Tous les champs sont remplacés dans le cas de mise à jour.

IndexBatch

Contient un lot d’actions d’écriture de document à envoyer à l’index.

Nom	Type	Description
value	IndexAction[]	Actions du lot.

IndexDocumentsResult

Réponse contenant le status d’opérations pour tous les documents de la demande d’indexation.

Nom	Type	Description
value	IndexingResult[]	Liste des informations status pour chaque document dans la demande d’indexation.

IndexingResult

État d’une opération d’indexation pour un document unique.

Nom	Type	Description
errorMessage	string	Message d’erreur expliquant pourquoi l’opération d’indexation a échoué pour le document identifié par la clé ; Null si l’indexation a réussi.
key	string	Clé d’un document qui se trouvait dans la demande d’indexation.
status	boolean	Valeur indiquant si l’opération d’indexation a réussi pour le document identifié par la clé.
statusCode	integer	Code status de l’opération d’indexation. Les valeurs possibles sont : 200 pour une mise à jour ou une suppression réussie, 201 pour une création de document réussie, 400 pour un document d’entrée mal formé, 404 pour le document introuvable, 409 pour un conflit de version, 422 lorsque l’index est temporairement indisponible ou 503 pour lorsque le service est trop occupé.

Partager via