Class protos.google.cloud.speech.v2.Speech (6.3.0)

Represents a Speech

Inheritance

$protobuf.rpc.Service > protos.google.cloud.speech.v2.Speech

Package

@google-cloud/speech

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new Speech service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

batchRecognize(request, callback)

public batchRecognize(request: google.cloud.speech.v2.IBatchRecognizeRequest, callback: google.cloud.speech.v2.Speech.BatchRecognizeCallback): void;

Calls BatchRecognize.

Parameters
Name Description
request IBatchRecognizeRequest

BatchRecognizeRequest message or plain object
callback BatchRecognizeCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

batchRecognize(request)

public batchRecognize(request: google.cloud.speech.v2.IBatchRecognizeRequest): Promise<google.longrunning.Operation>;

Calls BatchRecognize.

Parameter
Name Description
request IBatchRecognizeRequest

BatchRecognizeRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): Speech;

Creates new Speech service using the specified rpc implementation.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited
Returns
Type Description
Speech

RPC service. Useful where requests and/or responses are streamed.

createCustomClass(request, callback)

public createCustomClass(request: google.cloud.speech.v2.ICreateCustomClassRequest, callback: google.cloud.speech.v2.Speech.CreateCustomClassCallback): void;

Calls CreateCustomClass.

Parameters
Name Description
request ICreateCustomClassRequest

CreateCustomClassRequest message or plain object
callback CreateCustomClassCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

createCustomClass(request)

public createCustomClass(request: google.cloud.speech.v2.ICreateCustomClassRequest): Promise<google.longrunning.Operation>;

Calls CreateCustomClass.

Parameter
Name Description
request ICreateCustomClassRequest

CreateCustomClassRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

createPhraseSet(request, callback)

public createPhraseSet(request: google.cloud.speech.v2.ICreatePhraseSetRequest, callback: google.cloud.speech.v2.Speech.CreatePhraseSetCallback): void;

Calls CreatePhraseSet.

Parameters
Name Description
request ICreatePhraseSetRequest

CreatePhraseSetRequest message or plain object
callback CreatePhraseSetCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

createPhraseSet(request)

public createPhraseSet(request: google.cloud.speech.v2.ICreatePhraseSetRequest): Promise<google.longrunning.Operation>;

Calls CreatePhraseSet.

Parameter
Name Description
request ICreatePhraseSetRequest

CreatePhraseSetRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

createRecognizer(request, callback)

public createRecognizer(request: google.cloud.speech.v2.ICreateRecognizerRequest, callback: google.cloud.speech.v2.Speech.CreateRecognizerCallback): void;

Calls CreateRecognizer.

Parameters
Name Description
request ICreateRecognizerRequest

CreateRecognizerRequest message or plain object
callback CreateRecognizerCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

createRecognizer(request)

public createRecognizer(request: google.cloud.speech.v2.ICreateRecognizerRequest): Promise<google.longrunning.Operation>;

Calls CreateRecognizer.

Parameter
Name Description
request ICreateRecognizerRequest

CreateRecognizerRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

deleteCustomClass(request, callback)

public deleteCustomClass(request: google.cloud.speech.v2.IDeleteCustomClassRequest, callback: google.cloud.speech.v2.Speech.DeleteCustomClassCallback): void;

Calls DeleteCustomClass.

Parameters
Name Description
request IDeleteCustomClassRequest

DeleteCustomClassRequest message or plain object
callback DeleteCustomClassCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

deleteCustomClass(request)

public deleteCustomClass(request: google.cloud.speech.v2.IDeleteCustomClassRequest): Promise<google.longrunning.Operation>;

Calls DeleteCustomClass.

Parameter
Name Description
request IDeleteCustomClassRequest

DeleteCustomClassRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

deletePhraseSet(request, callback)

public deletePhraseSet(request: google.cloud.speech.v2.IDeletePhraseSetRequest, callback: google.cloud.speech.v2.Speech.DeletePhraseSetCallback): void;

Calls DeletePhraseSet.

Parameters
Name Description
request IDeletePhraseSetRequest

DeletePhraseSetRequest message or plain object
callback DeletePhraseSetCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

deletePhraseSet(request)

public deletePhraseSet(request: google.cloud.speech.v2.IDeletePhraseSetRequest): Promise<google.longrunning.Operation>;

Calls DeletePhraseSet.

Parameter
Name Description
request IDeletePhraseSetRequest

DeletePhraseSetRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

deleteRecognizer(request, callback)

public deleteRecognizer(request: google.cloud.speech.v2.IDeleteRecognizerRequest, callback: google.cloud.speech.v2.Speech.DeleteRecognizerCallback): void;

Calls DeleteRecognizer.

Parameters
Name Description
request IDeleteRecognizerRequest

DeleteRecognizerRequest message or plain object
callback DeleteRecognizerCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

deleteRecognizer(request)

public deleteRecognizer(request: google.cloud.speech.v2.IDeleteRecognizerRequest): Promise<google.longrunning.Operation>;

Calls DeleteRecognizer.

Parameter
Name Description
request IDeleteRecognizerRequest

DeleteRecognizerRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

getConfig(request, callback)

public getConfig(request: google.cloud.speech.v2.IGetConfigRequest, callback: google.cloud.speech.v2.Speech.GetConfigCallback): void;

Calls GetConfig.

Parameters
Name Description
request IGetConfigRequest

GetConfigRequest message or plain object
callback GetConfigCallback

Node-style callback called with the error, if any, and Config
Returns
Type Description
void

getConfig(request)

public getConfig(request: google.cloud.speech.v2.IGetConfigRequest): Promise<google.cloud.speech.v2.Config>;

Calls GetConfig.

Parameter
Name Description
request IGetConfigRequest

GetConfigRequest message or plain object
Returns
Type Description
Promise<google.cloud.speech.v2.Config>

Promise

getCustomClass(request, callback)

public getCustomClass(request: google.cloud.speech.v2.IGetCustomClassRequest, callback: google.cloud.speech.v2.Speech.GetCustomClassCallback): void;

Calls GetCustomClass.

Parameters
Name Description
request IGetCustomClassRequest

GetCustomClassRequest message or plain object
callback GetCustomClassCallback

Node-style callback called with the error, if any, and CustomClass
Returns
Type Description
void

getCustomClass(request)

public getCustomClass(request: google.cloud.speech.v2.IGetCustomClassRequest): Promise<google.cloud.speech.v2.CustomClass>;

Calls GetCustomClass.

Parameter
Name Description
request IGetCustomClassRequest

GetCustomClassRequest message or plain object
Returns
Type Description
Promise<google.cloud.speech.v2.CustomClass>

Promise

getPhraseSet(request, callback)

public getPhraseSet(request: google.cloud.speech.v2.IGetPhraseSetRequest, callback: google.cloud.speech.v2.Speech.GetPhraseSetCallback): void;

Calls GetPhraseSet.

Parameters
Name Description
request IGetPhraseSetRequest

GetPhraseSetRequest message or plain object
callback GetPhraseSetCallback

Node-style callback called with the error, if any, and PhraseSet
Returns
Type Description
void

getPhraseSet(request)

public getPhraseSet(request: google.cloud.speech.v2.IGetPhraseSetRequest): Promise<google.cloud.speech.v2.PhraseSet>;

Calls GetPhraseSet.

Parameter
Name Description
request IGetPhraseSetRequest

GetPhraseSetRequest message or plain object
Returns
Type Description
Promise<google.cloud.speech.v2.PhraseSet>

Promise

getRecognizer(request, callback)

public getRecognizer(request: google.cloud.speech.v2.IGetRecognizerRequest, callback: google.cloud.speech.v2.Speech.GetRecognizerCallback): void;

Calls GetRecognizer.

Parameters
Name Description
request IGetRecognizerRequest

GetRecognizerRequest message or plain object
callback GetRecognizerCallback

Node-style callback called with the error, if any, and Recognizer
Returns
Type Description
void

getRecognizer(request)

public getRecognizer(request: google.cloud.speech.v2.IGetRecognizerRequest): Promise<google.cloud.speech.v2.Recognizer>;

Calls GetRecognizer.

Parameter
Name Description
request IGetRecognizerRequest

GetRecognizerRequest message or plain object
Returns
Type Description
Promise<google.cloud.speech.v2.Recognizer>

Promise

listCustomClasses(request, callback)

public listCustomClasses(request: google.cloud.speech.v2.IListCustomClassesRequest, callback: google.cloud.speech.v2.Speech.ListCustomClassesCallback): void;

Calls ListCustomClasses.

Parameters
Name Description
request IListCustomClassesRequest

ListCustomClassesRequest message or plain object
callback ListCustomClassesCallback

Node-style callback called with the error, if any, and ListCustomClassesResponse
Returns
Type Description
void

listCustomClasses(request)

public listCustomClasses(request: google.cloud.speech.v2.IListCustomClassesRequest): Promise<google.cloud.speech.v2.ListCustomClassesResponse>;

Calls ListCustomClasses.

Parameter
Name Description
request IListCustomClassesRequest

ListCustomClassesRequest message or plain object
Returns
Type Description
Promise<google.cloud.speech.v2.ListCustomClassesResponse>

Promise

listPhraseSets(request, callback)

public listPhraseSets(request: google.cloud.speech.v2.IListPhraseSetsRequest, callback: google.cloud.speech.v2.Speech.ListPhraseSetsCallback): void;

Calls ListPhraseSets.

Parameters
Name Description
request IListPhraseSetsRequest

ListPhraseSetsRequest message or plain object
callback ListPhraseSetsCallback

Node-style callback called with the error, if any, and ListPhraseSetsResponse
Returns
Type Description
void

listPhraseSets(request)

public listPhraseSets(request: google.cloud.speech.v2.IListPhraseSetsRequest): Promise<google.cloud.speech.v2.ListPhraseSetsResponse>;

Calls ListPhraseSets.

Parameter
Name Description
request IListPhraseSetsRequest

ListPhraseSetsRequest message or plain object
Returns
Type Description
Promise<google.cloud.speech.v2.ListPhraseSetsResponse>

Promise

listRecognizers(request, callback)

public listRecognizers(request: google.cloud.speech.v2.IListRecognizersRequest, callback: google.cloud.speech.v2.Speech.ListRecognizersCallback): void;

Calls ListRecognizers.

Parameters
Name Description
request IListRecognizersRequest

ListRecognizersRequest message or plain object
callback ListRecognizersCallback

Node-style callback called with the error, if any, and ListRecognizersResponse
Returns
Type Description
void

listRecognizers(request)

public listRecognizers(request: google.cloud.speech.v2.IListRecognizersRequest): Promise<google.cloud.speech.v2.ListRecognizersResponse>;

Calls ListRecognizers.

Parameter
Name Description
request IListRecognizersRequest

ListRecognizersRequest message or plain object
Returns
Type Description
Promise<google.cloud.speech.v2.ListRecognizersResponse>

Promise

recognize(request, callback)

public recognize(request: google.cloud.speech.v2.IRecognizeRequest, callback: google.cloud.speech.v2.Speech.RecognizeCallback): void;

Calls Recognize.

Parameters
Name Description
request IRecognizeRequest

RecognizeRequest message or plain object
callback RecognizeCallback

Node-style callback called with the error, if any, and RecognizeResponse
Returns
Type Description
void

recognize(request)

public recognize(request: google.cloud.speech.v2.IRecognizeRequest): Promise<google.cloud.speech.v2.RecognizeResponse>;

Calls Recognize.

Parameter
Name Description
request IRecognizeRequest

RecognizeRequest message or plain object
Returns
Type Description
Promise<google.cloud.speech.v2.RecognizeResponse>

Promise

streamingRecognize(request, callback)

public streamingRecognize(request: google.cloud.speech.v2.IStreamingRecognizeRequest, callback: google.cloud.speech.v2.Speech.StreamingRecognizeCallback): void;

Calls StreamingRecognize.

Parameters
Name Description
request IStreamingRecognizeRequest

StreamingRecognizeRequest message or plain object
callback StreamingRecognizeCallback

Node-style callback called with the error, if any, and StreamingRecognizeResponse
Returns
Type Description
void

streamingRecognize(request)

public streamingRecognize(request: google.cloud.speech.v2.IStreamingRecognizeRequest): Promise<google.cloud.speech.v2.StreamingRecognizeResponse>;

Calls StreamingRecognize.

Parameter
Name Description
request IStreamingRecognizeRequest

StreamingRecognizeRequest message or plain object
Returns
Type Description
Promise<google.cloud.speech.v2.StreamingRecognizeResponse>

Promise

undeleteCustomClass(request, callback)

public undeleteCustomClass(request: google.cloud.speech.v2.IUndeleteCustomClassRequest, callback: google.cloud.speech.v2.Speech.UndeleteCustomClassCallback): void;

Calls UndeleteCustomClass.

Parameters
Name Description
request IUndeleteCustomClassRequest

UndeleteCustomClassRequest message or plain object
callback UndeleteCustomClassCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

undeleteCustomClass(request)

public undeleteCustomClass(request: google.cloud.speech.v2.IUndeleteCustomClassRequest): Promise<google.longrunning.Operation>;

Calls UndeleteCustomClass.

Parameter
Name Description
request IUndeleteCustomClassRequest

UndeleteCustomClassRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

undeletePhraseSet(request, callback)

public undeletePhraseSet(request: google.cloud.speech.v2.IUndeletePhraseSetRequest, callback: google.cloud.speech.v2.Speech.UndeletePhraseSetCallback): void;

Calls UndeletePhraseSet.

Parameters
Name Description
request IUndeletePhraseSetRequest

UndeletePhraseSetRequest message or plain object
callback UndeletePhraseSetCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

undeletePhraseSet(request)

public undeletePhraseSet(request: google.cloud.speech.v2.IUndeletePhraseSetRequest): Promise<google.longrunning.Operation>;

Calls UndeletePhraseSet.

Parameter
Name Description
request IUndeletePhraseSetRequest

UndeletePhraseSetRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

undeleteRecognizer(request, callback)

public undeleteRecognizer(request: google.cloud.speech.v2.IUndeleteRecognizerRequest, callback: google.cloud.speech.v2.Speech.UndeleteRecognizerCallback): void;

Calls UndeleteRecognizer.

Parameters
Name Description
request IUndeleteRecognizerRequest

UndeleteRecognizerRequest message or plain object
callback UndeleteRecognizerCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

undeleteRecognizer(request)

public undeleteRecognizer(request: google.cloud.speech.v2.IUndeleteRecognizerRequest): Promise<google.longrunning.Operation>;

Calls UndeleteRecognizer.

Parameter
Name Description
request IUndeleteRecognizerRequest

UndeleteRecognizerRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

updateConfig(request, callback)

public updateConfig(request: google.cloud.speech.v2.IUpdateConfigRequest, callback: google.cloud.speech.v2.Speech.UpdateConfigCallback): void;

Calls UpdateConfig.

Parameters
Name Description
request IUpdateConfigRequest

UpdateConfigRequest message or plain object
callback UpdateConfigCallback

Node-style callback called with the error, if any, and Config
Returns
Type Description
void

updateConfig(request)

public updateConfig(request: google.cloud.speech.v2.IUpdateConfigRequest): Promise<google.cloud.speech.v2.Config>;

Calls UpdateConfig.

Parameter
Name Description
request IUpdateConfigRequest

UpdateConfigRequest message or plain object
Returns
Type Description
Promise<google.cloud.speech.v2.Config>

Promise

updateCustomClass(request, callback)

public updateCustomClass(request: google.cloud.speech.v2.IUpdateCustomClassRequest, callback: google.cloud.speech.v2.Speech.UpdateCustomClassCallback): void;

Calls UpdateCustomClass.

Parameters
Name Description
request IUpdateCustomClassRequest

UpdateCustomClassRequest message or plain object
callback UpdateCustomClassCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

updateCustomClass(request)

public updateCustomClass(request: google.cloud.speech.v2.IUpdateCustomClassRequest): Promise<google.longrunning.Operation>;

Calls UpdateCustomClass.

Parameter
Name Description
request IUpdateCustomClassRequest

UpdateCustomClassRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

updatePhraseSet(request, callback)

public updatePhraseSet(request: google.cloud.speech.v2.IUpdatePhraseSetRequest, callback: google.cloud.speech.v2.Speech.UpdatePhraseSetCallback): void;

Calls UpdatePhraseSet.

Parameters
Name Description
request IUpdatePhraseSetRequest

UpdatePhraseSetRequest message or plain object
callback UpdatePhraseSetCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

updatePhraseSet(request)

public updatePhraseSet(request: google.cloud.speech.v2.IUpdatePhraseSetRequest): Promise<google.longrunning.Operation>;

Calls UpdatePhraseSet.

Parameter
Name Description
request IUpdatePhraseSetRequest

UpdatePhraseSetRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

updateRecognizer(request, callback)

public updateRecognizer(request: google.cloud.speech.v2.IUpdateRecognizerRequest, callback: google.cloud.speech.v2.Speech.UpdateRecognizerCallback): void;

Calls UpdateRecognizer.

Parameters
Name Description
request IUpdateRecognizerRequest

UpdateRecognizerRequest message or plain object
callback UpdateRecognizerCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

updateRecognizer(request)

public updateRecognizer(request: google.cloud.speech.v2.IUpdateRecognizerRequest): Promise<google.longrunning.Operation>;

Calls UpdateRecognizer.

Parameter
Name Description
request IUpdateRecognizerRequest

UpdateRecognizerRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise