Blame - docs/dyn/videointelligence_v1p1beta1.videos.html - platform/external/python/google-api-python-client - Gitiles

blob: 40cbe4adb64b73469558209f1ee7cad27633acb2 [file] [log] [blame]

Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	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_v1p1beta1.html">Cloud Video Intelligence API</a> . <a href="videointelligence_v1p1beta1.videos.html">videos</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	78	<code><a href="#annotate">annotate(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	79	<p class="firstline">Performs asynchronous video annotation. Progress and results can be</p>
				80	<h3>Method Details</h3>
				81	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	82	<code class="details" id="annotate">annotate(body=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	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:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	89	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	90	The object takes the form of:
				91
				92	{ # Video annotation request.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	93	"features": [ # Required. Requested video annotation features.
				94	"A String",
				95	],
				96	"outputUri": "A String", # Optional. Location where the output (in JSON format) should be stored.
				97	# Currently, only [Cloud Storage](https://cloud.google.com/storage/)
				98	# URIs are supported. These must be specified in the following format:
				99	# `gs://bucket-id/object-id` (other URI formats return
				100	# google.rpc.Code.INVALID_ARGUMENT). For more information, see
				101	# [Request URIs](https://cloud.google.com/storage/docs/request-endpoints).
				102	"videoContext": { # Video context and/or feature-specific parameters. # Additional video context and/or feature-specific parameters.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	103	"objectTrackingConfig": { # Config for OBJECT_TRACKING. # Config for OBJECT_TRACKING.
				104	"model": "A String", # Model to use for object tracking.
				105	# Supported values: "builtin/stable" (the default if unset) and
				106	# "builtin/latest".
				107	},
				108	"speechTranscriptionConfig": { # Config for SPEECH_TRANSCRIPTION. # Config for SPEECH_TRANSCRIPTION.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	109	"diarizationSpeakerCount": 42, # Optional. If set, specifies the estimated number of speakers in the conversation.
				110	# If not set, defaults to '2'.
				111	# Ignored unless enable_speaker_diarization is set to true.
				112	"maxAlternatives": 42, # Optional. Maximum number of recognition hypotheses to be returned.
				113	# Specifically, the maximum number of `SpeechRecognitionAlternative` messages
				114	# within each `SpeechTranscription`. The server may return fewer than
				115	# `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` will
				116	# return a maximum of one. If omitted, will return a maximum of one.
				117	"languageCode": "A String", # Required. Required The language of the supplied audio as a
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	118	# [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	119	# Example: "en-US".
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	120	# See [Language Support](https://cloud.google.com/speech/docs/languages)
				121	# for a list of the currently supported language codes.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	122	"speechContexts": [ # Optional. A means to provide context to assist the speech recognition.
				123	{ # Provides "hints" to the speech recognizer to favor specific words and phrases
				124	# in the results.
				125	"phrases": [ # Optional. A list of strings containing words and phrases "hints" so that
				126	# the speech recognition is more likely to recognize them. This can be used
				127	# to improve the accuracy for specific words and phrases, for example, if
				128	# specific commands are typically spoken by the user. This can also be used
				129	# to add additional words to the vocabulary of the recognizer. See
				130	# [usage limits](https://cloud.google.com/speech/limits#content).
				131	"A String",
				132	],
				133	},
				134	],
				135	"filterProfanity": True or False, # Optional. If set to `true`, the server will attempt to filter out
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	136	# profanities, replacing all but the initial character in each filtered word
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	137	# with asterisks, e.g. "f***". If set to `false` or omitted, profanities
				138	# won't be filtered out.
				139	"enableSpeakerDiarization": True or False, # Optional. If 'true', enables speaker detection for each recognized word in
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	140	# the top alternative of the recognition result using a speaker_tag provided
				141	# in the WordInfo.
				142	# Note: When this is true, we send all the words from the beginning of the
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	143	# audio for the top alternative in every consecutive response.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	144	# This is done in order to improve our speaker tags as our models learn to
				145	# identify the speakers in the conversation over time.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	146	"enableWordConfidence": True or False, # Optional. If `true`, the top result includes a list of words and the
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	147	# confidence for those words. If `false`, no word-level confidence
				148	# information is returned. The default is `false`.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	149	"enableAutomaticPunctuation": True or False, # Optional. If 'true', adds punctuation to recognition result hypotheses.
				150	# This feature is only available in select languages. Setting this for
				151	# requests in other languages has no effect at all. The default 'false' value
				152	# does not add punctuation to result hypotheses. NOTE: "This is currently
				153	# offered as an experimental service, complimentary to all users. In the
				154	# future this may be exclusively available as a premium feature."
				155	"audioTracks": [ # Optional. For file formats, such as MXF or MKV, supporting multiple audio
				156	# tracks, specify up to two tracks. Default: track 0.
				157	42,
				158	],
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	159	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	160	"segments": [ # Video segments to annotate. The segments may overlap and are not required
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	161	# to be contiguous or span the whole video. If unspecified, each video is
				162	# treated as a single segment.
				163	{ # Video segment.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	164	"endTimeOffset": "A String", # Time-offset, relative to the beginning of the video,
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	165	# corresponding to the end of the segment (inclusive).
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	166	"startTimeOffset": "A String", # Time-offset, relative to the beginning of the video,
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	167	# corresponding to the start of the segment (inclusive).
				168	},
				169	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	170	"textDetectionConfig": { # Config for TEXT_DETECTION. # Config for TEXT_DETECTION.
				171	"languageHints": [ # Language hint can be specified if the language to be detected is known a
				172	# priori. It can increase the accuracy of the detection. Language hint must
				173	# be language code in BCP-47 format.
				174	#
				175	# Automatic language detection is performed if no hint is provided.
				176	"A String",
				177	],
				178	"model": "A String", # Model to use for text detection.
				179	# Supported values: "builtin/stable" (the default if unset) and
				180	# "builtin/latest".
				181	},
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	182	"shotChangeDetectionConfig": { # Config for SHOT_CHANGE_DETECTION. # Config for SHOT_CHANGE_DETECTION.
				183	"model": "A String", # Model to use for shot change detection.
				184	# Supported values: "builtin/stable" (the default if unset) and
				185	# "builtin/latest".
				186	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	187	"labelDetectionConfig": { # Config for LABEL_DETECTION. # Config for LABEL_DETECTION.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	188	"model": "A String", # Model to use for label detection.
				189	# Supported values: "builtin/stable" (the default if unset) and
				190	# "builtin/latest".
				191	"labelDetectionMode": "A String", # What labels should be detected with LABEL_DETECTION, in addition to
				192	# video-level labels or segment-level labels.
				193	# If unspecified, defaults to `SHOT_MODE`.
				194	"stationaryCamera": True or False, # Whether the video has been shot from a stationary (i.e., non-moving)
				195	# camera. When set to true, might improve detection accuracy for moving
				196	# objects. Should be used with `SHOT_AND_FRAME_MODE` enabled.
				197	"videoConfidenceThreshold": 3.14, # The confidence threshold we perform filtering on the labels from
				198	# video-level and shot-level detections. If not set, it's set to 0.3 by
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	199	# default. The valid range for this threshold is [0.1, 0.9]. Any value set
				200	# outside of this range will be clipped.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	201	# Note: For best results, follow the default threshold. We will update
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	202	# the default threshold everytime when we release a new model.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	203	"frameConfidenceThreshold": 3.14, # The confidence threshold we perform filtering on the labels from
				204	# frame-level detection. If not set, it is set to 0.4 by default. The valid
				205	# range for this threshold is [0.1, 0.9]. Any value set outside of this
				206	# range will be clipped.
				207	# Note: For best results, follow the default threshold. We will update
				208	# the default threshold everytime when we release a new model.
				209	},
				210	"explicitContentDetectionConfig": { # Config for EXPLICIT_CONTENT_DETECTION. # Config for EXPLICIT_CONTENT_DETECTION.
				211	"model": "A String", # Model to use for explicit content detection.
				212	# Supported values: "builtin/stable" (the default if unset) and
				213	# "builtin/latest".
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	214	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	215	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	216	"locationId": "A String", # Optional. Cloud region where annotation should take place. Supported cloud
				217	# regions are: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no
				218	# region is specified, the region will be determined based on video file
				219	# location.
				220	"inputUri": "A String", # Input video location. Currently, only
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	221	# [Cloud Storage](https://cloud.google.com/storage/) URIs are
				222	# supported. URIs must be specified in the following format:
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	223	# `gs://bucket-id/object-id` (other URI formats return
				224	# google.rpc.Code.INVALID_ARGUMENT). For more information, see
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	225	# [Request URIs](https://cloud.google.com/storage/docs/request-endpoints).
				226	# To identify multiple videos, a video URI may include wildcards in the
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	227	# `object-id`. Supported wildcards: '*' to match 0 or more characters;
				228	# '?' to match 1 character. If unset, the input video should be embedded
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	229	# in the request as `input_content`. If set, `input_content` must be unset.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	230	"inputContent": "A String", # The video data bytes.
				231	# If unset, the input video(s) should be specified via the `input_uri`.
				232	# If set, `input_uri` must be unset.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	233	}
				234
				235	x__xgafv: string, V1 error format.
				236	Allowed values
				237	1 - v1 error format
				238	2 - v2 error format
				239
				240	Returns:
				241	An object of the form:
				242
				243	{ # This resource represents a long-running operation that is the result of a
				244	# network API call.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	245	"response": { # The normal response of the operation in case of success. If the original
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	246	# method returns no data on success, such as `Delete`, the response is
				247	# `google.protobuf.Empty`. If the original method is standard
				248	# `Get`/`Create`/`Update`, the response should be the resource. For other
				249	# methods, the response should have the type `XxxResponse`, where `Xxx`
				250	# is the original method name. For example, if the original method name
				251	# is `TakeSnapshot()`, the inferred response type is
				252	# `TakeSnapshotResponse`.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	253	"a_key": "", # Properties of the object. Contains field @type with type URL.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	254	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	255	"name": "A String", # The server-assigned name, which is only unique within the same service that
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	256	# originally returns it. If you use the default HTTP mapping, the
				257	# `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	258	"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	259	# different programming environments, including REST APIs and RPC APIs. It is
				260	# used by [gRPC](https://github.com/grpc). Each `Status` message contains
				261	# three pieces of data: error code, error message, and error details.
				262	#
				263	# You can find out more about this error model and how to work with it in the
				264	# [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	265	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	266	"message": "A String", # A developer-facing error message, which should be in English. Any
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	267	# user-facing error message should be localized and sent in the
				268	# google.rpc.Status.details field, or localized by the client.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	269	"details": [ # A list of messages that carry the error details. There is a common set of
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	270	# message types for APIs to use.
				271	{
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	272	"a_key": "", # Properties of the object. Contains field @type with type URL.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	273	},
				274	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	275	},
				276	"metadata": { # Service-specific metadata associated with the operation. It typically
				277	# contains progress information and common metadata such as create time.
				278	# Some services might not provide such metadata. Any method that returns a
				279	# long-running operation should document the metadata type, if any.
				280	"a_key": "", # Properties of the object. Contains field @type with type URL.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	281	},
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	282	"done": True or False, # If the value is `false`, it means the operation is still in progress.
				283	# If `true`, the operation is completed, and either `error` or `response` is
				284	# available.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	285	}</pre>
				286	</div>
				287
				288	</body></html>