কুইকস্টার্ট: ডেভেলপার নলেজ এপিআই দিয়ে শুরু করুন

এই নির্দেশিকাটি আপনাকে দেখাবে কীভাবে ডেভেলপার নলেজ এপিআই (Developer Knowledge API) ব্যবহার শুরু করতে হয়। আপনি শিখবেন কীভাবে ডেভেলপার নলেজ এপিআই সক্রিয় করতে হয়, একটি এপিআই কী (API key) পেতে হয় এবং ডেভেলপার ডকুমেন্টেশন অনুসন্ধান ও পুনরুদ্ধার করার জন্য আপনার প্রথম এপিআই কলগুলো করতে হয়।

শুরু করার আগে

ডেভেলপার নলেজ এপিআই ব্যবহার শুরু করার আগে, নিম্নলিখিত ধাপগুলো সম্পন্ন করেছেন কিনা তা নিশ্চিত করুন।

এপিআই সক্রিয় করুন

  1. গুগল এপিআই লাইব্রেরিতে থাকা ডেভেলপার নলেজ এপিআই পৃষ্ঠাটি খুলুন।
  2. আপনি যে প্রকল্পে এপিআই (API) ব্যবহার করতে চান, সেটি সঠিকভাবে নির্বাচন করেছেন কিনা তা যাচাই করুন।
  3. সক্ষম করুন -এ ক্লিক করুন। API সক্ষম করতে বা ব্যবহার করতে কোনো নির্দিষ্ট IAM ভূমিকার প্রয়োজন নেই।

এপিআই কী তৈরি ও সুরক্ষিত করুন

  1. যে প্রজেক্টে আপনি API সক্রিয় করেছেন, সেটির Google Cloud কনসোলে Credentials পৃষ্ঠায় যান।
  2. Create credentials-এ ক্লিক করুন, এবং তারপর মেনু থেকে API key নির্বাচন করুন।
  3. Name ফিল্ডে কী-টির জন্য একটি নাম দিন।
  4. 'Select API restrictions' ড্রপ-ডাউনে ক্লিক করুন এবং তারপর 'Developer Knowledge API' টাইপ করুন। ফলাফলে ক্লিক করুন এবং তারপর 'OK'-তে ক্লিক করুন।
    • দ্রষ্টব্য: আপনি যদি এইমাত্র ডেভেলপার নলেজ এপিআই (Developer Knowledge API) চালু করে থাকেন, তবে এটি তালিকায় প্রদর্শিত হতে কিছুটা বিলম্ব হতে পারে। কয়েক মিনিট অপেক্ষা করে আবার চেষ্টা করুন।
  5. তৈরি করুন- এ ক্লিক করুন।

গ্রাউন্ডেড জেনারেশন দিয়ে একটি প্রশ্নের উত্তর দিন

একবার আপনার ডেভেলপার নলেজ এপিআই কী (Developer Knowledge API key) পেয়ে গেলে, আপনি এপিআই ব্যবহার করা শুরু করতে পারবেন। ডকুমেন্টেশনের উপর ভিত্তি করে কীভাবে একটি প্রশ্ন জিজ্ঞাসা করতে হয় এবং তার উত্তর পেতে হয়, তা নিম্নলিখিত উদাহরণে দেখানো হয়েছে:

  1. আপনার ডেভেলপার নলেজ এপিআই কী একটি এনভায়রনমেন্ট ভেরিয়েবলে সংরক্ষণ করুন:

    export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"
    

    YOUR_API_KEY এর জায়গায় আপনার তৈরি করা এপিআই কী-টি বসান।

  2. AnswerQuery এন্ডপয়েন্টটি কল করতে curl ব্যবহার করুন:

    curl -X POST "https://developerknowledge.googleapis.com/v1alpha:answerQuery?key=$DEVELOPERKNOWLEDGE_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{"query": "How do I create a BigQuery dataset?"}'
    

এই কমান্ডটি ডকুমেন্টেশনের উপর ভিত্তি করে আপনার প্রশ্নের উত্তর প্রদান করে।

ডকুমেন্টের খণ্ডাংশ অনুসন্ধান করুন

আপনি যদি তৈরি হওয়া উত্তরের পরিবর্তে ডকুমেন্টেশনের নির্দিষ্ট অংশ খুঁজে পেতে চান, তাহলে সরাসরি ডকুমেন্টের অংশগুলো দিয়ে অনুসন্ধান করতে পারেন।

SearchDocumentChunks এন্ডপয়েন্টটি কল করতে curl ব্যবহার করুন:

curl "https://developerknowledge.googleapis.com/v1/documents:searchDocumentChunks?query=BigQuery&key=$DEVELOPERKNOWLEDGE_API_KEY"

প্রতিক্রিয়াটিতে ডকুমেন্টেশন থেকে প্রাসঙ্গিক বিষয়বস্তুর অংশ এবং মূল ডকুমেন্টগুলোর রেফারেন্স অন্তর্ভুক্ত রয়েছে।

একটি নথি পুনরুদ্ধার করুন

searchDocumentChunks থেকে প্রাপ্ত রেসপন্সে ডকুমেন্ট চাঙ্কগুলোর একটি তালিকা থাকে। প্রতিটি ডকুমেন্ট চাঙ্কের একটি parent ফিল্ড থাকে, যাতে ডকুমেন্টটির রিসোর্স নেম থাকে, যা আপনি GetDocument সাথে ব্যবহার করে ডকুমেন্টটির সম্পূর্ণ কন্টেন্ট পুনরুদ্ধার করতে পারেন।

একটি ডকুমেন্ট পুনরুদ্ধার করতে, searchDocumentChunks দ্বারা ফেরত আসা চাঙ্কগুলোর একটি থেকে parent ফিল্ডটি কপি করে একটি এনভায়রনমেন্ট ভেরিয়েবলে সংরক্ষণ করুন, তারপর curl ব্যবহার করে GetDocument এন্ডপয়েন্টটি কল করুন:

export DOC_NAME="PARENT_FIELD_FROM_SEARCH"
curl "https://developerknowledge.googleapis.com/v1/$DOC_NAME?key=$DEVELOPERKNOWLEDGE_API_KEY"

এটি নির্দিষ্ট ডকুমেন্টটির সম্পূর্ণ মার্কডাউন কন্টেন্ট ফেরত দেয়।

এরপর কী?