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

Atualiza um Document.

Pedido HTTP

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

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

Parâmetros de caminho

Parâmetros
document.name

string

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

Este campo tem de ser uma string codificada em UTF-8 com um limite de comprimento de 1024 carateres.

Parâmetros de consulta

Parâmetros
allowMissing

boolean

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

string (FieldMask format)

Indica que campos no "documento" importado fornecido devem ser atualizados. Se não for definido, atualiza todos os campos por predefinição.

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

Corpo do pedido

O corpo do pedido contém uma instância de Document.

Corpo da resposta

Se for bem-sucedido, o corpo da resposta contém uma instância de Document.

Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

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

Para mais informações, consulte o Authentication Overview.

Autorizações de IAM

Requer a seguinte autorização de IAM no recurso name:

  • discoveryengine.documents.update

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