Method: projects.locations.collections.engines.sessions.patch

Atualiza uma sessão.

Não é possível alterar o tipo de ação Session. Se o Session a atualizar não existir, é devolvido um erro NOT_FOUND.

Pedido HTTP

PATCH https://discoveryengine.googleapis.com/v1/{session.name=projects/*/locations/*/collections/*/engines/*/sessions/*}

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

Parâmetros de caminho

Parâmetros
session.name

string

Imutável. Nome totalmente qualificado projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*

Parâmetros de consulta

Parâmetros
updateMask

string (FieldMask format)

Indica os campos no Session fornecido a atualizar. As seguintes funcionalidades NÃO são suportadas:

Se não for definido ou estiver vazio, todos os campos suportados são atualizados.

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 Session.

Corpo da resposta

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

Â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
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite

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

Autorizações de IAM

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

  • discoveryengine.sessions.update

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