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 Transcoding 構文を使用します。

パスパラメータ

パラメータ
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 のドキュメントをご覧ください。