Method: projects.locations.collections.engines.conversations.list

Lista todas as conversas pelo recurso pai DataStore.

Solicitação HTTP

GET https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*/collections/*/engines/*}/conversations

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

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O nome do recurso do repositório de dados. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}

Parâmetros de consulta

Parâmetros
pageSize

integer

Número máximo de resultados a serem retornados. Se não for especificado, o padrão será 50. O valor máximo permitido é 1000.

pageToken

string

Um token de página recebido de uma chamada conversations.list anterior. Forneça isso para recuperar a página subsequente.

filter

string

Um filtro a ser aplicado nos resultados da lista. Os recursos compatíveis são: userPseudoId e state.

Exemplo: "userPseudoId = some_id"

orderBy

string

Uma lista separada por vírgulas de campos para ordenar, classificados em ordem crescente. Use "desc" depois de um nome de campo para ordem decrescente. Campos aceitos: * updateTime * createTime * conversation_name

Exemplo: "updateTime desc" "createTime"

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

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

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 parent:

  • discoveryengine.conversations.list

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