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

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

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta

Parámetros
name

string

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

Si el llamador no tiene permiso para acceder al Document, independientemente de si existe o no, se muestra un error PERMISSION_DENIED.

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

Parámetros de consulta

Parámetros
processedDocumentType

enum (ProcessedDocumentType)

Obligatorio. Qué tipo de procesamiento se debe mostrar.
processedDocumentFormat

enum (ProcessedDocumentFormat)

Qué formato de salida debe tener. Si no se especifica, se establece de forma predeterminada como JSON.
imageId

string

Es 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 se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de ProcessedDocument.

Alcances de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

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

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • discoveryengine.documents.get

Para obtener más información, consulta la documentación de IAM.