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

Obtient les informations de mise en page analysées pour un Document.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
name

string

Obligatoire. Nom complet de la ressource Document, par exemple projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{document}.

Si l'appelant n'est pas autorisé à accéder à Document, qu'il existe ou non, une erreur PERMISSION_DENIED est renvoyée.

Si le Document demandé n'existe pas, une erreur NOT_FOUND est renvoyée.

Paramètres de requête

Paramètres
processedDocumentType

enum (ProcessedDocumentType)

Obligatoire. Type de traitement à renvoyer.
processedDocumentFormat

enum (ProcessedDocumentFormat)

Format de sortie. Si aucune valeur n'est spécifiée, la valeur par défaut est JSON.
imageId

string

Facultatif. Spécifie la configuration pour IMAGE_BYTES.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de ProcessedDocument.

Niveaux d'accès des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour plus d'informations, consultez la Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource name :

  • discoveryengine.documents.get

Pour en savoir plus, consultez la documentation IAM.