REST Resource: settings.searchapplications

منبع: 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

نام برنامه جستجو

قالب: برنامه های جستجو/{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

فقط خروجی شناسه‌های عملیات طولانی مدت (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"، "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

منابع از پیش تعریف شده:

Enums
NONE
QUERY_HISTORY درخواست های ارائه شده توسط کاربر در گذشته را پیشنهاد می کند. فقط زمانی معتبر است که با پیشنهاد API استفاده شود. هنگام استفاده در Query API نادیده گرفته می شود.
PERSON به افراد سازمان پیشنهاد می دهد. فقط زمانی معتبر است که با پیشنهاد API استفاده شود. هنگام استفاده در query 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. نام باید با operatorName تعریف شده در طرح برای منبع داده شما مطابقت داشته باشد.

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

Enums
AND عملگرهای منطقی که فقط برای فیلترهای فرعی قابل اعمال هستند.
OR
NOT 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 )

پیکربندی crowding برای منبع.

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

آیا از تازگی به عنوان سیگنال رتبه بندی استفاده شود. به طور پیش فرض، تازه بودن به عنوان سیگنال رتبه بندی استفاده می شود. توجه داشته باشید که این تنظیم در رابط کاربری Admin در دسترس نیست.

disablePersonalization

boolean

آیا برای شخصی سازی نتایج. به طور پیش‌فرض، سیگنال‌های شخصی برای تقویت نتایج استفاده می‌شود.

SortOptions

نمایندگی JSON
{
  "operatorName": string,
  "sortOrder": enum (SortOptions.SortOrder)
}
زمینه های
operatorName

string

نام عملگر مربوط به فیلد برای مرتب سازی. ویژگی مربوطه باید به عنوان sortable علامت گذاری شود.

sortOrder

enum ( SortOptions.SortOrder )

صعودی ترتیب مرتب سازی پیش فرض است

SortOptions.SortOrder

Enums
ASCENDING
DESCENDING

FacetOptions

عملگرهایی را برای بازگرداندن نتایج جنبه ای مشخص می کند. برای هر ترکیب sourceName/objectType/operatorName یک FacetResult وجود خواهد داشت.

نمایندگی JSON
{
  "sourceName": string,
  "objectType": string,
  "operatorName": string,
  "numFacetBuckets": integer,
  "integerFacetingOptions": {
    object (IntegerFacetingOptions)
  }
}
زمینه های
sourceName

string

نام منبع به جنبه. قالب: منابع داده/{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 تنظیم شود، بر گزینه تنظیم شده در سطح Query اولویت دارد. برای مقدار پیش‌فرض False، پرچم سطح پرس و جو تفسیر صحیح را برای حالت کلمه به کلمه تنظیم می‌کند.

forceDisableSupplementalResults

boolean

این پرچم را برای غیرفعال کردن بازیابی نتایج تکمیلی تنظیم کنید، با تنظیم یک پرچم در اینجا، نتایج تکمیلی برای درخواست های مرتبط با یک برنامه جستجوی معین بازیابی نمی شود. اگر این پرچم روی True تنظیم شود، بر گزینه تنظیم شده در سطح Query اولویت دارد. برای مقدار پیش‌فرض False، پرچم سطح پرس و جو تفسیر صحیح را برای نتایج تکمیلی تنظیم می‌کند.

مواد و روش ها

create

 یک برنامه جستجو ایجاد می کند.

delete

 یک برنامه جستجو را حذف می کند.

get

 برنامه جستجوی مشخص شده را دریافت می کند.

list

 همه برنامه های جستجو را فهرست می کند.

patch

 یک برنامه جستجو را به روز می کند.

reset

 یک برنامه جستجو را به تنظیمات پیش فرض بازنشانی می کند.

update

 یک برنامه جستجو را به روز می کند.