رابط برنامهنویسی کاربردی (API) دانش توسعهدهندگان، دسترسی برنامهنویسیشده به اسناد عمومی توسعهدهندگان گوگل را فراهم میکند و شما را قادر میسازد تا این پایگاه دانش را در برنامهها و گردشهای کاری خود ادغام کنید.
نمای کلی
رابط برنامهنویسی کاربردی دانش توسعهدهندگان (Developer Knowledge API) به گونهای طراحی شده است که منبع اصلی دسترسی قابل خواندن توسط ماشین به اسناد توسعهدهندگان گوگل باشد. این رابط، توابعی برای جستجو و بازیابی اسناد و پاسخ به پرسشها ارائه میدهد:
-
SearchDocumentChunksبرای یافتن URI های صفحه و قطعه کدهای محتوا بر اساس یک پرس و جو. - برای دریافت محتوای کامل نتیجه(های) جستجو،
GetDocumentیاBatchGetDocumentsاستفاده کنید. -
AnswerQueryبرای دریافت پاسخ به پرسشهای مبتنی بر مجموعه مستندات.
برای شروع سریع، راهنمای شروع سریع را دنبال کنید.
مجموعه محتوای قابل جستجو در مرجع Corpus فهرست شده است.
رابط برنامهنویسی کاربردی دانش توسعهدهندگان (Developer Knowledge API) از جستجو و بازیابی صفحات مستندات به عنوان محتوای بدون ساختار Markdown پشتیبانی میکند.
فعال کردن API
برای استفاده از رابط برنامهنویسی کاربردی دانش توسعهدهندگان (Developer Knowledge API)، ابتدا باید آن را برای پروژه گوگل کلود خود فعال کنید.
- صفحه API دانش توسعهدهندگان را در کتابخانه APIهای گوگل باز کنید.
- بررسی کنید که پروژهی درستی را که قصد دارید در آن از API استفاده کنید، انتخاب کردهاید.
- روی فعال کردن کلیک کنید. برای فعال کردن یا استفاده از API، به هیچ نقش IAM خاصی نیاز نیست.
احراز هویت
برای استفاده از API دانش توسعهدهندگان، به یک کلید API دانش توسعهدهندگان نیاز است. برای ایجاد آن:
- در کنسول گوگل کلود مربوط به پروژهای که API را در آن فعال کردهاید، به صفحه اعتبارنامهها (Credentials) بروید.
- روی ایجاد اعتبارنامه کلیک کنید و سپس کلید API را از منو انتخاب کنید.
- در قسمت نام ، یک نام برای کلید وارد کنید.
- روی منوی کشویی «انتخاب محدودیتهای API» کلیک کنید و سپس عبارت «Developer Knowledge API» را تایپ کنید. روی نتیجه کلیک کنید و سپس روی «تأیید» کلیک کنید.
- توجه: اگر به تازگی رابط برنامهنویسی کاربردی دانش توسعهدهندگان (Developer Knowledge API) را فعال کردهاید، ممکن است نمایش آن در لیست با تأخیر مواجه شود. چند دقیقه صبر کنید و دوباره امتحان کنید.
- روی ایجاد کلیک کنید.
این کلید API دانش توسعهدهنده را در درخواستهای خود لحاظ کنید. برای مثال، فراخوانیهای REST باید آن را با استفاده از پارامتر پرسوجوی key لحاظ کنند. برای مثال به راهنمای شروع سریع مراجعه کنید.
مستندات گنجانده شده
برای اطلاعات بیشتر در مورد اینکه کدام اسناد توسط API جستجو میشوند، به مرجع Corpus مراجعه کنید.
محدودیتهای شناختهشده
- کیفیت Markdown: Markdown از HTML منبع تولید میشود. ممکن است برخی اختلافات یا مشکلات قالببندی وجود داشته باشد.
- محدوده محتوا: فقط صفحات عمومی در مرجع Corpus گنجانده شده است. محتوای منابع دیگر مانند GitHub، سایتهای OSS، وبلاگها یا YouTube شامل نمیشود.