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/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_v1p3beta1.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,
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 |
| 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_v1p3beta1.types.image_annotator.AsyncBatchAnnotateFilesRequest] = None, *, requests: Optional[Sequence[google.cloud.vision_v1p3beta1.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 |
AsyncBatchAnnotateFilesRequest
The request object. Multiple async file annotation requests are batched into a single service call. |
requests |
:class:
Required. Individual async file annotation requests for this batch. This corresponds to the |
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 |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be AsyncBatchAnnotateFilesResponse Response to an async batch file annotation request. |
batch_annotate_images
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 = <_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 |
BatchAnnotateImagesRequest
The request object. Multiple image annotation requests are batched into a single service call. |
requests |
:class:
Individual image annotation requests for this batch. This corresponds to the |
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 |
google.cloud.vision_v1p3beta1.types.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 |
ImageAnnotatorClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)Creates an instance of this client using the provided credentials info.
| Parameter | |
|---|---|
| Name | Description |
info |
dict
The service account private key info. |
| Returns | |
|---|---|
| Type | Description |
ImageAnnotatorClient | 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 |
ImageAnnotatorClient | 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.