Documentation

Google_Service_Document_Resource_ProjectsDocuments extends Google_Service_Resource
in package

The "documents" collection of methods.

Typical usage is: $documentaiService = new Google_Service_Document(...); $documents = $documentaiService->documents;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
batchProcess()  : Google_Service_Document_GoogleLongrunningOperation
LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format. (documents.batchProcess)
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
process()  : Google_Service_Document_GoogleCloudDocumentaiV1beta2Document
Processes a single document. (documents.process)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

batchProcess()

LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format. (documents.batchProcess)

public batchProcess(string $parent, Google_Service_Document_GoogleCloudDocumentaiV1beta2BatchProcessDocumentsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Document_GoogleLongrunningOperation
Parameters
$parent : string

Target project and location to make a call. Format: projects/{project-id}/locations/{location-id}. If no location is specified, a region will be chosen automatically.

$postBody : Google_Service_Document_GoogleCloudDocumentaiV1beta2BatchProcessDocumentsRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Document_GoogleLongrunningOperation —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

process()

Processes a single document. (documents.process)

public process(string $parent, Google_Service_Document_GoogleCloudDocumentaiV1beta2ProcessDocumentRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Document_GoogleCloudDocumentaiV1beta2Document
Parameters
$parent : string

Target project and location to make a call. Format: projects/{project-id}/locations/{location-id}. If no location is specified, a region will be chosen automatically. This field is only populated when used in ProcessDocument method.

$postBody : Google_Service_Document_GoogleCloudDocumentaiV1beta2ProcessDocumentRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Document_GoogleCloudDocumentaiV1beta2Document —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results