google_api_vision v0.21.0 GoogleApi.Vision.V1.Api.Images View Source

API calls for all endpoints tagged Images.

Link to this section Summary

Functions

Run image detection and annotation for a batch of images.

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

Link to this section Functions

Link to this function

vision_images_annotate(connection, optional_params \\ [], opts \\ [])

View Source
vision_images_annotate(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Vision.V1.Model.BatchAnnotateImagesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Run image detection and annotation for a batch of images.

Parameters

  • connection (type: GoogleApi.Vision.V1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :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.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Vision.V1.Model.BatchAnnotateImagesRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Vision.V1.Model.BatchAnnotateImagesResponse{}} on success
  • {:error, info} on failure
Link to this function

vision_images_async_batch_annotate(connection, optional_params \\ [], opts \\ [])

View Source
vision_images_async_batch_annotate(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Vision.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

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

  • connection (type: GoogleApi.Vision.V1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :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.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Vision.V1.Model.AsyncBatchAnnotateImagesRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Vision.V1.Model.Operation{}} on success
  • {:error, info} on failure