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)

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

object (ScoringConfig)

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

object (SortOptions)

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

object (FacetOptions)

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

boolean

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

string

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

boolean

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

object (QueryInterpretationConfig)

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

DataSourceRestriction

הגבלה על Datasource.

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

object (Source)

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

object (FilterOptions)

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

אפשר לכלול עד 20 רכיבים.

הערה: Suggest API תומך כרגע רק בכמה מסננים: "objecttype", "type" ו-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

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

טיפוסים בני מנייה (enum)
NONE
QUERY_HISTORY הצעות לשאילתות שהמשתמש הפעיל בעבר. השדה תקין רק כשמשתמשים בו עם ה-API של ההצעה. המערכת מתעלמת ממנו כשנעשה בו שימוש ב-API של השאילתה.
PERSON הצעות לאנשים בארגון. השדה תקין רק כשמשתמשים בו עם ה-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. הגדרת ValueFilter. השם חייב להיות זהה ל-אופרטורName שמוגדר בסכימה של מקור הנתונים.

2. הגדרת CompositeFilter. המערכת בודקת את המסננים באמצעות האופרטור הלוגי. האופרטורים ברמה העליונה יכולים להיות רק 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)

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

ערך

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

ייצוג 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 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "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

טיפוסים בני מנייה (enum)
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

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

טיפוסים בני מנייה (enum)
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

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

FacetOptions

מציינת לאופרטורים שעליהם להחזיר תוצאות מאפיינים. יהיה Facet result אחד לכל שילוב של 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)

אם מוגדר, מתאר אפשרויות פנייה למספרים שלמים למאפיין המספר השלם הנתון. מאפיין המספר השלם המתאים בסכימה צריך להיות מסומן כ-Facetable. מספר הקטגוריות שיוחזרו יהיה מינימלי מהמספר הזה ומ-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

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