Method: corpora.documents.patch

Actualiza un objeto Document.

Solicitud HTTP

PATCH https://generativelanguage.googleapis.com/v1beta/{document.name=corpora/*/documents/*}

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
document.name

string

Inmutable. Identificador. El nombre del recurso Document. El ID (nombre sin el prefijo “corpora/*/documents/”) puede contener hasta 40 caracteres alfanuméricos en minúscula o guiones (-). No puede comenzar ni terminar con un guion. Si el nombre está vacío durante la creación, se derivará un nombre único de displayName junto con un sufijo aleatorio de 12 caracteres. Ejemplo: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c

Parámetros de consulta

Parámetros
updateMask

string (FieldMask format)

Obligatorio. La lista de campos a actualizar. Por el momento, esto solo admite la actualización de displayName y customMetadata.

Esta es una lista separada por comas de los nombres de campos completamente calificados. Ejemplo: "user.displayName,photo".

Cuerpo de la solicitud

El cuerpo de la solicitud incluye una instancia de Document.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Document.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/generative-language.retriever

Para obtener más información, consulta Descripción general de la autenticación.