REST Resource: settings.searchapplications

משאב: SearchApplication

SearchApplication

ייצוג JSON 
{
  "name": string,
  "displayName": string,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ],
  "sourceConfig": [
    {
      object (SourceConfig)
    }
  ],
  "scoringConfig": {
    object (ScoringConfig)
  },
  "defaultSortOptions": {
    object (SortOptions)
  },
  "defaultFacetOptions": [
    {
      object (FacetOptions)
    }
  ],
  "returnResultThumbnailUrls": boolean,
  "operationIds": [
    string
  ],
  "enableAuditLog": boolean,
  "queryInterpretationConfig": {
    object (QueryInterpretationConfig)
  }
}
שדות
name

string

השם של אפליקציית החיפוש.

פורמט: searchapplications/{applicationId}.
displayName

string

השם המוצג של אפליקציית החיפוש. האורך המקסימלי הוא 300 תווים.
dataSourceRestrictions[]

object (DataSourceRestriction)

מגבלות שהופעלו בהגדרות. מספר הרכיבים המקסימלי הוא 10.
sourceConfig[]

object (SourceConfig)

הגדרה של מקורות שצוינו ב-dataSource restrictions.
scoringConfig

object (ScoringConfig)

תצורה לדירוג התוצאות.
defaultSortOptions

object (SortOptions)

אפשרויות ברירת המחדל למיון תוצאות החיפוש
defaultFacetOptions[]

object (FacetOptions)

שדות ברירת המחדל להחזרת תוצאות המאפיינים. המקורות שמצוינים כאן נכללו גם ב-dataSourceRestrictions למעלה.
returnResultThumbnailUrls

boolean

עם כל תוצאה אנחנו צריכים להחזיר את ה-URI עבור התמונה הממוזערת שלה (במקרים רלוונטיים)
operationIds[]

string

פלט בלבד. מזהים של פעולות ממושכות (LRO) שפועלות כרגע עבור הסכימה הזו. שדה פלט בלבד.
enableAuditLog

boolean

הערך מציין אם רישום ביומן הביקורת מופעל או מושבת עבור בקשות שנשלחו לאפליקציית החיפוש בממשקי ה-API של השאילתות.
queryInterpretationConfig

object (QueryInterpretationConfig)

אפשרויות ברירת המחדל לפירוש שאילתות

DataSourceRestriction

הגבלה על מקור נתונים.

ייצוג JSON 
{
  "source": {
    object (Source)
  },
  "filterOptions": [
    {
      object (FilterOptions)
    }
  ]
}
שדות
source

object (Source)

מקור ההגבלה.
filterOptions[]

object (FilterOptions)

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

מספר הרכיבים המקסימלי הוא 20.

הערה: בשלב זה, ממשק Suggest API תומך רק במספר מסננים: "objecttype", "סוג" ו "mimetype". בשלב זה, לא ניתן להשתמש במסננים ספציפיים לסכימה כדי לסנן הצעות.

מקור

הגדרת המקורות לממשקי ה-API של הצעות/חיפוש.

ייצוג JSON 
{

  // Union field source can be only one of the following:
  "name": string,
  "predefinedSource": enum (Source.PredefinedSource)
  // End of list of possible types for union field source.
}
שדות

שדה איחוד source.

הערך של source יכול להיות רק אחת מהאפשרויות הבאות:
name

string

שם המקור של התוכן שנוסף לאינדקס על ידי Indexing API.
predefinedSource

enum (Source.PredefinedSource)

מקור תוכן מוגדר מראש עבור Google Apps.

Source.PredefinedSource

מקורות מוגדרים מראש:

טיפוסים בני מנייה (enums)
NONE
QUERY_HISTORY מציעה שאילתות שהמשתמש יצר בעבר. תקף רק כשמשתמשים עם ממשק ה-API של הצעת ה-API. המערכת מתעלמת מהמדיניות הזו כשמשתמשים ב-API של השאילתה.
PERSON הצגת אנשים בארגון. תקף רק כשמשתמשים עם ממשק ה-API של הצעת ה-API. מתקבלת שגיאה כשמשתמשים ב-API של השאילתה.
GOOGLE_DRIVE
GOOGLE_GMAIL
GOOGLE_SITES
GOOGLE_GROUPS
GOOGLE_CALENDAR
GOOGLE_KEEP

FilterOptions

אפשרויות הסינון שרוצים להחיל על שאילתה.

ייצוג JSON 
{
  "objectType": string,
  "filter": {
    object (Filter)
  }
}
שדות
objectType

string

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

object (Filter)

מסנן כללי להגבלת החיפוש, כגון lang:en או site:xyz.

סינון

דרך כללית לבטא מסננים בשאילתה, שתומכת בשתי גישות:

1. הגדרת מסנן ערכים. השם חייב להתאים ל-אופרטור_Name שמוגדר בסכימה של מקור הנתונים.

2. הגדרת מסנן מורכב. המערכת בודקת את המסננים באמצעות האופרטור הלוגי. האופרטורים ברמה העליונה יכולים להיות רק AND או NOT. AND יכול להופיע רק ברמה העליונה ביותר. OR יכול להופיע רק מתחת ל-AND ברמה העליונה.

ייצוג JSON 
{

  // Union field filter can be only one of the following:
  "valueFilter": {
    object (Filter.ValueFilter)
  },
  "compositeFilter": {
    object (Filter.CompositeFilter)
  }
  // End of list of possible types for union field filter.
}
שדות

שדה איחוד filter.

הערך של filter יכול להיות רק אחת מהאפשרויות הבאות:
valueFilter

object (Filter.ValueFilter)
compositeFilter

object (Filter.CompositeFilter)

Filter.ValueFilter

ייצוג JSON 
{
  "operatorName": string,
  "value": {
    object (Value)
  }
}
שדות
operatorName

string

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

  1. operatorName, כאשר השאילתה מסננת תוצאות לפי הנכס שתואם לערך.

  2. greaterThanOperatorName או lessThanOperatorName בסכימה. השאילתה מסננת את התוצאות של ערכי הנכסים שגדולים או נמוכים מהערך שסופק בשאילתה.
value

object (Value)

הערך להשוואה.

Value

הגדרה של ערך יחיד עם סוג כללי.

ייצוג JSON 
{

  // Union field value can be only one of the following:
  "stringValue": string,
  "integerValue": string,
  "doubleValue": number,
  "timestampValue": string,
  "booleanValue": boolean,
  "dateValue": {
    object (Date)
  }
  // End of list of possible types for union field value.
}
שדות
שדה איחוד value. הערך של המאפיין בעל השם. הערך של value יכול להיות רק אחת מהאפשרויות הבאות:
stringValue

string
integerValue

string (int64 format)
doubleValue

number
timestampValue

string (Timestamp format)

חותמת זמן בפורמט "זולו" RFC3339 UTC, ברזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
booleanValue

boolean
dateValue

object (Date)

Filter.CompositeFilter

ייצוג JSON 
{
  "logicOperator": enum (Filter.CompositeFilter.LogicOperator),
  "subFilters": [
    {
      object (Filter)
    }
  ]
}
שדות
logicOperator

enum (Filter.CompositeFilter.LogicOperator)

האופרטור הלוגי של מסנן המשנה.
subFilters[]

object (Filter)

מסנני משנה.

Filter.CompositeFilter.LogicOperator

טיפוסים בני מנייה (enums)
AND אופרטורים לוגיים שאפשר להחיל רק על מסנני משנה.
OR
NOT לא ניתן להחיל רק על מסנן משנה אחד.

SourceConfig

ההגדרות של מקור בזמן העיבוד של בקשה מסוג query.search או query.suggest.

ייצוג JSON 
{
  "source": {
    object (Source)
  },
  "scoringConfig": {
    object (SourceScoringConfig)
  },
  "crowdingConfig": {
    object (SourceCrowdingConfig)
  }
}
שדות
source

object (Source)

המקור שעבורו יש להשתמש בתצורה הזו.
scoringConfig

object (SourceScoringConfig)

תצורת הציון של המקור.
crowdingConfig

object (SourceCrowdingConfig)

ההגדרה של הקיבוץ באשכולות עבור המקור.

SourceScoringConfig

קבע את תצורת הניקוד. כך ניתן לשנות את דירוג התוצאות עבור מקור.

ייצוג JSON 
{
  "sourceImportance": enum (SourceScoringConfig.SourceImportance)
}
שדות
sourceImportance

enum (SourceScoringConfig.SourceImportance)

חשיבות המקור.

SourceScoringConfig.SourceImportance

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

טיפוסים בני מנייה (enums)
DEFAULT
LOW
HIGH

SourceCrowdingConfig

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

ייצוג JSON 
{
  "numResults": integer,
  "numSuggestions": integer
}
שדות
numResults

integer

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

integer

מספר ההצעות המקסימלי המותר ממקור מסוים. לא יוגדרו מגבלות על תוצאות אם הערך הזה קטן מ-0 או שווה לו.

ScoringConfig

הגדרת ניקוד למקור במהלך עיבוד בקשה של query.search או query.suggest.

ייצוג JSON 
{
  "disableFreshness": boolean,
  "disablePersonalization": boolean
}
שדות
disableFreshness

boolean

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

boolean

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

SortOptions

ייצוג JSON 
{
  "operatorName": string,
  "sortOrder": enum (SortOptions.SortOrder)
}
שדות
operatorName

string

שם האופרטור שתואם לשדה שבו רוצים למיין. הנכס התואם צריך להיות מסומן כ-sortable.
sortOrder

enum (SortOptions.SortOrder)

בסדר עולה הוא סדר המיון המוגדר כברירת מחדל

SortOptions.SortOrder

טיפוסים בני מנייה (enums)
ASCENDING
DESCENDING

FacetOptions

מציינת את האופרטורים שעבורם יש להחזיר תוצאות מאפיינים. יהיה Facetתוצאה אחת לכל שילוב של sourceName/objectType/operatorName.

ייצוג JSON 
{
  "sourceName": string,
  "objectType": string,
  "operatorName": string,
  "numFacetBuckets": integer,
  "integerFacetingOptions": {
    object (IntegerFacetingOptions)
  }
}
שדות
sourceName

string

שם המקור שעליו יש להתמקד. פורמט: datasources/{sourceId} אם השדה הזה ריק, המערכת תשתמש בכל מקורות הנתונים.
objectType

string

אם מוגדר objectType, רק האובייקטים מהסוג הזה ישמשו לחישוב המאפיינים. אם השדה ריק, כל האובייקטים ישמשו לחישוב מאפיינים.
operatorName

string

שם האופרטור שנבחר לזיהוי. @see cloudsearch.SchemaPropertyOptions
numFacetBuckets

integer

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

object (IntegerFacetingOptions)

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

IntegerFacetingOptions

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

ייצוג JSON 
{
  "integerBuckets": [
    string
  ]
}
שדות
integerBuckets[]

string (Int64Value format)

סלים עבור ערכים נתונים של מספרים שלמים צריכים להיות בסדר עולה בלבד. לדוגמה, אם הערכים שסופקו הם (1,5,10,100), קטגוריות המאפיינים הבאות ייווצרו {<1, [1,5), [5-10), [10-100), >=100}.

QueryInterpretationConfig

אפשרויות ברירת מחדל לפירוש שאילתת משתמש.

ייצוג JSON 
{
  "forceVerbatimMode": boolean,
  "forceDisableSupplementalResults": boolean
}
שדות
forceVerbatimMode

boolean

הפעל את הסימון הזה כדי להשבית את כל האופטימיזציות הפנימיות כמו פרשנות שפה טבעית (NL) של שאילתות, אחזור תוצאות משלימות ושימוש במילים נרדפות, כולל אלה בהתאמה אישית. אם הסימון הזה מוגדר כ-True, הוא יקבל עדיפות על פני האפשרות שהוגדרה ברמת השאילתה. לערך ברירת המחדל False, סימון ברמת השאילתה יקבע את הפרשנות הנכונה למצב מילה במילה.
forceDisableSupplementalResults

boolean

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

שיטות

create

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

delete

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

get

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

list

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

patch

 עדכון אפליקציית חיפוש.

reset

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

update

 עדכון אפליקציית חיפוש.