Googly.CloudVision.Files (googly_cloud_vision v0.1.0)

Endpoints for the Files resource.

Summary

Functions

Service that performs image detection and annotation for a batch of files. Now only "application/pdf", "image/tiff" and "image/gif" are supported. This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted.

async_batch_annotate(opts \\ [])

Run asynchronous image detection and annotation for a list of generic files, such as PDF files, which may contain multiple pages and multiple images per page. Progress and results can be retrieved through the google.longrunning.Operations interface. Operation.metadata contains OperationMetadata (metadata). Operation.response contains AsyncBatchAnnotateFilesResponse (results).

Functions

annotate(opts \\ [])

@spec annotate(keyword()) ::
  {:ok, Googly.CloudVision.Model.BatchAnnotateFilesResponse.t()}
  | {:error, term()}

Parameters

opts (type: keyword()) - Query and call options (:token, plus any of the below)
- access_token (type: String.t()) - OAuth access token.
- alt (type: String.t()) - Data format for response.
- callback (type: String.t()) - JSONP
- fields (type: String.t()) - Selector specifying which fields to include in a partial response.
- key (type: String.t()) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- oauth_token (type: String.t()) - OAuth 2.0 token for the current user.
- pretty_print (type: boolean()) - Returns response with indentations and line breaks.
- quota_user (type: String.t()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- upload_protocol (type: String.t()) - Upload protocol for media (e.g. "raw", "multipart").
- upload_type (type: String.t()) - Legacy upload protocol for media (e.g. "media", "multipart").
- xgafv (type: String.t()) - V1 error format.
- body (type: Googly.CloudVision.Model.BatchAnnotateFilesRequest.t()) -

Returns

{:ok, %Googly.CloudVision.Model.BatchAnnotateFilesResponse{}} on success
{:error, %Googly.CloudVision.Error{}} on failure

async_batch_annotate(opts \\ [])

@spec async_batch_annotate(keyword()) ::
  {:ok, Googly.CloudVision.Model.Operation.t()} | {:error, term()}

Parameters

opts (type: keyword()) - Query and call options (:token, plus any of the below)
- access_token (type: String.t()) - OAuth access token.
- alt (type: String.t()) - Data format for response.
- callback (type: String.t()) - JSONP
- fields (type: String.t()) - Selector specifying which fields to include in a partial response.
- key (type: String.t()) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- oauth_token (type: String.t()) - OAuth 2.0 token for the current user.
- pretty_print (type: boolean()) - Returns response with indentations and line breaks.
- quota_user (type: String.t()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- upload_protocol (type: String.t()) - Upload protocol for media (e.g. "raw", "multipart").
- upload_type (type: String.t()) - Legacy upload protocol for media (e.g. "media", "multipart").
- xgafv (type: String.t()) - V1 error format.
- body (type: Googly.CloudVision.Model.AsyncBatchAnnotateFilesRequest.t()) -

Returns

{:ok, %Googly.CloudVision.Model.Operation{}} on success
{:error, %Googly.CloudVision.Error{}} on failure