Method: projects.locations.collections.engines.sessions.alphaEvolveExperiments.alphaEvolvePrograms.list

רשימה של כל AlphaEvolvePrograms בניסוי נתון שעומדים בקריטריונים שצוינו בבקשה.

בקשת HTTP


GET https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*/collections/*/engines/*/sessions/*/alphaEvolveExperiments/*}/alphaEvolvePrograms

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

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

פרמטרים
parent

string

חובה. שם משאב האב (AlphaEvolveExperiment) של הניסוי. פורמט: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alphaEvolveExperiment}

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

פרמטרים
pageSize

integer

זה שינוי אופציונלי. המספר המקסימלי של תוכניות שיוחזרו. יכול להיות שהשירות יחזיר פחות מהערך הזה.
pageToken

string

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

string

זה שינוי אופציונלי. קריטריון המיון של התוכניות. רשימה של מדדים מופרדים בפסיקים למיון, ואפשרות לבחור סדר מיון, לדוגמה: "score1 desc, score2". הקריטריונים מוחלים לפי הסדר שמופיע בשדה. קריטריון משתמע של מיון לפי createTime בסדר יורד מופעל תמיד כשובר השוויון הסופי אחרי כל שאר הקריטריונים שצוינו.
stateFilter

enum (ProgramState)

זה שינוי אופציונלי. המסנן שרוצים להחיל על התוכניות. דוגמאות: ‎"stateFilter = 'COMPLETED'"‎ ‎"stateFilter = 'INITIALIZED' OR ‎ "stateFilter = 'EVALUATING'"‎

אם השדה ריק, ברירת המחדל היא הצגת תוכניות בסטטוס REGISTRATION_COMPLETE או בסטטוס עיבוד NULL.

גוף הבקשה

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

גוף התשובה

הודעת תגובה ל-AlphaEvolveService.ListAlphaEvolvePrograms.

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

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

object (AlphaEvolveProgram)

פלט בלבד. רשימת התוכניות שתואמות לקריטריונים שצוינו בבקשה.
nextPageToken

string

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

היקפי הרשאות

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

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

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