WidgetListSessionsRequest

הודעת בקשה לשיטה WidgetService.WidgetListSessions.

ייצוג ב-JSON 
{
  "location": string,
  "configId": string,
  "listSessionsRequest": {
    object (ListSessionsRequest)
  },
  "additionalParams": {
    object (AdditionalParams)
  }
}
שדות
location

string

חובה. משאב המיקום שבו יתבצעו סשנים של רשימת הווידג'טים. פורמט: locations/{location}
configId

string

חובה. המזהה הייחודי האוניברסלי (UUID) של WidgetConfig. השדה הזה משמש לזיהוי הגדרות הווידג'ט.
listSessionsRequest

object (ListSessionsRequest)

חובה. הבקשה שמועברת דרך ה-proxy אל 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.