SearchSpec

מפרט החיפוש.

ייצוג JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "searchParams": {
    object (SearchParams)
  },
  "searchResultList": {
    object (SearchResultList)
  }
  // End of mutually exclusive fields.
}
שדות
פרמטרים של חיפוש שקובעים את התנהגות החיפוש. אפשר גם לספק רשימה של תוצאות חיפוש כדי ליצור תשובה. בהמשך מפורטת רשימה של שדות שאי אפשר להשתמש בהם בו-זמנית. רק אחד מהשדות הבאים יוגדר בתשובה:
searchParams

object (SearchParams)

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

object (SearchResultList)

רשימה של תוצאות חיפוש.
סוף השדות הבלעדיים.

SearchParams

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

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

integer

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

string

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

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

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

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

object (BoostSpec)

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

string

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

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

enum (SearchResultMode)

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

object (DataStoreSpec)

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

object (NaturalLanguageQueryUnderstandingSpec)

זה שינוי אופציונלי. מפרט להפעלת יכולות של הבנת שפה טבעית (NLU) לבקשות חיפוש.

SearchResultList

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

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

object (SearchResult)

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

SearchResult

תוצאת חיפוש.

ייצוג JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "unstructuredDocumentInfo": {
    object (UnstructuredDocumentInfo)
  },
  "chunkInfo": {
    object (ChunkInfo)
  }
  // End of mutually exclusive fields.
}
שדות
תוכן של תוצאת חיפוש. בהמשך מפורטת רשימה של שדות שאי אפשר להשתמש בהם בו-זמנית. רק אחד מהשדות הבאים יוגדר בתשובה:
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

שם המסמך.