Method: documents.searchDocumentChunks

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.

HTTP isteği

GET https://developerknowledge.googleapis.com/v1alpha/documents:searchDocumentChunks

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Sorgu parametreleri

Parametreler
query

string

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

integer

İ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.
pageToken

string

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

İstek metni

İstek metni boş olmalıdır.

Yanıt metni

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

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi 
{
  "results": [
    {
      object (DocumentChunk)
    }
  ],
  "nextPageToken": string
}
Alanlar
results[]

object (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.
nextPageToken

string

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

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.

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.

JSON gösterimi 
{
  "parent": string,
  "id": string,
  "content": string
}
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.