WidgetListSessionsRequest

WidgetService.WidgetListSessions 메서드의 요청 메시지입니다.

JSON 표현 
{
  "location": string,
  "configId": string,
  "listSessionsRequest": {
    object (ListSessionsRequest)
  },
  "additionalParams": {
    object (AdditionalParams)
  }
}
필드
location

string

필수 항목입니다. 위젯 목록 세션이 실행될 위치 리소스입니다. 형식: locations/{location}
configId

string

필수 항목입니다. WidgetConfig의 UUID입니다. 이 필드는 위젯 구성을 식별하는 데 사용됩니다.
listSessionsRequest

object (ListSessionsRequest)

필수 항목입니다. ConversationalSearchService.ListSessions에 대한 프록시 요청입니다.
additionalParams

object (AdditionalParams)

필수 항목입니다. 보안 및 개인 정보 보호 강화를 위한 추가 파라미터입니다.

ListSessionsRequest

ListSessions 메서드 요청입니다.

JSON 표현 
{
  "parent": string,
  "pageSize": integer,
  "pageToken": string,
  "filter": string,
  "orderBy": string
}
필드
parent

string

필수 항목입니다. 데이터 스토어 리소스 이름입니다. 형식: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}
pageSize

integer

반환할 결과의 최대 수입니다. 지정하지 않으면 기본값은 50입니다. 최대 허용 값은 1,000입니다.
pageToken

string

이전 ListSessions 호출에서 받은 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다.
filter

string

필터링할 쉼표로 구분한 필드 목록으로, EBNF 문법 형식입니다.

지원되는 필드는 다음과 같습니다.

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

예시:

  • 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"
  • collaborativeProject = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborativeProjects/cp1"
orderBy

string

정렬할 쉼표로 구분된 필드로, 오름차순으로 정렬됩니다. 내림차순으로 정렬할 경우 필드 이름 뒤에 "desc"를 사용합니다.

지원되는 필드:

  • update_time
  • create_time
  • session_name
  • is_pinned

예:

  • update_time desc
  • create_time
  • is_pinned desc,update_time desc: 먼저 세션을 is_pinned별로 정렬한 후 update_time별로 정렬합니다.