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

Actualiza un Document.

Solicitud HTTP

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

La URL utiliza la sintaxis de transcodificación a gRPC.

Parámetros de ruta

Parámetros
document.name

string

Inmutable. Nombre de recurso completo del documento. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{documentId}.

Este campo debe ser una cadena codificada en UTF-8 con un límite de 1024 caracteres.

Los parámetros de consulta

Parámetros
allowMissing

boolean

Si se define como true y no se encuentra el Document, se creará un Document.
updateMask

string (FieldMask format)

Indica qué campos del documento importado proporcionado se van a actualizar. Si no se define, se actualizan todos los campos de forma predeterminada.

Es una lista de nombres completos de campos separados por comas. Ejemplo: "user.displayName,photo"

Cuerpo de la solicitud

En el cuerpo de la solicitud se incluye una instancia de Document.

Cuerpo de la respuesta

Si la solicitud se hace correctamente, en el cuerpo de la respuesta se incluye una instancia de Document.

Permisos de autorización

Debes disponer de uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta el Authentication Overview.

Permisos de IAM

Requiere el siguiente permiso de gestión de identidades y accesos en el recurso name:

  • discoveryengine.documents.update

Para obtener más información, consulta la documentación de gestión de identidades y accesos.