इस गाइड में, Developer Knowledge API के फ़ंक्शन इस्तेमाल करने के तरीके के उदाहरण दिए गए हैं. जैसे, दस्तावेज़ खोजना, एक दस्तावेज़ वापस पाना, और बैच में कई दस्तावेज़ वापस पाना.
शुरू करने से पहले, पक्का करें कि आपने एपीआई चालू कर दिया हो और Developer Knowledge API पासकोड जनरेट कर लिया हो. साथ ही, अपने पासकोड को एनवायरमेंट वैरिएबल में सेव कर लिया हो:
export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"
SearchDocumentChunks वाले दस्तावेज़ खोजना
क्वेरी स्ट्रिंग से मेल खाने वाले दस्तावेज़ के हिस्सों को ढूंढने के लिए, documents.searchDocumentChunks
तरीके का इस्तेमाल करें. नतीजों में, दस्तावेज़ के कॉन्टेंट के कुछ हिस्से और एक parent रेफ़रंस शामिल होता है. इस रेफ़रंस का इस्तेमाल करके, दस्तावेज़ के पूरे कॉन्टेंट को वापस पाया जा सकता है.
यहां दिए गए उदाहरण में, "BigQuery" से मिलते-जुलते दस्तावेज़ों को खोजा गया है:
curl "https://developerknowledge.googleapis.com/v1/documents:searchDocumentChunks?query=BigQuery&key=$DEVELOPERKNOWLEDGE_API_KEY"
खोज के नतीजों को बेहतर बनाया जा सकता है. इसके लिए, pageSize जैसे पैरामीटर का इस्तेमाल करके, हर पेज पर नतीजों की संख्या को सीमित किया जा सकता है. साथ ही, pageToken का इस्तेमाल करके, अगले पेज पर जाया जा सकता है.
खोज के नतीजों को फ़िल्टर करना
खोज के नतीजों पर सख्त फ़िल्टर लागू करने के लिए, filter पैरामीटर का इस्तेमाल करें. फ़िल्टर, खोज के नतीजों के चंक से जुड़े दस्तावेज़ों के मेटाडेटा पर लागू होता है.
फ़िल्टर करने के लिए इस्तेमाल किए जा सकने वाले फ़ील्ड:
data_source(STRING): दस्तावेज़ का सोर्स, जैसे किdocs.cloud.google.com.update_time(TIMESTAMP): यह उस समय का टाइमस्टैंप होता है, जब दस्तावेज़ को आखिरी बार अपडेट किया गया था.uri(STRING): दस्तावेज़ का यूआरआई, जैसे किhttps://docs.cloud.google.com/bigquery/docs/tables.
ये ऑपरेटर इस्तेमाल किए जा सकते हैं:
- STRING फ़ील्ड में, पूरी स्ट्रिंग के एग्ज़ैक्ट मैच के लिए
=(बराबर है) और!=(बराबर नहीं है) ऑपरेटर काम करते हैं. - TIMESTAMP फ़ील्ड में
=,<,<=,>, और>=इस्तेमाल किए जा सकते हैं. टाइमस्टैंप, आरएफ़सी-3339 फ़ॉर्मैट में होने चाहिए. उदाहरण के लिए,"2025-01-01T00:00:00Z".
AND, OR, और NOT (या -) लॉजिकल ऑपरेटर का इस्तेमाल करके, एक्सप्रेशन को एक साथ लिखा जा सकता है. ध्यान दें कि OR की प्राथमिकता AND से ज़्यादा होती है.
यहां दिए गए उदाहरण में, "BigQuery" से मिलते-जुलते दस्तावेज़ खोजे गए हैं. साथ ही, नतीजों को docs.cloud.google.com से मिले दस्तावेज़ों तक सीमित किया गया है:
curl "https://developerknowledge.googleapis.com/v1/documents:searchDocumentChunks?query=BigQuery&filter=data_source%3D%22docs.cloud.google.com%22&key=$DEVELOPERKNOWLEDGE_API_KEY"
GetDocument की मदद से कोई दस्तावेज़ वापस पाना
किसी एक दस्तावेज़ का पूरा कॉन्टेंट वापस पाने के लिए, documents.get तरीके का इस्तेमाल करें.
यहां दिए गए उदाहरण में, documents/DOCUMENT_ID नाम का दस्तावेज़ वापस पाया जाता है:
curl "https://developerknowledge.googleapis.com/v1/documents:get?name=documents/DOCUMENT_ID&key=$DEVELOPERKNOWLEDGE_API_KEY"
जवाब, Document संसाधन का पूरा जवाब होता है. इसमें content फ़ील्ड भी शामिल होता है.
BatchGetDocuments की मदद से एक से ज़्यादा दस्तावेज़ों को वापस पाना
एक ही एपीआई कॉल में, नाम के हिसाब से ज़्यादा से ज़्यादा 100 दस्तावेज़ वापस पाने के लिए, documents.batchGet तरीके का इस्तेमाल करें. यह GetDocument के लिए कई अनुरोध करने से ज़्यादा असरदार है.
यहां दिए गए उदाहरण में, नाम के हिसाब से दो दस्तावेज़ों को वापस पाया गया है:
curl "https://developerknowledge.googleapis.com/v1/documents:batchGet?names=documents/DOCUMENT_ID_1&names=documents/DOCUMENT_ID_2&key=$DEVELOPERKNOWLEDGE_API_KEY"
जवाब में, अनुरोध किए गए Document संसाधनों की सूची शामिल होती है.