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

רשימה של כל השיחות לפי ההורה שלהן DataStore.

בקשת HTTP

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

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

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

פרמטרים
parent

string

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

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

פרמטרים
pageSize

integer

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

pageToken

string

טוקן של דף שהתקבל מקריאה קודמת של conversations.list. צריך להזין את הטוקן כדי לאחזר את הדף הבא.

filter

string

מסנן להחלה על תוצאות הרשימה. התכונות הנתמכות הן: userPseudoId, ‏ state.

דוגמה: userPseudoId = some_id

orderBy

string

רשימה מופרדת בפסיקים של שדות למיון, ממוינת בסדר עולה. כדי למיין בסדר יורד, מוסיפים את הערך desc אחרי שם השדה. שדות נתמכים: * updateTime * createTime * conversation_name

דוגמה: "updateTime desc" "createTime"

גוף הבקשה

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

גוף התשובה

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

היקפי הרשאות

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

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

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

הרשאות IAM

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

  • discoveryengine.conversations.list

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