কুইকস্টার্ট: Developer Knowledge API ব্যবহার করা শুরু করুন

এই নির্দেশিকা থেকে আপনি Developer Knowledge API কীভাবে ব্যবহার করা শুরু করবেন তা জানতে পারবেন। আপনি কীভাবে Developer Knowledge API চালু করবেন, API কী পাবেন এবং ডেভেলপার ডকুমেন্টেশন সার্চ ও রিট্রিভ করার জন্য আপনার প্রথম API কল করবেন তা জানবেন।

শুরু করার আগে

Developer Knowledge API ব্যবহার করা শুরু করার আগে, নিম্নলিখিত ধাপগুলি সম্পূর্ণ করেছেন কিনা তা ভালোভাবে দেখে নিন।

API চালু করুন

  1. Google APIs লাইব্রেরিতে Developer Knowledge API পৃষ্ঠা খুলুন।
  2. আপনি যে প্রোজেক্টে API ব্যবহার করতে চান সেটি বেছে নিয়েছেন কিনা তা চেক করে দেখুন।
  3. চালু করুন বিকল্পে ক্লিক করুন। API চালু বা ব্যবহার করার জন্য কোনও নির্দিষ্ট IAM ভূমিকা প্রয়োজন হয় না।

API কী তৈরি ও সুরক্ষিত করা

  1. আপনি যে প্রোজেক্টের জন্য API চালু করেছেন, সেটির Google Cloud Console-এ গিয়ে ক্রেডেনশিয়াল পেজে যান।
  2. ক্রেডেনশিয়াল তৈরি করুন বিকল্পে ক্লিক করুন এবং তারপর মেনু থেকে API কী বিকল্প বেছে নিন।
  3. নাম ফিল্ডে, কীয়ের একটি নাম দিন।

  4. API বিধিনিষেধ বেছে নিন ড্রপ-ডাউনে ক্লিক করুন এবং তারপরে Developer Knowledge API টাইপ করুন। ফলাফলে ক্লিক করুন, তারপরে ঠিক আছে বিকল্পে ক্লিক করুন।

    মনে রাখবেন:

    • আপনি যদি এইমাত্র Developer Knowledge API চালু করে থাকেন, তাহলে এটি তালিকায় দেখাতে কিছুটা সময় লাগতে পারে। কয়েক মিনিট অপেক্ষা করে আবার চেষ্টা করুন।
    • আপনার AI ক্লায়েন্টের সাধারণ মডেল কলের (যেমন, GEMINI_API_KEY) জন্য এই একই কী ব্যবহার করার পরিকল্পনা করলে, আপনাকে অবশ্যই জেনারেটিভ ল্যাঙ্গুয়েজ API বেছে নিতে হবে। অন্যথায়, সেইসব কল ব্লক করা হবে।
  5. তৈরি করুন বিকল্পে ক্লিক করুন।

ডকুমেন্টেশন থেকে উত্তর তৈরি করা

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

  1. পরিবেশগত ভেরিয়েবলে আপনার Developer Knowledge API কী সেভ করুন:

    export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

    আপনার জেনারেট করা API key দিয়ে YOUR_API_KEY পরিবর্তন করুন।

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

    curl -X POST "https://developerknowledge.googleapis.com/v1: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 ফিল্ড কপি করুন এবং এটি এনভায়রনমেন্ট ভেরিয়েবলে সেভ করুন, তারপর GetDocument এন্ডপয়েন্ট কল করতে curl ব্যবহার করুন:

export DOC_NAME="PARENT_FIELD_FROM_SEARCH"

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

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

এর পরে কী করতে হবে