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

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

Filtreleme için desteklenen alanlar:

  • dataSource (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.
  • updateTime (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.

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 değerinden daha yüksek önceliğe sahiptir. Açık öncelik gruplandırması için parantez kullanın.

Örnekler:

  • dataSource = "docs.cloud.google.com" OR dataSource = "firebase.google.com"
  • dataSource != "firebase.google.com"
  • updateTime < "2024-01-01T00:00:00Z"
  • updateTime >= "2025-01-22T00:00:00Z" AND (dataSource = "developer.chrome.com" OR dataSource = "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.

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