Method: projects.locations.collections.dataStores.branches.documents.patch

Met à jour un Document.

Requête HTTP

PATCH https://discoveryengine.googleapis.com/v1alpha/{document.name=projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*}

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
document.name

string

Immuable. Nom complet de la ressource de document. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{documentId}.

Ce champ doit être une chaîne encodée au format UTF-8 d'une longueur maximale de 1 024 caractères.

Paramètres de requête

Paramètres
allowMissing

boolean

Si la valeur est définie sur true et que le Document n'est pas trouvé, un nouveau Document est créé.
updateMask

string (FieldMask format)

Indique les champs du document importé fourni à mettre à jour. Si aucun champ n'est défini, tous les champs sont mis à jour par défaut.

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

Corps de la requête

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

Corps de la réponse

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

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/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

Pour plus d'informations, consultez la page Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource name :

  • discoveryengine.documents.update

Pour en savoir plus, consultez la documentation IAM.