As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

ImageAnnotator

class google.cloud.vision_v1p3beta1.services.image_annotator.ImageAnnotatorAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.vision_v1p3beta1.services.image_annotator.transports.base.ImageAnnotatorTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/.nox/docs/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]

Service that performs Google Cloud Vision API detection tasks over client images, such as face, landmark, logo, label, and text detection. The ImageAnnotator service returns detected entities from the images.

Instantiates the image annotator client.

Parameters
  • credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.

  • transport (Union[str, ImageAnnotatorTransport]) – The transport to use. If set to None, a transport is chosen automatically.

  • client_options (ClientOptions) – Custom options for the client. It won’t take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

async async_batch_annotate_files(request: Optional[google.cloud.vision_v1p3beta1.types.image_annotator.AsyncBatchAnnotateFilesRequest] = None, *, requests: Optional[Sequence[google.cloud.vision_v1p3beta1.types.image_annotator.AsyncAnnotateFileRequest]] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

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).

Parameters
  • request (google.cloud.vision_v1p3beta1.types.AsyncBatchAnnotateFilesRequest) – The request object. Multiple async file annotation requests are batched into a single service call.

  • requests (Sequence[google.cloud.vision_v1p3beta1.types.AsyncAnnotateFileRequest]) –

    Required. Individual async file annotation requests for this batch.

    This corresponds to the requests field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.vision_v1p3beta1.types.AsyncBatchAnnotateFilesResponse Response to an async batch file annotation request.

Return type

google.api_core.operation_async.AsyncOperation

async batch_annotate_images(request: Optional[google.cloud.vision_v1p3beta1.types.image_annotator.BatchAnnotateImagesRequest] = None, *, requests: Optional[Sequence[google.cloud.vision_v1p3beta1.types.image_annotator.AnnotateImageRequest]] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.vision_v1p3beta1.types.image_annotator.BatchAnnotateImagesResponse[source]

Run image detection and annotation for a batch of images.

Parameters
  • request (google.cloud.vision_v1p3beta1.types.BatchAnnotateImagesRequest) – The request object. Multiple image annotation requests are batched into a single service call.

  • requests (Sequence[google.cloud.vision_v1p3beta1.types.AnnotateImageRequest]) –

    Individual image annotation requests for this batch.

    This corresponds to the requests field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response to a batch image annotation request.

Return type

google.cloud.vision_v1p3beta1.types.BatchAnnotateImagesResponse

static common_billing_account_path(billing_account: str)str

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str)str

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str)str

Returns a fully-qualified location string.

static common_organization_path(organization: str)str

Returns a fully-qualified organization string.

static common_project_path(project: str)str

Returns a fully-qualified project string.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ImageAnnotatorAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters
  • info (dict) – The service account private key info.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ImageAnnotatorAsyncClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ImageAnnotatorAsyncClient

get_transport_class()Type[google.cloud.vision_v1p3beta1.services.image_annotator.transports.base.ImageAnnotatorTransport]

Returns an appropriate transport class.

Parameters

label – The name of the desired transport. If none is provided, then the first transport in the registry is used.

Returns

The transport class to use.

static parse_common_billing_account_path(path: str)Dict[str, str]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str)Dict[str, str]

Parse a folder path into its component segments.

static parse_common_location_path(path: str)Dict[str, str]

Parse a location path into its component segments.

static parse_common_organization_path(path: str)Dict[str, str]

Parse a organization path into its component segments.

static parse_common_project_path(path: str)Dict[str, str]

Parse a project path into its component segments.

static parse_product_path(path: str)Dict[str, str]

Parses a product path into its component segments.

static parse_product_set_path(path: str)Dict[str, str]

Parses a product_set path into its component segments.

static product_path(project: str, location: str, product: str)str

Returns a fully-qualified product string.

static product_set_path(project: str, location: str, product_set: str)str

Returns a fully-qualified product_set string.

property transport: google.cloud.vision_v1p3beta1.services.image_annotator.transports.base.ImageAnnotatorTransport

Returns the transport used by the client instance.

Returns

The transport used by the client instance.

Return type

ImageAnnotatorTransport

class google.cloud.vision_v1p3beta1.services.image_annotator.ImageAnnotatorClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.vision_v1p3beta1.services.image_annotator.transports.base.ImageAnnotatorTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]

Service that performs Google Cloud Vision API detection tasks over client images, such as face, landmark, logo, label, and text detection. The ImageAnnotator service returns detected entities from the images.

Instantiates the image annotator client.

Parameters
  • credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.

  • transport (Union[str, ImageAnnotatorTransport]) – The transport to use. If set to None, a transport is chosen automatically.

  • client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. It won’t take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

  • client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]

Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

async_batch_annotate_files(request: Optional[Union[google.cloud.vision_v1p3beta1.types.image_annotator.AsyncBatchAnnotateFilesRequest, dict]] = None, *, requests: Optional[Sequence[google.cloud.vision_v1p3beta1.types.image_annotator.AsyncAnnotateFileRequest]] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

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).

Parameters
Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.vision_v1p3beta1.types.AsyncBatchAnnotateFilesResponse Response to an async batch file annotation request.

Return type

google.api_core.operation.Operation

batch_annotate_images(request: Optional[Union[google.cloud.vision_v1p3beta1.types.image_annotator.BatchAnnotateImagesRequest, dict]] = None, *, requests: Optional[Sequence[google.cloud.vision_v1p3beta1.types.image_annotator.AnnotateImageRequest]] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.vision_v1p3beta1.types.image_annotator.BatchAnnotateImagesResponse[source]

Run image detection and annotation for a batch of images.

Parameters
Returns

Response to a batch image annotation request.

Return type

google.cloud.vision_v1p3beta1.types.BatchAnnotateImagesResponse

static common_billing_account_path(billing_account: str)str[source]

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str)str[source]

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str)str[source]

Returns a fully-qualified location string.

static common_organization_path(organization: str)str[source]

Returns a fully-qualified organization string.

static common_project_path(project: str)str[source]

Returns a fully-qualified project string.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ImageAnnotatorClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters
  • info (dict) – The service account private key info.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ImageAnnotatorClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ImageAnnotatorClient

static parse_common_billing_account_path(path: str)Dict[str, str][source]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str)Dict[str, str][source]

Parse a folder path into its component segments.

static parse_common_location_path(path: str)Dict[str, str][source]

Parse a location path into its component segments.

static parse_common_organization_path(path: str)Dict[str, str][source]

Parse a organization path into its component segments.

static parse_common_project_path(path: str)Dict[str, str][source]

Parse a project path into its component segments.

static parse_product_path(path: str)Dict[str, str][source]

Parses a product path into its component segments.

static parse_product_set_path(path: str)Dict[str, str][source]

Parses a product_set path into its component segments.

static product_path(project: str, location: str, product: str)str[source]

Returns a fully-qualified product string.

static product_set_path(project: str, location: str, product_set: str)str[source]

Returns a fully-qualified product_set string.

property transport: google.cloud.vision_v1p3beta1.services.image_annotator.transports.base.ImageAnnotatorTransport

Returns the transport used by the client instance.

Returns

The transport used by the client

instance.

Return type

ImageAnnotatorTransport