Cloud Speech-to-Text API v1 - Package cloud.google.com/go/speech/apiv1 (v1.28.1)

Note: To get more information about this package, such as access to older versions, viewthis package on pkg.go.dev.

Package speech is an auto-generated package for theCloud Speech-to-Text API.

Converts audio to text by applying powerful neural network models.

General documentation

For information that is relevant for all client libraries please referencehttps://pkg.go.dev/cloud.google.com/go#pkg-overview. Some information on thispage includes:

Example usage

To get started with this package, create a client.

// go get cloud.google.com/go/speech/apiv1@latestctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=speech.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()

The client will use your default application credentials. Clients should be reused instead of created as needed.The methods of Client are safe for concurrent use by multiple goroutines.The returned client must be Closed when it is done being used.

Using the Client

The following is an example of making an API call with the newly created client, mentioned above.

req:=&speechpb.LongRunningRecognizeRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/speech/apiv1/speechpb#LongRunningRecognizeRequest.}op,err:=c.LongRunningRecognize(ctx,req)iferr!=nil{// TODO: Handle error.}resp,err:=op.Wait(ctx)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp

Use of Context

The ctx passed to NewClient is used for authentication requests andfor creating the underlying connection, but is not used for subsequent calls.Individual methods on the client use the ctx given to them.

To close the open connection, use the Close() method.

Functions

func DefaultAuthScopes

funcDefaultAuthScopes()[]string

DefaultAuthScopes reports the default set of authentication scopes to use with this package.

AdaptationCallOptions

typeAdaptationCallOptionsstruct{CreatePhraseSet[]gax.CallOptionGetPhraseSet[]gax.CallOptionListPhraseSet[]gax.CallOptionUpdatePhraseSet[]gax.CallOptionDeletePhraseSet[]gax.CallOptionCreateCustomClass[]gax.CallOptionGetCustomClass[]gax.CallOptionListCustomClasses[]gax.CallOptionUpdateCustomClass[]gax.CallOptionDeleteCustomClass[]gax.CallOptionGetOperation[]gax.CallOptionListOperations[]gax.CallOption}

AdaptationCallOptions contains the retry settings for each method of AdaptationClient.

AdaptationClient

typeAdaptationClientstruct{// The call options for this service.CallOptions*AdaptationCallOptions// contains filtered or unexported fields}

AdaptationClient is a client for interacting with Cloud Speech-to-Text API.Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Service that implements Google Cloud Speech Adaptation API.

func NewAdaptationClient

funcNewAdaptationClient(ctxcontext.Context,opts...option.ClientOption)(*AdaptationClient,error)

NewAdaptationClient creates a new adaptation client based on gRPC.The returned client must be Closed when it is done being used to clean up its underlying connections.

Service that implements Google Cloud Speech Adaptation API.

Example

packagemainimport("context"speech"cloud.google.com/go/speech/apiv1")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=speech.NewAdaptationClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()// TODO: Use client._=c}

func NewAdaptationRESTClient

funcNewAdaptationRESTClient(ctxcontext.Context,opts...option.ClientOption)(*AdaptationClient,error)

NewAdaptationRESTClient creates a new adaptation rest client.

Service that implements Google Cloud Speech Adaptation API.

Example

packagemainimport("context"speech"cloud.google.com/go/speech/apiv1")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=speech.NewAdaptationRESTClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()// TODO: Use client._=c}

func (*AdaptationClient) Close

func(c*AdaptationClient)Close()error

Close closes the connection to the API service. The user should invoke this whenthe client is no longer required.

func (*AdaptationClient) Connection (deprecated)

func(c*AdaptationClient)Connection()*grpc.ClientConn

Connection returns a connection to the API service.

Deprecated: Connections are now pooled so this method does not alwaysreturn the same resource.

func (*AdaptationClient) CreateCustomClass

CreateCustomClass create a custom class.

Example

packagemainimport("context"speech"cloud.google.com/go/speech/apiv1"speechpb"cloud.google.com/go/speech/apiv1/speechpb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=speech.NewAdaptationClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&speechpb.CreateCustomClassRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/speech/apiv1/speechpb#CreateCustomClassRequest.}resp,err:=c.CreateCustomClass(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*AdaptationClient) CreatePhraseSet

CreatePhraseSet create a set of phrase hints. Each item in the set can be a single word ora multi-word phrase. The items in the PhraseSet are favored by therecognition model when you send a call that includes the PhraseSet.

Example

packagemainimport("context"speech"cloud.google.com/go/speech/apiv1"speechpb"cloud.google.com/go/speech/apiv1/speechpb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=speech.NewAdaptationClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&speechpb.CreatePhraseSetRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/speech/apiv1/speechpb#CreatePhraseSetRequest.}resp,err:=c.CreatePhraseSet(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*AdaptationClient) DeleteCustomClass

DeleteCustomClass delete a custom class.

Example

packagemainimport("context"speech"cloud.google.com/go/speech/apiv1"speechpb"cloud.google.com/go/speech/apiv1/speechpb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=speech.NewAdaptationClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&speechpb.DeleteCustomClassRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/speech/apiv1/speechpb#DeleteCustomClassRequest.}err=c.DeleteCustomClass(ctx,req)iferr!=nil{// TODO: Handle error.}}

func (*AdaptationClient) DeletePhraseSet

DeletePhraseSet delete a phrase set.

Example

packagemainimport("context"speech"cloud.google.com/go/speech/apiv1"speechpb"cloud.google.com/go/speech/apiv1/speechpb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=speech.NewAdaptationClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&speechpb.DeletePhraseSetRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/speech/apiv1/speechpb#DeletePhraseSetRequest.}err=c.DeletePhraseSet(ctx,req)iferr!=nil{// TODO: Handle error.}}

func (*AdaptationClient) GetCustomClass

GetCustomClass get a custom class.

Example

packagemainimport("context"speech"cloud.google.com/go/speech/apiv1"speechpb"cloud.google.com/go/speech/apiv1/speechpb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=speech.NewAdaptationClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&speechpb.GetCustomClassRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/speech/apiv1/speechpb#GetCustomClassRequest.}resp,err:=c.GetCustomClass(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*AdaptationClient) GetOperation

GetOperation is a utility method from google.longrunning.Operations.

Example

packagemainimport("context"longrunningpb"cloud.google.com/go/longrunning/autogen/longrunningpb"speech"cloud.google.com/go/speech/apiv1")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=speech.NewAdaptationClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&longrunningpb.GetOperationRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#GetOperationRequest.}resp,err:=c.GetOperation(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*AdaptationClient) GetPhraseSet

GetPhraseSet get a phrase set.

Example

packagemainimport("context"speech"cloud.google.com/go/speech/apiv1"speechpb"cloud.google.com/go/speech/apiv1/speechpb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=speech.NewAdaptationClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&speechpb.GetPhraseSetRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/speech/apiv1/speechpb#GetPhraseSetRequest.}resp,err:=c.GetPhraseSet(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*AdaptationClient) ListCustomClasses

ListCustomClasses list custom classes.

Examples

packagemainimport("context"speech"cloud.google.com/go/speech/apiv1"speechpb"cloud.google.com/go/speech/apiv1/speechpb""google.golang.org/api/iterator")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=speech.NewAdaptationClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&speechpb.ListCustomClassesRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/speech/apiv1/speechpb#ListCustomClassesRequest.}it:=c.ListCustomClasses(ctx,req)for{resp,err:=it.Next()iferr==iterator.Done{break}iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp// If you need to access the underlying RPC response,// you can do so by casting the `Response` as below.// Otherwise, remove this line. Only populated after// first call to Next(). Not safe for concurrent access._=it.Response.(*speechpb.ListCustomClassesResponse)}}
all
packagemainimport("context"speech"cloud.google.com/go/speech/apiv1"speechpb"cloud.google.com/go/speech/apiv1/speechpb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=speech.NewAdaptationClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&speechpb.ListCustomClassesRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/speech/apiv1/speechpb#ListCustomClassesRequest.}forresp,err:=rangec.ListCustomClasses(ctx,req).All(){iferr!=nil{// TODO: Handle error and break/return/continue. Iteration will stop after any error.}// TODO: Use resp._=resp}}

func (*AdaptationClient) ListOperations

ListOperations is a utility method from google.longrunning.Operations.

Examples

packagemainimport("context"longrunningpb"cloud.google.com/go/longrunning/autogen/longrunningpb"speech"cloud.google.com/go/speech/apiv1""google.golang.org/api/iterator")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=speech.NewAdaptationClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&longrunningpb.ListOperationsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.}it:=c.ListOperations(ctx,req)for{resp,err:=it.Next()iferr==iterator.Done{break}iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp// If you need to access the underlying RPC response,// you can do so by casting the `Response` as below.// Otherwise, remove this line. Only populated after// first call to Next(). Not safe for concurrent access._=it.Response.(*longrunningpb.ListOperationsResponse)}}
all
packagemainimport("context"longrunningpb"cloud.google.com/go/longrunning/autogen/longrunningpb"speech"cloud.google.com/go/speech/apiv1")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=speech.NewAdaptationClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&longrunningpb.ListOperationsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.}forresp,err:=rangec.ListOperations(ctx,req).All(){iferr!=nil{// TODO: Handle error and break/return/continue. Iteration will stop after any error.}// TODO: Use resp._=resp}}

func (*AdaptationClient) ListPhraseSet

ListPhraseSet list phrase sets.

Examples

packagemainimport("context"speech"cloud.google.com/go/speech/apiv1"speechpb"cloud.google.com/go/speech/apiv1/speechpb""google.golang.org/api/iterator")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=speech.NewAdaptationClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&speechpb.ListPhraseSetRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/speech/apiv1/speechpb#ListPhraseSetRequest.}it:=c.ListPhraseSet(ctx,req)for{resp,err:=it.Next()iferr==iterator.Done{break}iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp// If you need to access the underlying RPC response,// you can do so by casting the `Response` as below.// Otherwise, remove this line. Only populated after// first call to Next(). Not safe for concurrent access._=it.Response.(*speechpb.ListPhraseSetResponse)}}
all
packagemainimport("context"speech"cloud.google.com/go/speech/apiv1"speechpb"cloud.google.com/go/speech/apiv1/speechpb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=speech.NewAdaptationClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&speechpb.ListPhraseSetRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/speech/apiv1/speechpb#ListPhraseSetRequest.}forresp,err:=rangec.ListPhraseSet(ctx,req).All(){iferr!=nil{// TODO: Handle error and break/return/continue. Iteration will stop after any error.}// TODO: Use resp._=resp}}

func (*AdaptationClient) UpdateCustomClass

UpdateCustomClass update a custom class.

Example

packagemainimport("context"speech"cloud.google.com/go/speech/apiv1"speechpb"cloud.google.com/go/speech/apiv1/speechpb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=speech.NewAdaptationClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&speechpb.UpdateCustomClassRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/speech/apiv1/speechpb#UpdateCustomClassRequest.}resp,err:=c.UpdateCustomClass(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*AdaptationClient) UpdatePhraseSet

UpdatePhraseSet update a phrase set.

Example

packagemainimport("context"speech"cloud.google.com/go/speech/apiv1"speechpb"cloud.google.com/go/speech/apiv1/speechpb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=speech.NewAdaptationClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&speechpb.UpdatePhraseSetRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/speech/apiv1/speechpb#UpdatePhraseSetRequest.}resp,err:=c.UpdatePhraseSet(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

CallOptions

typeCallOptionsstruct{Recognize[]gax.CallOptionLongRunningRecognize[]gax.CallOptionStreamingRecognize[]gax.CallOptionGetOperation[]gax.CallOptionListOperations[]gax.CallOption}

CallOptions contains the retry settings for each method of Client.

Client

typeClientstruct{// The call options for this service.CallOptions*CallOptions// LROClient is used internally to handle long-running operations.// It is exposed so that its CallOptions can be modified if required.// Users should not Close this client.LROClient*lroauto.OperationsClient// contains filtered or unexported fields}

Client is a client for interacting with Cloud Speech-to-Text API.Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Service that implements Google Cloud Speech API.

func NewClient

funcNewClient(ctxcontext.Context,opts...option.ClientOption)(*Client,error)

NewClient creates a new speech client based on gRPC.The returned client must be Closed when it is done being used to clean up its underlying connections.

Service that implements Google Cloud Speech API.

Example

packagemainimport("context"speech"cloud.google.com/go/speech/apiv1")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=speech.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()// TODO: Use client._=c}

func NewRESTClient

funcNewRESTClient(ctxcontext.Context,opts...option.ClientOption)(*Client,error)

NewRESTClient creates a new speech rest client.

Service that implements Google Cloud Speech API.

Example

packagemainimport("context"speech"cloud.google.com/go/speech/apiv1")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=speech.NewRESTClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()// TODO: Use client._=c}

func (*Client) Close

func(c*Client)Close()error

Close closes the connection to the API service. The user should invoke this whenthe client is no longer required.

func (*Client) Connection (deprecated)

func(c*Client)Connection()*grpc.ClientConn

Connection returns a connection to the API service.

Deprecated: Connections are now pooled so this method does not alwaysreturn the same resource.

func (*Client) GetOperation

GetOperation is a utility method from google.longrunning.Operations.

Example

packagemainimport("context"longrunningpb"cloud.google.com/go/longrunning/autogen/longrunningpb"speech"cloud.google.com/go/speech/apiv1")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=speech.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&longrunningpb.GetOperationRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#GetOperationRequest.}resp,err:=c.GetOperation(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*Client) ListOperations

ListOperations is a utility method from google.longrunning.Operations.

Examples

packagemainimport("context"longrunningpb"cloud.google.com/go/longrunning/autogen/longrunningpb"speech"cloud.google.com/go/speech/apiv1""google.golang.org/api/iterator")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=speech.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&longrunningpb.ListOperationsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.}it:=c.ListOperations(ctx,req)for{resp,err:=it.Next()iferr==iterator.Done{break}iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp// If you need to access the underlying RPC response,// you can do so by casting the `Response` as below.// Otherwise, remove this line. Only populated after// first call to Next(). Not safe for concurrent access._=it.Response.(*longrunningpb.ListOperationsResponse)}}
all
packagemainimport("context"longrunningpb"cloud.google.com/go/longrunning/autogen/longrunningpb"speech"cloud.google.com/go/speech/apiv1")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=speech.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&longrunningpb.ListOperationsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.}forresp,err:=rangec.ListOperations(ctx,req).All(){iferr!=nil{// TODO: Handle error and break/return/continue. Iteration will stop after any error.}// TODO: Use resp._=resp}}

func (*Client) LongRunningRecognize

LongRunningRecognize performs asynchronous speech recognition: receive results via thegoogle.longrunning.Operations interface. Returns either anOperation.error or an Operation.response which containsa LongRunningRecognizeResponse message.For more information on asynchronous speech recognition, see thehow-to (athttps://cloud.google.com/speech-to-text/docs/async-recognize).

Example

packagemainimport("context"speech"cloud.google.com/go/speech/apiv1"speechpb"cloud.google.com/go/speech/apiv1/speechpb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=speech.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&speechpb.LongRunningRecognizeRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/speech/apiv1/speechpb#LongRunningRecognizeRequest.}op,err:=c.LongRunningRecognize(ctx,req)iferr!=nil{// TODO: Handle error.}resp,err:=op.Wait(ctx)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*Client) LongRunningRecognizeOperation

func(c*Client)LongRunningRecognizeOperation(namestring)*LongRunningRecognizeOperation

LongRunningRecognizeOperation returns a new LongRunningRecognizeOperation from a given name.The name must be that of a previously created LongRunningRecognizeOperation, possibly from a different process.

func (*Client) Recognize

Recognize performs synchronous speech recognition: receive results after all audiohas been sent and processed.

Example

packagemainimport("context"speech"cloud.google.com/go/speech/apiv1"speechpb"cloud.google.com/go/speech/apiv1/speechpb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=speech.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&speechpb.RecognizeRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/speech/apiv1/speechpb#RecognizeRequest.}resp,err:=c.Recognize(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*Client) StreamingRecognize

StreamingRecognize performs bidirectional streaming speech recognition: receive results whilesending audio. This method is only available via the gRPC API (not REST).

This method is not supported for the REST transport.

Example

packagemainimport("context""io"speech"cloud.google.com/go/speech/apiv1"speechpb"cloud.google.com/go/speech/apiv1/speechpb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=speech.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()stream,err:=c.StreamingRecognize(ctx)iferr!=nil{// TODO: Handle error.}gofunc(){reqs:=[]*speechpb.StreamingRecognizeRequest{// TODO: Create requests.}for_,req:=rangereqs{iferr:=stream.Send(req);err!=nil{// TODO: Handle error.}}stream.CloseSend()}()for{resp,err:=stream.Recv()iferr==io.EOF{break}iferr!=nil{// TODO: handle error.}// TODO: Use resp._=resp}}

CustomClassIterator

typeCustomClassIteratorstruct{// Response is the raw response for the current page.// It must be cast to the RPC response type.// Calling Next() or InternalFetch() updates this value.Responseinterface{}// InternalFetch is for use by the Google Cloud Libraries only.// It is not part of the stable interface of this package.//// InternalFetch returns results from a single call to the underlying RPC.// The number of results is no greater than pageSize.// If there are no more results, nextPageToken is empty and err is nil.InternalFetchfunc(pageSizeint,pageTokenstring)(results[]*speechpb.CustomClass,nextPageTokenstring,errerror)// contains filtered or unexported fields}

CustomClassIterator manages a stream of *speechpb.CustomClass.

func (*CustomClassIterator) All

func(it*CustomClassIterator)All()iter.Seq2[*speechpb.CustomClass,error]

All returns an iterator. If an error is returned by the iterator, theiterator will stop after that iteration.

func (*CustomClassIterator) Next

Next returns the next result. Its second return value is iterator.Done if there are no moreresults. Once Next returns Done, all subsequent calls will return Done.

func (*CustomClassIterator) PageInfo

func(it*CustomClassIterator)PageInfo()*iterator.PageInfo

PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.

LongRunningRecognizeOperation

typeLongRunningRecognizeOperationstruct{// contains filtered or unexported fields}

LongRunningRecognizeOperation manages a long-running operation from LongRunningRecognize.

func (*LongRunningRecognizeOperation) Done

Done reports whether the long-running operation has completed.

func (*LongRunningRecognizeOperation) Metadata

Metadata returns metadata associated with the long-running operation.Metadata itself does not contact the server, but Poll does.To get the latest metadata, call this method after a successful call to Poll.If the metadata is not available, the returned metadata and error are both nil.

func (*LongRunningRecognizeOperation) Name

Name returns the name of the long-running operation.The name is assigned by the server and is unique within the service from which the operation is created.

func (*LongRunningRecognizeOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds andthe operation has completed with failure, the error is returned and op.Done will return true.If Poll succeeds and the operation has completed successfully,op.Done will return true, and the response of the operation is returned.If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*LongRunningRecognizeOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

OperationIterator

typeOperationIteratorstruct{// Response is the raw response for the current page.// It must be cast to the RPC response type.// Calling Next() or InternalFetch() updates this value.Responseinterface{}// InternalFetch is for use by the Google Cloud Libraries only.// It is not part of the stable interface of this package.//// InternalFetch returns results from a single call to the underlying RPC.// The number of results is no greater than pageSize.// If there are no more results, nextPageToken is empty and err is nil.InternalFetchfunc(pageSizeint,pageTokenstring)(results[]*longrunningpb.Operation,nextPageTokenstring,errerror)// contains filtered or unexported fields}

OperationIterator manages a stream of *longrunningpb.Operation.

func (*OperationIterator) All

func(it*OperationIterator)All()iter.Seq2[*longrunningpb.Operation,error]

All returns an iterator. If an error is returned by the iterator, theiterator will stop after that iteration.

func (*OperationIterator) Next

Next returns the next result. Its second return value is iterator.Done if there are no moreresults. Once Next returns Done, all subsequent calls will return Done.

func (*OperationIterator) PageInfo

func(it*OperationIterator)PageInfo()*iterator.PageInfo

PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.

PhraseSetIterator

typePhraseSetIteratorstruct{// Response is the raw response for the current page.// It must be cast to the RPC response type.// Calling Next() or InternalFetch() updates this value.Responseinterface{}// InternalFetch is for use by the Google Cloud Libraries only.// It is not part of the stable interface of this package.//// InternalFetch returns results from a single call to the underlying RPC.// The number of results is no greater than pageSize.// If there are no more results, nextPageToken is empty and err is nil.InternalFetchfunc(pageSizeint,pageTokenstring)(results[]*speechpb.PhraseSet,nextPageTokenstring,errerror)// contains filtered or unexported fields}

PhraseSetIterator manages a stream of *speechpb.PhraseSet.

func (*PhraseSetIterator) All

func(it*PhraseSetIterator)All()iter.Seq2[*speechpb.PhraseSet,error]

All returns an iterator. If an error is returned by the iterator, theiterator will stop after that iteration.

func (*PhraseSetIterator) Next

Next returns the next result. Its second return value is iterator.Done if there are no moreresults. Once Next returns Done, all subsequent calls will return Done.

func (*PhraseSetIterator) PageInfo

func(it*PhraseSetIterator)PageInfo()*iterator.PageInfo

PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-10-30 UTC.