WidgetListSessionsRequest

Message de requête pour la méthode WidgetService.WidgetListSessions.

Représentation JSON 
{
  "location": string,
  "configId": string,
  "listSessionsRequest": {
    object (ListSessionsRequest)
  },
  "additionalParams": {
    object (AdditionalParams)
  }
}
Champs
location

string

Obligatoire. Ressource d'établissement dans laquelle les sessions de liste de widgets seront effectuées. Format : locations/{location}
configId

string

Obligatoire. UUID de WidgetConfig. Ce champ permet d'identifier la configuration du widget.
listSessionsRequest

object (ListSessionsRequest)

Obligatoire. Requête par procuration adressée à ConversationalSearchService.ListSessions.
additionalParams

object (AdditionalParams)

Obligatoire. Paramètres supplémentaires pour améliorer la sécurité et la confidentialité.

ListSessionsRequest

Requête pour la méthode ListSessions.

Représentation JSON 
{
  "parent": string,
  "pageSize": integer,
  "pageToken": string,
  "filter": string,
  "orderBy": string
}
Champs
parent

string

Obligatoire. Nom de ressource du data store. Format : projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}
pageSize

integer

Nombre maximal de résultats sur une page. Si aucune valeur n'est spécifiée, la valeur par défaut est 50. La valeur maximale autorisée est de 1 000.
pageToken

string

Jeton de page reçu d'un appel ListSessions précédent. Fournissez-le pour récupérer la page suivante.
filter

string

Liste de champs séparés par une virgule sur lesquels filtrer, dans la grammaire EBNF.

Voici les champs acceptés :

  • user_pseudo_id
  • state
  • display_name
  • starred
  • is_pinned
  • labels
  • create_time
  • update_time

Exemples :

  • user_pseudo_id = some_id
  • display_name = "some_name"
  • starred = true
  • is_pinned=true AND (NOT labels:hidden)
  • create_time > "1970-01-01T12:00:00Z"
orderBy

string

Liste de champs séparés par une virgule selon lesquels trier les résultats, dans l'ordre croissant. Utilisez "desc" après un nom de champ pour l'ordre décroissant.

Champs acceptés :

  • update_time
  • create_time
  • session_name
  • is_pinned

Exemple :

  • update_time desc
  • create_time
  • is_pinned desc,update_time desc : liste les sessions par is_pinned, puis par update_time.