Class ImageAnnotatorAsyncClient (2.1.0)

ImageAnnotatorAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.vision_v1p4beta1.services.image_annotator.transports.base.ImageAnnotatorTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-vision/.nox/docfx/lib/python3.9/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>)

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.

Properties

transport

Return the transport used by the client instance.

Returns
Type	Description
`ImageAnnotatorTransport`	The transport used by the client instance.

Methods

ImageAnnotatorAsyncClient

ImageAnnotatorAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.vision_v1p4beta1.services.image_annotator.transports.base.ImageAnnotatorTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-vision/.nox/docfx/lib/python3.9/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>)

Instantiate the image annotator client.

Parameters
Name	Description
`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.

Exceptions
Type	Description
`google.auth.exceptions.MutualTlsChannelError`	If mutual TLS transport creation failed for any reason.

async_batch_annotate_files

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

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
Name	Description
`request`	`.image_annotator.AsyncBatchAnnotateFilesRequest` The request object. Multiple async file annotation requests are batched into a single service call.
`requests`	`:class:Sequence[.image_annotator.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
Type	Description
`.operation_async.AsyncOperation`	An object representing a long-running operation. The result type for the operation will be .image_annotator.AsyncBatchAnnotateFilesResponse : Response to an async batch file annotation request.

async_batch_annotate_images

async_batch_annotate_images(request: Optional[google.cloud.vision_v1p4beta1.types.image_annotator.AsyncBatchAnnotateImagesRequest] = None, *, requests: Optional[Sequence[google.cloud.vision_v1p4beta1.types.image_annotator.AnnotateImageRequest]] = None, output_config: Optional[google.cloud.vision_v1p4beta1.types.image_annotator.OutputConfig] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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
Name	Description
`request`	`.image_annotator.AsyncBatchAnnotateImagesRequest` The request object. Request for async image annotation for a list of images.
`requests`	`:class:Sequence[.image_annotator.AnnotateImageRequest]` Required. 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.
`output_config`	`.image_annotator.OutputConfig` Required. The desired output location and metadata (e.g. format). This corresponds to the `output_config` 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
Type	Description
`.operation_async.AsyncOperation`	An object representing a long-running operation. The result type for the operation will be .image_annotator.AsyncBatchAnnotateImagesResponse : Response to an async batch image annotation request.

batch_annotate_files

batch_annotate_files(request: Optional[google.cloud.vision_v1p4beta1.types.image_annotator.BatchAnnotateFilesRequest] = None, *, requests: Optional[Sequence[google.cloud.vision_v1p4beta1.types.image_annotator.AnnotateFileRequest]] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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.

Parameters
Name	Description
`request`	`.image_annotator.BatchAnnotateFilesRequest` The request object. A list of requests to annotate files using the BatchAnnotateFiles API.
`requests`	`:class:Sequence[.image_annotator.AnnotateFileRequest]` Required. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest. 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
Type	Description
`.image_annotator.BatchAnnotateFilesResponse`	A list of file annotation responses.

batch_annotate_images

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

Run image detection and annotation for a batch of images.

Parameters
Name	Description
`request`	`.image_annotator.BatchAnnotateImagesRequest` The request object. Multiple image annotation requests are batched into a single service call.
`requests`	`:class:Sequence[.image_annotator.AnnotateImageRequest]` Required. 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
Type	Description
`.image_annotator.BatchAnnotateImagesResponse`	Response to a batch image annotation request.

common_billing_account_path

common_billing_account_path(billing_account: str)

Return a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Return a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Return a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Return a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Return a fully-qualified project string.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`{@api.name}`	The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`{@api.name}`	The constructed client.

get_transport_class

get_transport_class()

Return an appropriate transport class.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

parse_product_path

parse_product_path(path: str)

Parse a product path into its component segments.

parse_product_set_path

parse_product_set_path(path: str)

Parse a product_set path into its component segments.

product_path

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

Return a fully-qualified product string.

product_set_path

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

Return a fully-qualified product_set string.