Method: corpora.documents.list

Bir Corpus içindeki tüm Document öğelerini listeler.

HTTP isteği

GET https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/documents

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

Yol parametreleri

Parametreler
parent

string

Zorunlu. Document içeren Corpus öğesinin adı. Örnek: corpora/my-corpus-123

Sorgu parametreleri

Parametreler
pageSize

integer

İsteğe bağlı. Döndürülecek maksimum Document sayısı (sayfa başına). Hizmet daha az Document döndürebilir.

Belirtilmemişse en fazla 10 Document döndürülür. Maksimum boyut sınırı sayfa başına 20 Document'dir.
pageToken

string

İsteğe bağlı. Önceki bir documents.list çağrısından alınan sayfa jetonu.

Yanıtta döndürülen nextPageToken öğesini, sonraki sayfayı almak için sonraki isteğin bağımsız değişkeni olarak sağlayın.

Sayfalara ayırma sırasında documents.list için sağlanan diğer tüm parametreler, sayfa jetonunu sağlayan çağrıyla eşleşmelidir.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

Sayfalara ayrılmış Document listesi içeren documents.list yanıtı. Document öğeleri artan document.create_time ölçütüne göre sıralandı.

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

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

object (Document)

Döndürülen Document öğeleri.
nextPageToken

string

Sonraki sayfayı almak için pageToken olarak gönderilebilecek bir jeton. Bu alan atlanırsa başka sayfa olmaz.

Yetkilendirme kapsamları

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

  • https://www.googleapis.com/auth/generative-language.retriever
  • https://www.googleapis.com/auth/generative-language.retriever.readonly

Daha fazla bilgi için Kimlik Doğrulamaya Genel Bakış bölümüne bakın.