Hızlı başlangıç: Developer Knowledge API'yi kullanmaya başlama

Bu kılavuzda, Developer Knowledge API'yi kullanmaya nasıl başlayacağınız gösterilmektedir. Bu eğitimde, Developer Knowledge API'yi etkinleştirmeyi, API anahtarı almayı ve geliştirici belgelerini aramak ve almak için ilk API çağrılarınızı yapmayı öğreneceksiniz.

Başlamadan önce

Developer Knowledge API'yi kullanmaya başlamadan önce aşağıdaki adımları tamamladığınızdan emin olun.

API'yi etkinleştirme

  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.

API anahtarı oluşturma ve güvenliğini sağlama

  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.
  3. Ad alanında anahtar için bir ad girin.

  4. 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'ni de seçmeniz gerekir. Aksi takdirde bu aramalar engellenir.
  5. Oluştur'u tıklayın.

Dokümanlardan yanıt oluşturma

Geliştirici Bilgisi API anahtarınızı aldıktan sonra API'yi kullanmaya başlayabilirsiniz. Aşağıdaki örnekte, sorgu sorma ve dokümanlardan alınan bir yanıt oluşturma işlemi gösterilmektedir:

  1. Developer Knowledge API anahtarınızı bir ortam değişkenine kaydedin:

    export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

    YOUR_API_KEY kısmını oluşturduğunuz API anahtarıyla değiştirin.

  2. AnswerQuery uç noktasını aramak için curl kullanın:

    curl -X POST "https://developerknowledge.googleapis.com/v1:answerQuery?key=$DEVELOPERKNOWLEDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "How do I create a BigQuery dataset?"}'

Bu komut, dokümanlara dayalı olarak sorgunuza yanıt verir.

Belge parçalarını arama

Oluşturulan bir yanıt yerine belirli doküman snippet'lerini bulmak istiyorsanız doğrudan doküman parçalarını arayabilirsiniz.

SearchDocumentChunks uç noktasını aramak için curl kullanın:

curl "https://developerknowledge.googleapis.com/v1/documents:searchDocumentChunks?query=BigQuery&key=$DEVELOPERKNOWLEDGE_API_KEY"

Yanıtta, dokümantasyondaki eşleşen içerik parçaları ve üst dokümanlara yapılan referanslar yer alır.

Belge alma

searchDocumentChunks yanıtında belge parçaları listesi yer alıyor. Her belge parçası, belgenin kaynak adını içeren bir parent alanına sahiptir. Bu alanı, belgenin tam içeriğini almak için GetDocument ile birlikte kullanabilirsiniz.

Bir dokümanı almak için searchDocumentChunks tarafından döndürülen parçalardan birindeki parent alanını kopyalayıp bir ortam değişkenine kaydedin. Ardından GetDocument uç noktasını çağırmak için curl komutunu kullanın:

export DOC_NAME="PARENT_FIELD_FROM_SEARCH"

curl "https://developerknowledge.googleapis.com/v1/$DOC_NAME?key=$DEVELOPERKNOWLEDGE_API_KEY"

Bu işlev, belirtilen belgenin tam Markdown içeriğini döndürür.

Sırada ne var?