SearchSpec

מפרט החיפוש.

ייצוג ב-JSON 
{

  // Union field input can be only one of the following:
  "searchParams": {
    object (SearchParams)
  },
  "searchResultList": {
    object (SearchResultList)
  }
  // End of list of possible types for union field input.
}
שדות
שדה איחוד input. פרמטרים של חיפוש לשליטה בהתנהגות החיפוש. או לספק רשימה של תוצאות חיפוש כדי ליצור תשובה. הערך input יכול להיות רק אחד מהבאים:
searchParams

object (SearchParams)

פרמטרים של חיפוש.
searchResultList

object (SearchResultList)

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

SearchParams

פרמטרים של חיפוש.

ייצוג ב-JSON 
{
  "maxReturnResults": integer,
  "filter": string,
  "boostSpec": {
    object (BoostSpec)
  },
  "orderBy": string,
  "searchResultMode": enum (SearchResultMode),
  "dataStoreSpecs": [
    {
      object (DataStoreSpec)
    }
  ]
}
שדות
maxReturnResults

integer

מספר תוצאות החיפוש שיוחזרו. ערך ברירת המחדל הוא 10.
filter

string

תחביר המסנן מורכב משפת ביטויים לבניית פרדיקט משדה אחד או יותר של המסמכים שמסננים. ביטוי המסנן תלוי אותיות רישיות (case-sensitive). המידע הזה ישמש לסינון תוצאות החיפוש, ויכול להיות שהוא ישפיע על התשובה.

אם השדה לא מזוהה, מוחזר INVALID_ARGUMENT.

סינון ב-חיפוש מבוסס-Vertex AI מתבצע על ידי מיפוי של מפתח הסינון בצד ימין למאפיין מפתח שמוגדר בבק-אנד של חיפוש מבוסס-Vertex AI. הלקוח מגדיר את המיפוי הזה בסכימה שלו. לדוגמה, ללקוחות בתחום המדיה יכול להיות שדה בשם 'name' בסכימה שלהם. במקרה הזה, המסנן ייראה כך: filter --> name:'ANY("king kong")'

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

object (BoostSpec)

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

string

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

אם השדה לא מזוהה, מוחזר INVALID_ARGUMENT.
searchResultMode

enum (SearchResultMode)

מציינת את מצב תוצאות החיפוש. אם לא מציינים מצב, ברירת המחדל של מצב תוצאות החיפוש היא DOCUMENTS. איך מנתחים ומחלקים מסמכים לחלקים
dataStoreSpecs[]

object (DataStoreSpec)

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

SearchResultList

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

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

object (SearchResult)

תוצאות החיפוש

SearchResult

תוצאת חיפוש.

ייצוג ב-JSON 
{

  // Union field content can be only one of the following:
  "unstructuredDocumentInfo": {
    object (UnstructuredDocumentInfo)
  },
  "chunkInfo": {
    object (ChunkInfo)
  }
  // End of list of possible types for union field content.
}
שדות
שדה איחוד content. תוכן של תוצאת חיפוש. הערך content יכול להיות רק אחד מהבאים:
unstructuredDocumentInfo

object (UnstructuredDocumentInfo)

מידע לא מובנה במסמך.
chunkInfo

object (ChunkInfo)

פרטי המקטע.

UnstructuredDocumentInfo

מידע לא מובנה במסמך.

ייצוג ב-JSON 
{
  "document": string,
  "uri": string,
  "title": string,
  "documentContexts": [
    {
      object (DocumentContext)
    }
  ],
  "extractiveSegments": [
    {
      object (ExtractiveSegment)
    }
  ],
  "extractiveAnswers": [
    {
      object (ExtractiveAnswer)
    }
  ]
}
שדות
document

string

שם המשאב של המסמך.
uri

string

‫URI של המסמך.
title

string

שם.
documentContexts[]

object (DocumentContext)

רשימה של הקשרים של המסמך. התוכן ישמש ליצירת תשובות. זה אמור להיות התוכן העיקרי של המסמך, שיכול להיות ארוך ומקיף.
extractiveSegments[]

object (ExtractiveSegment)

רשימה של פלחים שחולצו.
extractiveAnswers[]
(deprecated)

object (ExtractiveAnswer)

הוצא משימוש: השדה הזה הוצא משימוש ולא תהיה לו השפעה על יצירת התשובה. במקומו צריך להשתמש בשדות documentContexts ו-extractiveSegments. רשימה של תשובות חילוץ.

DocumentContext

הקשר של המסמך.

ייצוג ב-JSON 
{
  "pageIdentifier": string,
  "content": string
}
שדות
pageIdentifier

string

מזהה הדף.
content

string

תוכן המסמך שישמש ליצירת תשובה.

ExtractiveSegment

קטע מידע שנשלף. הנחיות יצירת תשובות תתבסס על ההנחיות האלה רק אם documentContexts ריק. אלה אמורים להיות קטעי מידע קצרים יותר.

ייצוג ב-JSON 
{
  "pageIdentifier": string,
  "content": string
}
שדות
pageIdentifier

string

מזהה הדף.
content

string

תוכן של קטע שחולץ.

ExtractiveAnswer

תשובה שמבוססת על מידע שקיים בטקסט. מדריך

ייצוג ב-JSON 
{
  "pageIdentifier": string,
  "content": string
}
שדות
pageIdentifier

string

מזהה הדף.
content

string

תוכן תשובה שחולץ.

ChunkInfo

פרטי המקטע.

ייצוג ב-JSON 
{
  "chunk": string,
  "content": string,
  "documentMetadata": {
    object (DocumentMetadata)
  }
}
שדות
chunk

string

שם המשאב של החלק.
content

string

חלוקת תוכן טקסטואלי לחלקים.
documentMetadata

object (DocumentMetadata)

מטא-נתונים של המסמך מהחלק הנוכחי.

DocumentMetadata

המטא-נתונים של המסמך מכילים את המידע של המסמך של החלק הנוכחי.

ייצוג ב-JSON 
{
  "uri": string,
  "title": string
}
שדות
uri

string

כתובת ה-URI של המסמך.
title

string

שם המסמך.