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

Atualiza uma sessão.

O tipo de ação Session não pode ser alterado. Se o Session a ser atualizado não existir, um erro NOT_FOUND será retornado.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação 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 quais campos no Session fornecido serão atualizados. Não há suporte para o seguinte:

Se não estiver definido ou vazio, todos os campos com suporte serão atualizados.

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

Corpo da resposta

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

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

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

  • discoveryengine.sessions.update

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