Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(178)

Side by Side Diff: discovery/googleapis_beta/speech__v1beta1.json

Issue 2987103002: Api-Roll 52: 2017-07-31 (Closed)
Patch Set: Created 3 years, 4 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
OLDNEW
1 { 1 {
2 "auth": { 2 "auth": {
3 "oauth2": { 3 "oauth2": {
4 "scopes": { 4 "scopes": {
5 "https://www.googleapis.com/auth/cloud-platform": { 5 "https://www.googleapis.com/auth/cloud-platform": {
6 "description": "View and manage your data across Google Clou d Platform services" 6 "description": "View and manage your data across Google Clou d Platform services"
7 } 7 }
8 } 8 }
9 } 9 }
10 }, 10 },
11 "basePath": "", 11 "basePath": "",
12 "baseUrl": "https://speech.googleapis.com/", 12 "baseUrl": "https://speech.googleapis.com/",
13 "batchPath": "batch", 13 "batchPath": "batch",
14 "canonicalName": "Speech", 14 "canonicalName": "Speech",
15 "description": "Converts audio to text by applying powerful neural network m odels.", 15 "description": "Converts audio to text by applying powerful neural network m odels.",
16 "discoveryVersion": "v1", 16 "discoveryVersion": "v1",
17 "documentationLink": "https://cloud.google.com/speech/", 17 "documentationLink": "https://cloud.google.com/speech/",
18 "icons": { 18 "icons": {
19 "x16": "http://www.google.com/images/icons/product/search-16.gif", 19 "x16": "http://www.google.com/images/icons/product/search-16.gif",
20 "x32": "http://www.google.com/images/icons/product/search-32.gif" 20 "x32": "http://www.google.com/images/icons/product/search-32.gif"
21 }, 21 },
22 "id": "speech:v1beta1", 22 "id": "speech:v1beta1",
23 "kind": "discovery#restDescription", 23 "kind": "discovery#restDescription",
24 "name": "speech", 24 "name": "speech",
25 "ownerDomain": "google.com", 25 "ownerDomain": "google.com",
26 "ownerName": "Google", 26 "ownerName": "Google",
27 "parameters": { 27 "parameters": {
28 "pp": {
29 "default": "true",
30 "description": "Pretty-print response.",
31 "location": "query",
32 "type": "boolean"
33 },
34 "oauth_token": {
35 "description": "OAuth 2.0 token for the current user.",
36 "location": "query",
37 "type": "string"
38 },
39 "bearer_token": {
40 "description": "OAuth bearer token.",
41 "location": "query",
42 "type": "string"
43 },
44 "upload_protocol": {
45 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
46 "location": "query",
47 "type": "string"
48 },
49 "prettyPrint": {
50 "default": "true",
51 "description": "Returns response with indentations and line breaks." ,
52 "location": "query",
53 "type": "boolean"
54 },
55 "fields": {
56 "description": "Selector specifying which fields to include in a par tial response.",
57 "location": "query",
58 "type": "string"
59 },
60 "uploadType": {
61 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
62 "location": "query",
63 "type": "string"
64 },
65 "callback": {
66 "description": "JSONP",
67 "location": "query",
68 "type": "string"
69 },
70 "$.xgafv": { 28 "$.xgafv": {
71 "description": "V1 error format.", 29 "description": "V1 error format.",
72 "enum": [ 30 "enum": [
73 "1", 31 "1",
74 "2" 32 "2"
75 ], 33 ],
76 "enumDescriptions": [ 34 "enumDescriptions": [
77 "v1 error format", 35 "v1 error format",
78 "v2 error format" 36 "v2 error format"
79 ], 37 ],
80 "location": "query", 38 "location": "query",
81 "type": "string" 39 "type": "string"
82 }, 40 },
41 "callback": {
42 "description": "JSONP",
43 "location": "query",
44 "type": "string"
45 },
83 "alt": { 46 "alt": {
84 "default": "json", 47 "default": "json",
85 "description": "Data format for response.", 48 "description": "Data format for response.",
86 "enum": [ 49 "enum": [
87 "json", 50 "json",
88 "media", 51 "media",
89 "proto" 52 "proto"
90 ], 53 ],
91 "enumDescriptions": [ 54 "enumDescriptions": [
92 "Responses with Content-Type of application/json", 55 "Responses with Content-Type of application/json",
93 "Media download with context-dependent Content-Type", 56 "Media download with context-dependent Content-Type",
94 "Responses with Content-Type of application/x-protobuf" 57 "Responses with Content-Type of application/x-protobuf"
95 ], 58 ],
96 "location": "query", 59 "location": "query",
97 "type": "string" 60 "type": "string"
98 }, 61 },
62 "access_token": {
63 "description": "OAuth access token.",
64 "location": "query",
65 "type": "string"
66 },
99 "key": { 67 "key": {
100 "description": "API key. Your API key identifies your project and pr ovides you with API access, quota, and reports. Required unless you provide an O Auth 2.0 token.", 68 "description": "API key. Your API key identifies your project and pr ovides you with API access, quota, and reports. Required unless you provide an O Auth 2.0 token.",
101 "location": "query", 69 "location": "query",
102 "type": "string" 70 "type": "string"
103 }, 71 },
104 "access_token": {
105 "description": "OAuth access token.",
106 "location": "query",
107 "type": "string"
108 },
109 "quotaUser": { 72 "quotaUser": {
110 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters.", 73 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters.",
111 "location": "query", 74 "location": "query",
112 "type": "string" 75 "type": "string"
76 },
77 "pp": {
78 "default": "true",
79 "description": "Pretty-print response.",
80 "location": "query",
81 "type": "boolean"
82 },
83 "oauth_token": {
84 "description": "OAuth 2.0 token for the current user.",
85 "location": "query",
86 "type": "string"
87 },
88 "bearer_token": {
89 "description": "OAuth bearer token.",
90 "location": "query",
91 "type": "string"
92 },
93 "upload_protocol": {
94 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
95 "location": "query",
96 "type": "string"
97 },
98 "prettyPrint": {
99 "default": "true",
100 "description": "Returns response with indentations and line breaks." ,
101 "location": "query",
102 "type": "boolean"
103 },
104 "uploadType": {
105 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
106 "location": "query",
107 "type": "string"
108 },
109 "fields": {
110 "description": "Selector specifying which fields to include in a par tial response.",
111 "location": "query",
112 "type": "string"
113 } 113 }
114 }, 114 },
115 "protocol": "rest", 115 "protocol": "rest",
116 "resources": { 116 "resources": {
117 "speech": {
118 "methods": {
119 "asyncrecognize": {
120 "description": "Performs asynchronous speech recognition: re ceive results via the\n[google.longrunning.Operations]\n(/speech/reference/rest/ v1beta1/operations#Operation)\ninterface. Returns either an\n`Operation.error` o r an `Operation.response` which contains\nan `AsyncRecognizeResponse` message.",
121 "httpMethod": "POST",
122 "id": "speech.speech.asyncrecognize",
123 "parameterOrder": [],
124 "parameters": {},
125 "path": "v1beta1/speech:asyncrecognize",
126 "request": {
127 "$ref": "AsyncRecognizeRequest"
128 },
129 "response": {
130 "$ref": "Operation"
131 },
132 "scopes": [
133 "https://www.googleapis.com/auth/cloud-platform"
134 ]
135 },
136 "syncrecognize": {
137 "description": "Performs synchronous speech recognition: rec eive results after all audio\nhas been sent and processed.",
138 "httpMethod": "POST",
139 "id": "speech.speech.syncrecognize",
140 "parameterOrder": [],
141 "parameters": {},
142 "path": "v1beta1/speech:syncrecognize",
143 "request": {
144 "$ref": "SyncRecognizeRequest"
145 },
146 "response": {
147 "$ref": "SyncRecognizeResponse"
148 },
149 "scopes": [
150 "https://www.googleapis.com/auth/cloud-platform"
151 ]
152 }
153 }
154 },
117 "operations": { 155 "operations": {
118 "methods": { 156 "methods": {
119 "cancel": { 157 "cancel": {
120 "description": "Starts asynchronous cancellation on a long-r unning operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it retur ns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation o r\nother methods to check whether the cancellation succeeded or whether the\nope ration completed despite cancellation. On successful cancellation,\nthe operatio n is not deleted; instead, it becomes an operation with\nan Operation.error valu e with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.", 158 "description": "Starts asynchronous cancellation on a long-r unning operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it retur ns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation o r\nother methods to check whether the cancellation succeeded or whether the\nope ration completed despite cancellation. On successful cancellation,\nthe operatio n is not deleted; instead, it becomes an operation with\nan Operation.error valu e with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
121 "httpMethod": "POST", 159 "httpMethod": "POST",
122 "id": "speech.operations.cancel", 160 "id": "speech.operations.cancel",
123 "parameterOrder": [ 161 "parameterOrder": [
124 "name" 162 "name"
125 ], 163 ],
126 "parameters": { 164 "parameters": {
(...skipping 60 matching lines...) Expand 10 before | Expand all | Expand 10 after
187 "scopes": [ 225 "scopes": [
188 "https://www.googleapis.com/auth/cloud-platform" 226 "https://www.googleapis.com/auth/cloud-platform"
189 ] 227 ]
190 }, 228 },
191 "list": { 229 "list": {
192 "description": "Lists operations that match the specified fi lter in the request. If the\nserver doesn't support this method, it returns `UNI MPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the bin ding\nto use different resource name schemes, such as `users/*/operations`. To\n override the binding, API services can add a binding such as\n`\"/v1/{name=users /*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding user s must ensure the name binding\nis the parent resource, without the operations c ollection id.", 230 "description": "Lists operations that match the specified fi lter in the request. If the\nserver doesn't support this method, it returns `UNI MPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the bin ding\nto use different resource name schemes, such as `users/*/operations`. To\n override the binding, API services can add a binding such as\n`\"/v1/{name=users /*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding user s must ensure the name binding\nis the parent resource, without the operations c ollection id.",
193 "httpMethod": "GET", 231 "httpMethod": "GET",
194 "id": "speech.operations.list", 232 "id": "speech.operations.list",
195 "parameterOrder": [], 233 "parameterOrder": [],
196 "parameters": { 234 "parameters": {
235 "pageToken": {
236 "description": "The standard list page token.",
237 "location": "query",
238 "type": "string"
239 },
240 "name": {
241 "description": "The name of the operation's parent r esource.",
242 "location": "query",
243 "type": "string"
244 },
197 "pageSize": { 245 "pageSize": {
198 "description": "The standard list page size.", 246 "description": "The standard list page size.",
199 "format": "int32", 247 "format": "int32",
200 "location": "query", 248 "location": "query",
201 "type": "integer" 249 "type": "integer"
202 }, 250 },
203 "filter": { 251 "filter": {
204 "description": "The standard list filter.", 252 "description": "The standard list filter.",
205 "location": "query", 253 "location": "query",
206 "type": "string" 254 "type": "string"
207 },
208 "pageToken": {
209 "description": "The standard list page token.",
210 "location": "query",
211 "type": "string"
212 },
213 "name": {
214 "description": "The name of the operation's parent r esource.",
215 "location": "query",
216 "type": "string"
217 } 255 }
218 }, 256 },
219 "path": "v1beta1/operations", 257 "path": "v1beta1/operations",
220 "response": { 258 "response": {
221 "$ref": "ListOperationsResponse" 259 "$ref": "ListOperationsResponse"
222 }, 260 },
223 "scopes": [ 261 "scopes": [
224 "https://www.googleapis.com/auth/cloud-platform" 262 "https://www.googleapis.com/auth/cloud-platform"
225 ] 263 ]
226 } 264 }
227 } 265 }
228 },
229 "speech": {
230 "methods": {
231 "asyncrecognize": {
232 "description": "Performs asynchronous speech recognition: re ceive results via the\n[google.longrunning.Operations]\n(/speech/reference/rest/ v1beta1/operations#Operation)\ninterface. Returns either an\n`Operation.error` o r an `Operation.response` which contains\nan `AsyncRecognizeResponse` message.",
233 "httpMethod": "POST",
234 "id": "speech.speech.asyncrecognize",
235 "parameterOrder": [],
236 "parameters": {},
237 "path": "v1beta1/speech:asyncrecognize",
238 "request": {
239 "$ref": "AsyncRecognizeRequest"
240 },
241 "response": {
242 "$ref": "Operation"
243 },
244 "scopes": [
245 "https://www.googleapis.com/auth/cloud-platform"
246 ]
247 },
248 "syncrecognize": {
249 "description": "Performs synchronous speech recognition: rec eive results after all audio\nhas been sent and processed.",
250 "httpMethod": "POST",
251 "id": "speech.speech.syncrecognize",
252 "parameterOrder": [],
253 "parameters": {},
254 "path": "v1beta1/speech:syncrecognize",
255 "request": {
256 "$ref": "SyncRecognizeRequest"
257 },
258 "response": {
259 "$ref": "SyncRecognizeResponse"
260 },
261 "scopes": [
262 "https://www.googleapis.com/auth/cloud-platform"
263 ]
264 }
265 }
266 } 266 }
267 }, 267 },
268 "revision": "20170705", 268 "revision": "20170728",
269 "rootUrl": "https://speech.googleapis.com/", 269 "rootUrl": "https://speech.googleapis.com/",
270 "schemas": { 270 "schemas": {
271 "Operation": {
272 "description": "This resource represents a long-running operation th at is the result of a\nnetwork API call.",
273 "id": "Operation",
274 "properties": {
275 "done": {
276 "description": "If the value is `false`, it means the operat ion is still in progress.\nIf true, the operation is completed, and either `erro r` or `response` is\navailable.",
277 "type": "boolean"
278 },
279 "response": {
280 "additionalProperties": {
281 "description": "Properties of the object. Contains field @type with type URL.",
282 "type": "any"
283 },
284 "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delet e`, the response is\n`google.protobuf.Empty`. If the original method is standar d\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmet hods, the response should have the type `XxxResponse`, where `Xxx`\nis the origi nal method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
285 "type": "object"
286 },
287 "name": {
288 "description": "The server-assigned name, which is only uniq ue within the same service that\noriginally returns it. If you use the default H TTP mapping, the\n`name` should have the format of `operations/some/unique/name` .",
289 "type": "string"
290 },
291 "error": {
292 "$ref": "Status",
293 "description": "The error result of the operation in case of failure or cancellation."
294 },
295 "metadata": {
296 "additionalProperties": {
297 "description": "Properties of the object. Contains field @type with type URL.",
298 "type": "any"
299 },
300 "description": "Service-specific metadata associated with th e operation. It typically\ncontains progress information and common metadata su ch as create time.\nSome services might not provide such metadata. Any method t hat returns a\nlong-running operation should document the metadata type, if any. ",
301 "type": "object"
302 }
303 },
304 "type": "object"
305 },
271 "RecognitionConfig": { 306 "RecognitionConfig": {
272 "description": "Provides information to the recognizer that specifie s how to process the\nrequest.", 307 "description": "Provides information to the recognizer that specifie s how to process the\nrequest.",
273 "id": "RecognitionConfig", 308 "id": "RecognitionConfig",
274 "properties": { 309 "properties": {
310 "maxAlternatives": {
311 "description": "*Optional* Maximum number of recognition hyp otheses to be returned.\nSpecifically, the maximum number of `SpeechRecognitionA lternative` messages\nwithin each `SpeechRecognitionResult`.\nThe server may ret urn fewer than `max_alternatives`.\nValid values are `0`-`30`. A value of `0` or `1` will return a maximum of\none. If omitted, will return a maximum of one.",
312 "format": "int32",
313 "type": "integer"
314 },
275 "sampleRate": { 315 "sampleRate": {
276 "description": "*Required* Sample rate in Hertz of the audio data sent in all\n`RecognitionAudio` messages. Valid values are: 8000-48000.\n1 6000 is optimal. For best results, set the sampling rate of the audio\nsource to 16000 Hz. If that's not possible, use the native sample rate of\nthe audio sour ce (instead of re-sampling).", 316 "description": "*Required* Sample rate in Hertz of the audio data sent in all\n`RecognitionAudio` messages. Valid values are: 8000-48000.\n1 6000 is optimal. For best results, set the sampling rate of the audio\nsource to 16000 Hz. If that's not possible, use the native sample rate of\nthe audio sour ce (instead of re-sampling).",
277 "format": "int32", 317 "format": "int32",
278 "type": "integer" 318 "type": "integer"
279 }, 319 },
280 "languageCode": { 320 "languageCode": {
281 "description": "*Optional* The language of the supplied audi o as a BCP-47 language tag.\nExample: \"en-GB\" https://www.rfc-editor.org/rfc/ bcp/bcp47.txt\nIf omitted, defaults to \"en-US\". See\n[Language Support](https: //cloud.google.com/speech/docs/languages)\nfor a list of the currently supported language codes.", 321 "description": "*Optional* The language of the supplied audi o as a BCP-47 language tag.\nExample: \"en-GB\" https://www.rfc-editor.org/rfc/ bcp/bcp47.txt\nIf omitted, defaults to \"en-US\". See\n[Language Support](https: //cloud.google.com/speech/docs/languages)\nfor a list of the currently supported language codes.",
282 "type": "string" 322 "type": "string"
283 }, 323 },
284 "encoding": { 324 "encoding": {
(...skipping 16 matching lines...) Expand all
301 ], 341 ],
302 "type": "string" 342 "type": "string"
303 }, 343 },
304 "profanityFilter": { 344 "profanityFilter": {
305 "description": "*Optional* If set to `true`, the server will attempt to filter out\nprofanities, replacing all but the initial character in each filtered word\nwith asterisks, e.g. \"f***\". If set to `false` or omitted, profanities\nwon't be filtered out.", 345 "description": "*Optional* If set to `true`, the server will attempt to filter out\nprofanities, replacing all but the initial character in each filtered word\nwith asterisks, e.g. \"f***\". If set to `false` or omitted, profanities\nwon't be filtered out.",
306 "type": "boolean" 346 "type": "boolean"
307 }, 347 },
308 "speechContext": { 348 "speechContext": {
309 "$ref": "SpeechContext", 349 "$ref": "SpeechContext",
310 "description": "*Optional* A means to provide context to ass ist the speech recognition." 350 "description": "*Optional* A means to provide context to ass ist the speech recognition."
311 },
312 "maxAlternatives": {
313 "description": "*Optional* Maximum number of recognition hyp otheses to be returned.\nSpecifically, the maximum number of `SpeechRecognitionA lternative` messages\nwithin each `SpeechRecognitionResult`.\nThe server may ret urn fewer than `max_alternatives`.\nValid values are `0`-`30`. A value of `0` or `1` will return a maximum of\none. If omitted, will return a maximum of one.",
314 "format": "int32",
315 "type": "integer"
316 } 351 }
317 }, 352 },
318 "type": "object" 353 "type": "object"
319 }, 354 },
320 "SyncRecognizeRequest": { 355 "SyncRecognizeRequest": {
321 "description": "The top-level message sent by the client for the `Sy ncRecognize` method.", 356 "description": "The top-level message sent by the client for the `Sy ncRecognize` method.",
322 "id": "SyncRecognizeRequest", 357 "id": "SyncRecognizeRequest",
323 "properties": { 358 "properties": {
324 "audio": { 359 "audio": {
325 "$ref": "RecognitionAudio", 360 "$ref": "RecognitionAudio",
326 "description": "*Required* The audio data to be recognized." 361 "description": "*Required* The audio data to be recognized."
327 }, 362 },
328 "config": { 363 "config": {
329 "$ref": "RecognitionConfig", 364 "$ref": "RecognitionConfig",
330 "description": "*Required* Provides information to the recog nizer that specifies how to\nprocess the request." 365 "description": "*Required* Provides information to the recog nizer that specifies how to\nprocess the request."
331 } 366 }
332 }, 367 },
333 "type": "object" 368 "type": "object"
334 }, 369 },
335 "SyncRecognizeResponse": {
336 "description": "The only message returned to the client by `SyncReco gnize`. method. It\ncontains the result as zero or more sequential `SpeechRecogn itionResult`\nmessages.",
337 "id": "SyncRecognizeResponse",
338 "properties": {
339 "results": {
340 "description": "*Output-only* Sequential list of transcripti on results corresponding to\nsequential portions of audio.",
341 "items": {
342 "$ref": "SpeechRecognitionResult"
343 },
344 "type": "array"
345 }
346 },
347 "type": "object"
348 },
349 "Status": { 370 "Status": {
350 "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RP C APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is desig ned to be:\n\n- Simple to use and understand for most users\n- Flexible enough t o meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pie ces of data: error code, error message,\nand error details. The error code shoul d be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message tha t helps\ndevelopers *understand* and *resolve* the error. If a localized user-fa cing\nerror message is needed, put the localized message in the error details or \nlocalize it in the client. The optional error details may contain arbitrary\ni nformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Lang uage mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` mess age is\nexposed in different client libraries and different wire protocols, it c an be\nmapped differently. For example, it will likely be mapped to some excepti ons\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n \nThe error model and the `Status` message can be used in a variety of\nenvironm ents, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n - Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step m ay\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\ n- Asynchronous operations. If an API call embeds asynchronous operation\n re sults in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are store d in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.", 371 "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RP C APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is desig ned to be:\n\n- Simple to use and understand for most users\n- Flexible enough t o meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pie ces of data: error code, error message,\nand error details. The error code shoul d be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message tha t helps\ndevelopers *understand* and *resolve* the error. If a localized user-fa cing\nerror message is needed, put the localized message in the error details or \nlocalize it in the client. The optional error details may contain arbitrary\ni nformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Lang uage mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` mess age is\nexposed in different client libraries and different wire protocols, it c an be\nmapped differently. For example, it will likely be mapped to some excepti ons\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n \nThe error model and the `Status` message can be used in a variety of\nenvironm ents, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n - Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step m ay\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\ n- Asynchronous operations. If an API call embeds asynchronous operation\n re sults in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are store d in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
351 "id": "Status", 372 "id": "Status",
352 "properties": { 373 "properties": {
374 "message": {
375 "description": "A developer-facing error message, which shou ld be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
376 "type": "string"
377 },
353 "details": { 378 "details": {
354 "description": "A list of messages that carry the error deta ils. There will be a\ncommon set of message types for APIs to use.", 379 "description": "A list of messages that carry the error deta ils. There is a common set of\nmessage types for APIs to use.",
355 "items": { 380 "items": {
356 "additionalProperties": { 381 "additionalProperties": {
357 "description": "Properties of the object. Contains f ield @type with type URL.", 382 "description": "Properties of the object. Contains f ield @type with type URL.",
358 "type": "any" 383 "type": "any"
359 }, 384 },
360 "type": "object" 385 "type": "object"
361 }, 386 },
362 "type": "array" 387 "type": "array"
363 }, 388 },
364 "code": { 389 "code": {
365 "description": "The status code, which should be an enum val ue of google.rpc.Code.", 390 "description": "The status code, which should be an enum val ue of google.rpc.Code.",
366 "format": "int32", 391 "format": "int32",
367 "type": "integer" 392 "type": "integer"
368 },
369 "message": {
370 "description": "A developer-facing error message, which shou ld be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
371 "type": "string"
372 } 393 }
373 }, 394 },
374 "type": "object" 395 "type": "object"
396 },
397 "SyncRecognizeResponse": {
398 "description": "The only message returned to the client by `SyncReco gnize`. method. It\ncontains the result as zero or more sequential `SpeechRecogn itionResult`\nmessages.",
399 "id": "SyncRecognizeResponse",
400 "properties": {
401 "results": {
402 "description": "*Output-only* Sequential list of transcripti on results corresponding to\nsequential portions of audio.",
403 "items": {
404 "$ref": "SpeechRecognitionResult"
405 },
406 "type": "array"
407 }
408 },
409 "type": "object"
375 }, 410 },
376 "Empty": { 411 "Empty": {
377 "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use i t as the request\nor the response type of an API method. For instance:\n\n se rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty );\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", 412 "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use i t as the request\nor the response type of an API method. For instance:\n\n se rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty );\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
378 "id": "Empty", 413 "id": "Empty",
379 "properties": {}, 414 "properties": {},
380 "type": "object" 415 "type": "object"
381 }, 416 },
382 "SpeechRecognitionAlternative": {
383 "description": "Alternative hypotheses (a.k.a. n-best list).",
384 "id": "SpeechRecognitionAlternative",
385 "properties": {
386 "confidence": {
387 "description": "*Output-only* The confidence estimate betwee n 0.0 and 1.0. A higher number\nindicates an estimated greater likelihood that t he recognized words are\ncorrect. This field is typically provided only for the top hypothesis, and\nonly for `is_final=true` results. Clients should not rely o n the\n`confidence` field as it is not guaranteed to be accurate, or even set, i n\nany of the results.\nThe default of 0.0 is a sentinel value indicating `confi dence` was not set.",
388 "format": "float",
389 "type": "number"
390 },
391 "transcript": {
392 "description": "*Output-only* Transcript text representing t he words that the user spoke.",
393 "type": "string"
394 }
395 },
396 "type": "object"
397 },
398 "SpeechContext": { 417 "SpeechContext": {
399 "description": "Provides \"hints\" to the speech recognizer to favor specific words and phrases\nin the results.", 418 "description": "Provides \"hints\" to the speech recognizer to favor specific words and phrases\nin the results.",
400 "id": "SpeechContext", 419 "id": "SpeechContext",
401 "properties": { 420 "properties": {
402 "phrases": { 421 "phrases": {
403 "description": "*Optional* A list of strings containing word s and phrases \"hints\" so that\nthe speech recognition is more likely to recogn ize them. This can be used\nto improve the accuracy for specific words and phras es, for example, if\nspecific commands are typically spoken by the user. This ca n also be used\nto add additional words to the vocabulary of the recognizer. See \n[usage limits](https://cloud.google.com/speech/limits#content).", 422 "description": "*Optional* A list of strings containing word s and phrases \"hints\" so that\nthe speech recognition is more likely to recogn ize them. This can be used\nto improve the accuracy for specific words and phras es, for example, if\nspecific commands are typically spoken by the user. This ca n also be used\nto add additional words to the vocabulary of the recognizer. See \n[usage limits](https://cloud.google.com/speech/limits#content).",
404 "items": { 423 "items": {
405 "type": "string" 424 "type": "string"
406 }, 425 },
407 "type": "array" 426 "type": "array"
408 } 427 }
409 }, 428 },
410 "type": "object" 429 "type": "object"
411 }, 430 },
412 "ListOperationsResponse": { 431 "ListOperationsResponse": {
413 "description": "The response message for Operations.ListOperations." , 432 "description": "The response message for Operations.ListOperations." ,
414 "id": "ListOperationsResponse", 433 "id": "ListOperationsResponse",
415 "properties": { 434 "properties": {
416 "nextPageToken": {
417 "description": "The standard List next-page token.",
418 "type": "string"
419 },
420 "operations": { 435 "operations": {
421 "description": "A list of operations that matches the specif ied filter in the request.", 436 "description": "A list of operations that matches the specif ied filter in the request.",
422 "items": { 437 "items": {
423 "$ref": "Operation" 438 "$ref": "Operation"
424 }, 439 },
425 "type": "array" 440 "type": "array"
441 },
442 "nextPageToken": {
443 "description": "The standard List next-page token.",
444 "type": "string"
426 } 445 }
427 }, 446 },
428 "type": "object" 447 "type": "object"
448 },
449 "SpeechRecognitionAlternative": {
450 "description": "Alternative hypotheses (a.k.a. n-best list).",
451 "id": "SpeechRecognitionAlternative",
452 "properties": {
453 "confidence": {
454 "description": "*Output-only* The confidence estimate betwee n 0.0 and 1.0. A higher number\nindicates an estimated greater likelihood that t he recognized words are\ncorrect. This field is typically provided only for the top hypothesis, and\nonly for `is_final=true` results. Clients should not rely o n the\n`confidence` field as it is not guaranteed to be accurate, or even set, i n\nany of the results.\nThe default of 0.0 is a sentinel value indicating `confi dence` was not set.",
455 "format": "float",
456 "type": "number"
457 },
458 "transcript": {
459 "description": "*Output-only* Transcript text representing t he words that the user spoke.",
460 "type": "string"
461 }
462 },
463 "type": "object"
429 }, 464 },
430 "SpeechRecognitionResult": { 465 "SpeechRecognitionResult": {
431 "description": "A speech recognition result corresponding to a porti on of the audio.", 466 "description": "A speech recognition result corresponding to a porti on of the audio.",
432 "id": "SpeechRecognitionResult", 467 "id": "SpeechRecognitionResult",
433 "properties": { 468 "properties": {
434 "alternatives": { 469 "alternatives": {
435 "description": "*Output-only* May contain one or more recogn ition hypotheses (up to the\nmaximum specified in `max_alternatives`).", 470 "description": "*Output-only* May contain one or more recogn ition hypotheses (up to the\nmaximum specified in `max_alternatives`).",
436 "items": { 471 "items": {
437 "$ref": "SpeechRecognitionAlternative" 472 "$ref": "SpeechRecognitionAlternative"
438 }, 473 },
(...skipping 25 matching lines...) Expand all
464 "audio": { 499 "audio": {
465 "$ref": "RecognitionAudio", 500 "$ref": "RecognitionAudio",
466 "description": "*Required* The audio data to be recognized." 501 "description": "*Required* The audio data to be recognized."
467 }, 502 },
468 "config": { 503 "config": {
469 "$ref": "RecognitionConfig", 504 "$ref": "RecognitionConfig",
470 "description": "*Required* Provides information to the recog nizer that specifies how to\nprocess the request." 505 "description": "*Required* Provides information to the recog nizer that specifies how to\nprocess the request."
471 } 506 }
472 }, 507 },
473 "type": "object" 508 "type": "object"
474 },
475 "Operation": {
476 "description": "This resource represents a long-running operation th at is the result of a\nnetwork API call.",
477 "id": "Operation",
478 "properties": {
479 "error": {
480 "$ref": "Status",
481 "description": "The error result of the operation in case of failure or cancellation."
482 },
483 "metadata": {
484 "additionalProperties": {
485 "description": "Properties of the object. Contains field @type with type URL.",
486 "type": "any"
487 },
488 "description": "Service-specific metadata associated with th e operation. It typically\ncontains progress information and common metadata su ch as create time.\nSome services might not provide such metadata. Any method t hat returns a\nlong-running operation should document the metadata type, if any. ",
489 "type": "object"
490 },
491 "done": {
492 "description": "If the value is `false`, it means the operat ion is still in progress.\nIf true, the operation is completed, and either `erro r` or `response` is\navailable.",
493 "type": "boolean"
494 },
495 "response": {
496 "additionalProperties": {
497 "description": "Properties of the object. Contains field @type with type URL.",
498 "type": "any"
499 },
500 "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delet e`, the response is\n`google.protobuf.Empty`. If the original method is standar d\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmet hods, the response should have the type `XxxResponse`, where `Xxx`\nis the origi nal method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
501 "type": "object"
502 },
503 "name": {
504 "description": "The server-assigned name, which is only uniq ue within the same service that\noriginally returns it. If you use the default H TTP mapping, the\n`name` should have the format of `operations/some/unique/name` .",
505 "type": "string"
506 }
507 },
508 "type": "object"
509 } 509 }
510 }, 510 },
511 "servicePath": "", 511 "servicePath": "",
512 "title": "Google Cloud Speech API", 512 "title": "Google Cloud Speech API",
513 "version": "v1beta1" 513 "version": "v1beta1"
514 } 514 }
OLDNEW
« no previous file with comments | « discovery/googleapis_beta/runtimeconfig__v1beta1.json ('k') | discovery/googleapis_beta/toolresults__v1beta3.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698