460 lines
18 KiB
TypeScript
460 lines
18 KiB
TypeScript
/**
|
|
* Copyright 2015 Google Inc. All Rights Reserved.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
/* jshint maxlen: false */
|
|
|
|
import createAPIRequest from '../../lib/apirequest';
|
|
|
|
/**
|
|
* Google Cloud Speech API
|
|
*
|
|
* Converts audio to text by applying powerful neural network models.
|
|
*
|
|
* @example
|
|
* const google = require('googleapis');
|
|
* const speech = google.speech('v1');
|
|
*
|
|
* @namespace speech
|
|
* @type {Function}
|
|
* @version v1
|
|
* @variation v1
|
|
* @param {object=} options Options for Speech
|
|
*/
|
|
function Speech(options) { // eslint-disable-line
|
|
const self = this;
|
|
self._options = options || {};
|
|
|
|
self.operations = {
|
|
|
|
/**
|
|
* speech.operations.cancel
|
|
*
|
|
* @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
|
|
*
|
|
* @alias speech.operations.cancel
|
|
* @memberOf! speech(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.name The name of the operation resource to be cancelled.
|
|
* @param {speech(v1).CancelOperationRequest} params.resource Request body data
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
cancel: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://speech.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/v1/operations/{name}:cancel').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'POST'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['name'],
|
|
pathParams: ['name'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* speech.operations.delete
|
|
*
|
|
* @desc Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
|
|
*
|
|
* @alias speech.operations.delete
|
|
* @memberOf! speech(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.name The name of the operation resource to be deleted.
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
delete: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://speech.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/v1/operations/{name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'DELETE'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['name'],
|
|
pathParams: ['name'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* speech.operations.get
|
|
*
|
|
* @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
|
|
*
|
|
* @alias speech.operations.get
|
|
* @memberOf! speech(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.name The name of the operation resource.
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
get: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://speech.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/v1/operations/{name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['name'],
|
|
pathParams: ['name'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* speech.operations.list
|
|
*
|
|
* @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
|
|
*
|
|
* @alias speech.operations.list
|
|
* @memberOf! speech(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string=} params.filter The standard list filter.
|
|
* @param {string=} params.name The name of the operation's parent resource.
|
|
* @param {integer=} params.pageSize The standard list page size.
|
|
* @param {string=} params.pageToken The standard list page token.
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
list: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://speech.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/v1/operations').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: [],
|
|
pathParams: [],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
}
|
|
|
|
};
|
|
|
|
self.speech = {
|
|
|
|
/**
|
|
* speech.speech.longrunningrecognize
|
|
*
|
|
* @desc Performs asynchronous speech recognition: receive results via the google.longrunning.Operations interface. Returns either an `Operation.error` or an `Operation.response` which contains a `LongRunningRecognizeResponse` message.
|
|
*
|
|
* @alias speech.speech.longrunningrecognize
|
|
* @memberOf! speech(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {speech(v1).LongRunningRecognizeRequest} params.resource Request body data
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
longrunningrecognize: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://speech.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/v1/speech:longrunningrecognize').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'POST'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: [],
|
|
pathParams: [],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* speech.speech.recognize
|
|
*
|
|
* @desc Performs synchronous speech recognition: receive results after all audio has been sent and processed.
|
|
*
|
|
* @alias speech.speech.recognize
|
|
* @memberOf! speech(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {speech(v1).RecognizeRequest} params.resource Request body data
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
recognize: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://speech.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/v1/speech:recognize').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'POST'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: [],
|
|
pathParams: [],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
}
|
|
|
|
};
|
|
}
|
|
|
|
/**
|
|
* @typedef CancelOperationRequest
|
|
* @memberOf! speech(v1)
|
|
* @type object
|
|
*/
|
|
|
|
/**
|
|
* @typedef Empty
|
|
* @memberOf! speech(v1)
|
|
* @type object
|
|
*/
|
|
|
|
/**
|
|
* @typedef ListOperationsResponse
|
|
* @memberOf! speech(v1)
|
|
* @type object
|
|
* @property {string} nextPageToken The standard List next-page token.
|
|
* @property {speech(v1).Operation[]} operations A list of operations that matches the specified filter in the request.
|
|
*/
|
|
|
|
/**
|
|
* @typedef LongRunningRecognizeRequest
|
|
* @memberOf! speech(v1)
|
|
* @type object
|
|
* @property {speech(v1).RecognitionAudio} audio *Required* The audio data to be recognized.
|
|
* @property {speech(v1).RecognitionConfig} config *Required* Provides information to the recognizer that specifies how to
|
|
process the request.
|
|
*/
|
|
|
|
/**
|
|
* @typedef Operation
|
|
* @memberOf! speech(v1)
|
|
* @type object
|
|
* @property {boolean} done If the value is `false`, it means the operation is still in progress.
|
|
If `true`, the operation is completed, and either `error` or `response` is
|
|
available.
|
|
* @property {speech(v1).Status} error The error result of the operation in case of failure or cancellation.
|
|
* @property {object} metadata Service-specific metadata associated with the operation. It typically
|
|
contains progress information and common metadata such as create time.
|
|
Some services might not provide such metadata. Any method that returns a
|
|
long-running operation should document the metadata type, if any.
|
|
* @property {string} name The server-assigned name, which is only unique within the same service that
|
|
originally returns it. If you use the default HTTP mapping, the
|
|
`name` should have the format of `operations/some/unique/name`.
|
|
* @property {object} response The normal response of the operation in case of success. If the original
|
|
method returns no data on success, such as `Delete`, the response is
|
|
`google.protobuf.Empty`. If the original method is standard
|
|
`Get`/`Create`/`Update`, the response should be the resource. For other
|
|
methods, the response should have the type `XxxResponse`, where `Xxx`
|
|
is the original method name. For example, if the original method name
|
|
is `TakeSnapshot()`, the inferred response type is
|
|
`TakeSnapshotResponse`.
|
|
*/
|
|
|
|
/**
|
|
* @typedef RecognitionAudio
|
|
* @memberOf! speech(v1)
|
|
* @type object
|
|
* @property {string} content The audio data bytes encoded as specified in
|
|
`RecognitionConfig`. Note: as with all bytes fields, protobuffers use a
|
|
pure binary representation, whereas JSON representations use base64.
|
|
* @property {string} uri URI that points to a file that contains audio data bytes as specified in
|
|
`RecognitionConfig`. Currently, only Google Cloud Storage URIs are
|
|
supported, which must be specified in the following format:
|
|
`gs://bucket_name/object_name` (other URI formats return
|
|
google.rpc.Code.INVALID_ARGUMENT). For more information, see
|
|
[Request URIs](https://cloud.google.com/storage/docs/reference-uris).
|
|
*/
|
|
|
|
/**
|
|
* @typedef RecognitionConfig
|
|
* @memberOf! speech(v1)
|
|
* @type object
|
|
* @property {boolean} enableWordTimeOffsets *Optional* If `true`, the top result includes a list of words and
|
|
the start and end time offsets (timestamps) for those words. If
|
|
`false`, no word-level time offset information is returned. The default is
|
|
`false`.
|
|
* @property {string} encoding *Required* Encoding of audio data sent in all `RecognitionAudio` messages.
|
|
* @property {string} languageCode *Required* The language of the supplied audio as a
|
|
[BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
|
|
Example: "en-US".
|
|
See [Language Support](https://cloud.google.com/speech/docs/languages)
|
|
for a list of the currently supported language codes.
|
|
* @property {integer} maxAlternatives *Optional* Maximum number of recognition hypotheses to be returned.
|
|
Specifically, the maximum number of `SpeechRecognitionAlternative` messages
|
|
within each `SpeechRecognitionResult`.
|
|
The server may return fewer than `max_alternatives`.
|
|
Valid values are `0`-`30`. A value of `0` or `1` will return a maximum of
|
|
one. If omitted, will return a maximum of one.
|
|
* @property {boolean} profanityFilter *Optional* If set to `true`, the server will attempt to filter out
|
|
profanities, replacing all but the initial character in each filtered word
|
|
with asterisks, e.g. "f***". If set to `false` or omitted, profanities
|
|
won't be filtered out.
|
|
* @property {integer} sampleRateHertz *Required* Sample rate in Hertz of the audio data sent in all
|
|
`RecognitionAudio` messages. Valid values are: 8000-48000.
|
|
16000 is optimal. For best results, set the sampling rate of the audio
|
|
source to 16000 Hz. If that's not possible, use the native sample rate of
|
|
the audio source (instead of re-sampling).
|
|
* @property {speech(v1).SpeechContext[]} speechContexts *Optional* A means to provide context to assist the speech recognition.
|
|
*/
|
|
|
|
/**
|
|
* @typedef RecognizeRequest
|
|
* @memberOf! speech(v1)
|
|
* @type object
|
|
* @property {speech(v1).RecognitionAudio} audio *Required* The audio data to be recognized.
|
|
* @property {speech(v1).RecognitionConfig} config *Required* Provides information to the recognizer that specifies how to
|
|
process the request.
|
|
*/
|
|
|
|
/**
|
|
* @typedef RecognizeResponse
|
|
* @memberOf! speech(v1)
|
|
* @type object
|
|
* @property {speech(v1).SpeechRecognitionResult[]} results *Output-only* Sequential list of transcription results corresponding to
|
|
sequential portions of audio.
|
|
*/
|
|
|
|
/**
|
|
* @typedef SpeechContext
|
|
* @memberOf! speech(v1)
|
|
* @type object
|
|
* @property {string[]} phrases *Optional* A list of strings containing words and phrases "hints" so that
|
|
the speech recognition is more likely to recognize them. This can be used
|
|
to improve the accuracy for specific words and phrases, for example, if
|
|
specific commands are typically spoken by the user. This can also be used
|
|
to add additional words to the vocabulary of the recognizer. See
|
|
[usage limits](https://cloud.google.com/speech/limits#content).
|
|
*/
|
|
|
|
/**
|
|
* @typedef SpeechRecognitionAlternative
|
|
* @memberOf! speech(v1)
|
|
* @type object
|
|
* @property {number} confidence *Output-only* The confidence estimate between 0.0 and 1.0. A higher number
|
|
indicates an estimated greater likelihood that the recognized words are
|
|
correct. This field is typically provided only for the top hypothesis, and
|
|
only for `is_final=true` results. Clients should not rely on the
|
|
`confidence` field as it is not guaranteed to be accurate or consistent.
|
|
The default of 0.0 is a sentinel value indicating `confidence` was not set.
|
|
* @property {string} transcript *Output-only* Transcript text representing the words that the user spoke.
|
|
* @property {speech(v1).WordInfo[]} words *Output-only* A list of word-specific information for each recognized word.
|
|
*/
|
|
|
|
/**
|
|
* @typedef SpeechRecognitionResult
|
|
* @memberOf! speech(v1)
|
|
* @type object
|
|
* @property {speech(v1).SpeechRecognitionAlternative[]} alternatives *Output-only* May contain one or more recognition hypotheses (up to the
|
|
maximum specified in `max_alternatives`).
|
|
These alternatives are ordered in terms of accuracy, with the top (first)
|
|
alternative being the most probable, as ranked by the recognizer.
|
|
*/
|
|
|
|
/**
|
|
* @typedef Status
|
|
* @memberOf! speech(v1)
|
|
* @type object
|
|
* @property {integer} code The status code, which should be an enum value of google.rpc.Code.
|
|
* @property {object[]} details A list of messages that carry the error details. There is a common set of
|
|
message types for APIs to use.
|
|
* @property {string} message A developer-facing error message, which should be in English. Any
|
|
user-facing error message should be localized and sent in the
|
|
google.rpc.Status.details field, or localized by the client.
|
|
*/
|
|
|
|
/**
|
|
* @typedef WordInfo
|
|
* @memberOf! speech(v1)
|
|
* @type object
|
|
* @property {string} endTime *Output-only* Time offset relative to the beginning of the audio,
|
|
and corresponding to the end of the spoken word.
|
|
This field is only set if `enable_word_time_offsets=true` and only
|
|
in the top hypothesis.
|
|
This is an experimental feature and the accuracy of the time offset can
|
|
vary.
|
|
* @property {string} startTime *Output-only* Time offset relative to the beginning of the audio,
|
|
and corresponding to the start of the spoken word.
|
|
This field is only set if `enable_word_time_offsets=true` and only
|
|
in the top hypothesis.
|
|
This is an experimental feature and the accuracy of the time offset can
|
|
vary.
|
|
* @property {string} word *Output-only* The word corresponding to this set of information.
|
|
*/
|
|
export = Speech;
|