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

Document의 파싱된 레이아웃 정보를 가져옵니다.

HTTP 요청

GET https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*}:getProcessedDocument

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

경로 매개변수

매개변수
name

string

필수 항목입니다. Document의 전체 리소스 이름입니다(예: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{document}).

호출자에게 Document에 액세스할 권한이 없으면 Document의 존재 여부와 관계없이 PERMISSION_DENIED 오류가 반환됩니다.

요청된 Document가 없으면 NOT_FOUND 오류가 반환됩니다.

쿼리 매개변수

매개변수
processedDocumentType

enum (ProcessedDocumentType)

필수 항목입니다. 반환할 처리 유형입니다.
processedDocumentFormat

enum (ProcessedDocumentFormat)

출력 형식입니다. 지정하지 않으면 기본값은 JSON입니다.
imageId

string

(선택사항) IMAGE_BYTES의 구성을 지정합니다.

요청 본문

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

응답 본문

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

승인 범위

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

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

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

IAM 권한

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

  • discoveryengine.documents.get

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