Method: corpora.documents.list

Corpus의 모든 Document를 나열합니다.

HTTP 요청

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

URL은 gRPC 트랜스코딩 구문을 사용합니다.

경로 매개변수

매개변수
parent

string

필수 항목입니다. Document가 포함된 Corpus의 이름입니다. 예: corpora/my-corpus-123

쿼리 매개변수

매개변수
pageSize

integer

선택사항입니다. 반환할 최대 Document 수입니다 (페이지당). 서비스에서 더 적은 Document를 반환할 수도 있습니다.

지정하지 않으면 최대 10개의 Document가 반환됩니다. 페이지당 최대 크기 한도는 20Document입니다.
pageToken

string

선택사항입니다. 이전 documents.list 호출에서 받은 페이지 토큰입니다.

다음 페이지를 검색하려면 응답에서 반환된 nextPageToken를 다음 요청의 인수로 제공합니다.

페이지를 매길 때 documents.list에 제공된 다른 모든 매개변수는 페이지 토큰을 제공한 호출과 일치해야 합니다.

요청 본문

요청 본문은 비어 있어야 합니다.

응답 본문

페이지로 나눈 Document 목록을 포함하는 documents.list의 응답입니다. Document는 오름차순 document.create_time으로 정렬됩니다.

성공할 경우 응답 본문에 다음 구조의 데이터가 포함됩니다.

JSON 표현 
{
  "documents": [
    {
      object (Document)
    }
  ],
  "nextPageToken": string
}
필드
documents[]

object (Document)

반환된 Document
nextPageToken

string

다음 페이지를 검색하기 위해 pageToken으로 전송할 수 있는 토큰입니다. 이 필드를 생략하면 페이지가 더 이상 표시되지 않습니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

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

자세한 내용은 인증 개요를 참조하세요.