Googly.CloudVision.Images (googly_cloud_vision v0.1.0)

Copy Markdown View Source

Endpoints for the Images resource.

Summary

Functions

annotate(opts \\ [])

Run image detection and annotation for a batch of images.

async_batch_annotate(opts \\ [])

Run asynchronous image detection and annotation for a list of images. 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.

Functions

annotate(opts \\ [])

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

Run image detection and annotation for a batch of images.

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.BatchAnnotateImagesRequest.t()) -

Returns

  • {:ok, %Googly.CloudVision.Model.BatchAnnotateImagesResponse{}} 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()}

Run asynchronous image detection and annotation for a list of images. 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.

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.AsyncBatchAnnotateImagesRequest.t()) -

Returns

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