- 0.116.0 (latest)
- 0.115.1
- 0.114.0
- 0.113.0
- 0.112.2
- 0.111.0
- 0.110.10
- 0.109.0
- 0.108.0
- 0.107.0
- 0.106.0
- 0.105.0
- 0.104.0
- 0.103.0
- 0.102.1
- 0.101.1
- 0.100.2
- 0.99.0
- 0.98.0
- 0.97.0
- 0.96.0
- 0.95.0
- 0.94.1
- 0.93.3
- 0.92.3
- 0.91.1
- 0.90.0
- 0.89.0
- 0.88.0
- 0.87.0
- 0.86.0
- 0.85.0
- 0.84.0
- 0.83.0
- 0.82.0
- 0.81.0
- 0.80.0
- 0.79.0
- 0.78.0
- 0.77.0
- 0.76.0
- 0.75.0
Package speech is an auto-generated package for the Cloud Speech-to-Text API.
Converts audio to text by applying powerful neural network models.
NOTE: This package is in beta. It is not stable, and may be subject to changes.
Use of Context
The ctx passed to NewClient is used for authentication requests and for 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.
For information about setting deadlines, reusing contexts, and more please visit https://pkg.go.dev/cloud.google.com/go.
Functions
func DefaultAuthScopes
func DefaultAuthScopes() []string
DefaultAuthScopes reports the default set of authentication scopes to use with this package.
AdaptationCallOptions
type AdaptationCallOptions struct {
CreatePhraseSet []gax.CallOption
GetPhraseSet []gax.CallOption
ListPhraseSet []gax.CallOption
UpdatePhraseSet []gax.CallOption
DeletePhraseSet []gax.CallOption
CreateCustomClass []gax.CallOption
GetCustomClass []gax.CallOption
ListCustomClasses []gax.CallOption
UpdateCustomClass []gax.CallOption
DeleteCustomClass []gax.CallOption
}
AdaptationCallOptions contains the retry settings for each method of AdaptationClient.
AdaptationClient
type AdaptationClient struct {
// 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
func NewAdaptationClient(ctx context.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
package main
import (
"context"
speech "cloud.google.com/go/speech/apiv1p1beta1"
)
func main() {
ctx := context.Background()
c, err := speech.NewAdaptationClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.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 when the client is no longer required.
func (*AdaptationClient) Connection
func (c *AdaptationClient) Connection() *grpc.ClientConn
Connection returns a connection to the API service.
Deprecated.
func (*AdaptationClient) CreateCustomClass
func (c *AdaptationClient) CreateCustomClass(ctx context.Context, req *speechpb.CreateCustomClassRequest, opts ...gax.CallOption) (*speechpb.CustomClass, error)
CreateCustomClass create a custom class.
Example
package main
import (
"context"
speech "cloud.google.com/go/speech/apiv1p1beta1"
speechpb "google.golang.org/genproto/googleapis/cloud/speech/v1p1beta1"
)
func main() {
ctx := context.Background()
c, err := speech.NewAdaptationClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &speechpb.CreateCustomClassRequest{
// TODO: Fill request struct fields.
}
resp, err := c.CreateCustomClass(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*AdaptationClient) CreatePhraseSet
func (c *AdaptationClient) CreatePhraseSet(ctx context.Context, req *speechpb.CreatePhraseSetRequest, opts ...gax.CallOption) (*speechpb.PhraseSet, error)
CreatePhraseSet create a set of phrase hints. Each item in the set can be a single word or a multi-word phrase. The items in the PhraseSet are favored by the recognition model when you send a call that includes the PhraseSet.
Example
package main
import (
"context"
speech "cloud.google.com/go/speech/apiv1p1beta1"
speechpb "google.golang.org/genproto/googleapis/cloud/speech/v1p1beta1"
)
func main() {
ctx := context.Background()
c, err := speech.NewAdaptationClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &speechpb.CreatePhraseSetRequest{
// TODO: Fill request struct fields.
}
resp, err := c.CreatePhraseSet(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*AdaptationClient) DeleteCustomClass
func (c *AdaptationClient) DeleteCustomClass(ctx context.Context, req *speechpb.DeleteCustomClassRequest, opts ...gax.CallOption) error
DeleteCustomClass delete a custom class.
Example
package main
import (
"context"
speech "cloud.google.com/go/speech/apiv1p1beta1"
speechpb "google.golang.org/genproto/googleapis/cloud/speech/v1p1beta1"
)
func main() {
ctx := context.Background()
c, err := speech.NewAdaptationClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &speechpb.DeleteCustomClassRequest{
// TODO: Fill request struct fields.
}
err = c.DeleteCustomClass(ctx, req)
if err != nil {
// TODO: Handle error.
}
}
func (*AdaptationClient) DeletePhraseSet
func (c *AdaptationClient) DeletePhraseSet(ctx context.Context, req *speechpb.DeletePhraseSetRequest, opts ...gax.CallOption) error
DeletePhraseSet delete a phrase set.
Example
package main
import (
"context"
speech "cloud.google.com/go/speech/apiv1p1beta1"
speechpb "google.golang.org/genproto/googleapis/cloud/speech/v1p1beta1"
)
func main() {
ctx := context.Background()
c, err := speech.NewAdaptationClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &speechpb.DeletePhraseSetRequest{
// TODO: Fill request struct fields.
}
err = c.DeletePhraseSet(ctx, req)
if err != nil {
// TODO: Handle error.
}
}
func (*AdaptationClient) GetCustomClass
func (c *AdaptationClient) GetCustomClass(ctx context.Context, req *speechpb.GetCustomClassRequest, opts ...gax.CallOption) (*speechpb.CustomClass, error)
GetCustomClass get a custom class.
Example
package main
import (
"context"
speech "cloud.google.com/go/speech/apiv1p1beta1"
speechpb "google.golang.org/genproto/googleapis/cloud/speech/v1p1beta1"
)
func main() {
ctx := context.Background()
c, err := speech.NewAdaptationClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &speechpb.GetCustomClassRequest{
// TODO: Fill request struct fields.
}
resp, err := c.GetCustomClass(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*AdaptationClient) GetPhraseSet
func (c *AdaptationClient) GetPhraseSet(ctx context.Context, req *speechpb.GetPhraseSetRequest, opts ...gax.CallOption) (*speechpb.PhraseSet, error)
GetPhraseSet get a phrase set.
Example
package main
import (
"context"
speech "cloud.google.com/go/speech/apiv1p1beta1"
speechpb "google.golang.org/genproto/googleapis/cloud/speech/v1p1beta1"
)
func main() {
ctx := context.Background()
c, err := speech.NewAdaptationClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &speechpb.GetPhraseSetRequest{
// TODO: Fill request struct fields.
}
resp, err := c.GetPhraseSet(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*AdaptationClient) ListCustomClasses
func (c *AdaptationClient) ListCustomClasses(ctx context.Context, req *speechpb.ListCustomClassesRequest, opts ...gax.CallOption) *CustomClassIterator
ListCustomClasses list custom classes.
Example
package main
import (
"context"
speech "cloud.google.com/go/speech/apiv1p1beta1"
"google.golang.org/api/iterator"
speechpb "google.golang.org/genproto/googleapis/cloud/speech/v1p1beta1"
)
func main() {
ctx := context.Background()
c, err := speech.NewAdaptationClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &speechpb.ListCustomClassesRequest{
// TODO: Fill request struct fields.
}
it := c.ListCustomClasses(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*AdaptationClient) ListPhraseSet
func (c *AdaptationClient) ListPhraseSet(ctx context.Context, req *speechpb.ListPhraseSetRequest, opts ...gax.CallOption) *PhraseSetIterator
ListPhraseSet list phrase sets.
Example
package main
import (
"context"
speech "cloud.google.com/go/speech/apiv1p1beta1"
"google.golang.org/api/iterator"
speechpb "google.golang.org/genproto/googleapis/cloud/speech/v1p1beta1"
)
func main() {
ctx := context.Background()
c, err := speech.NewAdaptationClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &speechpb.ListPhraseSetRequest{
// TODO: Fill request struct fields.
}
it := c.ListPhraseSet(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*AdaptationClient) UpdateCustomClass
func (c *AdaptationClient) UpdateCustomClass(ctx context.Context, req *speechpb.UpdateCustomClassRequest, opts ...gax.CallOption) (*speechpb.CustomClass, error)
UpdateCustomClass update a custom class.
Example
package main
import (
"context"
speech "cloud.google.com/go/speech/apiv1p1beta1"
speechpb "google.golang.org/genproto/googleapis/cloud/speech/v1p1beta1"
)
func main() {
ctx := context.Background()
c, err := speech.NewAdaptationClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &speechpb.UpdateCustomClassRequest{
// TODO: Fill request struct fields.
}
resp, err := c.UpdateCustomClass(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*AdaptationClient) UpdatePhraseSet
func (c *AdaptationClient) UpdatePhraseSet(ctx context.Context, req *speechpb.UpdatePhraseSetRequest, opts ...gax.CallOption) (*speechpb.PhraseSet, error)
UpdatePhraseSet update a phrase set.
Example
package main
import (
"context"
speech "cloud.google.com/go/speech/apiv1p1beta1"
speechpb "google.golang.org/genproto/googleapis/cloud/speech/v1p1beta1"
)
func main() {
ctx := context.Background()
c, err := speech.NewAdaptationClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &speechpb.UpdatePhraseSetRequest{
// TODO: Fill request struct fields.
}
resp, err := c.UpdatePhraseSet(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
CallOptions
type CallOptions struct {
Recognize []gax.CallOption
LongRunningRecognize []gax.CallOption
StreamingRecognize []gax.CallOption
}
CallOptions contains the retry settings for each method of Client.
Client
type Client struct {
// 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
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
package main
import (
"context"
speech "cloud.google.com/go/speech/apiv1p1beta1"
)
func main() {
ctx := context.Background()
c, err := speech.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func (*Client) Close
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*Client) Connection
func (c *Client) Connection() *grpc.ClientConn
Connection returns a connection to the API service.
Deprecated.
func (*Client) LongRunningRecognize
func (c *Client) LongRunningRecognize(ctx context.Context, req *speechpb.LongRunningRecognizeRequest, opts ...gax.CallOption) (*LongRunningRecognizeOperation, error)
LongRunningRecognize 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. For more information on asynchronous speech recognition, see the how-to (at https://cloud.google.com/speech-to-text/docs/async-recognize).
Example
package main
import (
"context"
speech "cloud.google.com/go/speech/apiv1p1beta1"
speechpb "google.golang.org/genproto/googleapis/cloud/speech/v1p1beta1"
)
func main() {
ctx := context.Background()
c, err := speech.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &speechpb.LongRunningRecognizeRequest{
// TODO: Fill request struct fields.
}
op, err := c.LongRunningRecognize(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*Client) LongRunningRecognizeOperation
func (c *Client) LongRunningRecognizeOperation(name string) *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
func (c *Client) Recognize(ctx context.Context, req *speechpb.RecognizeRequest, opts ...gax.CallOption) (*speechpb.RecognizeResponse, error)
Recognize performs synchronous speech recognition: receive results after all audio has been sent and processed.
Example
package main
import (
"context"
speech "cloud.google.com/go/speech/apiv1p1beta1"
speechpb "google.golang.org/genproto/googleapis/cloud/speech/v1p1beta1"
)
func main() {
ctx := context.Background()
c, err := speech.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &speechpb.RecognizeRequest{
// TODO: Fill request struct fields.
}
resp, err := c.Recognize(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*Client) StreamingRecognize
func (c *Client) StreamingRecognize(ctx context.Context, opts ...gax.CallOption) (speechpb.Speech_StreamingRecognizeClient, error)
StreamingRecognize performs bidirectional streaming speech recognition: receive results while sending audio. This method is only available via the gRPC API (not REST).
Example
package main
import (
"context"
"io"
speech "cloud.google.com/go/speech/apiv1p1beta1"
speechpb "google.golang.org/genproto/googleapis/cloud/speech/v1p1beta1"
)
func main() {
ctx := context.Background()
c, err := speech.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
stream, err := c.StreamingRecognize(ctx)
if err != nil {
// TODO: Handle error.
}
go func() {
reqs := []*speechpb.StreamingRecognizeRequest{
// TODO: Create requests.
}
for _, req := range reqs {
if err := stream.Send(req); err != nil {
// TODO: Handle error.
}
}
stream.CloseSend()
}()
for {
resp, err := stream.Recv()
if err == io.EOF {
break
}
if err != nil {
// TODO: handle error.
}
// TODO: Use resp.
_ = resp
}
}
CustomClassIterator
type CustomClassIterator struct {
// 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.
Response interface{}
// 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.
InternalFetch func(pageSize int, pageToken string) (results []*speechpb.CustomClass, nextPageToken string, err error)
// contains filtered or unexported fields
}
CustomClassIterator manages a stream of *speechpb.CustomClass.
func (*CustomClassIterator) Next
func (it *CustomClassIterator) Next() (*speechpb.CustomClass, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. 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
type LongRunningRecognizeOperation struct {
// contains filtered or unexported fields
}
LongRunningRecognizeOperation manages a long-running operation from LongRunningRecognize.
func (*LongRunningRecognizeOperation) Done
func (op *LongRunningRecognizeOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*LongRunningRecognizeOperation) Metadata
func (op *LongRunningRecognizeOperation) Metadata() (*speechpb.LongRunningRecognizeMetadata, error)
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
func (op *LongRunningRecognizeOperation) Name() string
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
func (op *LongRunningRecognizeOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*speechpb.LongRunningRecognizeResponse, error)
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 and the 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
func (op *LongRunningRecognizeOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*speechpb.LongRunningRecognizeResponse, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
PhraseSetIterator
type PhraseSetIterator struct {
// 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.
Response interface{}
// 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.
InternalFetch func(pageSize int, pageToken string) (results []*speechpb.PhraseSet, nextPageToken string, err error)
// contains filtered or unexported fields
}
PhraseSetIterator manages a stream of *speechpb.PhraseSet.
func (*PhraseSetIterator) Next
func (it *PhraseSetIterator) Next() (*speechpb.PhraseSet, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. 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.