Method: projects.locations.rankingConfigs.rank

דירוג רשימה של רשומות טקסט על סמך שאילתת הקלט שניתנה.

בקשת HTTP


POST https://discoveryengine.googleapis.com/v1/{rankingConfig=projects/*/locations/*/rankingConfigs/*}:rank

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

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

פרמטרים
rankingConfig

string

חובה. שם המשאב של הגדרת שירות הדירוג, למשל projects/{projectNum}/locations/{location}/rankingConfigs/default_ranking_config.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "model": string,
  "topN": integer,
  "query": string,
  "records": [
    {
      object (RankingRecord)
    }
  ],
  "ignoreRecordDetailsInResponse": boolean,
  "userLabels": {
    string: string,
    ...
  }
}
שדות
model

string

המזהה של המודל שרוצים להשתמש בו. הוא אחד מהבאים:

  • ‫semantic-ranker-512@latest: מודל דירוג סמנטי עם גודל מקסימלי של אסימוני קלט של 512.

אם לא מציינים ערך, ברירת המחדל היא semantic-ranker-512@latest.
topN

integer

מספר התוצאות שיוחזרו. אם הערך לא מוגדר או שהוא לא גדול מאפס, הפונקציה מחזירה את כל התוצאות.
query

string

השאילתה שרוצים להשתמש בה.
records[]

object (RankingRecord)

חובה. רשימה של רשומות לדירוג.
ignoreRecordDetailsInResponse

boolean

אם הערך הוא true, התשובה תכיל רק את מזהה הרשומה והניקוד. כברירת מחדל, הערך הוא false, והתשובה תכיל פרטים על הרשומה.
userLabels

map (key: string, value: string)

התוויות של המשתמש שמוחלות על משאב צריכות לעמוד בדרישות הבאות:

  • לכל משאב יכולות להיות כמה תוויות, עד 64 לכל היותר.
  • כל תווית חייבת להיות צמד מפתח/ערך.
  • האורך המינימלי של המפתחות הוא תו אחד, והאורך המקסימלי הוא 63 תווים. המפתחות לא יכולים להיות ריקים. הערכים יכולים להיות ריקים, והאורך המקסימלי שלהם הוא 63 תווים.
  • המפתחות והערכים יכולים להכיל רק אותיות קטנות, ספרות, קווים תחתונים ומקפים. כל התווים צריכים להיות בקידוד UTF-8, ואפשר להשתמש בתווים בינלאומיים.
  • החלק של המפתח בתווית חייב להיות ייחודי. עם זאת, אפשר להשתמש באותו מפתח עם כמה משאבים.
  • המפתחות צריכים להתחיל באות קטנה או בתו בינלאומי.

פרטים נוספים מופיעים במאמר Google Cloud Document.

גוף התשובה

הודעת תגובה לשיטה RankService.Rank.

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

ייצוג ב-JSON 
{
  "records": [
    {
      object (RankingRecord)
    }
  ]
}
שדות
records[]

object (RankingRecord)

רשימה של רשומות שממוינות בסדר יורד לפי הציון.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של 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.

הרשאות IAM

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

  • discoveryengine.rankingConfigs.rank

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

RankingRecord

הקלטת הודעה לשיטה RankService.Rank.

ייצוג ב-JSON 
{
  "id": string,
  "title": string,
  "content": string,
  "score": number
}
שדות
id

string

המזהה הייחודי שמייצג את הרשומה.
title

string

השם של הרשומה. כברירת מחדל, השדה ריק. צריך להגדיר לפחות אחד מהערכים title או content, אחרת מוצגת השגיאה INVALID_ARGUMENT.
content

string

תוכן הרשומה. כברירת מחדל, השדה ריק. צריך להגדיר לפחות אחד מהערכים title או content, אחרת מוצגת השגיאה INVALID_ARGUMENT.
score

number

הציון של הרשומה הזו על סמך השאילתה שצוינה והמודל שנבחר. הציון יעוגל ל-4 ספרות אחרי הנקודה העשרונית. אם הציון קרוב ל-0, הוא יעוגל ל-0.00001 כדי למנוע החזרה של ערך לא מוגדר.