Class VideoIntelligenceServiceClient (1.15.0)

VideoIntelligenceServiceClient(
    transport=None,
    channel=None,
    credentials=None,
    client_config=None,
    client_info=None,
    client_options=None,
)

Service that implements the Video Intelligence API.

Methods

VideoIntelligenceServiceClient

VideoIntelligenceServiceClient(
    transport=None,
    channel=None,
    credentials=None,
    client_config=None,
    client_info=None,
    client_options=None,
)

Constructor.

Parameters
Name	Description
`channel`	`grpc.Channel` DEPRECATED. A `Channel` instance through which to make calls. This argument is mutually exclusive with `credentials`; providing both will raise an exception.
`credentials`	`google.auth.credentials.Credentials` The authorization credentials to attach to requests. These credentials identify this application to the service. If none are specified, the client will attempt to ascertain the credentials from the environment. This argument is mutually exclusive with providing a transport instance to `transport`; doing so will raise an exception.
`client_config`	`dict` DEPRECATED. A dictionary of call options for each method. If not specified, the default configuration is used.
`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 `None`, then default info will be used. Generally, you only need to set this if you're developing your own client library.
`client_options`	`Union[dict, google.api_core.client_options.ClientOptions]` Client options used to set user options on the client. API Endpoint should be set through client_options.

annotate_video

annotate_video(features, input_uri=None, input_content=None, video_context=None, output_uri=None, location_id=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Performs asynchronous video annotation. Progress and results can be retrieved through the google.longrunning.Operations interface. Operation.metadata contains AnnotateVideoProgress (progress). Operation.response contains AnnotateVideoResponse (results).

.. rubric:: Example

from google.cloud import videointelligence_v1p3beta1 from google.cloud.videointelligence_v1p3beta1 import enums

client = videointelligence_v1p3beta1.VideoIntelligenceServiceClient()

features_element = enums.Feature.LABEL_DETECTION features = [features_element] input_uri = 'gs://cloud-samples-data/video/cat.mp4'

response = client.annotate_video(features, input_uri=input_uri)

def callback(operation_future): ... # Handle result. ... result = operation_future.result()

response.add_done_callback(callback)

Handle metadata.

metadata = response.metadata()

Parameters
Name	Description
`features`	`list[Feature]` Required. Requested video annotation features.
`input_uri`	`str` Input video location. Currently, only `Cloud Storage https://cloud.google.com/storage/` URIs are supported. URIs must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return `google.rpc.Code.INVALID_ARGUMENT`). For more information, see `Request URIs https://cloud.google.com/storage/docs/request-endpoints`. To identify multiple videos, a video URI may include wildcards in the `object-id`. Supported wildcards: '*' to match 0 or more characters; '?' to match 1 character. If unset, the input video should be embedded in the request as `input_content`. If set, `input_content` must be unset.
`input_content`	`bytes` The video data bytes. If unset, the input video(s) should be specified via the `input_uri`. If set, `input_uri` must be unset.
`video_context`	`Union[dict, VideoContext]` Additional video context and/or feature-specific parameters. If a dict is provided, it must be of the same form as the protobuf message VideoContext
`output_uri`	`str` Optional. Location where the output (in JSON format) should be stored. Currently, only `Cloud Storage https://cloud.google.com/storage/` URIs are supported. These must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return `google.rpc.Code.INVALID_ARGUMENT`). For more information, see `Request URIs https://cloud.google.com/storage/docs/request-endpoints`.
`location_id`	`str` Optional. Cloud region where annotation should take place. Supported cloud regions are: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region is specified, the region will be determined based on video file location.
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`Optional[float]` The amount of time, in seconds, to wait for the request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
`metadata`	`Optional[Sequence[Tuple[str, str]]]` Additional metadata that is provided to the method.

Exceptions
Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

from_service_account_file

from_service_account_file(filename, *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
`VideoIntelligenceServiceClient`	The constructed client.

from_service_account_json

from_service_account_json(filename, *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
`VideoIntelligenceServiceClient`	The constructed client.