Documentation

Google_Service_Vision_Resource_ProjectsLocationsImages extends Google_Service_Resource
in package

The "images" collection of methods.

Typical usage is: $visionService = new Google_Service_Vision(...); $images = $visionService->images;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
annotate()  : Google_Service_Vision_BatchAnnotateImagesResponse
Run image detection and annotation for a batch of images. (images.annotate)
asyncBatchAnnotate()  : Google_Service_Vision_Operation
Run asynchronous image detection and annotation for a list of images.
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
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 —

annotate()

Run image detection and annotation for a batch of images. (images.annotate)

public annotate(string $parent, Google_Service_Vision_BatchAnnotateImagesRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Vision_BatchAnnotateImagesResponse
Parameters
$parent : string

Optional. Target project and location to make a call. Format: projects/{project-id}/locations/{location-id}. If no parent is specified, a region will be chosen automatically. Supported location-ids: us: USA country only, asia: East asia areas, like Japan, Taiwan, eu: The European Union. Example: projects/project-A/locations/eu.

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

Optional parameters.

Return values
Google_Service_Vision_BatchAnnotateImagesResponse —

asyncBatchAnnotate()

Run asynchronous image detection and annotation for a list of images.

public asyncBatchAnnotate(string $parent, Google_Service_Vision_AsyncBatchAnnotateImagesRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Vision_Operation

Progress and results can be retrieved through the google.longrunning.Operations interface. Operation.metadata contains OperationMetadata (metadata). Operation.response contains AsyncBatchAnnotateImagesResponse (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto. (images.asyncBatchAnnotate)

Parameters
$parent : string

Optional. Target project and location to make a call. Format: projects/{project-id}/locations/{location-id}. If no parent is specified, a region will be chosen automatically. Supported location-ids: us: USA country only, asia: East asia areas, like Japan, Taiwan, eu: The European Union. Example: projects/project-A/locations/eu.

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

Optional parameters.

Return values
Google_Service_Vision_Operation —

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

convertToArrayAndStripNulls()

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

Search results