एवरनोट एपीआई में नई कार्यक्षमता - findRelated (): संबंधित नोटों के लिए खोज करें

बहुत पहले नहीं, सैन फ्रांसिस्को में एवरनोट ट्रंक सम्मेलन में, हमने एक नए एपीआई फ़ंक्शन NoteStore.findRelated की घोषणा की, जिसका उपयोग स्वतंत्र डेवलपर्स और भागीदारों द्वारा किया जा सकता है। जैसा कि फ़ंक्शन के नाम का तात्पर्य है, यह ग्राहकों को नोट, नोटबुक और टैग का अनुरोध करने की अनुमति देता है जो किसी तरह स्रोत डेटा से संबंधित हैं (इनपुट पर ऐसा डेटा या तो किसी अन्य नोट या सादे पाठ का पहचानकर्ता हो सकता है)।

यह विचार है कि एवरनोट अधिक उपयोगी हो जाएगा यदि यह उपयोगकर्ता को अपने खाते से उस विषय पर तुरंत संकेत देता है जो वर्तमान में उसके लिए प्रासंगिक है। एक नया एपीआई फ़ंक्शन ऐसी जानकारी खोजने और प्रस्तुत करने में आसान बनाता है। आइए देखें कि यह फ़ंक्शन कैसे काम करता है।

Github पर आप एक उदाहरण पायथन एप्लिकेशन पा सकते हैं जो findRelated का उपयोग करता है। नीचे दिया गया कोड इस एप्लिकेशन से लिया गया है, इसलिए यदि आप चाहें, तो आप तुरंत उस पर जा सकते हैं।

मान लीजिए कि आप पहले से ही एवरनोट क्लाउड एपीआई के साथ प्रमाणित कर चुके हैं, और आपके पास एक नोट है जिसे आप स्रोत अनुरोध के रूप में उपयोग करना चाहते हैं। फिर अनुरोध कुछ इस तरह से लागू किया जाएगा:



हमारे प्राधिकरण टोकन के अलावा (परीक्षण के लिए डेवलपर टोकन दोनों और RelatedResultSpec माध्यम से प्राप्त टोकन), हमें दो ऑब्जेक्ट बनाने और पॉप्युलेट करने की आवश्यकता होगी जिन्हें हम खोजने के लिए मापदंडों के रूप में पास करेंगे: संबंधित RelatedQuery और संबंधित RelatedResultSpec ।

RelatedQuery

यह वर्ग हमें यह निर्दिष्ट करने की अनुमति देता है कि हम संबंधित नोटों की खोज के लिए इनपुट के रूप में वास्तव में क्या उपयोग करना चाहते हैं। उपरोक्त स्निपेट में, हमने विशेष रूप से अपरिभाषित तर्क parameter इंगित किया, जो या तो नोट या स्ट्रिंग हो सकता है। संबंधित व्यवसाय को परिभाषित करते RelatedQuery , यदि हमारे पास स्रोत डेटा के रूप में एक नोट है, तो हम इसके GUID का उपयोग करेंगे। फिर, फ़ंक्शन को कॉल करते समय पहले पैरामीटर के रूप में (जिसे हमारे उदाहरण में parameter कहा जाता है), हम टाइप नोट के ऑब्जेक्ट को पास करेंगे और इस GUID को noteGuid ऑब्जेक्ट के noteGuid विशेषता के रूप में निर्दिष्ट करेंगे। यदि पैरामीटर एक नोट नहीं है, तो हम इसे केवल एक स्ट्रिंग मानते हैं और इसके मान को plainText ऑब्जेक्ट के plainText विशेषता को असाइन करते हैं।

यह ध्यान देने योग्य है कि आप या तो plainText या noteGuid उपयोग कर सकते हैं; आप उन्हें एक ही समय में उपयोग नहीं कर सकते हैं या एक का उपयोग नहीं कर सकते हैं - इस मामले में सर्वर एक अपवाद फेंक देगा।

संबंधित काम के बारे में अधिक जानकारी के लिए, एपीआई सहायता RelatedQuery ।

RelatedResultSpec

RelatedResultSpec हमें RelatedResultSpec जाने वाले एवरनोट क्लाउड एपीआई द्वारा लौटाए गए परिणामों के प्रकार और संख्या को नियंत्रित करने की अनुमति देता है। हम निम्नलिखित मापदंडों में से एक या अधिक निर्दिष्ट कर सकते हैं:

• maxNotes
• maxNotebooks
• maxTags

उनके नामों से उनका उद्देश्य स्पष्ट है। यदि हम maxNotes संख्या में संख्या निर्दिष्ट करते हैं, तो हमें नोटों की संख्या (या कम) मिलती है। यह इसी तरह नोटपैड और लेबल के साथ काम करता है। यदि आप इस या उस पैरामीटर के लिए कोई मान निर्दिष्ट नहीं करते हैं, तो आपको संबंधित प्रकार के परिणाम प्राप्त नहीं होंगे।

हमारे उदाहरण में, हमने केवल maxNotes परिभाषित किया है। इसका मतलब यह है कि हमारे संबंधित। RelatedResult द्वारा findRelated हैं जिसमें नोटपैड या लेबल नहीं होंगे।

RelatedResultSpec पर अधिक जानकारी के लिए, एपीआई सहायता RelatedResultSpec ।

मामलों का उपयोग करें

यह एपीआई फ़ंक्शन कई स्थितियों में उपयोगी हो सकता है। एवरनोट में, हम अपने खाते से उपयोगकर्ताओं के नोट दिखाने के लिए अपने ब्राउज़र वेब findRelated में findRelated का उपयोग करते हैं जो वेबपेज को देखे जाने से संबंधित हो सकता है। वेब पेज के टुकड़े से एक नया नोट बनाते समय फ़ंक्शन का उपयोग "अनुमान लगाने" लेबल और नोटबुक में भी किया जाता है।

उदाहरण के लिए, यदि आप एक ऐसे एप्लिकेशन को विकसित कर रहे हैं जो नोट्स को पूरा करने और मीटिंग करने में माहिर है, तो findRelated वर्तमान दस्तावेज़ के समान मीटिंग नोट्स को जल्दी से देखने के लिए उपयोगी होगा। findRelated का उपयोग करना कई मामलों में उचित होगा, और आप अपेक्षाकृत कम श्रम लागत के साथ अपने आवेदन की उपयोगिता को काफी बढ़ा सकते हैं।

निष्कर्ष

यदि सब कुछ सुचारू रूप से चला गया, तो आपको 1-3 संबंधित नोटों के साथ हमारे मामले में एक RelatedResult वस्तु मिल जाएगी। ये नोट ऑब्जेक्ट हैं, इसलिए आप उनके नाम, GUID, मेटाडेटा, आदि का अनुरोध कर सकते हैं

findRelated फ़ंक्शन findRelated हमारे एपीआई प्रलेखन में पाया जा सकता है।

एवरनोट के साथ एकीकृत एप्लिकेशन विकसित करने पर हमारे एपीआई और अन्य जानकारी के साथ काम करने के बारे में अधिक जानकारी के लिए, हमारे डेवलपर साइट पर जाएं । और अगर आपने पहले से ही इस तरह की परियोजना पर काम शुरू कर दिया है, तो हमारी प्रतियोगिता में भाग लेना न भूलें और एवरनोट सब्सक्रिप्शन का उपयोग करने वाले पहले उपयोगकर्ताओं को आकर्षित करें।