Method: projects.locations.evaluations.listResults

מקבל רשימת תוצאות עבור Evaluation נתון.

בקשת HTTP

GET https://discoveryengine.googleapis.com/v1beta/{evaluation=projects/*/locations/*/evaluations/*}:listResults

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

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

פרמטרים
evaluation

string

חובה. שם משאב ההערכה, למשל projects/{project}/locations/{location}/evaluations/{evaluation}.

אם למבצע הקריאה אין הרשאה להציג את ListEvaluationResultsResponse.EvaluationResult במסגרת ההערכה הזו, בלי קשר לשאלה אם קבוצת ההערכה הזו קיימת או לא, תוחזר שגיאה PERMISSION_DENIED.

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

פרמטרים
pageSize

integer

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

אם הערך בשדה הזה הוא שלילי, תוחזר שגיאת INVALID_ARGUMENT.
pageToken

string

זה שינוי אופציונלי. טוקן של דף ListEvaluationResultsResponse.next_page_token שהתקבל מקריאה קודמת של EvaluationService.ListEvaluationResults. צריך להזין את הטוקן כדי לאחזר את הדף הבא.

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

גוף הבקשה

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

גוף התשובה

הודעת תגובה לשיטה EvaluationService.ListEvaluationResults.

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

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

object (EvaluationResult)

תוצאות הבדיקה של SampleQuery.
nextPageToken

string

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

היקפי הרשאות

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

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

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

הרשאות IAM

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

  • discoveryengine.evaluations.get

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

EvaluationResult

מייצג את תוצאות ההערכה של SampleQuery יחיד.

ייצוג ב-JSON 
{
  "sampleQuery": {
    object (SampleQuery)
  },
  "qualityMetrics": {
    object (QualityMetrics)
  }
}
שדות
sampleQuery

object (SampleQuery)

פלט בלבד. ה-SampleQuery שנבדק.
qualityMetrics

object (QualityMetrics)

פלט בלבד. המדידות שנוצרו על ידי ההערכה, עבור SampleQuery נתון.