Developer Knowledge API

Developer Knowledge API, Google-এর সর্বজনীন ডেভেলপার ডকুমেন্টেশনে প্রোগ্র্যামাটিক অ্যাক্সেস প্রদান করে, যা আপনাকে এই নলেজ বেসকে আপনার নিজস্ব অ্যাপ্লিকেশন এবং ওয়ার্কফ্লোতে ইন্টিগ্রেট করতে সক্ষম করে।

এক নজরে

Developer Knowledge API-কে Google-এর ডেভেলপার ডকুমেন্টেশনে মেশিনের ক্ষেত্রে গ্রহণযোগ্য অ্যাক্সেসের জন্য ক্যানোনিকাল সোর্স হিসেবে ডিজাইন করা হয়েছে। এটি ডকুমেন্ট সার্চ ও রিট্রিভ করা এবং কোয়েরির উত্তর দেওয়ার জন্য ফাংশন অফার করে:

• কোয়েরির ভিত্তিতে প্রাসঙ্গিক পৃষ্ঠার URI ও কন্টেন্ট স্নিপেট খুঁজে পেতে SearchDocumentChunks-কে বলুন।
• GetDocument অথবা BatchGetDocuments বিকল্পে ট্যাপ করে সার্চ ফলাফলের সম্পূর্ণ কন্টেন্ট দেখুন।
• AnswerQuery ডকুমেন্টেশন কর্পাস থেকে নেওয়া কোয়েরির উত্তর জেনারেট করতে।

Developer Knowledge API, আনস্ট্রাকচার্ড মার্কডাউন কন্টেন্ট হিসেবে ডকুমেন্টেশন পৃষ্ঠা সার্চ ও রিট্রিভ করার সুবিধা প্রদান করে। সার্চ করা যায় এমন কন্টেন্টের কর্পাস কর্পাস রেফারেন্স-এ তালিকাভুক্ত করা আছে।

ডেভেলপার নলেজ ব্যবহার করার উপায়

আপনার ওয়ার্কফ্লোর উপর নির্ভর করে নিম্নলিখিত সারফেসের মাধ্যমে আপনি Developer Knowledge অ্যাক্সেস করতে পারবেন:

• REST API এবং RPC API: সরাসরি HTTP বা gRPC এন্ডপয়েন্ট কল করুন। পদ্ধতি সংক্রান্ত স্পেসিফিকেশনের জন্য REST রেফারেন্স এবং RPC রেফারেন্স দেখুন।
• ক্লায়েন্ট লাইব্রেরি: C#, Go, Java, Node.js এবং TypeScript, PHP, Python ও Ruby-এর জন্য অফিসিয়াল ক্লায়েন্ট লাইব্রেরি ব্যবহার করে আপনার অ্যাপ্লিকেশনে Developer Knowledge API ইন্টিগ্রেট করুন।
• Google Cloud CLI (gcloud): ডকুমেন্ট চাঙ্ক সার্চ করতে, Markdown কন্টেন্ট ফেচ করতে এবং উত্তর জেনারেট করতে আপনার টার্মিনাল থেকে gcloud developer-knowledge কমান্ড রান করুন।
• ডেভেলপার নলেজ MCP সার্ভার: Model Context Protocol (MCP) টুল (search_documents, get_documents ও answer_query) ব্যবহার করে আপনার AI কোডিং অ্যাসিস্ট্যান্ট বা এজেন্টকে Google-এর ডকুমেন্টেশনের সাথে কানেক্ট করুন। MCP রেফারেন্স দেখুন।

পরামর্শ: আপনি AI কোডিং অ্যাসিস্ট্যান্ট ব্যবহার করলে, npx skills add google/skills --skill retrieving-developer-knowledge রান করে retrieving-developer-knowledge এজেন্ট স্কিল ইনস্টল করুন। এই স্কিল আপনার অ্যাসিস্ট্যান্টকে কোন Developer Knowledge MCP সার্ভার টুল বেছে নিতে হবে, কীভাবে সমস্যা সমাধান করতে হবে এবং MCP সার্ভার উপলভ্য না থাকলে কীভাবে curl-এর মাধ্যমে REST API কল করতে হবে সেই বিষয়ে বিল্ট-ইন নির্দেশাবলী দেয়। আরও জানতে, ডেভেলপার নলেজ এজেন্ট স্কিল ব্যবহার করুন দেখুন।

API ও MCP সার্ভারের মধ্যে থেকে বেছে নিন

Developer Knowledge API এবং Developer Knowledge MCP সার্ভার বিভিন্ন ইন্টিগ্রেশনের প্রয়োজনীয়তার জন্য ডিজাইন করা হয়েছে:

• এগুলি হলে Developer Knowledge API, ক্লায়েন্ট লাইব্রেরি বা gcloud CLI ব্যবহার করুন:
  • আপনার প্রোজেক্টে AI এজেন্ট ব্যবহার করা হয় না।
  • আপনি নিজের এজেন্টের জন্য কাস্টম টুল বা টুল সেট নির্ধারণ করতে চান।
  • আপনি কোনও মডেলে ফলাফল পাঠানোর আগে সেগুলি প্রসেস বা একত্রিত করতে চান (যেমন, সম্পূর্ণ কন্টেন্ট ফেচ করার আগে ডকুমেন্ট বাইট দৈর্ঘ্য চেক করা)।
  • আপনাকে সার্চ ফলাফল ফিল্টার করতে (যেমন, data_source বা update_time দ্বারা) অথবা ফিল্ড মাস্ক প্রয়োগ করতে হবে।
• Developer Knowledge MCP সার্ভার ও এজেন্ট স্কিল ব্যবহার করুন যখন:
  • আপনি কাস্টম টুল সংজ্ঞা ও বিবরণ না লিখে AI কোডিং অ্যাসিস্ট্যান্ট বা এজেন্ট কানেক্ট করতে চান।
  • Developer Knowledge MCP সার্ভার নতুন ক্ষমতা যোগ করার সাথে সাথে আপনি অটোমেটিক আপডেট চান।
  • সার্চ ফলাফলে কাস্টম মেটাডেটা ফিল্টার করার প্রয়োজন নেই।

API চালু করুন

Developer Knowledge API ব্যবহার করতে, আপনাকে প্রথমে আপনার Google Cloud প্রোজেক্টের জন্য এটি চালু করতে হবে।

পরামর্শ: আপনার Google Cloud প্রোজেক্ট না থাকলে, Google Cloud বা Firebase নির্দেশাবলী ব্যবহার করে একটি তৈরি করুন।

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

যাচাইকরণ

আপনি নিম্নলিখিত পদ্ধতির মধ্যে একটি ব্যবহার করে Developer Knowledge API-তে অনুরোধ যাচাই করতে পারেন:

• API কী: key কোয়েরি প্যারামিটার বা X-Goog-Api-Key হেডার ব্যবহার করে সরাসরি REST অনুরোধ বা Developer Knowledge MCP সার্ভার যাচাই করুন।
• অ্যাপ্লিকেশন ডিফল্ট ক্রেডেনশিয়াল (ADC), OAuth 2.0 বা পরিষেবা অ্যাকাউন্ট: অফিসিয়াল ক্লায়েন্ট লাইব্রেরি বা প্রোডাকশন ওয়ার্কফ্লো ব্যবহার করার সময় অনুরোধ যাচাই করুন। ক্রেডেনশিয়াল সেট-আপ করার ব্যাপারে আরও জানতে, অ্যাপ্লিকেশন ডিফল্ট ক্রেডেনশিয়াল ডকুমেন্টেশন দেখুন।
• ব্যবহারকারীর ক্রেডেনশিয়াল (gcloud CLI): আপনার Google Cloud অ্যাকাউন্টে সাইন-ইন করে gcloud auth login CLI অনুরোধ প্রমাণ করুন। সেট-আপ সংক্রান্ত নির্দেশাবলীর জন্য gcloud CLI কুইকস্টার্ট দেখুন।

OAuth স্কোপ

OAuth 2.0 বা পরিষেবা অ্যাকাউন্টের মাধ্যমে যাচাই করার সময়, Developer Knowledge API এবং Developer Knowledge MCP সার্ভার নিম্নলিখিত OAuth স্কোপ গ্রহণ করে:

• https://www.googleapis.com/auth/cloud-platform: অ্যাপ্লিকেশন ডিফল্ট ক্রেডেনশিয়াল (ADC), gcloud CLI এবং অফিসিয়াল Google Cloud ক্লায়েন্ট লাইব্রেরি দ্বারা ব্যবহৃত ডিফল্ট স্কোপ।
• https://www.googleapis.com/auth/devprofiles.full_control: scope used for user OAuth 2.0 consent flows and MCP server integrations.
• https://www.googleapis.com/auth/developerprofiles.readonly: শুধু-পড়ার-উপযোগী স্কোপ পরিষেবা অ্যাকাউন্ট এবং ক্রেডেনশিয়ালের জন্য কাজ করে যার জন্য ব্যবহারকারীর OAuth সম্মতি সংক্রান্ত স্ক্রিনের প্রয়োজন হয় না।

বিয়ারার টোকেন অনুমোদন

পরিষেবা অ্যাকাউন্ট বা OAuth 2.0 অ্যাক্সেস টোকেন দিয়ে সরাসরি REST অনুরোধ যাচাই করতে, Authorization: Bearer হেডারে টোকেন পাস করুন এবং X-Goog-User-Project-এ আপনার বিলিং প্রোজেক্ট নির্দিষ্ট করুন:

export ACCESS_TOKEN=$(gcloud auth print-access-token)
curl -X POST "https://developerknowledge.googleapis.com/v1:answerQuery" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "X-Goog-User-Project: PROJECT_ID" \
  -H "Content-Type: application/json" \
  -d '{"query": "How do I create a BigQuery dataset?"}'

PROJECT_ID-এর জায়গায় আপনার Google Cloud প্রোজেক্ট আইডি লিখুন।

Python, Node.js, Go এবং Java অ্যাপ্লিকেশনের জন্য, অফিসিয়াল ক্লায়েন্ট লাইব্রেরি অ্যাপ্লিকেশন ডিফল্ট ক্রেডেনশিয়াল (ADC) এবং টোকেন রিফ্রেশ অটোমেটিক ম্যানেজ করে। উদাহরণস্বরূপ, Developer Knowledge API-এর সাথে ক্লায়েন্ট লাইব্রেরি ব্যবহার করুন লিঙ্কটি দেখুন।

অন্তর্ভুক্ত ডকুমেন্টেশন

API কোন কোন ডকুমেন্ট সার্চ করে সেই তথ্য পেতে কর্পাস রেফারেন্স দেখুন।

Developer Knowledge API-এর লক্ষ্য হল লেটেস্ট Google ডেভেলপার ডকুমেন্টেশনে অ্যাক্সেস প্রদান করা। আমাদের লক্ষ্য হল, কন্টেন্ট প্রকাশ করার ৪৮ ঘণ্টার মধ্যে সেটিকে আবার ইন্ডেক্স করা যাতে নতুন বা আপডেট করা ডকুমেন্টেশন ২ কর্মদিবসের মধ্যে উপলভ্য হয়।

পরিচিত সীমাবদ্ধতা

• মার্কডাউন কোয়ালিটি: সোর্স HTML থেকে মার্কডাউন জেনারেট করা হয়। কিছু অসঙ্গতি বা ফর্ম্যাটিং সংক্রান্ত সমস্যা থাকতে পারে।
• কন্টেন্টের পরিধি: Corpus রেফারেন্স-এ শুধুমাত্র সর্বজনীন পৃষ্ঠা অন্তর্ভুক্ত করা হয়েছে। GitHub, OSS সাইট, ব্লগ বা YouTube-এর মতো অন্যান্য সোর্স থেকে নেওয়া কন্টেন্ট অন্তর্ভুক্ত করা হয় না।