SearchResponse

Search API का रिस्पॉन्स. NEXT आईडी: 17

JSON के काेड में दिखाना
{
  "queryInterpretation": {
    object (QueryInterpretation)
  },
  "results": [
    {
      object (SearchResult)
    }
  ],
  "structuredResults": [
    {
      object (StructuredResult)
    }
  ],
  "spellResults": [
    {
      object (SpellResult)
    }
  ],
  "facetResults": [
    {
      object (FacetResult)
    }
  ],
  "hasMoreResults": boolean,
  "debugInfo": {
    object (ResponseDebugInfo)
  },
  "errorInfo": {
    object (ErrorInfo)
  },
  "resultCounts": {
    object (ResultCounts)
  },

  // Union field result_count can be only one of the following:
  "resultCountEstimate": string,
  "resultCountExact": string
  // End of list of possible types for union field result_count.
}
फ़ील्ड
queryInterpretation

object (QueryInterpretation)

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

results[]

object (SearchResult)

खोज क्वेरी के नतीजे.

structuredResults[]

object (StructuredResult)

उपयोगकर्ता की क्वेरी के लिए स्ट्रक्चर्ड नतीजे. इन नतीजों को pageSize में शामिल नहीं किया जाता.

spellResults[]

object (SpellResult)

क्वेरी के लिए सुझाई गई स्पेलिंग.

facetResults[]

object (FacetResult)

फ़ेसेट के दोहराए गए नतीजे.

hasMoreResults

boolean

क्या क्वेरी से मैच होने वाले और खोज नतीजे हैं.

debugInfo

object (ResponseDebugInfo)

जवाब के बारे में डीबग करने से जुड़ी जानकारी.

errorInfo

object (ErrorInfo)

जवाब के बारे में गड़बड़ी की जानकारी.

resultCounts

object (ResultCounts)

नतीजों की संख्या की जानकारी को बड़ा किया गया.

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

  • जब क्वेरी में किसी वाक्यांश में दो से ज़्यादा शब्द हों, जैसे कि कोटेशन में "नतीजों की संख्या एग्ज़ैक्ट".

  • जब खोज के नतीजों के यूनीक एसीएल की संख्या बहुत ज़्यादा हो, ताकि तय समयसीमा में उनका आकलन किया जा सके.

अगर सिस्टम सभी दस्तावेज़ों में खोज नहीं कर पा रहा है, तो क्वेरी फिर से चलाएं. result_count इनमें से कोई एक हो सकता है:

resultCountEstimate

string (int64 format)

इस क्वेरी के लिए, नतीजों की अनुमानित संख्या.

resultCountExact

string (int64 format)

इस क्वेरी के लिए नतीजों की सटीक संख्या.

QueryInterpretation

JSON के काेड में दिखाना
{
  "interpretedQuery": string,
  "interpretationType": enum (QueryInterpretation.InterpretationType),
  "reason": enum (QueryInterpretation.Reason),
  "interpretedQueryActualResultCount": integer,
  "interpretedQueryEstimatedResultCount": string
}
फ़ील्ड
interpretedQuery

string

खोज में इस्तेमाल की गई क्वेरी का मतलब. उदाहरण के लिए, "जॉन से मिला ईमेल" जैसी सामान्य भाषा वाली क्वेरी को "from:john source:mail" के तौर पर समझा जाएगा. अगर वजह NOT_ENOUGH_RESULTS_FOUND_FOR_USER_QUERY है, तो यह फ़ील्ड नहीं भरा जाएगा.

interpretationType

enum (QueryInterpretation.InterpretationType)

reason

enum (QueryInterpretation.Reason)

क्वेरी के हिसाब से जवाब देने की वजह. अगर 'इंटरप्रिटेशन टाइप' की वैल्यू 'कोई नहीं' नहीं है, तो यह फ़ील्ड 'तय नहीं किया गया' नहीं होगा.

interpretedQueryActualResultCount

integer

व्याख्या की गई क्वेरी से मिले नतीजों की असल संख्या.

interpretedQueryEstimatedResultCount

string (int64 format)

अनुवाद की गई क्वेरी से मिले नतीजों की अनुमानित संख्या.

QueryInterpretation.InterpretationType

Enums
NONE खोज के नतीजे फ़ेच करने के लिए, न तो सामान्य भाषा के हिसाब से अनुवाद का इस्तेमाल किया जाता है और न ही क्वेरी के बड़े वर्शन का.
BLEND ओरिजनल क्वेरी के नतीजों को अन्य नतीजों के साथ ब्लेंड किया जाता है. इन अन्य नतीजों को ओरिजनल क्वेरी के नतीजों के साथ ब्लेंड करने की वजह, नीचे दिए गए 'वजह' फ़ील्ड में दिखती है.
REPLACE ओरिजनल क्वेरी के नतीजों को बदल दिया जाता है. ओरिजनल क्वेरी के नतीजों को बदलने की वजह, नीचे दिए गए 'वजह' फ़ील्ड में दिखती है.

QueryInterpretation.Reason

Enums
UNSPECIFIED
QUERY_HAS_NATURAL_LANGUAGE_INTENT खोज के नतीजे फ़ेच करने के लिए, क्वेरी की सामान्य भाषा के हिसाब से अनुवाद का इस्तेमाल किया जाता है.
NOT_ENOUGH_RESULTS_FOUND_FOR_USER_QUERY क्वेरी और दस्तावेज़ के शब्दों की समानता का इस्तेमाल, क्वेरी को चुनिंदा तौर पर बड़ा करने के लिए किया जाता है, ताकि खोज के ज़्यादा नतीजे मिल सकें. ऐसा इसलिए किया जाता है, क्योंकि उपयोगकर्ता की क्वेरी के लिए ज़रूरत के मुताबिक नतीजे नहीं मिलते. इस मामले में, अनुवाद की गई क्वेरी खाली होगी.

SearchResult

ऐसे नतीजे जिनमें किसी दस्तावेज़ के लिए इंडेक्स की गई जानकारी शामिल होती है.

JSON के काेड में दिखाना
{
  "title": string,
  "url": string,
  "snippet": {
    object (Snippet)
  },
  "metadata": {
    object (Metadata)
  },
  "clusteredResults": [
    {
      object (SearchResult)
    }
  ],
  "debugInfo": {
    object (ResultDebugInfo)
  }
}
फ़ील्ड
title

string

खोज के नतीजे का टाइटल.

url

string

खोज के नतीजे का यूआरएल. यूआरएल में, असल आइटम पर रीडायरेक्ट करने वाला Google लिंक शामिल है. इस यूआरएल पर हस्ताक्षर किया गया है और इसे बदला नहीं जाना चाहिए.

snippet

object (Snippet)

इस नतीजे के लिए उपलब्ध सभी स्निपेट (खास जानकारी) को जोड़ने पर बनने वाला कॉन्टेंट.

metadata

object (Metadata)

खोज के नतीजे का मेटाडेटा.

clusteredResults[]

object (SearchResult)

अगर सोर्स को क्लस्टर किया गया है, तो क्लस्टर किए गए नतीजों की सूची दें. क्लस्टर किए गए नतीजों का सिर्फ़ एक लेवल होगा. अगर मौजूदा सोर्स को क्लस्टर करने के लिए चालू नहीं किया गया है, तो यह फ़ील्ड खाली रहेगा.

debugInfo

object (ResultDebugInfo)

खोज के इस नतीजे के बारे में डीबग करने की जानकारी.

स्निपेट

खोज के नतीजे का स्निपेट, जो खोज के नतीजे वाले पेज के कॉन्टेंट की खास जानकारी देता है.

JSON के काेड में दिखाना
{
  "snippet": string,
  "matchRanges": [
    {
      object (MatchRange)
    }
  ]
}
फ़ील्ड
snippet

string

दस्तावेज़ का स्निपेट. इसमें एस्केप्ड एचटीएमएल कैरेक्टर हो सकते हैं. इन्हें रेंडर करने से पहले, एस्केप हटाना ज़रूरी है.

matchRanges[]

object (MatchRange)

स्निपेट में मेल खाने वाली रेंज.

MatchRange

स्निपेट की मैच होने वाली रेंज [शुरू, खत्म].

JSON के काेड में दिखाना
{
  "start": integer,
  "end": integer
}
फ़ील्ड
start

integer

स्निपेट में मैच की शुरुआती जगह.

end

integer

स्निपेट में मैच का आखिरी हिस्सा.

मेटाडेटा

खोज के मिलते-जुलते नतीजे का मेटाडेटा.

JSON के काेड में दिखाना
{
  "source": {
    object (Source)
  },
  "mimeType": string,
  "thumbnailUrl": string,
  "owner": {
    object (Person)
  },
  "createTime": string,
  "updateTime": string,
  "fields": [
    {
      object (NamedProperty)
    }
  ],
  "displayOptions": {
    object (ResultDisplayMetadata)
  },
  "objectType": string
}
फ़ील्ड
source

object (Source)

नतीजे का सोर्स, जैसे कि Gmail.

mimeType

string

खोज के नतीजे का MIME टाइप.

thumbnailUrl

string

खोज के नतीजे के थंबनेल का यूआरएल.

owner

object (Person)

खोज के नतीजे में दिखने वाले दस्तावेज़ या ऑब्जेक्ट का मालिक (आम तौर पर क्रिएटर).

createTime

string (Timestamp format)

खोज के नतीजे में मौजूद इस दस्तावेज़ या ऑब्जेक्ट को बनाने का समय.

आरएफ़सी 3339 का इस्तेमाल करता है. इसमें जनरेट किया गया आउटपुट हमेशा Z-नॉर्मलाइज़्ड होगा और इसमें 0, 3, 6 या 9 दशमलव अंक इस्तेमाल किए जाएंगे. "Z" के अलावा, अन्य ऑफ़सेट भी स्वीकार किए जाते हैं. उदाहरण: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" या "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

खोज के नतीजे में मौजूद ऑब्जेक्ट में पिछली बार बदलाव करने की तारीख. अगर आइटम में सेट नहीं किया गया है, तो यहां दी गई वैल्यू खाली होगी. अगर updateTime का इस्तेमाल, डेटा के अपडेट होने की फ़्रीक्वेंसी का हिसाब लगाने के लिए किया जाता है और इसे सेट नहीं किया जाता है, तो यह वैल्यू डिफ़ॉल्ट रूप से मौजूदा समय से दो साल पर सेट हो जाती है.

आरएफ़सी 3339 का इस्तेमाल करता है. इसमें जनरेट किया गया आउटपुट हमेशा Z-नॉर्मलाइज़्ड होगा और इसमें 0, 3, 6 या 9 दशमलव अंक इस्तेमाल किए जाएंगे. "Z" के अलावा, अन्य ऑफ़सेट भी स्वीकार किए जाते हैं. उदाहरण: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" या "2014-10-02T15:01:23+05:30".

fields[]

object (NamedProperty)

स्ट्रक्चर्ड डेटा में इंडेक्स किए गए फ़ील्ड, जिन्हें सामान्य नाम वाली प्रॉपर्टी के तौर पर दिखाया जाता है.

displayOptions

object (ResultDisplayMetadata)

विकल्प, जो स्ट्रक्चर्ड डेटा वाले खोज के नतीजे को दिखाने का तरीका बताते हैं.

objectType

string

खोज के नतीजे का ऑब्जेक्ट टाइप.

ResultDisplayMetadata

JSON के काेड में दिखाना
{
  "objectTypeLabel": string,
  "metalines": [
    {
      object (ResultDisplayMetadata.ResultDisplayLine)
    }
  ]
}
फ़ील्ड
objectTypeLabel

string

ऑब्जेक्ट का डिसप्ले लेबल.

metalines[]

object (ResultDisplayMetadata.ResultDisplayLine)

नतीजे के साथ दिखने वाला मेटालाइन कॉन्टेंट.

ResultDisplayMetadata.ResultDisplayLine

दिखाई गई लाइन बनाने वाले फ़ील्ड का कलेक्शन

JSON के काेड में दिखाना
{
  "fields": [
    {
      object (ResultDisplayMetadata.ResultDisplayField)
    }
  ]
}
फ़ील्ड
fields[]

object (ResultDisplayMetadata.ResultDisplayField)

ResultDisplayMetadata.ResultDisplayField

खोज के नतीजों के लिए फ़ील्ड दिखाना

JSON के काेड में दिखाना
{
  "label": string,
  "operatorName": string,
  "property": {
    object (NamedProperty)
  }
}
फ़ील्ड
label

string

प्रॉपर्टी का डिसप्ले लेबल.

operatorName

string

प्रॉपर्टी के ऑपरेटर का नाम.

property

object (NamedProperty)

प्रॉपर्टी के लिए नाम वैल्यू पेयर.

ResultDebugInfo

नतीजे के बारे में डीबग करने की जानकारी.

JSON के काेड में दिखाना
{
  "formattedDebugInfo": string
}
फ़ील्ड
formattedDebugInfo

string

डिसप्ले के लिए फ़ॉर्मैट की गई, डीबग की सामान्य जानकारी.

StructuredResult

खोज अनुरोध के हिस्से के तौर पर दिखाए जाने वाले स्ट्रक्चर्ड नतीजे.

JSON के काेड में दिखाना
{

  // Union field structured_result can be only one of the following:
  "person": {
    object (Person)
  }
  // End of list of possible types for union field structured_result.
}
फ़ील्ड

यूनियन फ़ील्ड structured_result.

structured_result इनमें से कोई एक हो सकता है:

person

object (Person)

किसी व्यक्ति की जानकारी

SpellResult

JSON के काेड में दिखाना
{
  "suggestedQuery": string,
  "suggestionType": enum (SpellResult.SuggestionType),
  "suggestedQueryHtml": {
    object (SafeHtmlProto)
  }
}
फ़ील्ड
suggestedQuery

string

क्वेरी की सुझाई गई स्पेलिंग.

suggestionType

enum (SpellResult.SuggestionType)

सुझाव, मौजूदा क्वेरी के लिए ट्रिगर हुआ.

suggestedQueryHtml

object (SafeHtmlProto)

सही स्पेलिंग वाली क्वेरी को दिखाने वाला साफ़ किया गया एचटीएमएल, जिसका इस्तेमाल यूज़र इंटरफ़ेस (यूआई) में किया जा सकता है. आम तौर पर, इसमें भाषा के हिसाब से टैग होते हैं, ताकि क्वेरी के उन हिस्सों को मार्क किया जा सके जिनकी वर्तनी की जांच की गई है.

SpellResult.SuggestionType

क्वेरी के लिए ट्रिगर किया गया सुझाव किस तरह का है.

Enums
SUGGESTION_TYPE_UNSPECIFIED स्पेल चेक का डिफ़ॉल्ट टाइप
NON_EMPTY_RESULTS_SPELL_SUGGESTION स्पेलिंग का सुझाव, जिसमें कोई नतीजा नहीं बदला गया. ओरिजनल क्वेरी (जिसमें नतीजे शून्य से ज़्यादा हैं) के लिए अब भी नतीजे दिखाए जाते हैं. साथ ही, स्पेलिंग के लिए ऐसा सुझाव दिया जाता है जिससे नतीजे मिल सकते हैं.
ZERO_RESULTS_FULL_PAGE_REPLACEMENT जब ओरिजनल क्वेरी से कोई नतीजा नहीं मिलता, तब वर्तनी का सुझाव ट्रिगर होता है. जब ओरिजनल क्वेरी के लिए कोई नतीजा नहीं मिलता है और स्पेलिंग के सुझाव के लिए नतीजे मिलते हैं, तो हम स्पेलिंग ठीक की गई क्वेरी के लिए नतीजे दिखाते हैं.

SafeHtmlProto

अहम जानकारी: किसी भरोसेमंद सोर्स से यह मैसेज स्वीकार करना असुरक्षित है. ऐसा इसलिए है, क्योंकि किसी हैकर के लिए, सीरियलाइज़ किए गए ऐसे मैसेज बनाना आसान है जो सुरक्षा समझौते की शर्तों को पूरा नहीं करते. उदाहरण के लिए, इसमें हैकर की कंट्रोल वाली स्क्रिप्ट हो सकती है. जिस सिस्टम को SafeHtmlProto मिलता है वह SafeHtmlProto बनाने वाले पर भरोसा करता है. इसलिए, आरपीसी के जवाबों में यह मैसेज दिखाना आम तौर पर सुरक्षित होता है. हालांकि, आरपीसी के अनुरोधों में इसे स्वीकार करना आम तौर पर सुरक्षित नहीं होता.

JSON के काेड में दिखाना
{
  "privateDoNotAccessOrElseSafeHtmlWrappedValue": string
}
फ़ील्ड
privateDoNotAccessOrElseSafeHtmlWrappedValue

string

अहम जानकारी: इस फ़ील्ड को कभी सेट या पढ़ा न करें. भले ही, आप टेस्ट कर रहे हों. यह निजी है. इस मैसेज को बनाने या पढ़ने के लिए, प्रोग्रामिंग भाषा के पैकेज के बारे में .proto फ़ाइल में सबसे ऊपर मौजूद दस्तावेज़ देखें.

FacetResult

सोर्स के हिसाब से फ़ेसेट का जवाब

JSON के काेड में दिखाना
{
  "sourceName": string,
  "objectType": string,
  "operatorName": string,
  "buckets": [
    {
      object (FacetBucket)
    }
  ]
}
फ़ील्ड
sourceName

string

उस सोर्स का नाम जिसके लिए फ़ेसेट के नतीजे दिखाए जाते हैं. यह खाली नहीं होगा.

objectType

string

वह ऑब्जेक्ट टाइप जिसके लिए फ़ेसेट के नतीजे दिखाए जाते हैं. इसे खाली छोड़ा जा सकता है.

operatorName

string

फ़ेसेट करने के लिए चुने गए ऑपरेटर का नाम. @see cloudsearch.SchemaPropertyOptions

buckets[]

object (FacetBucket)

जवाब में वैल्यू के लिए FacetBuckets, जिसमें उससे जुड़े फ़िल्टर के साथ कम से कम एक नतीजा हो.

FacetBucket

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

JSON के काेड में दिखाना
{
  "count": integer,
  "percentage": integer,
  "filter": {
    object (Filter)
  },

  // Union field bucket_value can be only one of the following:
  "value": {
    object (Value)
  }
  // End of list of possible types for union field bucket_value.
}
फ़ील्ड
count

integer

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

percentage

integer

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

filter

object (Filter)

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

यूनियन फ़ील्ड bucket_value. फ़ेसेट की गई bucket_value बकेट की रेंज या वैल्यू, इनमें से कोई एक हो सकती है:
value

object (Value)

ResponseDebugInfo

जवाब के बारे में डीबग करने से जुड़ी जानकारी.

JSON के काेड में दिखाना
{
  "formattedDebugInfo": string
}
फ़ील्ड
formattedDebugInfo

string

डिसप्ले के लिए फ़ॉर्मैट की गई, डीबग की सामान्य जानकारी.

ErrorInfo

जवाब के बारे में गड़बड़ी की जानकारी.

JSON के काेड में दिखाना
{
  "errorMessages": [
    {
      object (ErrorMessage)
    }
  ]
}
फ़ील्ड
errorMessages[]

object (ErrorMessage)

ErrorMessage

हर सोर्स के रिस्पॉन्स के हिसाब से गड़बड़ी का मैसेज.

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

object (Source)

errorMessage

string

ResultCounts

नतीजों की संख्या की जानकारी

JSON के काेड में दिखाना
{
  "sourceResultCounts": [
    {
      object (SourceResultCount)
    }
  ]
}
फ़ील्ड
sourceResultCounts[]

object (SourceResultCount)

नतीजों वाले हर सोर्स के लिए, नतीजों की संख्या की जानकारी.

SourceResultCount

हर सोर्स के नतीजों की संख्या की जानकारी.

JSON के काेड में दिखाना
{
  "source": {
    object (Source)
  },
  "hasMoreResults": boolean,

  // Union field result_count can be only one of the following:
  "resultCountEstimate": string,
  "resultCountExact": string
  // End of list of possible types for union field result_count.
}
फ़ील्ड
source

object (Source)

वह सोर्स जिससे नतीजों की संख्या की जानकारी जुड़ी है.

hasMoreResults

boolean

इस सोर्स के लिए, खोज के और नतीजे हैं या नहीं.

यूनियन फ़ील्ड result_count.

result_count इनमें से कोई एक हो सकता है:

resultCountEstimate

string (int64 format)

इस सोर्स के लिए अनुमानित नतीजों की संख्या.

resultCountExact

string (int64 format)

इस सोर्स के लिए, नतीजों की सटीक संख्या.