Method: query.suggest

क्वेरी को अपने-आप पूरा करने के सुझाव देता है.

ध्यान दें: इस एपीआई को चलाने के लिए, स्टैंडर्ड असली उपयोगकर्ता खाते की ज़रूरत होती है. सेवा खाता, सीधे क्वेरी एपीआई अनुरोध नहीं कर सकता; अगर क्वेरी करने के लिए किसी सेवा खाते का इस्तेमाल करना है, तो पूरे Google Workspace डोमेन पर अधिकार देने की सुविधा सेट अप करें.

एचटीटीपी अनुरोध

POST https://cloudsearch.googleapis.com/v1/query/suggest

यह यूआरएल gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

अनुरोध का मुख्य भाग

अनुरोध के मुख्य हिस्से में, यहां दिए गए स्ट्रक्चर का डेटा शामिल होता है:

JSON के काेड में दिखाना 
{
  "requestOptions": {
    object (RequestOptions)
  },
  "query": string,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ]
}
फ़ील्ड
requestOptions

object (RequestOptions)

अनुरोध के विकल्प, जैसे कि खोज ऐप्लिकेशन और उपयोगकर्ता का टाइमज़ोन.
query

string

ऐसी आंशिक क्वेरी जिसके लिए अपने आप पूरा होने वाले सुझाव दिखाए जाएंगे. उदाहरण के लिए, अगर क्वेरी "sea" है, तो सर्वर "सीज़न", "search", "seagull" दिखा सकता है वगैरह.
dataSourceRestrictions[]

object (DataSourceRestriction)

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

ध्यान दें: सुझाव सिर्फ़ इन सोर्स के लिए काम करते हैं:

  • तीसरे पक्ष के डेटा सोर्स
  • PredefinedSource.PERSON
  • PredefinedSource.GOOGLE_DRIVE

जवाब का मुख्य भाग

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

सुझाए गए एपीआई का रिस्पॉन्स.

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

object (SuggestResult)

सुझावों की सूची.

अनुमति पाने के लिंक

इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/cloud_search.query
  • https://www.googleapis.com/auth/cloud_search

ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.

SuggestResult

सुझाव का एक नतीजा.

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

  // Union field suggestion can be only one of the following:
  "querySuggestion": {
    object (QuerySuggestion)
  },
  "peopleSuggestion": {
    object (PeopleSuggestion)
  }
  // End of list of possible types for union field suggestion.
}
फ़ील्ड
suggestedQuery

string

सुझाई गई वह क्वेरी जिसका इस्तेमाल खोज के लिए किया जाएगा, जब कोई उपयोगकर्ता सुझाव पर क्लिक करेगा
source

object (Source)

सुझाव का सोर्स.
यूनियन फ़ील्ड suggestion. इसमें सुझाई गई क्वेरी के बारे में अतिरिक्त मेटाडेटा होता है. यह सुझाई गई क्वेरी का टाइप भी दिखाता है. उदाहरण के लिए अगर Peopleसुझाव मौजूद है, तो इससे पता चलता है कि suggested_query एक व्यक्ति का सुझाव है. suggestion इनमें से सिर्फ़ एक हो सकता है:
querySuggestion

object (QuerySuggestion)

अगर सुझाई गई क्वेरी कोई शब्द/वाक्यांश पूरा होना चाहिए, तो यह फ़ील्ड मौजूद होगा.
peopleSuggestion

object (PeopleSuggestion)

यह तब दिखता है, जब सुझाव किसी व्यक्ति के बारे में बताता है. इसमें उस व्यक्ति के बारे में ज़्यादा जानकारी होती है. जैसे, उसका ईमेल आईडी, नाम वगैरह.

QuerySuggestion

इस फ़ील्ड में अभी कुछ भी शामिल नहीं है और इसका इस्तेमाल सिर्फ़ एक इंडिकेटर के तौर पर किया जाता है, जिससे पता चलता है कि सुझाए गए नतीजे में एक वाक्यांश पूरा हुआ.

PeopleSuggestion

इस फ़ील्ड में उस व्यक्ति की जानकारी होती है जिसका सुझाव दिया जा रहा है.

JSON के काेड में दिखाना 
{
  "person": {
    object (Person)
  }
}
फ़ील्ड
person

object (Person)

सुझाया गया व्यक्ति. व्यक्ति ऑब्जेक्ट के सभी फ़ील्ड में शायद जानकारी नहीं भरी गई है.