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

Atualiza um Document.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
document.name

string

Imutável. O nome completo do recurso do documento. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{documentId}.

Este campo precisa ser uma string codificada em UTF-8 com um limite de 1.024 caracteres.

Parâmetros de consulta

Parâmetros
allowMissing

boolean

Se definido como true e o Document não for encontrado, um novo Document será criado.
updateMask

string (FieldMask format)

Indica quais campos do "documento" importado fornecido precisam ser atualizados. Se não for definido, todos os campos serão atualizados por padrão.

Uma lista separada por vírgulas de nomes de campos totalmente qualificados. Exemplo: "user.displayName,photo".

Corpo da solicitação

O corpo da solicitação contém uma instância de Document.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Document.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • discoveryengine.documents.update

Para mais informações, consulte a documentação do IAM.