def async_batch_annotate_images( self, request: image_annotator.AsyncBatchAnnotateImagesRequest = None, *, requests: Sequence[image_annotator.AnnotateImageRequest] = None, output_config: image_annotator.OutputConfig = None, retry: retries.Retry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> operation.Operation: r"""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. Args: request (:class:`~.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 (:class:`~.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: ~.operation.Operation: An object representing a long-running operation. The result type for the operation will be :class:``~.image_annotator.AsyncBatchAnnotateImagesResponse``: Response to an async batch image annotation request. """ # Create or coerce a protobuf request object. # Sanity check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. has_flattened_params = any([requests, output_config]) if request is not None and has_flattened_params: raise ValueError("If the `request` argument is set, then none of " "the individual field arguments should be set.") # Minor optimization to avoid making a copy if the user passes # in a image_annotator.AsyncBatchAnnotateImagesRequest. # There's no risk of modifying the input as we've already verified # there are no flattened fields. if not isinstance(request, image_annotator.AsyncBatchAnnotateImagesRequest): request = image_annotator.AsyncBatchAnnotateImagesRequest(request) if requests is not None: for i in range(len(requests)): requests[i] = image_annotator.AnnotateImageRequest( requests[i]) # If we have keyword arguments corresponding to fields on the # request, apply these. if output_config is not None: request.output_config = output_config if requests: request.requests.extend(requests) # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = self._transport._wrapped_methods[ self._transport.async_batch_annotate_images] # Send the request. response = rpc( request, retry=retry, timeout=timeout, metadata=metadata, ) # Wrap the response in an operation future. response = operation.from_gapic( response, self._transport.operations_client, image_annotator.AsyncBatchAnnotateImagesResponse, metadata_type=image_annotator.OperationMetadata, ) # Done; return the response. return response
def batch_annotate_images( self, request: image_annotator.BatchAnnotateImagesRequest = None, *, requests: Sequence[image_annotator.AnnotateImageRequest] = None, retry: retries.Retry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> image_annotator.BatchAnnotateImagesResponse: r"""Run image detection and annotation for a batch of images. Args: request (:class:`~.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: ~.image_annotator.BatchAnnotateImagesResponse: Response to a batch image annotation request. """ # Create or coerce a protobuf request object. # Sanity check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. has_flattened_params = any([requests]) if request is not None and has_flattened_params: raise ValueError("If the `request` argument is set, then none of " "the individual field arguments should be set.") # Minor optimization to avoid making a copy if the user passes # in a image_annotator.BatchAnnotateImagesRequest. # There's no risk of modifying the input as we've already verified # there are no flattened fields. if not isinstance(request, image_annotator.BatchAnnotateImagesRequest): request = image_annotator.BatchAnnotateImagesRequest(request) if requests is not None: for i in range(len(requests)): requests[i] = image_annotator.AnnotateImageRequest( requests[i]) # If we have keyword arguments corresponding to fields on the # request, apply these. if requests: request.requests.extend(requests) # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = self._transport._wrapped_methods[ self._transport.batch_annotate_images] # Send the request. response = rpc( request, retry=retry, timeout=timeout, metadata=metadata, ) # Done; return the response. return response