SearchResponse

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

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

object (SearchResult)

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

object (Facet)

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

object (GuidedSearchResult)

תוצאת חיפוש מודרכת.
totalSize

integer

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

string

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

string

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

string

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

string

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

string

שאילתה מתוקנת עם רמת סמך נמוכה, כלומר שאילתה מסוג 'האם התכוונת לשאילתה הבאה'. בהשוואה ל-correctedQuery, השדה הזה מוגדר כש-SpellCorrector מחזיר תגובה, אבל לא מופעל FPR(החלפה של הדף המלא) כי רמת הביטחון של התיקון נמוכה(למשל, הפוך כי יש התאמות של השאילתה המקורית במאגר המסמכים).
summary

object (Summary)

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

string

זה שינוי אופציונלי. אמצעי הבקרה שמוחלים כחלק משירות הבקרה.
geoSearchDebugInfo[]

object (GeoSearchDebugInfo)
queryExpansionInfo

object (QueryExpansionInfo)

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

object (NaturalLanguageQueryUnderstandingInfo)

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

object (SessionInfo)

פרטי הסשן.

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

object (OneBoxResult)

רשימה של תוצאות בתיבה אחת. יכולות להיות כמה תוצאות מסוג One box מסוגים שונים.
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,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "value": string,
  "interval": {
    object (Interval)
  }
  // End of mutually exclusive fields.
}
שדות
count

string (int64 format)

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

string

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

object (Interval)

ערך המרווח של היבט, למשל [10, 20) עבור היבט 'מחיר'. היא תואמת ל-SearchRequest.FacetSpec.FacetKey.intervals.
סוף השדות הבלעדיים.

GuidedSearchResult

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

ייצוג JSON 
{
  "refinementAttributes": [
    {
      object (RefinementAttribute)
    }
  ],
  "followUpQuestions": [
    string
  ]
}
שדות
refinementAttributes[]

object (RefinementAttribute)

רשימה של מאפייני סינון מדורגים.
followUpQuestions[]

string

הצעות לשאלות המשך.

RefinementAttribute

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

ייצוג JSON 
{
  "attributeKey": string,
  "attributeValue": string
}
שדות
attributeKey

string

מפתח המאפיין שמשמש לסינון התוצאות. לדוגמה, "movie_type".
attributeValue

string

ערך המאפיין שמשמש לסינון התוצאות. לדוגמה, "drama".

GeoSearchDebugInfo

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

ייצוג JSON 
{
  "originalAddressQuery": string,
  "errorMessage": string
}
שדות
originalAddressQuery

string

הכתובת שממנה נבעו בעיות בהטמעה של המרת כתובות לקואורדינטות.
errorMessage

string

השגיאה שנוצרה.

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 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "stringConstraint": {
    object (StringConstraint)
  },
  "numberConstraint": {
    object (NumberConstraint)
  },
  "geolocationConstraint": {
    object (GeolocationConstraint)
  },
  "andExpr": {
    object (AndExpression)
  },
  "orExpr": {
    object (OrExpression)
  }
  // End of mutually exclusive fields.
}
שדות
סוג הביטוי. בהמשך מפורטת רשימה של שדות שאי אפשר להשתמש בהם בו-זמנית. רק אחד מהשדות הבאים יוגדר בתשובה:
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, התשובה נוצרת בהקשר של תוצאות החיפוש מהקריאה הזו לחיפוש.

OneBoxResult

‫OneBoxResult הוא placeholder לכל התוצאות מסוג מסוים שאנחנו רוצים להציג בממשק המשתמש באופן שונה.

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

enum (OneBoxType)

סוג התוצאה בתיבה אחת.
searchResults[]

object (SearchResult)

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

OneBoxType

סוג התוצאה בתיבה אחת.

טיפוסים בני מנייה (enum)
ONE_BOX_TYPE_UNSPECIFIED ערך ברירת המחדל. אין להשתמש בו.
PEOPLE תיבת תוצאות אחת מכילה תוצאות של אנשים.
ORGANIZATION תוצאה אחת בתיבה מכילה תוצאות מהארגון.
SLACK תוצאה אחת בתיבה מכילה תוצאות מ-Slack.
KNOWLEDGE_GRAPH תוצאה אחת בתיבה מכילה תגובות לחיפוש של גרף הידע.

SemanticState

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

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