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

• HTTP-Anfrage
• Pfadparameter
• Anfrageparameter
• Anfragetext
• Antworttext
• Autorisierungsbereiche
• IAM-Berechtigungen

Ruft die geparsten Layoutinformationen für ein Document ab.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter

name

string Erforderlich. Vollständiger Ressourcenname von Document, z. B. projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{document}. Wenn der Aufrufer keine Berechtigung für den Zugriff auf die Document hat, unabhängig davon, ob sie vorhanden ist oder nicht, wird ein PERMISSION_DENIED-Fehler zurückgegeben. Wenn die angeforderte Document nicht vorhanden ist, wird ein NOT_FOUND-Fehler zurückgegeben.

Abfrageparameter

Parameter
processedDocumentType	enum (ProcessedDocumentType) Erforderlich. Welche Art der Verarbeitung zurückgegeben werden soll.
processedDocumentFormat	enum (ProcessedDocumentFormat) In welchem Format die Ausgabe erfolgen soll. Wenn nicht angegeben, wird standardmäßig JSON verwendet.
imageId	string Optional. Gibt die Konfiguration für IMAGE_BYTES an.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von ProcessedDocument.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter Authentication Overview.

IAM-Berechtigungen

Erfordert die folgende IAM-Berechtigung für die Ressource name:

• discoveryengine.documents.get

Weitere Informationen finden Sie in der IAM-Dokumentation.