Method: projects.locations.collections.engines.assistants.cannedQueries.list

רשימה של כל הCannedQuerys בדומיין Assistant.

בקשת HTTP

GET https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*/collections/*/engines/*/assistants/*}/cannedQueries

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

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

פרמטרים
parent

string

חובה. שם משאב האב. פורמט: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

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

פרמטרים
filter

string

זה שינוי אופציונלי. ביטוי הסינון.

שדות נתמכים:

  • enabled
  • googleDefined

דוגמאות:

  • enabled=true
  • googleDefined=true
  • enabled=true AND googleDefined=true
pageSize

integer

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

string

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

כשמבצעים חלוקה לעמודים, כל הפרמטרים האחרים שסופקו ל-CannedQueryService.ListCannedQueries חייבים להיות זהים לקריאה שסיפקה את הטוקן של הדף.

גוף הבקשה

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

גוף התשובה

הודעת התגובה לשיטה CannedQueryService.ListCannedQueries.

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

ייצוג ב-JSON 
{
  "cannedQueries": [
    {
      object (CannedQuery)
    }
  ],
  "nextPageToken": string
}
שדות
cannedQueries[]

object (CannedQuery)

רשימת CannedQuerys שתואמים לבקשה.
nextPageToken

string

טוקן שאפשר לשלוח כ-ListCannedQueriesRequest.page_token כדי לאחזר את הדף הבא. אם משמיטים את השדה הזה, לא יופיעו דפים נוספים.

היקפי הרשאות

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

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

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

הרשאות IAM

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

  • discoveryengine.cannedQueries.list

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