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 bankası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 alanı, önce bir sorguya dayalı olarak alakalı belge parçalarını bulmak için DeveloperKnowledge.SearchDocumentChunks yöntemini, ardından en iyi sonuçların tam içeriğini almak için belge kaynak adlarıyla (ör. DocumentChunk.parent veya documents/{uri_without_scheme}) DeveloperKnowledge.GetDocument ya da DeveloperKnowledge.BatchGetDocuments yöntemini kullanmaktır.

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

AnswerQuery

rpc AnswerQuery(AnswerQueryRequest) returns (AnswerQueryResponse)

Temellendirilmiş üretim kullanarak bir sorguyu yanıtlar.

Yetkilendirme kapsamları

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

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

Daha fazla bilgi için OAuth 2.0 Overview sayfasını inceleyin.
BatchGetDocuments

rpc BatchGetDocuments(BatchGetDocumentsRequest) returns (BatchGetDocumentsResponse)

Her biri tam Markdown içeriğine sahip birden fazla belge 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/developerprofiles.readonly
  • https://www.googleapis.com/auth/cloud-platform

Daha fazla bilgi için OAuth 2.0 Overview sayfasını inceleyin.
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/developerprofiles.readonly
  • https://www.googleapis.com/auth/cloud-platform

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

rpc SearchDocumentChunks(SearchDocumentChunksRequest) returns (SearchDocumentChunksResponse)

Google'ın geliştirici belgelerinde geliştirici bilgileri arar. Kullanıcının sorgusuna göre DocumentChunk döndürür. Aynı Document öğesinden birçok parça olabilir. Belgelerin tamamını almak için SearchDocumentChunksResponse.results içinde döndürülen DocumentChunk.parent ile DeveloperKnowledge.GetDocument veya DeveloperKnowledge.BatchGetDocuments 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/developerprofiles.readonly
  • https://www.googleapis.com/auth/cloud-platform

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

Cevap

Sorguya verilen yanıt.

Alanlar
answer_text

string

Yanıtın metnini içerir.
citations[]

AnswerCitation

Yalnızca çıkış. Yanıtla ilgili alıntıları içerir.
references[]

AnswerReference

Yalnızca çıkış. Yanıtla ilgili referanslar içeriyor.

AnswerCitation

Bir segmentle ilgili alıntı bilgileri.

Alanlar
start_index

int32

Yalnızca çıkış. Segmentin başlangıcını gösterir. Bayt (UTF-8 unicode) cinsinden ölçülür ve dahildir. ASCII olmayan karakterler gibi çok baytlı karakterler varsa dizin ölçümü dize uzunluğundan daha fazladır.
end_index

int32

Yalnızca çıkış. Segmentin sonunu gösterir. Bayt (UTF-8 unicode) cinsinden ölçülür ve hariç tutulur. ASCII olmayan karakterler gibi çok baytlı karakterler varsa dizin ölçümü dize uzunluğundan daha fazladır.
sources[]

CitationSource

Yalnızca çıkış. İlişkilendirilen segment için alıntı kaynaklarını içerir.

AnswerReference

Bir kaynağa yapılan referansı temsil eder.

Alanlar
content birleşik alanı. Referansın içeriğini barındırır. content aşağıdakilerden yalnızca biri olabilir:
document_reference

DocumentReference

Yalnızca çıkış. Referans doküman.

CitationSource

Alıntı kaynağı.

Alanlar
reference_index

int32

Yalnızca çıkış. references yinelenen alanındaki Answer.AnswerReference dizinini içerir.

DocumentReference

Bir dokümana yapılan referansı temsil eder.

Alanlar
document_chunk

DocumentChunk

Yalnızca çıkış. Doküman parçasını içerir. document_chunk.id alanı ayarlanmamış ve boş bırakılacak.

AnswerQueryRequest

DeveloperKnowledge.AnswerQuery için istek mesajı.

Alanlar
query

string

Zorunlu. Yanıtlanacak sorgu.
filter

string

İsteğe bağlıdır. Yanıtı temellendirmek için kullanılan 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.

Filtreleme için desteklenen alanlar:

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

INTEGER alanları =, <, <=, > ve >= operatörlerini destekler.

STRING alanları, tüm dizede tam eşleme 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.

TIMESTAMP 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 politikasından daha önceliklidir. Açık öncelik gruplandırması için parantez kullanın.

Örnekler:

  • Document.content_length_bytes: content_length_bytes < 50000 etiketine göre filtrele
  • 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.

AnswerQueryResponse

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

Alanlar
answer

Answer

Sorgunun yanıtı.

BatchGetDocumentsRequest

DeveloperKnowledge.BatchGetDocuments için istek mesajı.

Alanlar
names[]

string

Zorunlu. Alınacak dokümanların adlarını belirtir. Bir grupta en fazla 20 doküman 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

Her ad 500 karakteri aşmamalıdır. 500 karakterden uzun değerler INVALID_ARGUMENT hatasına neden olur.
view

DocumentView

İsteğe bağlıdır. Dokümanın DocumentView değerini belirtir. Belirtilmezse DeveloperKnowledge.BatchGetDocuments varsayılan olarak DOCUMENT_VIEW_CONTENT değerine ayarlanır.

BatchGetDocumentsResponse

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

Alanlar
documents[]

Document

İstenen belgeleri içerir.

Doküman

Belge, Geliştirici Bilgi Tabanı'ndaki bir belge sayfasını (ör. https://docs.cloud.google.com/storage/docs/creating-buckets adresindeki sayfa) temsil eder.

Alanlar
name

string

Tanımlayıcı. Dokümanın 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. https://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ış. Dokümanın içeriğinin veya meta verilerinin en son güncellendiği zaman damgasını temsil eder.
view

DocumentView

Yalnızca çıkış. Dokümanın DocumentView değerini belirtir.
content_length_bytes

int32

Yalnızca çıkış. content alanının bayt cinsinden uzunluğu.

DocumentChunk

DocumentChunk, DeveloperKnowledge derlemindeki bir Document öğesinin içerik parçasını temsil eder. Doküman içeriğinin tamamını almak için parent değerini DeveloperKnowledge.GetDocument veya DeveloperKnowledge.BatchGetDocuments yöntemine iletin.

Alanlar
parent

string

Yalnızca çıkış. Bu parçanın ait olduğu dokümanın 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ış. Bu parçanın dokümandaki 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ış. Doküman parçasının içeriğini barındırır.
document

Document

Yalnızca çıkış. Bu parçanın ait olduğu Document ile ilgili meta verileri temsil eder. Bu Document mesajının DocumentView değeri DOCUMENT_VIEW_BASIC olarak ayarlanacak. Yalnızca meta veri alanlarına ihtiyaç duyan istemcilerin DeveloperKnowledge.GetDocument veya DeveloperKnowledge.BatchGetDocuments yöntemini çağırmasına gerek kalmaması için kolaylık sağlamak amacıyla buraya eklenmiştir. Aksi takdirde istemciler, doküman içeriğinin tamamını almak için DeveloperKnowledge.GetDocument veya DeveloperKnowledge.BatchGetDocuments kullanmalıdır.
relevance_score

double

Yalnızca çıkış. Parçanın arama sorgusuyla alaka düzeyi puanını temsil eder. Puan ne kadar yüksekse parçanın alaka düzeyi de o kadar yüksektir. Puan [0,0, 1,0] aralığındadır.

DocumentView

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

Sıralamalar
DOCUMENT_VIEW_UNSPECIFIED Varsayılan / ayarlanmamış değer. DocumentView belirtilmezse her API yönteminin varsayılan değerini inceleyin.
DOCUMENT_VIEW_BASIC

Yalnızca temel meta veri alanlarını içerir:

  • name
  • uri
  • data_source
  • title
  • description
  • update_time
  • view
  • content_length_bytes

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 dokümanın adını belirtir. Biçim: documents/{uri_without_scheme} Örnek: documents/docs.cloud.google.com/storage/docs/creating-buckets

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

DocumentView

İsteğe bağlıdır. Dokümanın DocumentView değerini belirtir. Belirtilmezse DeveloperKnowledge.GetDocument varsayılan olarak DOCUMENT_VIEW_CONTENT değerine ayarlanır.

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. Sorgu 500 karakteri aşmamalıdır. 500 karakterden uzun değerler INVALID_ARGUMENT hatasına neden olur.
page_size

int32

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

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

Maksimum değer 100'dür. 100'ün üzerindeki değerler 100'e zorlanır.
page_token

string

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

string

İsteğe bağlıdır. 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 döndürürken filtre DocumentChunk.document alanlarına uygulanır.

Filtreleme için desteklenen alanlar:

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

INTEGER alanları =, <, <=, > ve >= operatörlerini destekler.

STRING alanları, tüm dizede tam eşleme 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.

TIMESTAMP alanları =, <, <=, > ve >= operatörlerini destekler. Zaman damgaları RFC-3339 biçiminde olmalıdır (ör. "2025-01-01T00:00:00Z").

Not: Alan adları snake_case biçiminde olmalıdır (ör. data_source). Filtreleme ifadelerinin sağ tarafındaki değerler, çift tırnak içine alınmış dize değerleri olmalıdır (ör. "docs.cloud.google.com").

AND, OR ve NOT (veya -) mantıksal operatörlerini kullanarak ifadeleri birleştirebilirsiniz. OR, AND politikasından daha önceliklidir. Açık öncelik gruplandırması için parantez kullanın.

Örnekler:

  • Document.content_length_bytes: content_length_bytes < 50000 etiketine göre filtrele
  • 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

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

string

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