Method: projects.locations.collections.dataObjects.batchSearch

חיפוש אובייקטים של נתונים בקבוצות.

בקשת HTTP

POST https://vectorsearch.googleapis.com/v1beta/{parent}/dataObjects:batchSearch

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

פרמטרים
parent

string

חובה. שם המשאב של האוסף שרוצים לחפש. פורמט: projects/{project}/locations/{location}/collections/{collection}

גוף הבקשה

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

ייצוג ב-JSON 
{
  "searches": [
    {
      object (Search)
    }
  ],
  "combine": {
    object (CombineResultsOptions)
  }
}
שדות
searches[]

object (Search)

חובה. רשימה של בקשות חיפוש להרצה במקביל.
combine

object (CombineResultsOptions)

זה שינוי אופציונלי. אפשרויות לשילוב התוצאות של פעולות החיפוש באצווה.

גוף התשובה

תשובה מפעולת חיפוש באצווה.

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

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

object (SearchDataObjectsResponse)

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

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

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

הרשאות IAM

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

  • vectorsearch.dataObjects.search

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

CombineResultsOptions

אפשרויות לשילוב התוצאות של פעולות החיפוש באצווה.

ייצוג ב-JSON 
{
  "ranker": {
    object (Ranker)
  },
  "outputFields": {
    object (OutputFields)
  },
  "topK": integer
}
שדות
ranker

object (Ranker)

חובה. הדירוג שבו ישתמשו כדי לשלב את התוצאות.
outputFields

object (OutputFields)

זה שינוי אופציונלי. מסכה שמציינת אילו שדות להחזיר.
topK

integer

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

Ranker

הגדרת כלי לדירוג כדי לשלב תוצאות מכמה חיפושים.

ייצוג ב-JSON 
{

  // Union field ranker can be only one of the following:
  "rrf": {
    object (ReciprocalRankFusion)
  },
  "vertex": {
    object (VertexRanker)
  }
  // End of list of possible types for union field ranker.
}
שדות
שדה איחוד ranker. שיטת הדירוג שבה רוצים להשתמש. הערך ranker יכול להיות רק אחד מהבאים:
rrf

object (ReciprocalRankFusion)

דירוג Reciprocal Rank Fusion.
vertex

object (VertexRanker)

דירוג ב-Vertex AI.

ReciprocalRankFusion

הגדרת אלגוריתם Reciprocal Rank Fusion ‏ (RRF) לדירוג תוצאות.

ייצוג ב-JSON 
{
  "weights": [
    number
  ]
}
שדות
weights[]

number

חובה. המשקלים להחלה על כל קבוצת תוצאות חיפוש במהלך המיזוג.

VertexRanker

הגדרת כלי לדירוג באמצעות שירות הדירוג של Vertex AI. פרטים נוספים זמינים בכתובת https://cloud.google.com/generative-ai-app-builder/docs/ranking.

ייצוג ב-JSON 
{
  "query": string,
  "titleTemplate": string,
  "contentTemplate": string,
  "model": string
}
שדות
query

string

חובה. השאילתה שלפיה הרשומות מדורגות ומקבלות ניקוד.
titleTemplate

string

זה שינוי אופציונלי. התבנית שמשמשת ליצירת שם הרשומה.
contentTemplate

string

זה שינוי אופציונלי. התבנית ששימשה ליצירת התוכן של הרשומה.
model

string

חובה. המודל שמשמש לדירוג מסמכים. אם לא מציינים מודל, המערכת משתמשת במודל semantic-ranker-default@latest.