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

• Permintaan HTTP
• Parameter lokasi
• Parameter kueri
• Isi permintaan
• Isi respons
• Cakupan otorisasi
• Izin IAM

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. Nama resource lengkap 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 Document 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. Jenis pemrosesan yang akan ditampilkan.
processedDocumentFormat	enum (ProcessedDocumentFormat) Format output yang diinginkan. Jika tidak ditentukan, defaultnya adalah JSON.
imageId	string Opsional. Menentukan konfigurasi untuk IMAGE_BYTES.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons akan berisi instance ProcessedDocument.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

Izin IAM

Memerlukan izin IAM berikut pada resource name:

• discoveryengine.documents.get

Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.