go: cloud.google.com/go/speech/apiv1 Index | Examples | Files

package speech

import "cloud.google.com/go/speech/apiv1"

Package speech is an experimental, auto-generated package for the Google Cloud Speech API.

Google Cloud Speech API.

Index

Examples

Package Files

doc.go speech_client.go

func DefaultAuthScopes Uses

func DefaultAuthScopes() []string

DefaultAuthScopes reports the authentication scopes required by this package.

type CallOptions Uses

type CallOptions struct {
    Recognize            []gax.CallOption
    LongRunningRecognize []gax.CallOption
    StreamingRecognize   []gax.CallOption
}

CallOptions contains the retry settings for each method of Client.

type Client Uses

type Client struct {

    // LROClient is used internally to handle longrunning operations.
    // It is exposed so that its CallOptions can be modified if required.
    // Users should not Close this client.
    LROClient *lroauto.OperationsClient

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

Client is a client for interacting with Google Cloud Speech API.

func NewClient Uses

func NewClient(ctx context.Context, opts ...option.ClientOption) (*Client, error)

NewClient creates a new speech client.

Service that implements Google Cloud Speech API.

Code:

ctx := context.Background()
c, err := speech.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use client.
_ = c

func (*Client) Close Uses

func (c *Client) Close() error

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

func (*Client) Connection Uses

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

Connection returns the client's connection to the API service.

func (*Client) LongRunningRecognize Uses

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.

Code:

ctx := context.Background()
c, err := speech.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}

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 Uses

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 Uses

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.

Code:

ctx := context.Background()
c, err := speech.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}

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) SetGoogleClientInfo Uses

func (c *Client) SetGoogleClientInfo(keyval ...string)

SetGoogleClientInfo sets the name and version of the application in the `x-goog-api-client` header passed on each request. Intended for use by Google-written clients.

func (*Client) StreamingRecognize Uses

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).

Code:

ctx := context.Background()
c, err := speech.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}
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
}

type LongRunningRecognizeOperation Uses

type LongRunningRecognizeOperation struct {
    // contains filtered or unexported fields
}

LongRunningRecognizeOperation manages a long-running operation from LongRunningRecognize.

func (*LongRunningRecognizeOperation) Done Uses

func (op *LongRunningRecognizeOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*LongRunningRecognizeOperation) Metadata Uses

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 Uses

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 Uses

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 Uses

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.

Package speech imports 13 packages (graph) and is imported by 1 packages. Updated 2017-07-21. Refresh now. Tools for package owners.