ImageAnnotatorAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.vision_v1p3beta1.services.image_annotator.transports.base.ImageAnnotatorTransport] = 'grpc_asyncio', 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>)
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
Returns the transport used by the client instance.
Type | Description |
ImageAnnotatorTransport | The transport used by the client instance. |
Methods
ImageAnnotatorAsyncClient
ImageAnnotatorAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.vision_v1p3beta1.services.image_annotator.transports.base.ImageAnnotatorTransport] = 'grpc_asyncio', 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>)
Instantiates the image annotator client.
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 |
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[Union[google.cloud.vision_v1p3beta1.types.image_annotator.AsyncBatchAnnotateFilesRequest, dict]] = None, *, requests: Optional[MutableSequence[google.cloud.vision_v1p3beta1.types.image_annotator.AsyncAnnotateFileRequest]] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, 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).
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import vision_v1p3beta1
async def sample_async_batch_annotate_files():
# Create a client
client = vision_v1p3beta1.ImageAnnotatorAsyncClient()
# Initialize request argument(s)
request = vision_v1p3beta1.AsyncBatchAnnotateFilesRequest(
)
# Make the request
operation = client.async_batch_annotate_files(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Name | Description |
request |
Optional[Union[google.cloud.vision_v1p3beta1.types.AsyncBatchAnnotateFilesRequest, dict]]
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. |
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[Union[google.cloud.vision_v1p3beta1.types.image_annotator.BatchAnnotateImagesRequest, dict]] = None, *, requests: Optional[MutableSequence[google.cloud.vision_v1p3beta1.types.image_annotator.AnnotateImageRequest]] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Run image detection and annotation for a batch of images.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import vision_v1p3beta1
async def sample_batch_annotate_images():
# Create a client
client = vision_v1p3beta1.ImageAnnotatorAsyncClient()
# Initialize request argument(s)
request = vision_v1p3beta1.BatchAnnotateImagesRequest(
)
# Make the request
response = await client.batch_annotate_images(request=request)
# Handle the response
print(response)
Name | Description |
request |
Optional[Union[google.cloud.vision_v1p3beta1.types.BatchAnnotateImagesRequest, dict]]
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. |
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)
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)
Returns 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.