ImageAnnotatorClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.vision_v1p4beta1.services.image_annotator.transports.base.ImageAnnotatorTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = 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.
Returns | |
---|---|
Type | Description |
ImageAnnotatorTransport | The transport used by the client instance. |
Methods
ImageAnnotatorClient
ImageAnnotatorClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.vision_v1p4beta1.services.image_annotator.transports.base.ImageAnnotatorTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = 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.
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 |
Optional[Union[google.api_core.client_options.ClientOptions, dict]]
Custom options for the client. It won't take effect if a |
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 |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
async_batch_annotate_files
async_batch_annotate_files(
request: typing.Optional[
typing.Union[
google.cloud.vision_v1p4beta1.types.image_annotator.AsyncBatchAnnotateFilesRequest,
dict,
]
] = None,
*,
requests: typing.Optional[
typing.MutableSequence[
google.cloud.vision_v1p4beta1.types.image_annotator.AsyncAnnotateFileRequest
]
] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
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_v1p4beta1
def sample_async_batch_annotate_files():
# Create a client
client = vision_v1p4beta1.ImageAnnotatorClient()
# Initialize request argument(s)
request = vision_v1p4beta1.AsyncBatchAnnotateFilesRequest(
)
# Make the request
operation = client.async_batch_annotate_files(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.vision_v1p4beta1.types.AsyncBatchAnnotateFilesRequest, dict]
The request object. Multiple async file annotation requests are batched into a single service call. |
requests |
MutableSequence[google.cloud.vision_v1p4beta1.types.AsyncAnnotateFileRequest]
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.Operation | An object representing a long-running operation. The result type for the operation will be AsyncBatchAnnotateFilesResponse Response to an async batch file annotation request. |
async_batch_annotate_images
async_batch_annotate_images(
request: typing.Optional[
typing.Union[
google.cloud.vision_v1p4beta1.types.image_annotator.AsyncBatchAnnotateImagesRequest,
dict,
]
] = None,
*,
requests: typing.Optional[
typing.MutableSequence[
google.cloud.vision_v1p4beta1.types.image_annotator.AnnotateImageRequest
]
] = None,
output_config: typing.Optional[
google.cloud.vision_v1p4beta1.types.image_annotator.OutputConfig
] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
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.
# 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_v1p4beta1
def sample_async_batch_annotate_images():
# Create a client
client = vision_v1p4beta1.ImageAnnotatorClient()
# Initialize request argument(s)
request = vision_v1p4beta1.AsyncBatchAnnotateImagesRequest(
)
# Make the request
operation = client.async_batch_annotate_images(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.vision_v1p4beta1.types.AsyncBatchAnnotateImagesRequest, dict]
The request object. Request for async image annotation for a list of images. |
requests |
MutableSequence[google.cloud.vision_v1p4beta1.types.AnnotateImageRequest]
Required. Individual image annotation requests for this batch. This corresponds to the |
output_config |
google.cloud.vision_v1p4beta1.types.OutputConfig
Required. The desired output location and metadata (e.g. format). 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.Operation | An object representing a long-running operation. The result type for the operation will be AsyncBatchAnnotateImagesResponse Response to an async batch image annotation request. |
batch_annotate_files
batch_annotate_files(
request: typing.Optional[
typing.Union[
google.cloud.vision_v1p4beta1.types.image_annotator.BatchAnnotateFilesRequest,
dict,
]
] = None,
*,
requests: typing.Optional[
typing.MutableSequence[
google.cloud.vision_v1p4beta1.types.image_annotator.AnnotateFileRequest
]
] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.vision_v1p4beta1.types.image_annotator.BatchAnnotateFilesResponse
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.
# 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_v1p4beta1
def sample_batch_annotate_files():
# Create a client
client = vision_v1p4beta1.ImageAnnotatorClient()
# Initialize request argument(s)
request = vision_v1p4beta1.BatchAnnotateFilesRequest(
)
# Make the request
response = client.batch_annotate_files(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.vision_v1p4beta1.types.BatchAnnotateFilesRequest, dict]
The request object. A list of requests to annotate files using the BatchAnnotateFiles API. |
requests |
MutableSequence[google.cloud.vision_v1p4beta1.types.AnnotateFileRequest]
Required. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest. 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_v1p4beta1.types.BatchAnnotateFilesResponse | A list of file annotation responses. |
batch_annotate_images
batch_annotate_images(
request: typing.Optional[
typing.Union[
google.cloud.vision_v1p4beta1.types.image_annotator.BatchAnnotateImagesRequest,
dict,
]
] = None,
*,
requests: typing.Optional[
typing.MutableSequence[
google.cloud.vision_v1p4beta1.types.image_annotator.AnnotateImageRequest
]
] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.vision_v1p4beta1.types.image_annotator.BatchAnnotateImagesResponse
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_v1p4beta1
def sample_batch_annotate_images():
# Create a client
client = vision_v1p4beta1.ImageAnnotatorClient()
# Initialize request argument(s)
request = vision_v1p4beta1.BatchAnnotateImagesRequest(
)
# Make the request
response = client.batch_annotate_images(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.vision_v1p4beta1.types.BatchAnnotateImagesRequest, dict]
The request object. Multiple image annotation requests are batched into a single service call. |
requests |
MutableSequence[google.cloud.vision_v1p4beta1.types.AnnotateImageRequest]
Required. 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_v1p4beta1.types.BatchAnnotateImagesResponse | Response to a batch image annotation request. |
common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str) -> 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.