Bu kılavuzda, Developer Knowledge API'nin işlevlerinin nasıl kullanılacağına dair örnekler verilmektedir: doküman arama, tek bir dokümanı alma ve toplu olarak birden fazla dokümanı alma.
Başlamadan önce API'yi etkinleştirdiğinizden ve bir Developer Knowledge API anahtarı oluşturduğunuzdan emin olun. Ardından, anahtarınızı bir ortam değişkenine kaydedin:
export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"
SearchDocumentChunks ile doküman arama
Bir sorgu dizesiyle eşleşen doküman parçalarını bulmak için documents.searchDocumentChunks yöntemini kullanın. Sonuçlar, dokümandaki içerik parçalarını ve dokümanın tam içeriğini almak için kullanabileceğiniz bir parent referansı içerir.
Aşağıdaki örnekte, "BigQuery" ile eşleşen dokümanlar aranır:
curl "https://developerknowledge.googleapis.com/v1/documents:searchDocumentChunks?query=BigQuery&key=$DEVELOPERKNOWLEDGE_API_KEY"
Sayfa başına sonuç sayısını sınırlamak için pageSize ve sonraki sayfaları almak için pageToken gibi parametreleri kullanarak arama sonuçlarını hassaslaştırabilirsiniz.
Arama sonuçlarını filtreleme
Arama sonuçlarına katı bir filtre uygulamak için filter parametresini kullanın. Filtre, arama sonucu parçalarıyla ilişkili belgelerin meta verilerine uygulanır.
Filtreleme için desteklenen alanlar:
data_source(STRING): Belgenin kaynağı (ör.docs.cloud.google.com).update_time(TIMESTAMP): Belgenin en son güncellendiği zamanın zaman damgası.uri(STRING): Doküman URI'si (ör.https://docs.cloud.google.com/bigquery/docs/tables).
Desteklenen operatörler:
- DİZE alanları, dizenin tamamında tam eşleşme için
=(eşittir) ve!=(eşit değildir) operatörlerini destekler. - TIMESTAMP alanları
=,<,<=,>ve>=değerlerini destekler. Zaman damgaları RFC-3339 biçiminde olmalıdır (ör."2025-01-01T00:00:00Z").
AND, OR ve NOT (veya -) mantıksal operatörlerini kullanarak ifadeleri birleştirebilirsiniz. OR değerinin AND değerinden daha öncelikli olduğunu unutmayın.
Aşağıdaki örnekte, "BigQuery" ile eşleşen dokümanlar aranır ve sonuçlar docs.cloud.google.com ile sınırlanır:
curl "https://developerknowledge.googleapis.com/v1/documents:searchDocumentChunks?query=BigQuery&filter=data_source%3D%22docs.cloud.google.com%22&key=$DEVELOPERKNOWLEDGE_API_KEY"
GetDocument ile belge alma
Tek bir belgenin içeriğinin tamamını almak için documents.get yöntemini kullanın.
Aşağıdaki örnekte, documents/DOCUMENT_ID adlı bir doküman alınır:
curl "https://developerknowledge.googleapis.com/v1/documents:get?name=documents/DOCUMENT_ID&key=$DEVELOPERKNOWLEDGE_API_KEY"
Yanıtta, content alanı da dahil olmak üzere Document kaynağının tamamı yer alıyor.
BatchGetDocuments ile birden fazla dokümanı alma
Tek bir API çağrısında 100'e kadar belgeyi ada göre almak için documents.batchGet yöntemini kullanın. Bu, birden fazla GetDocument isteği göndermekten daha verimlidir.
Aşağıdaki örnekte, ada göre iki belge alınmaktadır:
curl "https://developerknowledge.googleapis.com/v1/documents:batchGet?names=documents/DOCUMENT_ID_1&names=documents/DOCUMENT_ID_2&key=$DEVELOPERKNOWLEDGE_API_KEY"
Yanıtta, istenen Document kaynakların listesi yer alır.