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

Aggiorna un Document.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
document.name

string

Immutabile. Il nome completo della risorsa del documento. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{documentId}.

Questo campo deve essere una stringa codificata in UTF-8 con un limite di lunghezza di 1024 caratteri.

Parametri di query

Parametri
allowMissing

boolean

Se è impostato su true e Document non viene trovato, viene creato un nuovo Document.
updateMask

string (FieldMask format)

Indica quali campi del "documento" importato fornito devono essere aggiornati. Se non è impostato, per impostazione predefinita vengono aggiornati tutti i campi.

Si tratta di un elenco separato da virgole di nomi completi dei campi. Esempio: "user.displayName,photo".

Corpo della richiesta

Il corpo della richiesta contiene un'istanza di Document.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di Document.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • discoveryengine.documents.update

Per saperne di più, consulta la documentazione di IAM.