এই নির্দেশিকাটি আপনাকে দেখাবে কীভাবে ডেভেলপার নলেজ এপিআই (Developer Knowledge API) ব্যবহার শুরু করতে হয়। আপনি শিখবেন কীভাবে ডেভেলপার নলেজ এপিআই সক্রিয় করতে হয়, একটি এপিআই কী (API key) পেতে হয় এবং ডেভেলপার ডকুমেন্টেশন অনুসন্ধান ও পুনরুদ্ধার করার জন্য আপনার প্রথম এপিআই কলগুলো করতে হয়।
শুরু করার আগে
এপিআই সক্রিয় করুন
- গুগল এপিআই লাইব্রেরিতে থাকা ডেভেলপার নলেজ এপিআই পৃষ্ঠাটি খুলুন।
- আপনি যে প্রকল্পে এপিআই (API) ব্যবহার করতে চান, সেটি সঠিকভাবে নির্বাচন করেছেন কিনা তা যাচাই করুন।
- সক্ষম করুন -এ ক্লিক করুন। API সক্ষম করতে বা ব্যবহার করতে কোনো নির্দিষ্ট IAM ভূমিকার প্রয়োজন নেই।
এপিআই কী তৈরি ও সুরক্ষিত করুন
- যে প্রজেক্টে আপনি API সক্রিয় করেছেন, সেটির Google Cloud কনসোলে Credentials পৃষ্ঠায় যান।
- Create credentials-এ ক্লিক করুন, এবং তারপর মেনু থেকে API key নির্বাচন করুন।
- Name ফিল্ডে কী-টির জন্য একটি নাম দিন।
- 'Select API restrictions' ড্রপ-ডাউনে ক্লিক করুন এবং তারপর 'Developer Knowledge API' টাইপ করুন। ফলাফলে ক্লিক করুন এবং তারপর 'OK'-তে ক্লিক করুন।
- দ্রষ্টব্য: আপনি যদি এইমাত্র ডেভেলপার নলেজ এপিআই (Developer Knowledge API) চালু করে থাকেন, তবে এটি তালিকায় প্রদর্শিত হতে কিছুটা বিলম্ব হতে পারে। কয়েক মিনিট অপেক্ষা করে আবার চেষ্টা করুন।
- তৈরি করুন- এ ক্লিক করুন।
ডকুমেন্টের খণ্ডাংশ অনুসন্ধান করুন
একবার আপনার ডেভেলপার নলেজ এপিআই কী (Developer Knowledge API key) পেয়ে গেলে, আপনি এপিআই ব্যবহার করা শুরু করতে পারবেন। নিচের উদাহরণটিতে দেখানো হয়েছে কীভাবে 'BigQuery' সম্পর্কিত ডকুমেন্ট চাঙ্ক (document chunks) অনুসন্ধান করতে হয়:
আপনার ডেভেলপার নলেজ এপিআই কী একটি এনভায়রনমেন্ট ভেরিয়েবলে সংরক্ষণ করুন:
export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"YOUR_API_KEYএর জায়গায় আপনার তৈরি করা এপিআই কী-টি বসান।searchDocumentChunksএন্ডপয়েন্টটি কল করতেcurlব্যবহার করুন:curl "https://developerknowledge.googleapis.com/v1alpha/documents:searchDocumentChunks?query=BigQuery&key=$DEVELOPERKNOWLEDGE_API_KEY"
এই কমান্ডটি কোয়েরির সাথে মেলে এমন ডকুমেন্ট খণ্ডাংশের একটি তালিকা ফেরত দেয়, যার মধ্যে প্রতিটি ডকুমেন্টের বিষয়বস্তুর অংশবিশেষ এবং তার parent অন্তর্ভুক্ত থাকে।
একটি নথি পুনরুদ্ধার করুন
searchDocumentChunks থেকে প্রাপ্ত রেসপন্সে ডকুমেন্ট চাঙ্কগুলোর একটি তালিকা থাকে। প্রতিটি ডকুমেন্ট চাঙ্কের একটি parent ফিল্ড থাকে, যা ব্যবহার করে আপনি GetDocument এর মাধ্যমে ডকুমেন্টটির সম্পূর্ণ কন্টেন্ট পুনরুদ্ধার করতে পারেন।
searchDocumentChunks কল দ্বারা ফেরত আসা ডকুমেন্ট চাঙ্কগুলোর একটির parent (যেমন, documents/developers.google.com/... ) কপি করে একটি এনভায়রনমেন্ট ভেরিয়েবলে সেভ করুন, এবং curl ব্যবহার করে ` GetDocument এন্ডপয়েন্টটি কল করুন:
export DOC_NAME="DOCUMENT_NAME"
curl "https://developerknowledge.googleapis.com/v1alpha/$DOC_NAME?key=$DEVELOPERKNOWLEDGE_API_KEY"
এটি নির্দিষ্ট ডকুমেন্টটির সম্পূর্ণ মার্কডাউন কন্টেন্ট ফেরত দেয়।
এরপর কী?
- অন্তর্ভুক্ত ডকুমেন্টেশনের সম্পূর্ণ তালিকা দেখতে কর্পাস রেফারেন্সটি অন্বেষণ করুন।
- এপিআই মেথড এবং প্যারামিটার সম্পর্কে আরও বিস্তারিত জানতে এপিআই রেফারেন্স ডকুমেন্টেশন দেখুন।