Developer Knowledge API

Önizleme

Bu ürün, Hizmete Özel Şartlar'ın Genel Hizmet Şartları bölümündeki "GKST Öncesi Teklif Şartları"na tabidir. GKST öncesi ürünler "olduğu gibi" sunulur ve desteği sınırlı olabilir. Daha fazla bilgi için lansman aşamalarının açıklamalarını inceleyin.

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. İki temel işlevi vardır:

• SearchDocumentChunks Sorguya 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 GetDocument veya BatchGetDocuments simgesini tıklayın.

Hızlı bir başlangıç için Hızlı Başlangıç Kılavuzu'nu inceleyin.

Aranabilir içerik derlemesi Corpus referansı bölümünde listelenmiştir.

Önizlemeyle ilgili not: Bu önizleme sürümünde, doküman sayfaları yapılandırılmamış Markdown içeriği olarak aranabilir ve alınabilir.

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

Developer Knowledge API'yi kullanmak için Developer Knowledge API anahtarı gerekir. Oluşturmak için:

1. API'yi etkinleştirdiğiniz projenin Google Cloud Console'unda Kimlik Bilgileri sayfasına gidin.
2. Kimlik bilgileri oluştur'u tıklayın ve menüden API anahtarı'nı seçin. Oluşturulan API anahtarı iletişim kutusunda, yeni oluşturduğunuz anahtarın dizesi gösterilir.
3. API anahtarını düzenle'yi tıklayın.
4. Ad alanında anahtar için bir ad girin.
5. API kısıtlamaları bölümünde Anahtarı kısıtla'yı seçin.
6. API'leri seçin listesinden Developer Knowledge API'yi etkinleştirin ve Tamam'ı tıklayın.
   • Not: Developer Knowledge API'yi yeni etkinleştirdiyseniz API seçin listesinde görünmesi biraz zaman alabilir.
7. Kaydet'i 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ılavuzuna 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.