Developer Knowledge API

Developer Knowledge API, Google'ın herkese açık geliştirici belgelerine programatik erişim sağlayarak bu bilgi bankası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:

• SearchDocumentChunks özelliğini kullanarak sorguya dayalı olarak alakalı sayfa URI'lerini ve içerik snippet'lerini bulabilirsiniz.
• GetDocument veya BatchGetDocuments simgesine dokunarak arama sonuçlarının tamamını getirin.
• AnswerQuery, doküman derlemesinden alınan sorgulara yanıt oluşturmak için kullanılır.

Developer Knowledge API, doküman sayfalarının yapılandırılmamış Markdown içeriği olarak aranmasını ve alınmasını destekler. Aranabilir içerik derlemesi, Corpus referansı'nda listelenmiştir.

Geliştirici Bilgisi'ni kullanma yöntemleri

İş akışınıza bağlı olarak aşağıdaki platformlardan Geliştirici Bilgisi'ne erişebilirsiniz:

• REST API ve RPC API: HTTP veya gRPC uç noktalarını doğrudan çağırın. Yöntem spesifikasyonları için REST referansı ve RPC referansı'na bakın.
• İstemci kitaplıkları: Python, Node.js ve TypeScript, Go, Java, PHP ve Ruby için resmi istemci kitaplıklarını kullanarak Developer Knowledge API'yi uygulamalarınıza entegre edin.
• Google Cloud CLI (gcloud): Doküman parçalarını aramak, Markdown içeriğini getirmek ve yanıt oluşturmak için terminalinizden gcloud developer-knowledge komutlarını çalıştırın.
• Geliştirici Bilgisi MCP sunucusu: Yapay zeka kodlama asistanınızı veya aracınızı Model Bağlam Protokolü (MCP) araçlarını (search_documents, get_documents ve answer_query) kullanarak Google'ın dokümanlarına bağlayın. MCP referansına bakın.

İpucu: Yapay zeka kod yazma desteği kullanıyorsanız retrieving-developer-knowledge ajan becerisini çalıştırarak npx skills add google/skills --skill retrieving-developer-knowledge yükleyin. Bu beceri, asistanınıza hangi Developer Knowledge MCP sunucu aracını seçeceği, hataları nasıl ele alacağı ve MCP sunucusu kullanılamıyorsa curl ile REST API'yi nasıl çağıracağı konusunda yerleşik talimatlar verir. Daha fazla bilgi edinmek için Use the Developer Knowledge agent skill (Geliştirici Bilgisi aracısı becerisini kullanma) başlıklı makaleyi inceleyin.

API ile MCP sunucusu arasında seçim yapma

Developer Knowledge API ve Developer Knowledge MCP sunucusu, farklı entegrasyon ihtiyaçları için tasarlanmıştır:

• Aşağıdaki durumlarda Developer Knowledge API'yi, istemci kitaplıklarını veya gcloud CLI'yı kullanın:
  • Projenizde yapay zeka aracısı kullanılmıyor.
  • Ajanınız için özel araçlar veya araç setleri tanımlamak istiyorsunuz.
  • Sonuçları bir modele iletmeden önce işlemek veya birleştirmek istiyorsanız (ör. tam içerik getirilmeden önce doküman bayt uzunluğunu kontrol etme).
  • Arama sonuçlarını filtrelemeniz (ör. data_source veya update_time ile) ya da alan maskeleri uygulamanız gerekir.
• Aşağıdaki durumlarda Developer Knowledge MCP sunucusunu ve agent skill'ini kullanın:
  • Özel araç tanımları ve açıklamaları yazmadan bir yapay zeka kodlama asistanı veya ajanı bağlamak istiyorsunuz.
  • Geliştirici Bilgisi MCP sunucusu yeni özellikler ekledikçe otomatik güncellemeler almak istiyorsunuz.
  • Arama sonuçlarında özel meta veri filtrelemeye ihtiyacınız yoksa.

API'yi etkinleştirme

Developer Knowledge API'yi kullanmak için önce Google Cloud projenizde etkinleştirmeniz gerekir.

İpucu: Google Cloud projeniz yoksa Google Cloud veya Firebase talimatlarını kullanarak bir proje oluşturun.

1. Google API'leri kitaplığında Developer Knowledge API sayfasını açın.
2. API'yi kullanmayı planladığınız projeyi doğru seçtiğinizden emin olun.
3. Etkinleştir'i tıklayın. API'yi etkinleştirmek veya kullanmak için belirli IAM rolleri gerekmez.

Kimlik doğrulama

Aşağıdaki yöntemlerden birini kullanarak Developer Knowledge API'ye yapılan isteklerin kimliğini doğrulayabilirsiniz:

• API anahtarı: key sorgu parametresini veya X-Goog-Api-Key başlığını kullanarak doğrudan REST isteklerinin ya da Developer Knowledge MCP sunucusunun kimliğini doğrulayın.
• Uygulama varsayılan kimlik bilgileri (ADC), OAuth 2.0 veya hizmet hesapları: Resmi istemci kitaplıkları ya da üretim iş akışları kullanılırken isteklerin kimliğini doğrulayın. Kimlik bilgileri ayarlama hakkında daha fazla bilgi edinmek için Uygulama Varsayılan Kimlik Bilgileri dokümanlarına bakın.
• Kullanıcı kimlik bilgileri (gcloud CLI): gcloud auth login ile Google Cloud hesabınızda oturum açarak KSA isteklerinin kimliğini doğrulayın. Kurulum talimatları için gcloud CLI hızlı başlangıç kılavuzuna bakın.

Dahil edilen belgeler

API'nin hangi belgelerde arama yaptığı hakkında bilgi için Corpus referansı'na bakın.

Developer Knowledge API, en yeni Google geliştirici belgelerine erişim sağlamayı amaçlar. Amacımız, yeni veya güncellenmiş belgelerin 2 iş günü içinde kullanılabilmesi için yayınlandıktan sonraki 48 saat içinde içeriği yeniden dizine eklemektir.

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, bloglar veya YouTube gibi diğer kaynaklardaki içerikler dahil edilmez.