Package google.developers.knowledge.v1

Dizin

DeveloperKnowledge

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.

API, Google'ın geliştirici belgelerine makine tarafından okunabilir erişim için standart kaynak olacak şekilde tasarlanmıştır.

Tipik bir kullanım örneğinde, önce bir sorguya göre alakalı sayfa URI'lerini bulmak için DeveloperKnowledge.SearchDocumentChunks kullanılır. Ardından, en iyi sonuçların tam içeriğini getirmek için DeveloperKnowledge.GetDocument veya DeveloperKnowledge.BatchGetDocuments kullanılır.

Tüm belge içeriği Markdown biçiminde sağlanır.

BatchGetDocuments

rpc BatchGetDocuments(BatchGetDocumentsRequest) returns (BatchGetDocumentsResponse)

Her biri tam Markdown içeriğine sahip birden fazla dokümanı alır.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/devprofiles.full_control
  • https://www.googleapis.com/auth/cloud-platform

Daha fazla bilgi için OAuth 2.0 Overview sayfasına bakın.
GetDocument

rpc GetDocument(GetDocumentRequest) returns (Document)

Tam Markdown içeriğiyle tek bir dokümanı alır.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/devprofiles.full_control
  • https://www.googleapis.com/auth/cloud-platform

Daha fazla bilgi için OAuth 2.0 Overview sayfasına bakın.
SearchDocumentChunks

rpc SearchDocumentChunks(SearchDocumentChunksRequest) returns (SearchDocumentChunksResponse)

Google'ın geliştirici belgelerinde geliştirici bilgisi için arama yapar. Kullanıcının sorgusuna göre DocumentChunk döndürür. Aynı Document'dan birçok parça olabilir. Tam belgeleri almak için DeveloperKnowledge.GetDocument veya DeveloperKnowledge.BatchGetDocuments ile SearchDocumentChunksResponse.results içinde döndürülen DocumentChunk.parent kullanın.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/devprofiles.full_control
  • https://www.googleapis.com/auth/cloud-platform

Daha fazla bilgi için OAuth 2.0 Overview sayfasına bakın.

BatchGetDocumentsRequest

DeveloperKnowledge.BatchGetDocuments için istek mesajı.

Alanlar
names[]

string

Zorunlu. Alınacak dokümanların adlarını belirtir. Bir toplu işlemde en fazla 20 belge alınabilir. Dokümanlar, istekteki names ile aynı sırada döndürülür.

Biçim: documents/{uri_without_scheme} Örnek: documents/docs.cloud.google.com/storage/docs/creating-buckets
view

DocumentView

İsteğe bağlı. Belgenin DocumentView özelliğini belirtir. Belirtilmemişse DeveloperKnowledge.BatchGetDocuments varsayılan olarak DOCUMENT_VIEW_CONTENT olur.

BatchGetDocumentsResponse

DeveloperKnowledge.BatchGetDocuments için yanıt mesajı.

Alanlar
documents[]

Document

İstenen belgeleri içeriyorsa

Belge

Belge, Geliştirici Bilgi Korpusu'ndaki bir içeriği temsil eder.

Alanlar
name

string

Tanımlayıcı. Belgenin kaynak adını içerir. Biçim: documents/{uri_without_scheme} Örnek: documents/docs.cloud.google.com/storage/docs/creating-buckets
uri

string

Yalnızca çıkış. İçeriğin URI'sini (ör. docs.cloud.google.com/storage/docs/creating-buckets) sağlar.
content

string

Yalnızca çıkış. Dokümanın tüm içeriğini Markdown biçiminde içerir.
description

string

Yalnızca çıkış. Belgenin açıklamasını sağlar.
data_source

string

Yalnızca çıkış. Belgenin veri kaynağını belirtir. Örnek veri kaynağı: firebase.google.com
title

string

Yalnızca çıkış. Dokümanın başlığını sağlar.
update_time

Timestamp

Yalnızca çıkış. Belgenin içeriğinin veya meta verilerinin en son güncellendiği zaman damgasını gösterir.
view

DocumentView

Yalnızca çıkış. Belgenin DocumentView özelliğini belirtir.

DocumentChunk

DocumentChunk, DeveloperKnowledge gövdesindeki bir Document içeriğini temsil eder. Belge içeriğinin tamamını getirmek için parent değerini DeveloperKnowledge.GetDocument veya DeveloperKnowledge.BatchGetDocuments parametresine iletin.

Alanlar
parent

string

Yalnızca çıkış. Bu parçanın geldiği belgenin kaynak adını içerir. Biçim: documents/{uri_without_scheme} Örnek: documents/docs.cloud.google.com/storage/docs/creating-buckets
id

string

Yalnızca çıkış. Belge içindeki bu parçanın kimliğini belirtir. Parça kimliği, bir doküman içinde benzersizdir ancak dokümanlar arasında genel olarak benzersiz değildir. Parça kimliği sabit değildir ve zaman içinde değişebilir.
content

string

Yalnızca çıkış. Belge parçasının içeriğini barındırır.
document

Document

Yalnızca çıkış. Bu parçanın geldiği Document ile ilgili meta verileri temsil eder. Bu Document mesajının DocumentView değeri DOCUMENT_VIEW_BASIC olarak ayarlanacak. Müşterilerin yalnızca meta veri alanlarına ihtiyacı varsa DeveloperKnowledge.GetDocument veya DeveloperKnowledge.BatchGetDocuments'u aramasına gerek kalmaması için bu alanlar buraya eklenmiştir. Aksi takdirde, istemciler tam doküman içeriğini getirmek için DeveloperKnowledge.GetDocument veya DeveloperKnowledge.BatchGetDocuments kullanmalıdır.

DocumentView

Document öğesinin hangi alanlarının dahil edileceğini belirtir.

Sıralamalar
DOCUMENT_VIEW_UNSPECIFIED Varsayılan / ayarlanmamış değer. DocumentView belirtilmemişse varsayılan değer için her API yöntemine bakın.
DOCUMENT_VIEW_BASIC

Yalnızca temel meta veri alanlarını içerir: - name - uri - data_source - title - description - update_time - view

Bu, DeveloperKnowledge.SearchDocumentChunks için varsayılan görünümdür.
DOCUMENT_VIEW_FULL Tüm Document alanlarını içerir.
DOCUMENT_VIEW_CONTENT

DOCUMENT_VIEW_BASIC alanlarını ve content alanını içerir.

Bu, DeveloperKnowledge.GetDocument ve DeveloperKnowledge.BatchGetDocuments için varsayılan görünümdür.

GetDocumentRequest

DeveloperKnowledge.GetDocument için istek mesajı.

Alanlar
name

string

Zorunlu. Alınacak belgenin adını belirtir. Biçim: documents/{uri_without_scheme} Örnek: documents/docs.cloud.google.com/storage/docs/creating-buckets
view

DocumentView

İsteğe bağlı. Belgenin DocumentView özelliğini belirtir. Belirtilmemişse DeveloperKnowledge.GetDocument varsayılan olarak DOCUMENT_VIEW_CONTENT olur.

SearchDocumentChunksRequest

DeveloperKnowledge.SearchDocumentChunks için istek mesajı.

Alanlar
query

string

Zorunlu. Kullanıcı tarafından sağlanan ham sorgu dizesini (ör. "Cloud Storage paketi nasıl oluşturulur?") sağlar.
page_size

int32

İsteğe bağlı. Döndürülecek maksimum sonuç sayısını belirtir. Hizmet, bu değerden daha az sonuç döndürebilir.

Belirtilmemesi halinde en fazla 5 sonuç döndürülür.

Maksimum değer 20'dir. 20'den büyük değerler INVALID_ARGUMENT hatasına neden olur.
page_token

string

İsteğe bağlı. Önceki bir SearchDocumentChunks çağrısından alınan bir sayfa jetonu içerir. Sonraki sayfayı almak için bunu sağlayın.
filter

string

İsteğe bağlı. Arama sonuçlarına katı bir filtre uygular. İfade, https://google.aip.dev/160 adresinde açıklanan söz diziminin bir alt kümesini destekler.

SearchDocumentChunks, DocumentChunk değerlerini döndürürken filtre DocumentChunk.document alanlarına uygulanır.

Filtreleme için desteklenen alanlar:

  • data_source (STRING): Belgenin kaynağı (ör. docs.cloud.google.com). Korpusdaki veri kaynaklarının tam listesi için https://developers.google.com/knowledge/reference/corpus-reference adresini ziyaret edin.
  • update_time (TIMESTAMP): Belgenin en son anlamlı şekilde güncellendiği zamanın zaman damgası. Anlamlı bir güncelleme, dokümanın Markdown içeriğini veya meta verilerini değiştiren bir güncellemedir.
  • uri (STRING): Belge URI'si (ör. https://docs.cloud.google.com/bigquery/docs/tables).

DİZİ alanları, dizenin tamamında tam eşleşme için = (eşittir) ve != (eşit değildir) operatörlerini destekler. Kısmi eşleşme, ön ek eşleşmesi ve normal ifade eşleşmesi desteklenmez.

ZAMAN DAMGASI alanları =, <, <=, > ve >= operatörlerini 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, AND değerinden daha yüksek önceliğe sahiptir. Açık öncelik gruplandırması için parantez kullanın.

Örnekler:

  • data_source = "docs.cloud.google.com" OR data_source = "firebase.google.com"
  • data_source != "firebase.google.com"
  • update_time < "2024-01-01T00:00:00Z"
  • update_time >= "2025-01-22T00:00:00Z" AND (data_source = "developer.chrome.com" OR data_source = "web.dev")
  • uri = "https://docs.cloud.google.com/release-notes"

filter dizesi 500 karakteri aşmamalıdır. 500 karakterden uzun değerler INVALID_ARGUMENT hatasına neden olur.

SearchDocumentChunksResponse

DeveloperKnowledge.SearchDocumentChunks için yanıt mesajı.

Alanlar
results[]

DocumentChunk

Belirtilen sorgunun arama sonuçlarını içerir. Bu listedeki her DocumentChunk, arama sorgusuyla alakalı bir içerik snippet'i barındırır. Tam doküman içeriğini almak için her sonucun DocumentChunk.parent alanını DeveloperKnowledge.GetDocument veya DeveloperKnowledge.BatchGetDocuments ile birlikte kullanın.
next_page_token

string

İsteğe bağlı. Sonraki sayfayı almak için page_token olarak gönderilebilecek bir jeton sağlar. Bu alan atlanırsa sonraki sayfa yoktur.