- משאב: SearchApplication
- DataSourceRestriction
- מקור
- Source.PredefinedSource
- FilterOptions
- סינון
- Filter.ValueFilter
- ערך
- Filter.CompositeFilter
- Filter.CompositeFilter.LogicOperator
- SourceConfig
- SourceScoringConfig
- SourceScoringConfig.SourceImportance
- SourceCrowdingConfig
- ScoringConfig
- SortOptions
- SortOptions.SortOrder
- FacetOptions
- IntegerFacetingOptions
- QueryInterpretationConfig
- שיטות
משאב: SearchApplication
SearchApplication
ייצוג JSON |
---|
{ "name": string, "displayName": string, "dataSourceRestrictions": [ { object ( |
שדות | |
---|---|
name |
השם של אפליקציית החיפוש. פורמט: searchapplications/{applicationId}. |
displayName |
השם המוצג של אפליקציית החיפוש. האורך המקסימלי הוא 300 תווים. |
dataSourceRestrictions[] |
מגבלות שהופעלו בהגדרות. מספר הרכיבים המקסימלי הוא 10. |
sourceConfig[] |
הגדרה של מקורות שצוינו ב-dataSource restrictions. |
scoringConfig |
תצורה לדירוג התוצאות. |
defaultSortOptions |
אפשרויות ברירת המחדל למיון תוצאות החיפוש |
defaultFacetOptions[] |
שדות ברירת המחדל להחזרת תוצאות המאפיינים. המקורות שמצוינים כאן נכללו גם ב- |
returnResultThumbnailUrls |
עם כל תוצאה אנחנו צריכים להחזיר את ה-URI עבור התמונה הממוזערת שלה (במקרים רלוונטיים) |
operationIds[] |
פלט בלבד. מזהים של פעולות ממושכות (LRO) שפועלות כרגע עבור הסכימה הזו. שדה פלט בלבד. |
enableAuditLog |
הערך מציין אם רישום ביומן הביקורת מופעל או מושבת עבור בקשות שנשלחו לאפליקציית החיפוש בממשקי ה-API של השאילתות. |
queryInterpretationConfig |
אפשרויות ברירת המחדל לפירוש שאילתות |
DataSourceRestriction
הגבלה על מקור נתונים.
ייצוג JSON |
---|
{ "source": { object ( |
שדות | |
---|---|
source |
מקור ההגבלה. |
filterOptions[] |
אפשרויות סינון להגבלת התוצאות. אם קיימים כמה מסננים, הם יקובצו לפי סוג האובייקט לפני האיחוד. מסננים עם אותו סוג אובייקט מצורפים באופן רציף, והביטויים שמתקבלים מצורפים בנפרד. מספר הרכיבים המקסימלי הוא 20. הערה: בשלב זה, ממשק Suggest API תומך רק במספר מסננים: "objecttype", "סוג" ו "mimetype". בשלב זה, לא ניתן להשתמש במסננים ספציפיים לסכימה כדי לסנן הצעות. |
מקור
הגדרת המקורות לממשקי ה-API של הצעות/חיפוש.
ייצוג JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה איחוד הערך של |
|
name |
שם המקור של התוכן שנוסף לאינדקס על ידי |
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 ( |
שדות | |
---|---|
objectType |
אם מוגדר objectType, מוחזרים רק אובייקטים מאותו סוג. השם הזה צריך להיות תואם לשם האובייקט שנרשם בהגדרת הסכימה. האורך המקסימלי הוא 256 תווים. |
filter |
מסנן כללי להגבלת החיפוש, כגון |
סינון
דרך כללית לבטא מסננים בשאילתה, שתומכת בשתי גישות:
1. הגדרת מסנן ערכים. השם חייב להתאים ל-אופרטור_Name שמוגדר בסכימה של מקור הנתונים.
2. הגדרת מסנן מורכב. המערכת בודקת את המסננים באמצעות האופרטור הלוגי. האופרטורים ברמה העליונה יכולים להיות רק AND או NOT. AND יכול להופיע רק ברמה העליונה ביותר. OR יכול להופיע רק מתחת ל-AND ברמה העליונה.
ייצוג JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה איחוד הערך של |
|
valueFilter |
|
compositeFilter |
|
Filter.ValueFilter
ייצוג JSON |
---|
{
"operatorName": string,
"value": {
object ( |
שדות | |
---|---|
operatorName |
הערך
|
value |
הערך להשוואה. |
Value
הגדרה של ערך יחיד עם סוג כללי.
ייצוג JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה איחוד value . הערך של המאפיין בעל השם. הערך של value יכול להיות רק אחת מהאפשרויות הבאות: |
|
stringValue |
|
integerValue |
|
doubleValue |
|
timestampValue |
חותמת זמן בפורמט "זולו" RFC3339 UTC, ברזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: |
booleanValue |
|
dateValue |
|
Filter.CompositeFilter
ייצוג JSON |
---|
{ "logicOperator": enum ( |
שדות | |
---|---|
logicOperator |
האופרטור הלוגי של מסנן המשנה. |
subFilters[] |
מסנני משנה. |
Filter.CompositeFilter.LogicOperator
טיפוסים בני מנייה (enums) | |
---|---|
AND |
אופרטורים לוגיים שאפשר להחיל רק על מסנני משנה. |
OR |
|
NOT |
לא ניתן להחיל רק על מסנן משנה אחד. |
SourceConfig
ההגדרות של מקור בזמן העיבוד של בקשה מסוג query.search
או query.suggest
.
ייצוג JSON |
---|
{ "source": { object ( |
שדות | |
---|---|
source |
המקור שעבורו יש להשתמש בתצורה הזו. |
scoringConfig |
תצורת הציון של המקור. |
crowdingConfig |
ההגדרה של הקיבוץ באשכולות עבור המקור. |
SourceScoringConfig
קבע את תצורת הניקוד. כך ניתן לשנות את דירוג התוצאות עבור מקור.
ייצוג JSON |
---|
{
"sourceImportance": enum ( |
שדות | |
---|---|
sourceImportance |
חשיבות המקור. |
SourceScoringConfig.SourceImportance
החשיבות של מקור מסוים כדי לציין אם צריך לתת למקור מסוים עדיפות גבוהה יותר בדירוג בהשוואה למקור אחר.
טיפוסים בני מנייה (enums) | |
---|---|
DEFAULT |
|
LOW |
|
HIGH |
SourceCrowdingConfig
הגדרת מגבלות לצפיפות תוצאות חיפוש. צפיפות היא מצב שבו מספר תוצאות מאותו מקור או מארח משמיצות תוצאות אחרות, באופן שמפחית את איכות החיפוש של המשתמשים. כדי לעודד איכות חיפוש טובה יותר ומגוון מקורות בתוצאות חיפוש, אפשר להגדיר תנאי שיצמצם תוצאות שחוזרות על עצמן לפי מקור.
ייצוג JSON |
---|
{ "numResults": integer, "numSuggestions": integer } |
שדות | |
---|---|
numResults |
מספר התוצאות המקסימלי המותר בדף תוצאות ממקור נתונים, כל עוד התוצאות ממקורות אחרים לא מומשו. הערך שצוין אינו יכול להיות שלילי. ייעשה שימוש בערך ברירת מחדל אם הערך הזה שווה ל-0. כדי להשבית את הצפיפות, צריך להגדיר ערך גדול מ-100. |
numSuggestions |
מספר ההצעות המקסימלי המותר ממקור מסוים. לא יוגדרו מגבלות על תוצאות אם הערך הזה קטן מ-0 או שווה לו. |
ScoringConfig
הגדרת ניקוד למקור במהלך עיבוד בקשה של query.search
או query.suggest
.
ייצוג JSON |
---|
{ "disableFreshness": boolean, "disablePersonalization": boolean } |
שדות | |
---|---|
disableFreshness |
האם להשתמש בעדכניות כאות דירוג. כברירת מחדל, העדכניות משמשת כאות דירוג. שימו לב שההגדרה הזו לא זמינה בממשק המשתמש של האדמין. |
disablePersonalization |
בחירה אם להתאים אישית את התוצאות. כברירת מחדל, המערכת תשתמש באותות אישיים כדי לשפר את התוצאות. |
SortOptions
ייצוג JSON |
---|
{
"operatorName": string,
"sortOrder": enum ( |
שדות | |
---|---|
operatorName |
שם האופרטור שתואם לשדה שבו רוצים למיין. הנכס התואם צריך להיות מסומן כ- |
sortOrder |
בסדר עולה הוא סדר המיון המוגדר כברירת מחדל |
SortOptions.SortOrder
טיפוסים בני מנייה (enums) | |
---|---|
ASCENDING |
|
DESCENDING |
FacetOptions
מציינת את האופרטורים שעבורם יש להחזיר תוצאות מאפיינים. יהיה Facetתוצאה אחת לכל שילוב של sourceName/objectType/operatorName.
ייצוג JSON |
---|
{
"sourceName": string,
"objectType": string,
"operatorName": string,
"numFacetBuckets": integer,
"integerFacetingOptions": {
object ( |
שדות | |
---|---|
sourceName |
שם המקור שעליו יש להתמקד. פורמט: datasources/{sourceId} אם השדה הזה ריק, המערכת תשתמש בכל מקורות הנתונים. |
objectType |
אם מוגדר objectType, רק האובייקטים מהסוג הזה ישמשו לחישוב המאפיינים. אם השדה ריק, כל האובייקטים ישמשו לחישוב מאפיינים. |
operatorName |
שם האופרטור שנבחר לזיהוי. @see cloudsearch.SchemaPropertyOptions |
numFacetBuckets |
המספר המקסימלי של קטגוריות מאפיינים שיש להחזיר למאפיין הזה. ברירת המחדל היא 10. הערך המקסימלי הוא 100. |
integerFacetingOptions |
אם השדה מוגדר, מתאר את האפשרויות למיקוד לפי מספרים שלמים למאפיין הנתון של מספר שלם. המאפיין של המספר השלם התואם בסכימה צריך להיות מסומן כ-isFacetable. מספר הקטגוריות שיוחזרו יהיה מינימלי זה וגם numFacetBuckets. |
IntegerFacetingOptions
משמש לציון אפשרויות של התאמת מספרים שלמים.
ייצוג JSON |
---|
{ "integerBuckets": [ string ] } |
שדות | |
---|---|
integerBuckets[] |
סלים עבור ערכים נתונים של מספרים שלמים צריכים להיות בסדר עולה בלבד. לדוגמה, אם הערכים שסופקו הם (1,5,10,100), קטגוריות המאפיינים הבאות ייווצרו {<1, [1,5), [5-10), [10-100), >=100}. |
QueryInterpretationConfig
אפשרויות ברירת מחדל לפירוש שאילתת משתמש.
ייצוג JSON |
---|
{ "forceVerbatimMode": boolean, "forceDisableSupplementalResults": boolean } |
שדות | |
---|---|
forceVerbatimMode |
הפעל את הסימון הזה כדי להשבית את כל האופטימיזציות הפנימיות כמו פרשנות שפה טבעית (NL) של שאילתות, אחזור תוצאות משלימות ושימוש במילים נרדפות, כולל אלה בהתאמה אישית. אם הסימון הזה מוגדר כ-True, הוא יקבל עדיפות על פני האפשרות שהוגדרה ברמת השאילתה. לערך ברירת המחדל False, סימון ברמת השאילתה יקבע את הפרשנות הנכונה למצב מילה במילה. |
forceDisableSupplementalResults |
הגדר את הדגל הזה כדי להשבית אחזור של תוצאות משלימות, הגדרת סימון כאן לא תאחזר תוצאות משלימות עבור שאילתות המשויכות לאפליקציית חיפוש נתונה. אם הסימון הזה מוגדר כ-True, הוא יקבל עדיפות על פני האפשרות שהוגדרה ברמת השאילתה. לערך ברירת המחדל של False, סימון ברמת השאילתה יגדיר את הפרשנות הנכונה לתוצאות הנוספות. |
שיטות |
|
---|---|
|
יצירה של אפליקציית חיפוש. |
|
מחיקה של אפליקציית חיפוש. |
|
הפונקציה מקבלת את אפליקציית החיפוש שצוינה. |
|
בתיבת הדו-שיח הזו מפורטים כל אפליקציות החיפוש. |
|
עדכון אפליקציית חיפוש. |
|
איפוס אפליקציית חיפוש להגדרות ברירת המחדל. |
|
עדכון אפליקציית חיפוש. |