ডেভেলপার নলেজ এপিআই গুগলের পাবলিক ডেভেলপার ডকুমেন্টেশনে প্রোগ্রাম্যাটিক অ্যাক্সেস প্রদান করে, যা আপনাকে এই নলেজ বেসটি আপনার নিজস্ব অ্যাপ্লিকেশন এবং ওয়ার্কফ্লোতে একীভূত করতে সক্ষম করে।
সংক্ষিপ্ত বিবরণ
ডেভেলপার নলেজ এপিআই-কে গুগলের ডেভেলপার ডকুমেন্টেশনে মেশিন-পঠনযোগ্য অ্যাক্সেসের জন্য প্রামাণ্য উৎস হিসেবে ডিজাইন করা হয়েছে। এটি ডকুমেন্ট অনুসন্ধান ও পুনরুদ্ধার এবং প্রশ্নের উত্তর দেওয়ার জন্য ফাংশন সরবরাহ করে:
- একটি কোয়েরির উপর ভিত্তি করে প্রাসঙ্গিক পেজ ইউআরআই এবং কন্টেন্ট স্নিপেট খুঁজে বের করার জন্য
SearchDocumentChunksকরা হয়। - অনুসন্ধানের ফলাফলের সম্পূর্ণ বিষয়বস্তু পেতে
GetDocumentবাBatchGetDocumentsব্যবহার করুন। - ডকুমেন্টেশন কর্পাস থেকে নেওয়া কোয়েরিগুলোর উত্তর তৈরি করার জন্য
AnswerQuery।
ডেভেলপার নলেজ এপিআই অসংগঠিত মার্কডাউন কন্টেন্ট হিসেবে ডকুমেন্টেশন পেজ অনুসন্ধান এবং পুনরুদ্ধার করা সমর্থন করে। অনুসন্ধানযোগ্য কন্টেন্টের কর্পাসটি কর্পাস রেফারেন্সে তালিকাভুক্ত করা আছে।
ডেভেলপার জ্ঞান ব্যবহারের উপায়
আপনার কর্মপ্রবাহের উপর নির্ভর করে, আপনি নিম্নলিখিত মাধ্যমগুলোর মাধ্যমে ডেভেলপার নলেজ অ্যাক্সেস করতে পারেন:
- REST API এবং RPC API : সরাসরি HTTP বা gRPC এন্ডপয়েন্ট কল করুন। মেথড স্পেসিফিকেশনের জন্য REST রেফারেন্স এবং RPC রেফারেন্স দেখুন।
- ক্লায়েন্ট লাইব্রেরি : Python, Node.js, TypeScript, Go, Java, PHP এবং Ruby-এর অফিসিয়াল ক্লায়েন্ট লাইব্রেরি ব্যবহার করে আপনার অ্যাপ্লিকেশনগুলিতে ডেভেলপার নলেজ এপিআই (Developer Knowledge API) সংহত করুন।
- গুগল ক্লাউড সিএলআই (
gcloud): ডকুমেন্টের অংশবিশেষ অনুসন্ধান করতে, মার্কডাউন কন্টেন্ট আনতে এবং উত্তর তৈরি করতে আপনার টার্মিনাল থেকেgcloud developer-knowledgeকমান্ডগুলো চালান। - ডেভেলপার নলেজ এমসিপি সার্ভার : মডেল কনটেক্সট প্রোটোকল (এমসিপি) টুলস (
search_documents,get_documents, এবংanswer_query) ব্যবহার করে আপনার এআই কোডিং অ্যাসিস্ট্যান্ট বা এজেন্টকে গুগলের ডকুমেন্টেশনের সাথে সংযুক্ত করুন। এমসিপি রেফারেন্স দেখুন।
API এবং MCP সার্ভারের মধ্যে একটি বেছে নিন
ডেভেলপার নলেজ এপিআই এবং ডেভেলপার নলেজ এমসিপি সার্ভার বিভিন্ন ইন্টিগ্রেশন চাহিদা পূরণের জন্য ডিজাইন করা হয়েছে:
- নিম্নলিখিত ক্ষেত্রে ডেভেলপার নলেজ এপিআই, ক্লায়েন্ট লাইব্রেরি, বা জিক্লাউড সিএলআই ব্যবহার করুন :
- আপনার প্রজেক্টে কোনো এআই এজেন্ট ব্যবহার করা হয় না।
- আপনি আপনার এজেন্টের জন্য নিজস্ব টুল বা টুল সেট নির্ধারণ করতে চান।
- আপনি কোনো মডেলে ফলাফল পাঠানোর আগে সেগুলোকে প্রসেস বা একত্রিত করতে চান (উদাহরণস্বরূপ, সম্পূর্ণ কন্টেন্ট আনার আগে ডকুমেন্টের বাইট দৈর্ঘ্য যাচাই করা)।
- আপনাকে সার্চের ফলাফল ফিল্টার করতে হবে (যেমন
data_sourceবাupdate_timeঅনুযায়ী) অথবা ফিল্ড মাস্ক প্রয়োগ করতে হবে।
- ডেভেলপার নলেজ এমসিপি সার্ভার এবং এজেন্ট স্কিলটি নিম্নলিখিত ক্ষেত্রে ব্যবহার করুন :
- আপনি কাস্টম টুল ডেফিনিশন ও ডেসক্রিপশন না লিখেই একটি এআই কোডিং অ্যাসিস্ট্যান্ট বা এজেন্ট সংযোগ করতে চান।
- ডেভেলপার নলেজ এমসিপি সার্ভার নতুন সক্ষমতা যোগ করার সাথে সাথে আপনি স্বয়ংক্রিয় আপডেট চান।
- অনুসন্ধানের ফলাফলে কাস্টম মেটাডেটা ফিল্টারিংয়ের প্রয়োজন নেই।
এপিআই সক্রিয় করুন
ডেভেলপার নলেজ এপিআই ব্যবহার করতে হলে, প্রথমে আপনাকে আপনার গুগল ক্লাউড প্রোজেক্টের জন্য এটি সক্রিয় করতে হবে।
- গুগল এপিআই লাইব্রেরিতে থাকা ডেভেলপার নলেজ এপিআই পৃষ্ঠাটি খুলুন।
- আপনি যে প্রকল্পে এপিআই (API) ব্যবহার করতে চান, সেটি সঠিকভাবে নির্বাচন করেছেন কিনা তা যাচাই করুন।
- সক্ষম করুন -এ ক্লিক করুন। API সক্ষম করতে বা ব্যবহার করতে কোনো নির্দিষ্ট IAM ভূমিকার প্রয়োজন নেই।
প্রমাণীকরণ
আপনি নিম্নলিখিত পদ্ধতিগুলোর যেকোনো একটি ব্যবহার করে ডেভেলপার নলেজ এপিআই-এর অনুরোধগুলো প্রমাণীকরণ করতে পারেন:
- এপিআই কী (API key) : '
keyকোয়েরি প্যারামিটার অথবাX-Goog-Api-Keyহেডার ব্যবহার করে সরাসরি REST অনুরোধ বা ডেভেলপার নলেজ এমসিপি (Developer Knowledge MCP) সার্ভারকে প্রমাণীকরণ করুন। - অ্যাপ্লিকেশন ডিফল্ট ক্রেডেনশিয়ালস (ADC), OAuth 2.0, অথবা সার্ভিস অ্যাকাউন্ট : অফিসিয়াল ক্লায়েন্ট লাইব্রেরি বা প্রোডাকশন ওয়ার্কফ্লো ব্যবহার করার সময় অনুরোধগুলি প্রমাণীকরণ করে। ক্রেডেনশিয়াল সেট আপ করার বিষয়ে আরও জানতে, অ্যাপ্লিকেশন ডিফল্ট ক্রেডেনশিয়ালস ডকুমেন্টেশন দেখুন।
- ব্যবহারকারীর পরিচয়পত্র (gcloud CLI) :
gcloud auth loginব্যবহার করে আপনার Google Cloud অ্যাকাউন্টে সাইন ইন করে CLI অনুরোধগুলি প্রমাণীকরণ করুন। সেটআপ নির্দেশাবলীর জন্য gcloud CLI কুইকস্টার্ট দেখুন।
অন্তর্ভুক্ত নথিপত্র
এপিআই দ্বারা কোন কোন ডকুমেন্ট অনুসন্ধান করা হয়, সে সম্পর্কে তথ্যের জন্য কর্পাস রেফারেন্স দেখুন।
ডেভেলপার নলেজ এপিআই-এর লক্ষ্য হলো গুগলের সর্বশেষ ডেভেলপার ডকুমেন্টেশনে অ্যাক্সেস প্রদান করা। আমাদের উদ্দেশ্য হলো প্রকাশের ৪৮ ঘণ্টার মধ্যে কন্টেন্ট পুনরায় ইনডেক্স করা, যাতে নতুন বা আপডেট করা ডকুমেন্টেশন ২ কার্যদিবসের মধ্যে উপলব্ধ হয়।জ্ঞাত সীমাবদ্ধতা
- মার্কডাউনের গুণমান: মার্কডাউনটি মূল HTML থেকে তৈরি করা হয়েছে। এতে কিছু অমিল বা ফরম্যাটিং সমস্যা থাকতে পারে।
- বিষয়বস্তুর পরিধি: শুধুমাত্র কর্পাস রেফারেন্সের পাবলিক পেজগুলোই অন্তর্ভুক্ত। গিটহাব, ওপেন সোর্স সাইট, ব্লগ বা ইউটিউবের মতো অন্যান্য উৎসের বিষয়বস্তু অন্তর্ভুক্ত নয়।