Documents - Index

Service:: Search Service

Version d'API:: 2026-04-01

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

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string (uri)	URL du point de terminaison du service de recherche.
indexName	path	True	string	Nom de l’index.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

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	Obligatoire	Type	Description
value	True	IndexAction[]	Les actions du lot.

Réponses

Nom	Type	Description
200 OK	IndexDocumentsResult	Réponse contenant l’état des opérations pour tous les documents de la demande d’indexation.
Other Status Codes	IndexDocumentsResult	Réponse contenant l’état des opérations pour tous les documents de la demande d’indexation.
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

SearchIndexIndexDocuments

Exemple de requête

HTTP

POST https://exampleservice.search.windows.net/indexes('example-index')/docs/search.index?api-version=2026-04-01


{
  "value": [
    {
      "@search.action": "mergeOrUpload",
      "id": "0",
      "name": "test",
      "description": "test0 hello",
      "vector1": [
        0,
        1,
        2,
        3,
        4,
        5,
        6,
        7,
        8,
        9,
        10,
        11,
        12,
        13,
        14,
        15,
        16,
        17,
        18,
        19
      ],
      "vector1b": [
        10,
        11,
        12,
        13,
        14,
        15,
        16,
        17,
        18,
        19
      ],
      "vector2": [
        0,
        1,
        2,
        3,
        4
      ],
      "vector3": [
        0,
        1,
        2,
        3,
        4
      ],
      "vector22": [
        20,
        21,
        22,
        23,
        24,
        25,
        26,
        27,
        28,
        29
      ],
      "ownerId": "benny",
      "category": "purple",
      "price": 0
    },
    {
      "@search.action": "mergeOrUpload",
      "id": "1",
      "name": "test",
      "description": "test1 hello",
      "vector1": [
        1,
        2,
        3,
        4,
        5,
        6,
        7,
        8,
        9,
        10,
        11,
        12,
        13,
        14,
        15,
        16,
        17,
        18,
        19,
        20
      ],
      "vector1b": [
        11,
        12,
        13,
        14,
        15,
        16,
        17,
        18,
        19,
        20
      ],
      "vector2": [
        1,
        2,
        3,
        4,
        5
      ],
      "vector3": [
        1,
        2,
        3,
        4,
        5
      ],
      "vector22": [
        21,
        22,
        23,
        24,
        25,
        26,
        27,
        28,
        29,
        30
      ],
      "ownerId": "sam",
      "category": "purple",
      "price": 1
    },
    {
      "@search.action": "mergeOrUpload",
      "id": "2",
      "name": "test",
      "description": "test2 hello",
      "vector1": [
        2,
        3,
        4,
        5,
        6,
        7,
        8,
        9,
        10,
        11,
        12,
        13,
        14,
        15,
        16,
        17,
        18,
        19,
        20,
        21
      ],
      "vector1b": [
        12,
        13,
        14,
        15,
        16,
        17,
        18,
        19,
        20,
        21
      ],
      "vector2": [
        2,
        3,
        4,
        5,
        6
      ],
      "vector3": [
        2,
        3,
        4,
        5,
        6
      ],
      "vector22": [
        22,
        23,
        24,
        25,
        26,
        27,
        28,
        29,
        30,
        31
      ],
      "ownerId": "sam",
      "category": "purple",
      "price": 2
    }
  ]
}

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "key": "0",
      "status": true,
      "statusCode": 201
    },
    {
      "key": "1",
      "status": true,
      "statusCode": 201
    },
    {
      "key": "2",
      "status": true,
      "statusCode": 201
    }
  ]
}

Code d’état:: 207

{
  "value": [
    {
      "key": "0",
      "status": true,
      "statusCode": 201
    },
    {
      "key": "1",
      "status": true,
      "statusCode": 201
    },
    {
      "key": "2",
      "status": true,
      "statusCode": 201
    }
  ]
}

Définitions

Nom	Description
Accept	L’en-tête Accept.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse à l’erreur courante pour toutes les API Azure Resource Manager afin de renvoyer les détails d’erreur pour les opérations ratées. (Cela suit également le format de réponse d’erreur OData.).
IndexAction	Représente une action d’index qui fonctionne sur un document.
IndexActionType	Opération à effectuer sur un document d’un lot d’indexation.
IndexBatch	Contient un lot d’actions d’écriture de document à envoyer à l’index.
IndexDocumentsResult	Réponse contenant l’état des opérations pour tous les documents de la demande d’indexation.
IndexingResult	État d’une opération d’indexation pour un document unique.

Accept

Énumération

L’en-tête Accept.

Valeur	Description
application/json;odata.metadata=none

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 à l’erreur courante pour toutes les API Azure Resource Manager afin de renvoyer les détails d’erreur pour les opérations ratées. (Cela suit également le format de réponse d’erreur OData.).

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

IndexAction

Objet

Représente une action d’index qui fonctionne sur un document.

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

IndexActionType

Énumération

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

Valeur	Description
upload	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 la mise à jour.
merge	Fusionne les valeurs de champ spécifiées avec un document existant. Si le document n’existe pas, la fusion échouera. Tout champ que vous spécifiez dans une fusion remplacera le champ existant dans le document. Cela s’applique également aux collections de types primitifs et complexes.
mergeOrUpload	Se comporte comme merge 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 téléchargement avec un nouveau document.
delete	Supprime le document spécifié de l’index. Tout champ spécifié dans une opération de suppression autre que le champ clé sera ignoré. Si vous souhaitez supprimer un champ individuel d'un document, utilisez plutôt une fusion en définissant explicitement la valeur du champ sur null.

IndexBatch

Objet

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

Nom	Type	Description
value	IndexAction[]	Les actions du lot.

IndexDocumentsResult

Objet

Réponse contenant l’état des opérations pour tous les documents de la demande d’indexation.

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

IndexingResult

Objet

É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 (int32)	Code d’état de l’opération d’indexation. Les valeurs possibles sont les suivantes : 200 pour une mise à jour ou une suppression réussie, 201 pour la création réussie du document, 400 pour un document d’entrée incorrect, 404 pour le document introuvable, 409 pour un conflit de version, 422 lorsque l’index est temporairement indisponible ou 503 lorsque le service est trop occupé.