Method: corpora.documents.list

Wyświetla listę wszystkich elementów Document w elemencie Corpus.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
parent

string

To pole jest wymagane. Nazwa obiektu Corpus zawierającego Document. Przykład: corpora/my-corpus-123

Parametry zapytania

Parametry
pageSize

integer

Opcjonalnie. Maksymalna liczba elementów Document do zwrócenia (na stronę). Usługa może zwrócić mniej Document.

Jeśli wartość ta nie zostanie określona, zwróconych zostanie maksymalnie 10 s (Document). Maksymalny rozmiar strony to 20 Document.
pageToken

string

Opcjonalnie. Token strony otrzymany z poprzedniego wywołania documents.list.

Podaj nextPageToken zwrócony w odpowiedzi jako argument następnego żądania, aby pobrać następną stronę.

Podczas podziału na strony wszystkie pozostałe parametry przekazywane w metodzie documents.list muszą odpowiadać wywołaniu, które przekazało token strony.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź z documents.list zawierająca listę Document podzieloną na strony. Elementy typu Document są sortowane rosnąco według kolumny document.create_time.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "documents": [
    {
      object (Document)
    }
  ],
  "nextPageToken": string
}
Pola
documents[]

object (Document)

Zwrócone elementy Document.
nextPageToken

string

Token, który można wysłać jako pageToken, aby pobrać następną stronę. Jeśli pominiesz to pole, nie będzie więcej stron.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w artykule Omówienie uwierzytelniania.