Method: projects.locations.dataStores.patch

Met à jour les paramètres d'un seul DataStore.

dataStores.patch, dataStores.importDocuments et dataStores.purgeDocuments s'exécutent un par un par DataStore. Pendant qu'une opération est en cours d'exécution, une autre peut être mise en attente. Toute autre requête échoue avec l'erreur ABORTED jusqu'à ce que l'opération en cours se termine.

Requête HTTP

PATCH https://vectorsearch.googleapis.com/v1beta/{dataStore.name}

Paramètres de chemin d'accès

Paramètres
dataStore.name

string

Identifiant. Nom complet de la ressource du datastore.

Format : projects/{project}/locations/{location}/dataStores/{dataStoreId}

Paramètres de requête

Paramètres
updateMask

string (FieldMask format)

Facultatif. Le masque de champ permet de spécifier les champs à écraser dans la ressource DataStore lors de la mise à jour. Les champs spécifiés dans le paramètre updateMask sont relatifs à la ressource, et non à la requête complète. Un champ sera écrasé s'il figure dans le masque. Un chemin d'accès qui nomme un message remplace l'intégralité du message : les sous-champs omis de la requête sont effacés et, sous processingConfig, rétablis à leurs valeurs par défaut.

Si l'utilisateur ne fournit pas de masque, tous les champs que la requête définit sur une valeur autre que celle par défaut sont écrasés. Les messages envoyés vides (par exemple, layoutParsingConfig: {}) et les champs définis sur leur valeur par défaut (par exemple, false) ne sont pas appliqués. Nommez-les plutôt dans le masque.

Les champs suivants sont compatibles avec la mise à jour : displayName, description, labels, processingConfig et documentMetadataSchema. documentMetadataSchema doit être mis à jour dans son intégralité (le chemin du masque est documentMetadataSchema) et uniquement en ajoutant des propriétés : les propriétés existantes ne peuvent pas être supprimées ni modifiées.

Si * est fourni dans updateMask, un remplacement complet sera effectué.

Il s'agit d'une liste de noms de champs complets séparés par une virgule. Exemple : "user.displayName,photo".
requestId

string

Facultatif. ID de requête facultatif permettant d'identifier les requêtes. Spécifiez un ID de requête unique pour indiquer au serveur d'ignorer la requête si vous devez la relancer alors qu'elle a déjà été traitée. Le serveur garantira cette logique pendant au moins 60 minutes après la première requête.

Imaginons que vous effectuez une requête initiale et que celle-ci expire. Si vous effectuez de nouveau la requête avec le même ID, le serveur peut vérifier si une opération initiale avec cet ID de requête a déjà été reçue et, si c'est le cas, ignorer la deuxième requête. Cela permet d'éviter que les clients ne créent accidentellement des engagements en double.

L'ID de requête doit être un UUID valide, sachant qu'un UUID égal à zéro (00000000-0000-0000-0000-000000000000) n'est pas accepté.

Corps de la requête

Le corps de la requête contient une instance de DataStore.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de Operation.

Niveaux d'accès des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/vectorsearch

Pour plus d'informations, consultez la Authentication Overview.