Developer Knowledge API, Google'ın herkese açık geliştirici belgelerine programatik erişim sağlayarak bu bilgi tabanını kendi uygulamalarınıza ve iş akışlarınıza entegre etmenize olanak tanır.
Genel Bakış
Developer Knowledge API, Google'ın geliştirici belgelerine makine tarafından okunabilir erişim için standart kaynak olarak tasarlanmıştır. Belgeleri arama ve alma, sorguları yanıtlama gibi işlevler sunar:
SearchDocumentChunksSorguya göre alakalı sayfa URI'lerini ve içerik snippet'lerini bulmak için kullanılır.- Arama sonuçlarının tamamını getirmek için
GetDocumentveyaBatchGetDocumentssimgesini tıklayın. AnswerQuery: Doküman gövdesine dayalı sorgulara yanıt almak için kullanılır.
Hızlı bir başlangıç için Hızlı Başlangıç Kılavuzu'nu inceleyin.
Aranabilir içerik derlemi, Corpus reference (Derlem referansı) bölümünde listelenir.
Developer Knowledge API, doküman sayfalarının yapılandırılmamış Markdown içeriği olarak aranmasını ve alınmasını destekler.
API'yi etkinleştirme
Developer Knowledge API'yi kullanmak için önce Google Cloud projenizde etkinleştirmeniz gerekir.
- Google API'leri kitaplığında Developer Knowledge API sayfasını açın.
- API'yi kullanmayı planladığınız projeyi doğru seçtiğinizden emin olun.
- Etkinleştir'i tıklayın. API'yi etkinleştirmek veya kullanmak için belirli IAM rolleri gerekmez.
Kimlik doğrulama
Developer Knowledge API'yi kullanmak için Developer Knowledge API anahtarı gerekir. Oluşturmak için:
- API'yi etkinleştirdiğiniz projenin Google Cloud Console'unda Kimlik Bilgileri sayfasına gidin.
- Kimlik bilgisi oluştur'u tıklayın ve menüden API anahtarı'nı seçin.
- Ad alanında anahtara bir ad verin.
-
API kısıtlamalarını seçin açılır listesini tıklayın ve Developer Knowledge API yazın. Sonucu ve ardından Tamam'ı tıklayın.
Notlar:
- Geliştirici Bilgisi API'sini yeni etkinleştirdiyseniz listede görünmesi biraz zaman alabilir. Birkaç dakika bekleyip tekrar deneyin.
-
Bu anahtarı yapay zeka istemcinizin genel model çağrıları (ör.
GEMINI_API_KEY) için de kullanmayı planlıyorsanız Generative Language API'yi de seçmeniz gerekir. Aksi takdirde bu aramalar engellenir.
- Oluştur'u tıklayın.
Bu Developer Knowledge API anahtarını isteklerinize ekleyin. Örneğin, REST çağrıları key sorgu parametresi kullanılarak dahil edilmelidir. Örnek için Hızlı Başlangıç Kılavuzu'na bakın.
Dahil edilen belgeler
API'nin hangi belgelerde arama yaptığı hakkında bilgi edinmek için Corpus referansı'na bakın.
Bilinen sınırlamalar
- Markdown Kalitesi: Markdown, kaynak HTML'den oluşturulur. Bazı tutarsızlıklar veya biçimlendirme sorunları olabilir.
- İçerik Kapsamı: Yalnızca Corpus referansındaki herkese açık sayfalar dahil edilir. GitHub, OSS siteleri, blog'lar veya YouTube gibi diğer kaynaklardaki içerikler dahil edilmez.