Method: corpora.documents.chunks.list

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

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
parent

string

To pole jest wymagane. Nazwa obiektu Document zawierającego Chunk. Przykład: corpora/my-corpus-123/documents/the-doc-abc

Parametry zapytania

Parametry
pageSize

integer

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

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

pageToken

string

Opcjonalnie. Token strony otrzymany z poprzedniego wywołania chunks.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 chunks.list muszą odpowiadać wywołaniu, które przekazało token strony.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź z chunks.list zawierająca listę Chunk podzieloną na strony. Elementy typu Chunk są sortowane rosnąco według kolumny chunk.create_time.

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

Zapis JSON
{
  "chunks": [
    {
      object (Chunk)
    }
  ],
  "nextPageToken": string
}
Pola
chunks[]

object (Chunk)

Zwrócone elementy Chunk.

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.