REST Resource: settings.searchapplications

संसाधन: SearchApplication

SearchApplication

जेएसओएन के काेड में दिखाना
{
  "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)

dataSourceSource में बताए गए सोर्स के लिए कॉन्फ़िगरेशन.

scoringConfig

object (ScoringConfig)

रैंकिंग से जुड़े नतीजों के लिए कॉन्फ़िगरेशन.

defaultSortOptions

object (SortOptions)

खोज के नतीजों को क्रम से लगाने के डिफ़ॉल्ट विकल्प

defaultFacetOptions[]

object (FacetOptions)

मुखिका परिणाम देने के लिए डिफ़ॉल्ट फ़ील्ड. यहां बताए गए सोर्स को ऊपर दिए गए dataSourceRestrictions में भी शामिल किया गया है.

returnResultThumbnailUrls

boolean

हर नतीजे के साथ हमें उसके थंबनेल का यूआरआई वापस करना चाहिए (लागू होने पर)

operationIds[]

string

सिर्फ़ आउटपुट के लिए. इस स्कीमा के लिए, मौजूदा समय में चल रहे लॉन्ग रनिंग ऑपरेशन (एलआरओ) के आईडी. सिर्फ़ आउटपुट के लिए फ़ील्ड.

enableAuditLog

boolean

यह बताता है कि क्वेरी एपीआई में खोज ऐप्लिकेशन के लिए किए गए अनुरोधों के लिए, ऑडिट लॉगिंग की सुविधा चालू/बंद है या नहीं.

queryInterpretationConfig

object (QueryInterpretationConfig)

क्वेरी को समझने के लिए डिफ़ॉल्ट विकल्प

DataSourceRestriction

डेटा सोर्स पर पाबंदी.

जेएसओएन के काेड में दिखाना
{
  "source": {
    object (Source)
  },
  "filterOptions": [
    {
      object (FilterOptions)
    }
  ]
}
फ़ील्ड
source

object (Source)

पाबंदी का सोर्स.

filterOptions[]

object (FilterOptions)

नतीजों को सीमित करने वाले फ़िल्टर विकल्प. अगर कई फ़िल्टर मौजूद हैं, तो जोड़ने से पहले उन्हें ऑब्जेक्ट टाइप के हिसाब से ग्रुप में रखा जाता है. एक ही ऑब्जेक्ट टाइप वाले फ़िल्टर कंजंक रूप से जोड़े जाते हैं, फिर नतीजे के तौर पर मिलने वाले एक्सप्रेशन अलग-अलग तरीके से जोड़े जाते हैं.

ज़्यादा से ज़्यादा 20 एलिमेंट जोड़े जा सकते हैं.

ध्यान दें: Suggest API इस समय सिर्फ़ कुछ ही फ़िल्टर के साथ काम करता है: "objecttype", "type", और "mimetype". फ़िलहाल, सुझावों को फ़िल्टर करने के लिए, स्कीमा से जुड़े फ़िल्टर इस्तेमाल नहीं किए जा सकते.

सोर्स

सुझाव/खोज एपीआई के सोर्स के बारे में बताता है.

जेएसओएन के काेड में दिखाना
{

  // 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 उपयोगकर्ता की ओर से पहले जारी की गई क्वेरी का सुझाव देता है. सिर्फ़ सुझाए गए एपीआई के साथ इस्तेमाल किए जाने पर ही मान्य है. क्वेरी एपीआई में इस्तेमाल किए जाने पर अनदेखा किया जाता है.
PERSON संगठन के लोगों का सुझाव देता है. सिर्फ़ सुझाए गए एपीआई के साथ इस्तेमाल किए जाने पर ही मान्य है. क्वेरी एपीआई में इस्तेमाल करने पर, नतीजे में गड़बड़ी होती है.
GOOGLE_DRIVE
GOOGLE_GMAIL
GOOGLE_SITES
GOOGLE_GROUPS
GOOGLE_CALENDAR
GOOGLE_KEEP

FilterOptions

क्वेरी पर लागू किए जाने वाले फ़िल्टर के विकल्प.

जेएसओएन के काेड में दिखाना
{
  "objectType": string,
  "filter": {
    object (Filter)
  }
}
फ़ील्ड
objectType

string

अगर ऑब्जेक्ट टाइप को सेट किया जाता है, तो सिर्फ़ उस तरह के ऑब्जेक्ट दिखते हैं. यह उस ऑब्जेक्ट के नाम से मेल खाना चाहिए जिसे स्कीमा की परिभाषा में रजिस्टर किया गया था. ज़्यादा से ज़्यादा 256 वर्ण हाेने चाहिए.

filter

object (Filter)

खोज पर पाबंदी लगाने के लिए जेनरिक फ़िल्टर, जैसे कि lang:en, site:xyz.

फ़िल्टर करें

किसी क्वेरी में फ़िल्टर दिखाने का एक सामान्य तरीका, जो दो तरीकों का इस्तेमाल करता है:

1. वैल्यू फ़िल्टर सेट करें. यह नाम, आपके डेटा सोर्स के स्कीमा में बताए गए ऑपरेटरनाम से मेल खाना चाहिए.

2. कंपोज़िट फ़िल्टर सेट करना. फ़िल्टर का आकलन, लॉजिकल ऑपरेटर का इस्तेमाल करके किया जाता है. टॉप-लेवल ऑपरेटर, सिर्फ़ AND या NOT, हो सकते हैं. AND सिर्फ़ सबसे ऊपर के लेवल पर दिख सकता है. OR सिर्फ़ टॉप-लेवल AND के तहत दिख सकता है.

जेएसओएन के काेड में दिखाना
{

  // 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

जेएसओएन के काेड में दिखाना
{
  "operatorName": string,
  "value": {
    object (Value)
  }
}
फ़ील्ड
operatorName

string

क्वेरी पर लागू किया गया operatorName, जैसे कि price_greater_than. फ़िल्टर, आपके डेटा सोर्स के लिए स्कीमा में तय किए गए दोनों तरह के फ़िल्टर के साथ काम कर सकता है:

  1. operatorName, जहां क्वेरी नतीजों को वैल्यू से मेल खाने वाली प्रॉपर्टी के हिसाब से फ़िल्टर करती है.

  2. आपके स्कीमा में greaterThanOperatorName या lessThanOperatorName है. क्वेरी, उन प्रॉपर्टी वैल्यू के नतीजों को फ़िल्टर करती है जो क्वेरी में दी गई वैल्यू से ज़्यादा या कम हैं.

value

object (Value)

तुलना करने के लिए मान.

वैल्यू

जेनरिक टाइप वाली एक वैल्यू की परिभाषा.

जेएसओएन के काेड में दिखाना
{

  // 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 यूटीसी "ज़ुलु" फ़ॉर्मैट में एक टाइमस्टैंप, जिसमें नैनोसेकंड रिज़ॉल्यूशन और नौ फ़्रैक्शनल अंक तक हो सकते हैं. उदाहरण: "2014-10-02T15:01:23Z" और "2014-10-02T15:01:23.045123456Z".

booleanValue

boolean

dateValue

object (Date)

Filter.CompositeFilter

जेएसओएन के काेड में दिखाना
{
  "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 अनुरोध को प्रोसेस करते समय सोर्स के लिए कॉन्फ़िगरेशन.

जेएसओएन के काेड में दिखाना
{
  "source": {
    object (Source)
  },
  "scoringConfig": {
    object (SourceScoringConfig)
  },
  "crowdingConfig": {
    object (SourceCrowdingConfig)
  }
}
फ़ील्ड
source

object (Source)

वह सोर्स जिसके लिए इस कॉन्फ़िगरेशन का इस्तेमाल किया जाना है.

scoringConfig

object (SourceScoringConfig)

सोर्स के लिए स्कोरिंग कॉन्फ़िगरेशन.

crowdingConfig

object (SourceCrowdingConfig)

सोर्स के लिए क्राउडिंग कॉन्फ़िगरेशन.

SourceScoringConfig

स्कोरिंग कॉन्फ़िगरेशन सेट करें. इससे किसी सोर्स के लिए नतीजों की रैंकिंग में बदलाव किया जा सकता है.

जेएसओएन के काेड में दिखाना
{
  "sourceImportance": enum (SourceScoringConfig.SourceImportance)
}
फ़ील्ड
sourceImportance

enum (SourceScoringConfig.SourceImportance)

सोर्स की अहमियत.

SourceScoringConfig.SourceImportance

सोर्स की अहमियत. इसका इस्तेमाल यह बताने के लिए किया जा सकता है कि किसी सोर्स को दूसरे सोर्स की तुलना में रैंकिंग में ज़्यादा प्राथमिकता दी जानी चाहिए या नहीं.

Enums
DEFAULT
LOW
HIGH

SourceCrowdingConfig

खोज के नतीजों के लिए, इकट्ठा करने की सीमा सेट करें. क्राउडिंग एक ऐसी स्थिति है जिसमें एक ही सोर्स से कई नतीजे मिलते हैं या एक ही सोर्स से कई दूसरे नतीजे होस्ट होते हैं, जिससे दूसरे नतीजे "क्राउड आउट" हो जाते हैं. इससे उपयोगकर्ताओं के लिए खोज की क्वालिटी पर असर पड़ता है. खोज के नतीजों में बेहतर खोज क्वालिटी और अलग-अलग तरह के सोर्स को बढ़ावा देने के लिए, एक शर्त सेट की जा सकती है. इससे आपको सोर्स के हिसाब से, बार-बार दिखने वाले नतीजों की संख्या कम करने में मदद मिलेगी.

जेएसओएन के काेड में दिखाना
{
  "numResults": integer,
  "numSuggestions": integer
}
फ़ील्ड
numResults

integer

किसी डेटा सोर्स से, नतीजे वाले पेज में ज़्यादा से ज़्यादा नतीजे मिल सकते हैं. हालांकि, इसके लिए ज़रूरी है कि अन्य सोर्स से मिले नतीजे खत्म न हों. सेट की गई वैल्यू नेगेटिव नहीं होनी चाहिए. अगर यह वैल्यू 0 के बराबर होती है, तो डिफ़ॉल्ट वैल्यू का इस्तेमाल किया जाता है. क्राउडिंग की सुविधा बंद करने के लिए, वैल्यू को 100 से ज़्यादा पर सेट करें.

numSuggestions

integer

किसी स्रोत से मिलने वाले सुझावों की ज़्यादा से ज़्यादा संख्या. अगर यह वैल्यू 0 से कम या इसके बराबर है, तो नतीजों के लिए कोई सीमा सेट नहीं की जाएगी.

ScoringConfig

query.search या query.suggest अनुरोध को प्रोसेस करते समय, सोर्स के लिए स्कोरिंग कॉन्फ़िगरेशन.

जेएसओएन के काेड में दिखाना
{
  "disableFreshness": boolean,
  "disablePersonalization": boolean
}
फ़ील्ड
disableFreshness

boolean

रैंकिंग सिग्नल के तौर पर, अपडेट होने की सुविधा का इस्तेमाल करना है या नहीं. डिफ़ॉल्ट रूप से, फ़्रेशनेस का इस्तेमाल रैंकिंग सिग्नल के तौर पर किया जाता है. ध्यान दें कि यह सेटिंग, एडमिन यूज़र इंटरफ़ेस (यूआई) में उपलब्ध नहीं है.

disablePersonalization

boolean

नतीजों को आपके हिसाब से बनाना है या नहीं. डिफ़ॉल्ट रूप से, बेहतर नतीजे देने के लिए निजी सिग्नल का इस्तेमाल किया जाएगा.

SortOptions

जेएसओएन के काेड में दिखाना
{
  "operatorName": string,
  "sortOrder": enum (SortOptions.SortOrder)
}
फ़ील्ड
operatorName

string

क्रम से लगाए जाने वाले फ़ील्ड से जुड़े ऑपरेटर का नाम. इससे जुड़ी प्रॉपर्टी को sortable के तौर पर मार्क किया जाना चाहिए.

sortOrder

enum (SortOptions.SortOrder)

बढ़ते क्रम में, डेटा को क्रम से लगाने का डिफ़ॉल्ट क्रम है

SortOptions.SortOrder

Enums
ASCENDING
DESCENDING

FacetOptions

इस नीति से, उन ऑपरेटर को तय किया जाता है जिनके लिए फ़िल्टर से जुड़े नतीजे दिखाए जाते हैं. हर sourceName/objectType/operatorName कॉम्बिनेशन के लिए एक Facetresults होगा.

जेएसओएन के काेड में दिखाना
{
  "sourceName": string,
  "objectType": string,
  "operatorName": string,
  "numFacetBuckets": integer,
  "integerFacetingOptions": {
    object (IntegerFacetingOptions)
  }
}
फ़ील्ड
sourceName

string

मुखिका पर स्रोत का नाम. फ़ॉर्मैट: datasources/{sourceId} खाली होने पर, सभी डेटा सोर्स का इस्तेमाल किया जाएगा.

objectType

string

अगरObjectType सेट है, तो उस प्रकार के केवल उन ऑब्जेक्ट का उपयोग पहलुओं की गणना करने के लिए किया जाएगा. अगर यह फ़ील्ड खाली है, तो सभी ऑब्जेक्ट का इस्तेमाल, पहलुओं की गिनती करने के लिए किया जाएगा.

operatorName

string

फ़ेसिंग के लिए चुने गए ऑपरेटर का नाम. @see cloudsearch.schemaप्रॉपर्टी विकल्प

numFacetBuckets

integer

इस मुखिका के लिए लौटाए जाने वाली मुखिका बकेट की अधिकतम संख्या. डिफ़ॉल्ट वैल्यू 10 होती है. वैल्यू ज़्यादा से ज़्यादा 100 हो सकती है.

integerFacetingOptions

object (IntegerFacetingOptions)

अगर यह सेट है, तो दी गई पूर्णांक प्रॉपर्टी के लिए, पूर्णांक की मास्किंग के विकल्पों के बारे में बताता है. स्कीमा में संबंधित पूर्णांक प्रॉपर्टी को isFacetable के रूप में मार्क किया जाना चाहिए. लौटाए गए बकेट की संख्या इस और numFacetBuckets से कम होगी.

IntegerFacetingOptions

पूर्णांक फ़ेसिंग के विकल्प तय करने के लिए इस्तेमाल किया जाता है.

जेएसओएन के काेड में दिखाना
{
  "integerBuckets": [
    string
  ]
}
फ़ील्ड
integerBuckets[]

string (Int64Value format)

दिए गए पूर्णांक मानों के बकेट पूरी तरह से बढ़ते क्रम में होने चाहिए. उदाहरण के लिए, अगर मान (1,5,10,100) दिए गए हैं, तो नीचे दी गई फ़ैसेट बकेट {<1, [1,5), [5-10), [10-100), >=100} बनेंगी.

QueryInterpretationConfig

उपयोगकर्ता की क्वेरी को समझने के डिफ़ॉल्ट विकल्प.

जेएसओएन के काेड में दिखाना
{
  "forceVerbatimMode": boolean,
  "forceDisableSupplementalResults": boolean
}
फ़ील्ड
forceVerbatimMode

boolean

क्वेरी की नैचुरल लैंग्वेज (एनएल) व्याख्या, पूरक नतीजों को वापस पाने, और पसंद के मुताबिक बनाए गए समानार्थी शब्दों के इस्तेमाल जैसे सभी इंटरनल ऑप्टिमाइज़ेशन को बंद करने के लिए, इस फ़्लैग को चालू करें. अगर यह फ़्लैग 'सही है' पर सेट है, तो इसे क्वेरी लेवल पर सेट किए गए विकल्प के मुकाबले प्राथमिकता दी जाएगी. 'गलत' की डिफ़ॉल्ट वैल्यू के लिए, क्वेरी लेवल फ़्लैग हूबहू मोड का सही मतलब सेट करेगा.

forceDisableSupplementalResults

boolean

पूरक नतीजे फिर से पाने की सुविधा को बंद करने के लिए इस फ़्लैग को सेट करें. यहां फ़्लैग सेट करने से, दिए गए खोज ऐप्लिकेशन से जुड़ी क्वेरी के पूरक नतीजे नहीं मिलेंगे. अगर यह फ़्लैग 'सही है' पर सेट है, तो इसे क्वेरी लेवल पर सेट किए गए विकल्प के मुकाबले प्राथमिकता दी जाएगी. 'गलत' की डिफ़ॉल्ट वैल्यू के लिए, क्वेरी लेवल फ़्लैग पूरक नतीजों की सही जानकारी सेट करेगा.

तरीके

create

सर्च ऐप्लिकेशन बनाता है.

delete

खोज ऐप्लिकेशन को मिटाता है.

get

चुना गया खोज ऐप्लिकेशन दिखाता है.

list

यह सभी खोज ऐप्लिकेशन की सूची बनाता है.

patch

यह ऐप्लिकेशन, सर्च ऐप्लिकेशन को अपडेट करता है.

reset

खोज ऐप्लिकेशन को डिफ़ॉल्ट सेटिंग पर रीसेट करता है.

update

यह ऐप्लिकेशन, सर्च ऐप्लिकेशन को अपडेट करता है.