SearchResponse

הודעת תגובה לשיטה SearchService.Search.

ייצוג ב-JSON 
{
  "results": [
    {
      object (SearchResult)
    }
  ],
  "facets": [
    {
      object (Facet)
    }
  ],
  "totalSize": integer,
  "attributionToken": string,
  "redirectUri": string,
  "nextPageToken": string,
  "correctedQuery": string,
  "summary": {
    object (Summary)
  },
  "queryExpansionInfo": {
    object (QueryExpansionInfo)
  },
  "naturalLanguageQueryUnderstandingInfo": {
    object (NaturalLanguageQueryUnderstandingInfo)
  },
  "sessionInfo": {
    object (SessionInfo)
  },
  "searchLinkPromotions": [
    {
      object (SearchLinkPromotion)
    }
  ],
  "semanticState": enum (SemanticState)
}
שדות
results[]

object (SearchResult)

רשימה של מסמכים שתואמים לחיפוש. הסדר מייצג את הדירוג.
facets[]

object (Facet)

תוצאות של היבטים שהמשתמש ביקש.
totalSize

integer

המספר הכולל המשוער של פריטים שתואמים לשאילתה, ללא קשר להחלוקה לדפים. יכול להיות שמספר התוצאות results שמוחזרות על ידי חלוקה לעמודים יהיה קטן ממספר התוצאות totalSize שתואמות.
attributionToken

string

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

string

ה-URI של דף הפניה שהוגדר על ידי הלקוח. אם מופעלת פעולת הפניה אוטומטית, לא מתבצע חיפוש ורק הערכים redirectUri ו-attributionToken מוגדרים בתגובה.
nextPageToken

string

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

string

מכיל את השאילתה עם תיקון האיות, אם נמצאה. אם סוג תיקון האיות הוא AUTOMATIC, תוצאות החיפוש מבוססות על correctedQuery. אחרת, נעשה שימוש בשאילתה המקורית לחיפוש.
summary

object (Summary)

סיכום כחלק מתוצאות החיפוש. השדה הזה מוחזר רק אם מוגדר הערך SearchRequest.ContentSearchSpec.summary_spec.
queryExpansionInfo

object (QueryExpansionInfo)

מידע על הרחבת השאילתה עבור התוצאות שהוחזרו.
naturalLanguageQueryUnderstandingInfo

object (NaturalLanguageQueryUnderstandingInfo)

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

object (SessionInfo)

פרטי הסשן.

המאפיין הזה מוגדר רק אם מציינים את SearchRequest.session. פרטים נוספים מופיעים בתיאור.
semanticState

enum (SemanticState)

פלט בלבד. מציין את המצב הסמנטי של תשובת החיפוש.

מאפיין

תוצאה של מאפיין.

ייצוג ב-JSON 
{
  "key": string,
  "values": [
    {
      object (FacetValue)
    }
  ],
  "dynamicFacet": boolean
}
שדות
key

string

המפתח של ההיבט הזה. לדוגמה, "colors" או "price". היא תואמת ל-SearchRequest.FacetSpec.FacetKey.key.
values[]

object (FacetValue)

ערכי הפנים של השדה הזה.
dynamicFacet

boolean

האם הפן נוצר באופן דינמי.

FacetValue

ערך של היבט שמכיל שמות של ערכים ואת המספר שלהם.

ייצוג ב-JSON 
{
  "count": string,

  // Union field facet_value can be only one of the following:
  "value": string,
  "interval": {
    object (Interval)
  }
  // End of list of possible types for union field facet_value.
}
שדות
count

string (int64 format)

מספר הפריטים שכוללים את ערך ההיבט הזה.
שדה איחוד facet_value. ערך של היבט שמכיל ערכים. הערך facet_value יכול להיות רק אחד מהבאים:
value

string

ערך טקסט של היבט, כמו 'שחור' עבור ההיבט 'צבעים'.
interval

object (Interval)

ערך המרווח של פן, כמו [10, 20) עבור הפן 'מחיר'. היא תואמת ל-SearchRequest.FacetSpec.FacetKey.intervals.

QueryExpansionInfo

מידע שמתאר את הרחבת השאילתה, כולל אם ההרחבה התרחשה.

ייצוג ב-JSON 
{
  "expandedQuery": boolean,
  "pinnedResultCount": string
}
שדות
expandedQuery

boolean

ערך בוליאני שמתאר אם בוצעה הרחבת שאילתה.
pinnedResultCount

string (int64 format)

מספר התוצאות המוצמדות. השדה הזה יוגדר רק כשההרחבה תתבצע והשדה SearchRequest.QueryExpansionSpec.pin_unexpanded_results יוגדר כ-true.

NaturalLanguageQueryUnderstandingInfo

מידע שמתאר את תהליך הבנת השפה הטבעית שבוצע בשאילתת הקלט.

ייצוג ב-JSON 
{
  "extractedFilters": string,
  "rewrittenQuery": string,
  "classifiedIntents": [
    string
  ],
  "structuredExtractedFilter": {
    object (StructuredExtractedFilter)
  }
}
שדות
extractedFilters

string

המסננים שחולצו משאילתת הקלט.
rewrittenQuery

string

השאילתה שנכתבה מחדש, ללא המסננים שחולצו.
classifiedIntents[]

string

הכוונות שסווגו מתוך שאילתת הקלט.
structuredExtractedFilter

object (StructuredExtractedFilter)

המסננים שחולצו משאילתת הקלט, שמוצגים בצורה מובנית.

StructuredExtractedFilter

המסננים שחולצו משאילתת הקלט, שמוצגים בצורה מובנית.

ייצוג ב-JSON 
{
  "expression": {
    object (Expression)
  }
}
שדות
expression

object (Expression)

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

ביטוי

הביטוי שמציין את המסנן שחולץ משאילתת הקלט.

ייצוג ב-JSON 
{

  // Union field expr can be only one of the following:
  "stringConstraint": {
    object (StringConstraint)
  },
  "numberConstraint": {
    object (NumberConstraint)
  },
  "geolocationConstraint": {
    object (GeolocationConstraint)
  },
  "andExpr": {
    object (AndExpression)
  },
  "orExpr": {
    object (OrExpression)
  }
  // End of list of possible types for union field expr.
}
שדות
שדה איחוד expr. סוג הביטוי. הערך expr יכול להיות רק אחד מהבאים:
stringConstraint

object (StringConstraint)

ביטוי של אילוץ מחרוזת.
numberConstraint

object (NumberConstraint)

ביטוי של אילוץ מספרי.
geolocationConstraint

object (GeolocationConstraint)

ביטוי של מגבלת מיקום גיאוגרפי.
andExpr

object (AndExpression)

אופרטור מורכב לוגי And שמחבר בין כמה ביטויים.
orExpr

object (OrExpression)

אופרטור מורכב לוגי 'או' שמקשר בין כמה ביטויים.

StringConstraint

ביטוי אילוץ של שדה מחרוזת.

ייצוג ב-JSON 
{
  "fieldName": string,
  "values": [
    string
  ],
  "querySegment": string
}
שדות
fieldName

string

השם של שדה המחרוזת כפי שהוא מוגדר בסכימה.
values[]

string

הערכים של שדה המחרוזת. הרשומה תוחזר רק אם ערך השדה תואם לאחד מהערכים שצוינו כאן.
querySegment

string

מזהה את מילות המפתח בשאילתת החיפוש שתואמות למסנן.

NumberConstraint

ביטוי אילוץ של שדה מספר. דוגמה: price < 100.

ייצוג ב-JSON 
{
  "fieldName": string,
  "comparison": enum (Comparison),
  "value": number,
  "querySegment": string
}
שדות
fieldName

string

השם של השדה המספרי כפי שהוא מוגדר בסכימה.
comparison

enum (Comparison)

פעולת ההשוואה שמתבצעת בין ערך השדה לבין הערך שצוין באילוץ.
value

number

הערך שצוין באילוץ המספרי.
querySegment

string

מזהה את מילות המפתח בשאילתת החיפוש שתואמות למסנן.

השוואה

פעולת ההשוואה שבוצעה.

טיפוסים בני מנייה (enum)
COMPARISON_UNSPECIFIED אופרטור השוואה לא מוגדר.
EQUALS מציין את האופרטור = של שוויון.
LESS_THAN_EQUALS מציין אופרטור של קטן מ- או שווה ל- <=.
LESS_THAN מציין פחות מ-<.
GREATER_THAN_EQUALS מציין את האופרטור 'גדול מ- או שווה ל-' >=.
GREATER_THAN מציין את האופרטור 'גדול מ-' >.

GeolocationConstraint

מגבלה של שדה מיקום גיאוגרפי. שם שדה המיקום הגיאוגרפי כפי שהוגדר בסכימה.

ייצוג ב-JSON 
{
  "fieldName": string,
  "address": string,
  "latitude": number,
  "longitude": number,
  "radiusInMeters": number
}
שדות
fieldName

string

השם של שדה המיקום הגיאוגרפי כפי שהוגדר בסכימה.
address

string

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

number

קו הרוחב של המיקום הגיאוגרפי שמשתמע משאילתת הקלט.
longitude

number

קו האורך של המיקום הגיאוגרפי שהוסק משאילתת הקלט.
radiusInMeters

number

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

AndExpression

אופרטור לוגי And.

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

object (Expression)

הביטויים שחוברו באמצעות AND.

OrExpression

אופרטור לוגי Or.

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

object (Expression)

הביטויים שבוצע ביניהם פעולת OR.

SessionInfo

מידע על הסשן.

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

string

שם הסשן. אם משתמשים במצב של סשן אוטומטי (כאשר SearchRequest.session מסתיים ב-'-'), השדה הזה מכיל את שם הסשן שנוצר לאחרונה.
queryId

string

מזהה השאילתה שתואם לקריאה הזו ל-Search API. בסשן אחד יכולים להיות כמה תורות, ולכל אחת מהן יש מזהה שאילתה ייחודי.

אם מציינים את שם הסשן ואת מזהה השאילתה הזו בקריאה ל-Answer API, יצירת התשובה מתבצעת בהקשר של תוצאות החיפוש מהקריאה הזו לחיפוש.

SemanticState

מצב סמנטי של התגובה לחיפוש.

טיפוסים בני מנייה (enum)
SEMANTIC_STATE_UNSPECIFIED ערך ברירת המחדל. אין להשתמש בו.
DISABLED החיפוש הסמנטי הושבת בתשובה הזו.
ENABLED החיפוש הזה בוצע באמצעות חיפוש סמנטי.