Console
    Contact Us Start free

    Class v1p1beta1.SpeechClient (4.8.1)

    Service that implements Google Cloud Speech API. v1p1beta1

    Package

    @google-cloud/speech!

    Constructors

    (constructor)(opts)

      constructor 
 ( 
 opts 
 ?: 
  
 ClientOptions 
 );

    Construct an instance of SpeechClient.

    Parameter
    Name Description
    opts ClientOptions

    Properties

    apiEndpoint

      static 
  
 get 
  
 apiEndpoint 
 () 
 : 
  
 string 
 ;

    The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

    Property Value
    Type Description
    string

    auth

      auth 
 : 
  
 gax 
 . 
 GoogleAuth 
 ;
    Property Value
    Type Description
    gax. GoogleAuth

    descriptors

      descriptors 
 : 
  
 Descriptors 
 ;
    Property Value
    Type Description
    Descriptors

    innerApiCalls

      innerApiCalls 
 : 
  
 { 
  
 [ 
 name 
 : 
  
 string 
 ] 
 : 
  
 Function 
 ; 
  
 };
    Property Value
    Type Description
    { [name: string]: Function ; }

    operationsClient

      operationsClient 
 : 
  
 gax 
 . 
 OperationsClient 
 ;
    Property Value
    Type Description
    gax. OperationsClient

    pathTemplates

      pathTemplates 
 : 
  
 { 
  
 [ 
 name 
 : 
  
 string 
 ] 
 : 
  
 gax 
 . 
 PathTemplate 
 ; 
  
 };
    Property Value
    Type Description
    { [name: string]: gax. PathTemplate ; }

    port

      static 
  
 get 
  
 port 
 () 
 : 
  
 number 
 ;

    The port for this API service.

    Property Value
    Type Description
    number

    scopes

      static 
  
 get 
  
 scopes 
 () 
 : 
  
 string 
 [];

    The scopes needed to make gRPC calls for every method defined in this service.

    Property Value
    Type Description
    string[]

    servicePath

      static 
  
 get 
  
 servicePath 
 () 
 : 
  
 string 
 ;

    The DNS address for this API service.

    Property Value
    Type Description
    string

    speechStub

      speechStub 
 ?: 
  
 Promise 
< { 
  
 [ 
 name 
 : 
  
 string 
 ] 
 : 
  
 Function 
 ; 
  
 }>;
    Property Value
    Type Description
    Promise <{ [name: string]: Function ; }>

    warn

      warn 
 : 
  
 ( 
 code 
 : 
  
 string 
 , 
  
 message 
 : 
  
 string 
 , 
  
 warnType 
 ?: 
  
 string 
 ) 
  
 = 
>  
 void 
 ;
    Property Value
    Type Description
    (code: string, message: string, warnType?: string) => void

    Methods

    _streamingRecognize(options)

      _streamingRecognize 
 ( 
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 gax 
 . 
 CancellableStream 
 ;

    Performs bidirectional streaming speech recognition: receive results while sending audio. This method is only available via the gRPC API (not REST).

    Parameter
    Name Description
    options CallOptions

    Call options. See CallOptions for more details.
    Returns
    Type Description
    gax. CancellableStream

    {Stream} An object stream which is both readable and writable. It accepts objects representing [StreamingRecognizeRequest] for write() method, and will emit objects representing [StreamingRecognizeResponse] on 'data' event asynchronously. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#bi-directional-streaming) for more details and examples.

    checkLongRunningRecognizeProgress(name)

      checkLongRunningRecognizeProgress 
 ( 
 name 
 : 
  
 string 
 ) 
 : 
  
 Promise<LROperation<protos 
 . 
 google 
 . 
 cloud 
 . 
 speech 
 . 
 v1p1beta1 
 . 
 LongRunningRecognizeResponse 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 speech 
 . 
 v1p1beta1 
 . 
 LongRunningRecognizeMetadata 
>> ;

    Check the status of the long running operation returned by longRunningRecognize() .

    Parameter
    Name Description
    name string

    The operation name that will be passed.
    Returns
    Type Description
    Promise < LROperation <protos. google.cloud.speech.v1p1beta1.LongRunningRecognizeResponse , protos. google.cloud.speech.v1p1beta1.LongRunningRecognizeMetadata >>

    {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

    close()

      close 
 () 
 : 
  
 Promise<void> 
 ;

    Terminate the gRPC channel and close the client.

    The client will no longer be usable and all future behavior is undefined.

    Returns
    Type Description
    Promise <void>

    {Promise} A promise that resolves when the client is closed.

    customClassPath(project, location, customClass)

      customClassPath 
 ( 
 project 
 : 
  
 string 
 , 
  
 location 
 : 
  
 string 
 , 
  
 customClass 
 : 
  
 string 
 ) 
 : 
  
 string 
 ;

    Return a fully-qualified customClass resource name string.

    Parameters
    Name Description
    project string
    location string
    customClass string
    Returns
    Type Description
    string

    {string} Resource name string.

    getProjectId()

      getProjectId 
 () 
 : 
  
 Promise<string> 
 ;
    Returns
    Type Description
    Promise <string>

    getProjectId(callback)

      getProjectId 
 ( 
 callback 
 : 
  
 Callback<string 
 , 
  
 undefined 
 , 
  
 undefined 
> ) 
 : 
  
 void 
 ;
    Parameter
    Name Description
    callback Callback <string, undefined, undefined>
    Returns
    Type Description
    void

    initialize()

      initialize 
 () 
 : 
  
 Promise 
< { 
  
 [ 
 name 
 : 
  
 string 
 ] 
 : 
  
 Function 
 ; 
  
 }>;

    Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

    You can await on this method if you want to make sure the client is initialized.

    Returns
    Type Description
    Promise <{ [name: string]: Function ; }>

    {Promise} A promise that resolves to an authenticated service stub.

    longRunningRecognize(request, options)

      longRunningRecognize 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 speech 
 . 
 v1p1beta1 
 . 
 ILongRunningRecognizeRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
 LROperation<protos 
 . 
 google 
 . 
 cloud 
 . 
 speech 
 . 
 v1p1beta1 
 . 
 ILongRunningRecognizeResponse 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 speech 
 . 
 v1p1beta1 
 . 
 ILongRunningRecognizeMetadata 
> , 
  
 protos 
 . 
 google 
 . 
 longrunning 
 . 
 IOperation 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 undefined 
 ]>;
    Parameters
    Name Description
    request protos. google.cloud.speech.v1p1beta1.ILongRunningRecognizeRequest
    options CallOptions
    Returns
    Type Description
    Promise <[ LROperation <protos. google.cloud.speech.v1p1beta1.ILongRunningRecognizeResponse , protos. google.cloud.speech.v1p1beta1.ILongRunningRecognizeMetadata >, protos. google.longrunning.IOperation | undefined, {} | undefined]>

    longRunningRecognize(request, options, callback)

      longRunningRecognize 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 speech 
 . 
 v1p1beta1 
 . 
 ILongRunningRecognizeRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 Callback<LROperation<protos 
 . 
 google 
 . 
 cloud 
 . 
 speech 
 . 
 v1p1beta1 
 . 
 ILongRunningRecognizeResponse 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 speech 
 . 
 v1p1beta1 
 . 
 ILongRunningRecognizeMetadata 
> , 
  
 protos 
 . 
 google 
 . 
 longrunning 
 . 
 IOperation 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    request protos. google.cloud.speech.v1p1beta1.ILongRunningRecognizeRequest
    options CallOptions
    callback Callback < LROperation <protos. google.cloud.speech.v1p1beta1.ILongRunningRecognizeResponse , protos. google.cloud.speech.v1p1beta1.ILongRunningRecognizeMetadata >, protos. google.longrunning.IOperation | null | undefined, {} | null | undefined>
    Returns
    Type Description
    void

    longRunningRecognize(request, callback)

      longRunningRecognize 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 speech 
 . 
 v1p1beta1 
 . 
 ILongRunningRecognizeRequest 
 , 
  
 callback 
 : 
  
 Callback<LROperation<protos 
 . 
 google 
 . 
 cloud 
 . 
 speech 
 . 
 v1p1beta1 
 . 
 ILongRunningRecognizeResponse 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 speech 
 . 
 v1p1beta1 
 . 
 ILongRunningRecognizeMetadata 
> , 
  
 protos 
 . 
 google 
 . 
 longrunning 
 . 
 IOperation 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    request protos. google.cloud.speech.v1p1beta1.ILongRunningRecognizeRequest
    callback Callback < LROperation <protos. google.cloud.speech.v1p1beta1.ILongRunningRecognizeResponse , protos. google.cloud.speech.v1p1beta1.ILongRunningRecognizeMetadata >, protos. google.longrunning.IOperation | null | undefined, {} | null | undefined>
    Returns
    Type Description
    void

    matchCustomClassFromCustomClassName(customClassName)

      matchCustomClassFromCustomClassName 
 ( 
 customClassName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the custom_class from CustomClass resource.

    Parameter
    Name Description
    customClassName string

    A fully-qualified path representing CustomClass resource.
    Returns
    Type Description
    string | number

    {string} A string representing the custom_class.

    matchLocationFromCustomClassName(customClassName)

      matchLocationFromCustomClassName 
 ( 
 customClassName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the location from CustomClass resource.

    Parameter
    Name Description
    customClassName string

    A fully-qualified path representing CustomClass resource.
    Returns
    Type Description
    string | number

    {string} A string representing the location.

    matchLocationFromPhraseSetName(phraseSetName)

      matchLocationFromPhraseSetName 
 ( 
 phraseSetName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the location from PhraseSet resource.

    Parameter
    Name Description
    phraseSetName string

    A fully-qualified path representing PhraseSet resource.
    Returns
    Type Description
    string | number

    {string} A string representing the location.

    matchPhraseSetFromPhraseSetName(phraseSetName)

      matchPhraseSetFromPhraseSetName 
 ( 
 phraseSetName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the phrase_set from PhraseSet resource.

    Parameter
    Name Description
    phraseSetName string

    A fully-qualified path representing PhraseSet resource.
    Returns
    Type Description
    string | number

    {string} A string representing the phrase_set.

    matchProjectFromCustomClassName(customClassName)

      matchProjectFromCustomClassName 
 ( 
 customClassName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the project from CustomClass resource.

    Parameter
    Name Description
    customClassName string

    A fully-qualified path representing CustomClass resource.
    Returns
    Type Description
    string | number

    {string} A string representing the project.

    matchProjectFromPhraseSetName(phraseSetName)

      matchProjectFromPhraseSetName 
 ( 
 phraseSetName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the project from PhraseSet resource.

    Parameter
    Name Description
    phraseSetName string

    A fully-qualified path representing PhraseSet resource.
    Returns
    Type Description
    string | number

    {string} A string representing the project.

    phraseSetPath(project, location, phraseSet)

      phraseSetPath 
 ( 
 project 
 : 
  
 string 
 , 
  
 location 
 : 
  
 string 
 , 
  
 phraseSet 
 : 
  
 string 
 ) 
 : 
  
 string 
 ;

    Return a fully-qualified phraseSet resource name string.

    Parameters
    Name Description
    project string
    location string
    phraseSet string
    Returns
    Type Description
    string

    {string} Resource name string.

    recognize(request, options)

      recognize 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 speech 
 . 
 v1p1beta1 
 . 
 IRecognizeRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
 protos 
 . 
 google 
 . 
 cloud 
 . 
 speech 
 . 
 v1p1beta1 
 . 
 IRecognizeResponse 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 speech 
 . 
 v1p1beta1 
 . 
 IRecognizeRequest 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 undefined 
 ]>;
    Parameters
    Name Description
    request protos. google.cloud.speech.v1p1beta1.IRecognizeRequest
    options CallOptions
    Returns
    Type Description
    Promise <[protos. google.cloud.speech.v1p1beta1.IRecognizeResponse , protos. google.cloud.speech.v1p1beta1.IRecognizeRequest | undefined, {} | undefined]>

    recognize(request, options, callback)

      recognize 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 speech 
 . 
 v1p1beta1 
 . 
 IRecognizeRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 cloud 
 . 
 speech 
 . 
 v1p1beta1 
 . 
 IRecognizeResponse 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 speech 
 . 
 v1p1beta1 
 . 
 IRecognizeRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    request protos. google.cloud.speech.v1p1beta1.IRecognizeRequest
    options CallOptions
    callback Callback <protos. google.cloud.speech.v1p1beta1.IRecognizeResponse , protos. google.cloud.speech.v1p1beta1.IRecognizeRequest | null | undefined, {} | null | undefined>
    Returns
    Type Description
    void

    recognize(request, callback)

      recognize 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 speech 
 . 
 v1p1beta1 
 . 
 IRecognizeRequest 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 cloud 
 . 
 speech 
 . 
 v1p1beta1 
 . 
 IRecognizeResponse 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 speech 
 . 
 v1p1beta1 
 . 
 IRecognizeRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    request protos. google.cloud.speech.v1p1beta1.IRecognizeRequest
    callback Callback <protos. google.cloud.speech.v1p1beta1.IRecognizeResponse , protos. google.cloud.speech.v1p1beta1.IRecognizeRequest | null | undefined, {} | null | undefined>
    Returns
    Type Description
    void
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: