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

Mendapatkan informasi tata letak yang diuraikan untuk Document.

Permintaan HTTP

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

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
name

string

Wajib diisi. Nama lengkap resource Document, seperti projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{document}.

Jika pemanggil tidak memiliki izin untuk mengakses Document, terlepas dari apakah dokumen tersebut ada atau tidak, error PERMISSION_DENIED akan ditampilkan.

Jika Document yang diminta tidak ada, error NOT_FOUND akan ditampilkan.

Parameter kueri

Parameter
processedDocumentType

enum (ProcessedDocumentType)

Wajib diisi. Jenis pemrosesan yang akan ditampilkan.
processedDocumentFormat

enum (ProcessedDocumentFormat)

Format output yang akan digunakan. Jika tidak ditentukan, nilai defaultnya adalah JSON.
imageId

string

Opsional. Menentukan konfigurasi untuk IMAGE_BYTES.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons akan memuat instance ProcessedDocument.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

Izin IAM

Memerlukan izin IAM berikut pada resource name:

  • discoveryengine.documents.get

Untuk mengetahui informasi selengkapnya, baca dokumentasi IAM.