Method: projects.locations.collections.dataStores.branches.documents.list

Document 목록을 가져옵니다.

HTTP 요청

GET https://discoveryengine.googleapis.com/v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*/branches/*}/documents

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

경로 매개변수

매개변수
parent

string

필수 항목입니다. 상위 브랜치 리소스 이름입니다(예: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}). default_branch를 브랜치 ID로 사용하여 기본 브랜치 아래에 문서를 표시합니다.

호출자에게 이 브랜치에 속한 Document를 나열할 권한이 없으면 이 브랜치의 존재 여부와 관계없이 PERMISSION_DENIED 오류가 반환됩니다.

쿼리 매개변수

매개변수
pageSize

integer

반환할 최대 Document 수입니다. 지정하지 않으면 기본값은 100입니다. 허용되는 최댓값은 1000입니다. 1,000을 초과하는 값은 1,000으로 설정됩니다.

이 필드가 음수이면 INVALID_ARGUMENT 오류가 반환됩니다.
pageToken

string

이전 DocumentService.ListDocuments 호출에서 받은 ListDocumentsResponse.next_page_token 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다.

페이지를 매길 때 DocumentService.ListDocuments에 제공된 다른 모든 매개변수는 페이지 토큰을 제공한 호출과 일치해야 합니다. 그렇지 않으면 INVALID_ARGUMENT 오류가 반환됩니다.

요청 본문

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

응답 본문

성공한 경우 응답 본문에 ListDocumentsResponse의 인스턴스가 포함됩니다.

승인 범위

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

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

자세한 내용은 Authentication Overview를 참조하세요.

IAM 권한

parent 리소스에 대해서는 다음 IAM 권한이 필요합니다.

  • discoveryengine.documents.list

자세한 내용은 IAM 문서를 참조하세요.