1 <html><body> 2 <style> 3 4 body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13 } 14 15 body { 16 font-size: 13px; 17 padding: 1em; 18 } 19 20 h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23 } 24 25 h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28 } 29 30 h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34 } 35 36 pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39 } 40 41 pre { 42 margin-top: 0.5em; 43 } 44 45 h1, h2, h3, p { 46 font-family: Arial, sans serif; 47 } 48 49 h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51 } 52 53 .toc_element { 54 margin-top: 0.5em; 55 } 56 57 .firstline { 58 margin-left: 2 em; 59 } 60 61 .method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66 } 67 68 .details { 69 font-weight: bold; 70 font-size: 14px; 71 } 72 73 </style> 74 75 <h1><a href="videointelligence_v1beta1.html">Google Cloud Video Intelligence API</a> . <a href="videointelligence_v1beta1.videos.html">videos</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#annotate">annotate(body, x__xgafv=None)</a></code></p> 79 <p class="firstline">Performs asynchronous video annotation. Progress and results can be</p> 80 <h3>Method Details</h3> 81 <div class="method"> 82 <code class="details" id="annotate">annotate(body, x__xgafv=None)</code> 83 <pre>Performs asynchronous video annotation. Progress and results can be 84 retrieved through the `google.longrunning.Operations` interface. 85 `Operation.metadata` contains `AnnotateVideoProgress` (progress). 86 `Operation.response` contains `AnnotateVideoResponse` (results). 87 88 Args: 89 body: object, The request body. (required) 90 The object takes the form of: 91 92 { # Video annotation request. 93 "videoContext": { # Video context and/or feature-specific parameters. # Additional video context and/or feature-specific parameters. 94 "shotChangeDetectionModel": "A String", # Model to use for shot change detection. 95 # Supported values: "latest" and "stable" (the default). 96 "labelDetectionModel": "A String", # Model to use for label detection. 97 # Supported values: "latest" and "stable" (the default). 98 "segments": [ # Video segments to annotate. The segments may overlap and are not required 99 # to be contiguous or span the whole video. If unspecified, each video 100 # is treated as a single segment. 101 { # Video segment. 102 "endTimeOffset": "A String", # End offset in microseconds (inclusive). Unset means 0. 103 "startTimeOffset": "A String", # Start offset in microseconds (inclusive). Unset means 0. 104 }, 105 ], 106 "labelDetectionMode": "A String", # If label detection has been requested, what labels should be detected 107 # in addition to video-level labels or segment-level labels. If unspecified, 108 # defaults to `SHOT_MODE`. 109 }, 110 "features": [ # Requested video annotation features. 111 "A String", 112 ], 113 "inputContent": "A String", # The video data bytes. Encoding: base64. If unset, the input video(s) 114 # should be specified via `input_uri`. If set, `input_uri` should be unset. 115 "inputUri": "A String", # Input video location. Currently, only 116 # [Google Cloud Storage](https://cloud.google.com/storage/) URIs are 117 # supported, which must be specified in the following format: 118 # `gs://bucket-id/object-id` (other URI formats return 119 # google.rpc.Code.INVALID_ARGUMENT). For more information, see 120 # [Request URIs](/storage/docs/reference-uris). 121 # A video URI may include wildcards in `object-id`, and thus identify 122 # multiple videos. Supported wildcards: '*' to match 0 or more characters; 123 # '?' to match 1 character. If unset, the input video should be embedded 124 # in the request as `input_content`. If set, `input_content` should be unset. 125 "locationId": "A String", # Optional cloud region where annotation should take place. Supported cloud 126 # regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region 127 # is specified, a region will be determined based on video file location. 128 "outputUri": "A String", # Optional location where the output (in JSON format) should be stored. 129 # Currently, only [Google Cloud Storage](https://cloud.google.com/storage/) 130 # URIs are supported, which must be specified in the following format: 131 # `gs://bucket-id/object-id` (other URI formats return 132 # google.rpc.Code.INVALID_ARGUMENT). For more information, see 133 # [Request URIs](/storage/docs/reference-uris). 134 } 135 136 x__xgafv: string, V1 error format. 137 Allowed values 138 1 - v1 error format 139 2 - v2 error format 140 141 Returns: 142 An object of the form: 143 144 { # This resource represents a long-running operation that is the result of a 145 # network API call. 146 "metadata": { # Service-specific metadata associated with the operation. It typically 147 # contains progress information and common metadata such as create time. 148 # Some services might not provide such metadata. Any method that returns a 149 # long-running operation should document the metadata type, if any. 150 "a_key": "", # Properties of the object. Contains field @type with type URL. 151 }, 152 "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation. 153 # programming environments, including REST APIs and RPC APIs. It is used by 154 # [gRPC](https://github.com/grpc). The error model is designed to be: 155 # 156 # - Simple to use and understand for most users 157 # - Flexible enough to meet unexpected needs 158 # 159 # # Overview 160 # 161 # The `Status` message contains three pieces of data: error code, error message, 162 # and error details. The error code should be an enum value of 163 # google.rpc.Code, but it may accept additional error codes if needed. The 164 # error message should be a developer-facing English message that helps 165 # developers *understand* and *resolve* the error. If a localized user-facing 166 # error message is needed, put the localized message in the error details or 167 # localize it in the client. The optional error details may contain arbitrary 168 # information about the error. There is a predefined set of error detail types 169 # in the package `google.rpc` that can be used for common error conditions. 170 # 171 # # Language mapping 172 # 173 # The `Status` message is the logical representation of the error model, but it 174 # is not necessarily the actual wire format. When the `Status` message is 175 # exposed in different client libraries and different wire protocols, it can be 176 # mapped differently. For example, it will likely be mapped to some exceptions 177 # in Java, but more likely mapped to some error codes in C. 178 # 179 # # Other uses 180 # 181 # The error model and the `Status` message can be used in a variety of 182 # environments, either with or without APIs, to provide a 183 # consistent developer experience across different environments. 184 # 185 # Example uses of this error model include: 186 # 187 # - Partial errors. If a service needs to return partial errors to the client, 188 # it may embed the `Status` in the normal response to indicate the partial 189 # errors. 190 # 191 # - Workflow errors. A typical workflow has multiple steps. Each step may 192 # have a `Status` message for error reporting. 193 # 194 # - Batch operations. If a client uses batch request and batch response, the 195 # `Status` message should be used directly inside batch response, one for 196 # each error sub-response. 197 # 198 # - Asynchronous operations. If an API call embeds asynchronous operation 199 # results in its response, the status of those operations should be 200 # represented directly using the `Status` message. 201 # 202 # - Logging. If some API errors are stored in logs, the message `Status` could 203 # be used directly after any stripping needed for security/privacy reasons. 204 "message": "A String", # A developer-facing error message, which should be in English. Any 205 # user-facing error message should be localized and sent in the 206 # google.rpc.Status.details field, or localized by the client. 207 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 208 "details": [ # A list of messages that carry the error details. There will be a 209 # common set of message types for APIs to use. 210 { 211 "a_key": "", # Properties of the object. Contains field @type with type URL. 212 }, 213 ], 214 }, 215 "done": True or False, # If the value is `false`, it means the operation is still in progress. 216 # If true, the operation is completed, and either `error` or `response` is 217 # available. 218 "response": { # The normal response of the operation in case of success. If the original 219 # method returns no data on success, such as `Delete`, the response is 220 # `google.protobuf.Empty`. If the original method is standard 221 # `Get`/`Create`/`Update`, the response should be the resource. For other 222 # methods, the response should have the type `XxxResponse`, where `Xxx` 223 # is the original method name. For example, if the original method name 224 # is `TakeSnapshot()`, the inferred response type is 225 # `TakeSnapshotResponse`. 226 "a_key": "", # Properties of the object. Contains field @type with type URL. 227 }, 228 "name": "A String", # The server-assigned name, which is only unique within the same service that 229 # originally returns it. If you use the default HTTP mapping, the 230 # `name` should have the format of `operations/some/unique/name`. 231 }</pre> 232 </div> 233 234 </body></html>
