- एचटीटीपी अनुरोध
- अनुरोध का मुख्य हिस्सा
- जवाब का मुख्य हिस्सा
- अनुमति पाने के लिंक
- QueryInterpretationOptions
- QueryInterpretation
- QueryInterpretation.InterpretationType
- QueryInterpretation.Reason
- SearchResult
- स्निपेट
- MatchRange
- मेटाडेटा
- ResultDisplayMetadata
- ResultDisplayMetadata.ResultDisplayLine
- ResultDisplayMetadata.ResultDisplayField
- ResultDebugInfo
- StructuredResult
- SpellResult
- FacetResult
- FacetBucket
- ResponseDebugInfo
- ErrorInfo
- ErrorMessage
- ResultCounts
- SourceResultCount
- इसे आज़माएं!
Cloud Search Query API, खोज का तरीका उपलब्ध कराता है. इससे उपयोगकर्ता की क्वेरी के हिसाब से सबसे काम के नतीजे मिलते हैं. ये नतीजे, Gmail या Google Drive जैसे Google Workspace ऐप्लिकेशन से मिल सकते हैं. इसके अलावा, ये किसी तीसरे पक्ष के उस डेटा से भी मिल सकते हैं जिसे आपने इंडेक्स किया है.
ध्यान दें: इस एपीआई को चलाने के लिए, स्टैंडर्ड असली उपयोगकर्ता खाते की ज़रूरत होती है. कोई सेवा खाता, सीधे तौर पर क्वेरी एपीआई के अनुरोधों को पूरा नहीं कर सकता. क्वेरी करने के लिए, सेवा खाते का इस्तेमाल करने के लिए, Google Workspace के डोमेन के लिए, अधिकार देने की सुविधा सेट अप करें.
एचटीटीपी अनुरोध
POST https://cloudsearch.googleapis.com/v1/query/search
यूआरएल में gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल किया गया है.
अनुरोध का मुख्य भाग
अनुरोध के मुख्य भाग में नीचे दिए गए स्ट्रक्चर वाला डेटा होता है:
JSON के काेड में दिखाना |
---|
{ "requestOptions": { object ( |
फ़ील्ड | |
---|---|
requestOptions |
अनुरोध के विकल्प, जैसे कि खोज ऐप्लिकेशन और उपयोगकर्ता का टाइमज़ोन. |
query |
रॉ क्वेरी स्ट्रिंग. ऑपरेटर की मदद से खोज के सटीक नतीजे पाना में, काम करने वाले खोज ऑपरेटर देखें |
pageSize |
एक पेज पर दिखाए जाने वाले खोज के नतीजों की ज़्यादा से ज़्यादा संख्या. मान्य वैल्यू 1 से 100 के बीच होनी चाहिए. डिफ़ॉल्ट वैल्यू 10 है. अगर 2,000 से ज़्यादा नतीजों का अनुरोध किया जाता है, तो कम से कम वैल्यू 50 होनी चाहिए. |
start |
नतीजों का शुरुआती इंडेक्स. |
dataSourceRestrictions[] |
क्वेरी करने के लिए इस्तेमाल किए जाने वाले सोर्स. अगर कोई डेटा सोर्स नहीं चुना जाता है, तो मौजूदा सर्च ऐप्लिकेशन के सभी डेटा सोर्स का इस्तेमाल किया जाता है. |
facetOptions[] |
|
sortOptions |
खोज के नतीजों को क्रम से लगाने के विकल्प |
queryInterpretationOptions |
उपयोगकर्ता की क्वेरी को समझने के लिए विकल्प. |
contextAttributes[] |
अनुरोध के लिए कॉन्टेक्स्ट एट्रिब्यूट, जिनका इस्तेमाल खोज के नतीजों की रैंकिंग में बदलाव करने के लिए किया जाएगा. एलिमेंट की ज़्यादा से ज़्यादा संख्या 10 हो सकती है. |
जवाब का मुख्य भाग
अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.
Search API का रिस्पॉन्स.
JSON के काेड में दिखाना |
---|
{ "queryInterpretation": { object ( |
फ़ील्ड | |
---|---|
queryInterpretation |
उपयोगकर्ता की क्वेरी के लिए, क्वेरी के बारे में जानकारी देने वाला नतीजा. अगर क्वेरी का विश्लेषण करने की सुविधा बंद है, तो यह फ़ील्ड खाली रहेगा. |
results[] |
खोज क्वेरी के नतीजे. |
structuredResults[] |
उपयोगकर्ता की क्वेरी के लिए स्ट्रक्चर्ड नतीजे. इन नतीजों को pageSize में शामिल नहीं किया जाता. |
spellResults[] |
क्वेरी के लिए सुझाई गई स्पेलिंग. |
facetResults[] |
फ़ेसेट के दोहराए गए नतीजे. |
hasMoreResults |
क्या क्वेरी से मैच होने वाले और खोज नतीजे हैं. |
debugInfo |
जवाब के बारे में डीबग करने से जुड़ी जानकारी. |
errorInfo |
जवाब के बारे में गड़बड़ी की जानकारी. |
resultCounts |
नतीजों की संख्या की जानकारी को बड़ा किया गया. |
यूनियन फ़ील्ड
अगर सिस्टम सभी दस्तावेज़ों में खोज नहीं कर पा रहा है, तो क्वेरी फिर से चलाएं. |
|
resultCountEstimate |
इस क्वेरी के लिए, नतीजों की अनुमानित संख्या. |
resultCountExact |
इस क्वेरी के लिए नतीजों की सटीक संख्या. |
अनुमति के दायरे
इसके लिए, OAuth के इनमें से किसी एक स्कोप की ज़रूरत होती है:
https://www.googleapis.com/auth/cloud_search.query
https://www.googleapis.com/auth/cloud_search
ज़्यादा जानकारी के लिए, अनुमति से जुड़ी गाइड देखें.
QueryInterpretationOptions
उपयोगकर्ता की क्वेरी को समझने के विकल्प.
JSON के काेड में दिखाना |
---|
{ "disableNlInterpretation": boolean, "enableVerbatimMode": boolean, "disableSupplementalResults": boolean } |
फ़ील्ड | |
---|---|
disableNlInterpretation |
क्वेरी के लिए, नैचुरल लैंग्वेज (एनएल) के हिसाब से अनुवाद करने की सुविधा बंद करने के लिए फ़्लैग करें. डिफ़ॉल्ट रूप से गलत पर सेट होती है. नैचुरल लैंग्वेज इंटरप्रिटेशन की सुविधा बंद करने के लिए, इसे 'सही' पर सेट करें. नेदरलैंड्स के हिसाब से डेटा का विश्लेषण करने की सुविधा, सिर्फ़ पहले से तय किए गए डेटा सोर्स पर लागू होती है. |
enableVerbatimMode |
इस फ़्लैग को चालू करके, सभी इंटरनल ऑप्टिमाइज़ेशन बंद किए जा सकते हैं. जैसे, क्वेरी की सामान्य भाषा (एनएल) का अनुवाद, अतिरिक्त नतीजे हासिल करना, और कस्टम के साथ-साथ मिलते-जुलते शब्दों का इस्तेमाल करना. अगर इन दोनों में से कोई एक फ़्लैग सही है, तो Nl interpretation बंद हो जाएगा. |
disableSupplementalResults |
किसी क्वेरी के लिए, अन्य नतीजे दिखाने की सुविधा बंद करने के लिए, इस फ़्लैग का इस्तेमाल करें. अगर 'सही है' पर सेट किया जाता है, तो SearchApplication लेवल पर चुनी गई, अन्य नतीजों की सेटिंग को प्राथमिकता दी जाएगी. |
QueryInterpretation
JSON के काेड में दिखाना |
---|
{ "interpretedQuery": string, "interpretationType": enum ( |
फ़ील्ड | |
---|---|
interpretedQuery |
खोज में इस्तेमाल की गई क्वेरी का मतलब. उदाहरण के लिए, "जॉन से मिला ईमेल" जैसी सामान्य भाषा वाली क्वेरी को "from:john source:mail" के तौर पर समझा जाएगा. अगर वजह NOT_ENOUGH_RESULTS_FOUND_FOR_USER_QUERY है, तो यह फ़ील्ड नहीं भरा जाएगा. |
interpretationType |
|
reason |
क्वेरी के हिसाब से जवाब देने की वजह. अगर 'इंटरप्रिटेशन टाइप' की वैल्यू 'कोई नहीं' नहीं है, तो यह फ़ील्ड 'तय नहीं किया गया' नहीं होगा. |
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 ( |
फ़ील्ड | |
---|---|
title |
खोज के नतीजे का टाइटल. |
url |
खोज के नतीजे का यूआरएल. यूआरएल में, असल आइटम पर रीडायरेक्ट करने वाला Google लिंक शामिल है. इस यूआरएल पर हस्ताक्षर किया गया है और इसे बदला नहीं जाना चाहिए. |
snippet |
इस नतीजे के लिए उपलब्ध सभी स्निपेट (खास जानकारी) को जोड़ने पर जो जानकारी मिलती है. |
metadata |
खोज के नतीजे का मेटाडेटा. |
clusteredResults[] |
अगर सोर्स को क्लस्टर किया गया है, तो क्लस्टर किए गए नतीजों की सूची दें. क्लस्टर किए गए नतीजों का सिर्फ़ एक लेवल होगा. अगर मौजूदा सोर्स को क्लस्टर करने के लिए चालू नहीं किया गया है, तो यह फ़ील्ड खाली रहेगा. |
debugInfo |
खोज के इस नतीजे के बारे में डीबग करने की जानकारी. |
स्निपेट
खोज के नतीजे का स्निपेट, जो खोज के नतीजे वाले पेज के कॉन्टेंट की खास जानकारी देता है.
JSON के काेड में दिखाना |
---|
{
"snippet": string,
"matchRanges": [
{
object ( |
फ़ील्ड | |
---|---|
snippet |
दस्तावेज़ का स्निपेट. दस्तावेज़ का स्निपेट. इसमें एस्केप्ड एचटीएमएल कैरेक्टर हो सकते हैं. इन्हें रेंडर करने से पहले, एस्केप हटाना ज़रूरी है. |
matchRanges[] |
स्निपेट में मेल खाने वाली रेंज. |
MatchRange
स्निपेट की मैच होने वाली रेंज [शुरू, खत्म].
JSON के काेड में दिखाना |
---|
{ "start": integer, "end": integer } |
फ़ील्ड | |
---|---|
start |
स्निपेट में मैच की शुरुआती जगह. |
end |
स्निपेट में मैच का आखिरी हिस्सा. |
मेटाडेटा
खोज के मिलते-जुलते नतीजे का मेटाडेटा.
JSON के काेड में दिखाना |
---|
{ "source": { object ( |
फ़ील्ड | |
---|---|
source |
नतीजे का सोर्स, जैसे कि Gmail. |
mimeType |
खोज के नतीजे का MIME टाइप. |
thumbnailUrl |
खोज के नतीजे के थंबनेल का यूआरएल. |
owner |
खोज के नतीजे में दिखने वाले दस्तावेज़ या ऑब्जेक्ट का मालिक (आम तौर पर क्रिएटर). |
createTime |
खोज के नतीजे में मौजूद इस दस्तावेज़ या ऑब्जेक्ट को बनाने का समय. आरएफ़सी3339 यूटीसी के "Zulu" फ़ॉर्मैट में एक टाइमस्टैंप, नैनोसेकंड रिज़ॉल्यूशन और नौ दशमलव अंकों तक का होता है. उदाहरण के लिए: |
updateTime |
खोज के नतीजे में मौजूद ऑब्जेक्ट में, पिछली बार बदलाव करने की तारीख. अगर आइटम में सेट नहीं किया गया है, तो यहां दी गई वैल्यू खाली होगी. अगर आरएफ़सी3339 यूटीसी के "Zulu" फ़ॉर्मैट में एक टाइमस्टैंप, नैनोसेकंड रिज़ॉल्यूशन और नौ दशमलव अंकों तक का होता है. उदाहरण के लिए: |
fields[] |
स्ट्रक्चर्ड डेटा में इंडेक्स किए गए फ़ील्ड, जिन्हें सामान्य नाम वाली प्रॉपर्टी के तौर पर दिखाया जाता है. |
displayOptions |
विकल्प, जो स्ट्रक्चर्ड डेटा वाले खोज के नतीजे को दिखाने का तरीका बताते हैं. |
objectType |
खोज के नतीजे का ऑब्जेक्ट टाइप. |
ResultDisplayMetadata
JSON के काेड में दिखाना |
---|
{
"objectTypeLabel": string,
"metalines": [
{
object ( |
फ़ील्ड | |
---|---|
objectTypeLabel |
ऑब्जेक्ट का डिसप्ले लेबल. |
metalines[] |
नतीजे के साथ दिखने वाला मेटालाइन कॉन्टेंट. |
ResultDisplayMetadata.ResultDisplayLine
दिखाई गई लाइन बनाने वाले फ़ील्ड का कलेक्शन
JSON के काेड में दिखाना |
---|
{
"fields": [
{
object ( |
फ़ील्ड | |
---|---|
fields[] |
ResultDisplayMetadata.ResultDisplayField
query.search के नतीजों के लिए डिसप्ले फ़ील्ड
JSON के काेड में दिखाना |
---|
{
"label": string,
"operatorName": string,
"property": {
object ( |
फ़ील्ड | |
---|---|
label |
प्रॉपर्टी का डिसप्ले लेबल. |
operatorName |
प्रॉपर्टी के ऑपरेटर का नाम. |
property |
प्रॉपर्टी के लिए नाम वैल्यू पेयर. |
ResultDebugInfo
नतीजे के बारे में डीबग करने की जानकारी.
JSON के काेड में दिखाना |
---|
{ "formattedDebugInfo": string } |
फ़ील्ड | |
---|---|
formattedDebugInfo |
डिसप्ले के लिए फ़ॉर्मैट की गई, डीबग की सामान्य जानकारी. |
StructuredResult
खोज अनुरोध के हिस्से के तौर पर दिखाए जाने वाले स्ट्रक्चर्ड नतीजे.
JSON के काेड में दिखाना |
---|
{
"person": {
object ( |
फ़ील्ड | |
---|---|
person |
किसी व्यक्ति की जानकारी |
SpellResult
JSON के काेड में दिखाना |
---|
{ "suggestedQuery": string } |
फ़ील्ड | |
---|---|
suggestedQuery |
क्वेरी की सुझाई गई स्पेलिंग. |
FacetResult
सोर्स के हिसाब से फ़ेसेट का जवाब
JSON के काेड में दिखाना |
---|
{
"sourceName": string,
"objectType": string,
"operatorName": string,
"buckets": [
{
object ( |
फ़ील्ड | |
---|---|
sourceName |
उस सोर्स का नाम जिसके लिए फ़ेसेट के नतीजे दिखाए जाते हैं. यह खाली नहीं होगा. |
objectType |
वह ऑब्जेक्ट टाइप जिसके लिए फ़ेसेट के नतीजे दिखाए जाते हैं. इसे खाली छोड़ा जा सकता है. |
operatorName |
फ़ेसेट करने के लिए चुने गए ऑपरेटर का नाम. @see cloudsearch.SchemaPropertyOptions |
buckets[] |
जवाब में वैल्यू के लिए FacetBuckets, जिसमें उससे जुड़े फ़िल्टर के साथ कम से कम एक नतीजा हो. |
FacetBucket
फ़ेसेट में मौजूद बकेट, ऑपरेशन की बुनियादी इकाई होती है. किसी बकेट में एक वैल्यू या वैल्यू की एक सीमा हो सकती है. यह इस बात पर निर्भर करता है कि बकेट किए गए फ़ील्ड का टाइप क्या है. फ़िलहाल, FacetBucket का इस्तेमाल सिर्फ़ रिस्पॉन्स ऑब्जेक्ट को दिखाने के लिए किया जाता है.
फ़ील्ड | |
---|---|
count |
बकेट वैल्यू से मैच करने वाले नतीजों की संख्या. खोज के लिए, सिर्फ़ तब ही आंकड़े दिखाए जाते हैं, जब यह पक्का हो जाता है कि आंकड़े सटीक हैं. Cloud Search, किसी भी क्वेरी के लिए फ़ेसेट की संख्या की गारंटी नहीं देता. साथ ही, फ़ेसेट की संख्या, एक जैसी क्वेरी के लिए भी कभी-कभी ही दिख सकती है. फ़ेसेट की संख्या के मौजूद होने पर डिपेंडेंसी न बनाएं. इसके बजाय, फ़ेसेट की संख्या के प्रतिशत का इस्तेमाल करें, जो हमेशा दिखाए जाते हैं. |
percentage |
बकेट वैल्यू से मैच करने वाले नतीजों का प्रतिशत. यह फ़ंक्शन 0 से 100 के बीच की वैल्यू दिखाता है. अगर वैल्यू में दशमलव अंक है, तो उसे पूर्णांक में बदल दिया जाता है. अगर वैल्यू साफ़ तौर पर नहीं दी जाती है, तो यह प्रतिशत वैल्यू दिखाती है, जो 0 पर राउंड ऑफ़ होती है. प्रतिशत सभी खोजों के लिए दिखाए जाते हैं, लेकिन ये अनुमानित होते हैं. प्रतिशत हमेशा दिखाए जाते हैं. इसलिए, आपको संख्याओं के बजाय प्रतिशत दिखाने चाहिए. |
filter |
अगर उससे जुड़ी बकेट चुनी जाती है, तो खोज अनुरोध में पास किया जाने वाला फ़िल्टर. |
value |
|
ResponseDebugInfo
जवाब के बारे में डीबग करने से जुड़ी जानकारी.
JSON के काेड में दिखाना |
---|
{ "formattedDebugInfo": string } |
फ़ील्ड | |
---|---|
formattedDebugInfo |
डिसप्ले के लिए फ़ॉर्मैट की गई, डीबग की सामान्य जानकारी. |
ErrorInfo
जवाब के बारे में गड़बड़ी की जानकारी.
JSON के काेड में दिखाना |
---|
{
"errorMessages": [
{
object ( |
फ़ील्ड | |
---|---|
errorMessages[] |
|
ErrorMessage
हर सोर्स के रिस्पॉन्स के हिसाब से गड़बड़ी का मैसेज.
JSON के काेड में दिखाना |
---|
{
"source": {
object ( |
फ़ील्ड | |
---|---|
source |
|
errorMessage |
|
ResultCounts
नतीजों की संख्या की जानकारी
JSON के काेड में दिखाना |
---|
{
"sourceResultCounts": [
{
object ( |
फ़ील्ड | |
---|---|
sourceResultCounts[] |
नतीजों वाले हर सोर्स के लिए, नतीजों की संख्या की जानकारी. |
SourceResultCount
हर सोर्स के नतीजों की संख्या की जानकारी.
JSON के काेड में दिखाना |
---|
{ "source": { object ( |
फ़ील्ड | |
---|---|
source |
वह सोर्स जिससे नतीजों की संख्या की जानकारी जुड़ी है. |
hasMoreResults |
इस सोर्स के लिए, खोज के और नतीजे हैं या नहीं. |
यूनियन फ़ील्ड
|
|
resultCountEstimate |
इस सोर्स के लिए अनुमानित नतीजों की संख्या. |
resultCountExact |
इस सोर्स के लिए, नतीजों की सटीक संख्या. |