Method: projects.locations.dataStores.sessions.list

רשימה של כל הסשנים לפי DataStore ההורה שלהם.

בקשת HTTP


GET https://discoveryengine.googleapis.com/v1beta/{parent=projects/*/locations/*/dataStores/*}/sessions

כתובות ה-URL כתובות בתחביר של gRPC Transcoding.

פרמטרים של נתיב

פרמטרים
parent

string

חובה. שם המשאב של מאגר הנתונים. פורמט: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}

פרמטרים של שאילתה

פרמטרים
pageSize

integer

המספר המקסימלי של תוצאות שיוחזרו. אם לא מציינים ערך, ברירת המחדל היא 50. הערך המקסימלי המותר הוא 1,000.
pageToken

string

טוקן של דף שהתקבל מקריאה קודמת של sessions.list. צריך להזין את הטוקן כדי לאחזר את הדף הבא.
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
  • display_name

דוגמה:

  • update_time desc
  • create_time
  • ‫is_pinned desc,update_time desc: רשימת הסשנים, קודם לפי is_pinned ואז לפי update_time.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של ListSessionsResponse.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

ניתן למצוא מידע נוסף כאן: Authentication Overview.

הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב parent:

  • discoveryengine.sessions.list

מידע נוסף מופיע במאמרי העזרה בנושא IAM.