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

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

operationIds[]

string

सिर्फ़ आउटपुट के लिए. इस स्कीमा के लिए, लंबे समय तक चलने वाली कार्रवाइयों (एलआरओ) के आईडी. सिर्फ़ आउटपुट वाला फ़ील्ड.

enableAuditLog

boolean

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

queryInterpretationConfig

object (QueryInterpretationConfig)

क्वेरी की व्याख्या के लिए डिफ़ॉल्ट विकल्प

DataSourceRestriction

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

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

object (Source)

पाबंदी की वजह.

filterOptions[]

object (FilterOptions)

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

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

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

स्रोत

सुझाव/खोज एपीआई के लिए सोर्स तय करता है.

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

FilterOptions

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

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

string

अगर ऑब्जेक्ट टाइप सेट है, तो सिर्फ़ उस टाइप के ऑब्जेक्ट दिखाए जाते हैं. यह उस ऑब्जेक्ट के नाम से मेल खाना चाहिए जिसे स्कीमा की परिभाषा में रजिस्टर किया गया था. ज़्यादा से ज़्यादा 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)

आरएफ़सी3339 यूटीसी "ज़ुलु" में टाइमस्टैंप फ़ॉर्मैट, नैनोसेकंड रिज़ॉल्यूशन और ज़्यादा से ज़्यादा नौ फ़्रैक्शनल अंकों के साथ हो सकता है. उदाहरण: "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

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

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

string

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

objectType

string

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

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) में क्वेरी का मतलब निकालना, पूरक नतीजे वापस पाना, और पसंद के मुताबिक बनाए गए शब्दों के साथ समानार्थी शब्दों का इस्तेमाल करना. अगर यह फ़्लैग 'सही है' पर सेट है, तो क्वेरी लेवल पर सेट किए गए विकल्प के बजाय, इसे प्राथमिकता दी जाएगी. 'गलत' की डिफ़ॉल्ट वैल्यू के लिए, क्वेरी लेवल फ़्लैग 'शब्द' मोड के लिए सही व्याख्या सेट करेगा.

forceDisableSupplementalResults

boolean

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

तरीके

create

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

delete

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

get

बताए गए खोज ऐप्लिकेशन को फ़ेच करता है.

list

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

patch

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

reset

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

update

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