Package google.developers.knowledge.v1alpha

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

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ış. Belgenin tam içeriğini Markdown biçiminde içerir.
description

string

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

string

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

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.

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

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.

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.