Developer Knowledge API की क्लाइंट लाइब्रेरी

इस पेज पर, Developer Knowledge API के लिए Cloud Client Libraries का इस्तेमाल शुरू करने का तरीका बताया गया है. क्लाइंट लाइब्रेरी, रॉ एचटीटीपी अनुरोध बनाने के बजाय, मुहावरेदार टाइप, पहले से मौजूद पुष्टि करने की सुविधा, अपने-आप पेज नंबर डालने की सुविधा, और फिर से कोशिश करने की सुविधा देती हैं. इससे आपको कम कोड लिखना पड़ता है.

Google APIs की क्लाइंट लाइब्रेरी के बारे में ज़्यादा जानने के लिए, क्लाइंट लाइब्रेरी के बारे में जानकारी लेख पढ़ें.

सलाह: दस्तावेज़ के चंक खोजने, दस्तावेज़ों को वापस पाने, और भरोसेमंद जवाब जनरेट करने के लिए, Go, Java, Node.js, और Python के पूरे कोड सैंपल देखने के लिए, क्विकस्टार्ट: Developer Knowledge API के साथ क्लाइंट लाइब्रेरी का इस्तेमाल करना देखें.

क्लाइंट लाइब्रेरी इंस्टॉल करना

Developer Knowledge API की आधिकारिक क्लाइंट लाइब्रेरी इंस्टॉल करने के लिए, अपनी प्रोग्रामिंग भाषा चुनें:

ऐप पर जाएं

अपने Go प्रोजेक्ट में मॉड्यूल जोड़ें:

go get cloud.google.com/go/developerknowledge/apiv1

ज़्यादा जानने के लिए, Go डेवलपमेंट एनवायरमेंट सेट अप करना लेख पढ़ें.

Java

अगर Maven का इस्तेमाल किया जाता है, तो अपनी pom.xml फ़ाइल में यह डिपेंडेंसी जोड़ें:

<dependency>
  <groupId>com.google.cloud</groupId>
  <artifactId>google-cloud-developer-knowledge</artifactId>
  <version>0.6.0</version>
</dependency>

अगर Gradle का इस्तेमाल किया जाता है, तो अपनी build.gradle फ़ाइल में यह डिपेंडेंसी जोड़ें:

implementation 'com.google.cloud:google-cloud-developer-knowledge:0.6.0'

ज़्यादा जानने के लिए, Java डेवलपमेंट एनवायरमेंट सेट अप करना लेख पढ़ें.

Node.js और TypeScript

npm का इस्तेमाल करके पैकेज इंस्टॉल करें:

npm install @google/developer-knowledge

ज़्यादा जानने के लिए, Node.js डेवलपमेंट एनवायरमेंट सेट अप करना लेख पढ़ें.

PHP

Composer का इस्तेमाल करके पैकेज इंस्टॉल करें:

composer require google/developer-knowledge

ज़्यादा जानने के लिए, Google Cloud पर PHP का इस्तेमाल करना लेख पढ़ें.

Python

pip का इस्तेमाल करके पैकेज इंस्टॉल करें:

pip install --upgrade google-developer-knowledge

ज़्यादा जानने के लिए, Python डेवलपमेंट एनवायरमेंट सेट अप करना लेख पढ़ें.

Ruby

जेम इंस्टॉल करें:

gem install google-developers-developer_knowledge

ज़्यादा जानने के लिए, Ruby डेवलपमेंट एनवायरमेंट सेट अप करना लेख पढ़ें.

पुष्टि करने की सुविधा सेट अप करना

एपीआई से अनुरोध करने से पहले, पक्का करें कि आपने अपने Google Cloud प्रोजेक्ट में Developer Knowledge API चालू किया हो.

Developer Knowledge API को किए गए कॉल की पुष्टि करने के लिए, क्लाइंट लाइब्रेरी ऐप्लिकेशन के डिफ़ॉल्ट क्रेडेंशियल (एडीसी) का इस्तेमाल करती हैं. लाइब्रेरी, तय की गई जगहों पर क्रेडेंशियल ढूंढती हैं. साथ ही, उन क्रेडेंशियल का इस्तेमाल करके, एपीआई के अनुरोधों की पुष्टि करती हैं. एडीसी की मदद से, अपने ऐप्लिकेशन के लिए क्रेडेंशियल उपलब्ध कराए जा सकते हैं. इसके लिए, आपको ऐप्लिकेशन कोड में बदलाव करने की ज़रूरत नहीं होती. क्रेडेंशियल को अलग-अलग एनवायरमेंट में उपलब्ध कराया जा सकता है. जैसे, लोकल डेवलपमेंट या प्रोडक्शन.

प्रोडक्शन एनवायरमेंट के लिए, एडीसी को सेट अप करने का तरीका सेवा और कॉन्टेक्स्ट पर निर्भर करता है:

• Google Cloud एनवायरमेंट: जब आपका ऐप्लिकेशन Cloud Run, Google Kubernetes Engine, Compute Engine या Cloud Run फ़ंक्शन पर चलता है, तो एडीसी, कंप्यूट रिसोर्स से जुड़े सेवा खाते का इस्तेमाल अपने-आप करता है.
• बाहरी या कंपनी की इमारत में एनवायरमेंट: Workload Identity Federation का इस्तेमाल करें या GOOGLE_APPLICATION_CREDENTIALS एनवायरमेंट वैरिएबल को क्रेडेंशियल कॉन्फ़िगरेशन फ़ाइल के पाथ पर सेट करें.

प्रोडक्शन क्रेडेंशियल के विकल्पों के बारे में ज़्यादा जानने के लिए, ऐप्लिकेशन के डिफ़ॉल्ट क्रेडेंशियल सेट अप करना लेख पढ़ें.

लोकल डेवलपमेंट एनवायरमेंट के लिए, अपने Google खाते से जुड़े क्रेडेंशियल का इस्तेमाल करके एडीसी सेट अप किया जा सकता है:

1. gcloud सीएलआई को इंस्टॉल करें और इस्तेमाल शुरू करें.

2. अपने Google खाते के लिए, स्थानीय पुष्टि करने के क्रेडेंशियल बनाएं:

   gcloud auth application-default login
   

   आपको साइन-इन करने की स्क्रीन दिखेगी. साइन इन करने के बाद, आपके क्रेडेंशियल उस लोकल क्रेडेंशियल फ़ाइल में सेव किए जाते हैं जिसका इस्तेमाल ADC करता है.

अन्य संसाधन

हर क्लाइंट लाइब्रेरी के लिए, एपीआई के संदर्भ दस्तावेज़, कोड के सैंपल, सबसे सही तरीके, समस्या ट्रैकर, और सोर्स कोड रिपॉज़िटरी के लिंक ढूंढने के लिए, भाषा टैब चुनें:

ऐप पर जाएं

यहां दी गई सूची में, Go के लिए क्लाइंट लाइब्रेरी से जुड़े अन्य संसाधनों के लिंक दिए गए हैं:

• एपीआई का संदर्भ
• pkg.go.dev पर पैकेज
• GitHub पर कोड के सैंपल
• क्लाइंट लाइब्रेरी इस्तेमाल करने के सबसे सही तरीके
• समस्या ट्रैकर
• सोर्स कोड

Java

यहां Java के लिए क्लाइंट लाइब्रेरी से जुड़े अन्य संसाधनों के लिंक दिए गए हैं:

• एपीआई का संदर्भ
• Maven Central पर आर्टफ़ैक्ट
• GitHub पर कोड के सैंपल
• क्लाइंट लाइब्रेरी इस्तेमाल करने के सबसे सही तरीके
• समस्या ट्रैकर
• सोर्स कोड

Node.js और TypeScript

यहां दी गई सूची में, Node.js और TypeScript के लिए क्लाइंट लाइब्रेरी से जुड़े अन्य संसाधनों के लिंक दिए गए हैं:

• npm पर पैकेज
• GitHub पर कोड के सैंपल
• क्लाइंट लाइब्रेरी इस्तेमाल करने के सबसे सही तरीके
• समस्या ट्रैकर
• सोर्स कोड

PHP

यहां दी गई सूची में, PHP के लिए क्लाइंट लाइब्रेरी से जुड़े अन्य संसाधनों के लिंक दिए गए हैं:

• एपीआई का संदर्भ
• Packagist पर पैकेज
• GitHub पर कोड के सैंपल
• क्लाइंट लाइब्रेरी इस्तेमाल करने के सबसे सही तरीके
• समस्या ट्रैकर
• सोर्स कोड

Python

यहां Python के लिए क्लाइंट लाइब्रेरी से जुड़े अन्य संसाधनों के लिंक दिए गए हैं:

• एपीआई का संदर्भ
• PyPI पर पैकेज
• GitHub पर कोड के सैंपल
• क्लाइंट लाइब्रेरी इस्तेमाल करने के सबसे सही तरीके
• समस्या ट्रैकर
• सोर्स कोड

Ruby

यहां दी गई सूची में, Ruby के लिए क्लाइंट लाइब्रेरी से जुड़े अन्य संसाधनों के लिंक दिए गए हैं:

• एपीआई का संदर्भ
• RubyGems पर Gem
• GitHub पर कोड के सैंपल
• क्लाइंट लाइब्रेरी इस्तेमाल करने के सबसे सही तरीके
• समस्या ट्रैकर
• सोर्स कोड

आगे क्या करना है

• AnswerQuery, SearchDocumentChunks, GetDocument, और BatchGetDocuments के लिए कोड के सैंपल देखने और उन्हें चलाने के लिए, क्लाइंट लाइब्रेरी के क्विकस्टार्ट को फ़ॉलो करें.
• दस्तावेज़ों को खोजना और वापस पाना लेख में, क्वेरी फ़िल्टर, पेज नंबर, और फ़ील्ड मास्क के बारे में ज़्यादा जानें.
• दस्तावेज़ से जवाब जनरेट करें सुविधा के साथ, भरोसेमंद सोर्स से जानकारी जनरेट करने की सुविधा का इस्तेमाल करें.
• गड़बड़ी ठीक करने, अनुरोध संख्या सीमित करने, और कोटा मैनेज करने में, फिर से कोशिश करने की रणनीतियों और स्टेटस कोड की समीक्षा करें.
• इस्तेमाल किए जा सकने वाले सभी दस्तावेज़ डोमेन देखने के लिए, कॉर्पस रेफ़रंस ब्राउज़ करें.