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

Obtiene la información de diseño analizada de un Document.

Solicitud HTTP

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

La URL utiliza la sintaxis de transcodificación a gRPC.

Parámetros de ruta

Parámetros
name

string

Obligatorio. Nombre completo del recurso Document, como projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{document}.

Si la persona que llama no tiene permiso para acceder a Document, independientemente de si existe o no, se devuelve un error PERMISSION_DENIED.

Si el Document solicitado no existe, se devuelve un error NOT_FOUND.

Los parámetros de consulta

Parámetros
processedDocumentType

enum (ProcessedDocumentType)

Obligatorio. Qué tipo de procesamiento se va a devolver.
processedDocumentFormat

enum (ProcessedDocumentFormat)

El formato de salida que debe tener. Si no se especifica, se usa JSON de forma predeterminada.
imageId

string

Opcional. Especifica la configuración de IMAGE_BYTES.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si la solicitud se hace correctamente, en el cuerpo de la respuesta se incluye una instancia de ProcessedDocument.

Permisos de autorización

Debes disponer de uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta el Authentication Overview.

Permisos de IAM

Requiere el siguiente permiso de gestión de identidades y accesos en el recurso name:

  • discoveryengine.documents.get

Para obtener más información, consulta la documentación de gestión de identidades y accesos.