Documentation ¶
Overview ¶
Package speech provides access to the Google Cloud Speech API.
See https://cloud.google.com/speech/
Usage example:
import "google.golang.org/api/speech/v1beta1" ... speechService, err := speech.New(oauthHttpClient)
Index ¶
- Constants
- type AsyncRecognizeRequest
- type CancelOperationRequest
- type Empty
- type ListOperationsResponse
- type Operation
- type OperationMetadata
- type OperationResponse
- type OperationsCancelCall
- type OperationsDeleteCall
- type OperationsGetCall
- func (c *OperationsGetCall) Context(ctx context.Context) *OperationsGetCall
- func (c *OperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)
- func (c *OperationsGetCall) Fields(s ...googleapi.Field) *OperationsGetCall
- func (c *OperationsGetCall) IfNoneMatch(entityTag string) *OperationsGetCall
- type OperationsListCall
- func (c *OperationsListCall) Context(ctx context.Context) *OperationsListCall
- func (c *OperationsListCall) Do(opts ...googleapi.CallOption) (*ListOperationsResponse, error)
- func (c *OperationsListCall) Fields(s ...googleapi.Field) *OperationsListCall
- func (c *OperationsListCall) Filter(filter string) *OperationsListCall
- func (c *OperationsListCall) IfNoneMatch(entityTag string) *OperationsListCall
- func (c *OperationsListCall) Name(name string) *OperationsListCall
- func (c *OperationsListCall) PageSize(pageSize int64) *OperationsListCall
- func (c *OperationsListCall) PageToken(pageToken string) *OperationsListCall
- func (c *OperationsListCall) Pages(ctx context.Context, f func(*ListOperationsResponse) error) error
- type OperationsService
- func (r *OperationsService) Cancel(name string, canceloperationrequest *CancelOperationRequest) *OperationsCancelCall
- func (r *OperationsService) Delete(name string) *OperationsDeleteCall
- func (r *OperationsService) Get(name string) *OperationsGetCall
- func (r *OperationsService) List() *OperationsListCall
- type RecognitionAudio
- type RecognitionConfig
- type Service
- type SpeechAsyncrecognizeCall
- type SpeechContext
- type SpeechRecognitionAlternative
- type SpeechRecognitionResult
- type SpeechService
- type SpeechSyncrecognizeCall
- type Status
- type StatusDetails
- type SyncRecognizeRequest
- type SyncRecognizeResponse
Constants ¶
const (
// View and manage your data across Google Cloud Platform services
CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)
OAuth2 scopes used by this API.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AsyncRecognizeRequest ¶
type AsyncRecognizeRequest struct { // Audio: [Required] The audio data to be recognized. Audio *RecognitionAudio `json:"audio,omitempty"` // Config: [Required] The `config` message provides information to the // recognizer // that specifies how to process the request. Config *RecognitionConfig `json:"config,omitempty"` // ForceSendFields is a list of field names (e.g. "Audio") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Audio") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AsyncRecognizeRequest: `AsyncRecognizeRequest` is the top-level message sent by the client for the `AsyncRecognize` method.
func (*AsyncRecognizeRequest) MarshalJSON ¶
func (s *AsyncRecognizeRequest) MarshalJSON() ([]byte, error)
type CancelOperationRequest ¶
type CancelOperationRequest struct { }
CancelOperationRequest: The request message for Operations.CancelOperation.
type Empty ¶
type Empty struct { // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` }
Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:
service Foo { rpc Bar(google.protobuf.Empty) returns
(google.protobuf.Empty);
}
The JSON representation for `Empty` is empty JSON object `{}`.
type ListOperationsResponse ¶
type ListOperationsResponse struct { // NextPageToken: The standard List next-page token. NextPageToken string `json:"nextPageToken,omitempty"` // Operations: A list of operations that matches the specified filter in // the request. Operations []*Operation `json:"operations,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "NextPageToken") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "NextPageToken") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ListOperationsResponse: The response message for Operations.ListOperations.
func (*ListOperationsResponse) MarshalJSON ¶
func (s *ListOperationsResponse) MarshalJSON() ([]byte, error)
type Operation ¶
type Operation struct { // Done: If the value is `false`, it means the operation is still in // progress. // If true, the operation is completed, and either `error` or `response` // is // available. Done bool `json:"done,omitempty"` // Error: The error result of the operation in case of failure or // cancellation. Error *Status `json:"error,omitempty"` // Metadata: Service-specific metadata associated with the operation. // It typically // contains progress information and common metadata such as create // time. // Some services might not provide such metadata. Any method that // returns a // long-running operation should document the metadata type, if any. Metadata OperationMetadata `json:"metadata,omitempty"` // Name: The server-assigned name, which is only unique within the same // service that // originally returns it. If you use the default HTTP mapping, // the // `name` should have the format of `operations/some/unique/name`. Name string `json:"name,omitempty"` // Response: The normal response of the operation in case of success. // If the original // method returns no data on success, such as `Delete`, the response // is // `google.protobuf.Empty`. If the original method is // standard // `Get`/`Create`/`Update`, the response should be the resource. For // other // methods, the response should have the type `XxxResponse`, where // `Xxx` // is the original method name. For example, if the original method // name // is `TakeSnapshot()`, the inferred response type // is // `TakeSnapshotResponse`. Response OperationResponse `json:"response,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Done") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Done") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Operation: This resource represents a long-running operation that is the result of a network API call.
func (*Operation) MarshalJSON ¶
type OperationMetadata ¶
type OperationMetadata interface{}
type OperationResponse ¶
type OperationResponse interface{}
type OperationsCancelCall ¶
type OperationsCancelCall struct {
// contains filtered or unexported fields
}
func (*OperationsCancelCall) Context ¶
func (c *OperationsCancelCall) Context(ctx context.Context) *OperationsCancelCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*OperationsCancelCall) Do ¶
func (c *OperationsCancelCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "speech.operations.cancel" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*OperationsCancelCall) Fields ¶
func (c *OperationsCancelCall) Fields(s ...googleapi.Field) *OperationsCancelCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type OperationsDeleteCall ¶
type OperationsDeleteCall struct {
// contains filtered or unexported fields
}
func (*OperationsDeleteCall) Context ¶
func (c *OperationsDeleteCall) Context(ctx context.Context) *OperationsDeleteCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*OperationsDeleteCall) Do ¶
func (c *OperationsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "speech.operations.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*OperationsDeleteCall) Fields ¶
func (c *OperationsDeleteCall) Fields(s ...googleapi.Field) *OperationsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type OperationsGetCall ¶
type OperationsGetCall struct {
// contains filtered or unexported fields
}
func (*OperationsGetCall) Context ¶
func (c *OperationsGetCall) Context(ctx context.Context) *OperationsGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*OperationsGetCall) Do ¶
func (c *OperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "speech.operations.get" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*OperationsGetCall) Fields ¶
func (c *OperationsGetCall) Fields(s ...googleapi.Field) *OperationsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*OperationsGetCall) IfNoneMatch ¶
func (c *OperationsGetCall) IfNoneMatch(entityTag string) *OperationsGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type OperationsListCall ¶
type OperationsListCall struct {
// contains filtered or unexported fields
}
func (*OperationsListCall) Context ¶
func (c *OperationsListCall) Context(ctx context.Context) *OperationsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*OperationsListCall) Do ¶
func (c *OperationsListCall) Do(opts ...googleapi.CallOption) (*ListOperationsResponse, error)
Do executes the "speech.operations.list" call. Exactly one of *ListOperationsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListOperationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*OperationsListCall) Fields ¶
func (c *OperationsListCall) Fields(s ...googleapi.Field) *OperationsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*OperationsListCall) Filter ¶
func (c *OperationsListCall) Filter(filter string) *OperationsListCall
Filter sets the optional parameter "filter": The standard list filter.
func (*OperationsListCall) IfNoneMatch ¶
func (c *OperationsListCall) IfNoneMatch(entityTag string) *OperationsListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*OperationsListCall) Name ¶
func (c *OperationsListCall) Name(name string) *OperationsListCall
Name sets the optional parameter "name": The name of the operation collection.
func (*OperationsListCall) PageSize ¶
func (c *OperationsListCall) PageSize(pageSize int64) *OperationsListCall
PageSize sets the optional parameter "pageSize": The standard list page size.
func (*OperationsListCall) PageToken ¶
func (c *OperationsListCall) PageToken(pageToken string) *OperationsListCall
PageToken sets the optional parameter "pageToken": The standard list page token.
func (*OperationsListCall) Pages ¶
func (c *OperationsListCall) Pages(ctx context.Context, f func(*ListOperationsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type OperationsService ¶
type OperationsService struct {
// contains filtered or unexported fields
}
func NewOperationsService ¶
func NewOperationsService(s *Service) *OperationsService
func (*OperationsService) Cancel ¶
func (r *OperationsService) Cancel(name string, canceloperationrequest *CancelOperationRequest) *OperationsCancelCall
Cancel: Starts asynchronous cancellation on a long-running operation.
The server
makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
func (*OperationsService) Delete ¶
func (r *OperationsService) Delete(name string) *OperationsDeleteCall
Delete: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
func (*OperationsService) Get ¶
func (r *OperationsService) Get(name string) *OperationsGetCall
Get: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
func (*OperationsService) List ¶
func (r *OperationsService) List() *OperationsListCall
List: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
NOTE: the `name` binding below allows API services to override the binding to use different resource name schemes, such as `users/*/operations`.
type RecognitionAudio ¶
type RecognitionAudio struct { // Content: The audio data bytes encoded as specified // in // `RecognitionConfig`. Note: as with all bytes fields, protobuffers use // a // pure binary representation, whereas JSON representations use base64. Content string `json:"content,omitempty"` // Uri: URI that points to a file that contains audio data bytes as // specified in // `RecognitionConfig`. Currently, only Google Cloud Storage URIs // are // supported, which must be specified in the following // format: // `gs://bucket_name/object_name` (other URI formats // return // google.rpc.Code.INVALID_ARGUMENT). For more information, see // [Request URIs](https://cloud.google.com/storage/docs/reference-uris). Uri string `json:"uri,omitempty"` // ForceSendFields is a list of field names (e.g. "Content") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Content") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
RecognitionAudio: Contains audio data in the encoding specified in the `RecognitionConfig`. Either `content` or `uri` must be supplied. Supplying both or neither returns google.rpc.Code.INVALID_ARGUMENT. See [audio limits](https://cloud.google.com/speech/limits#content).
func (*RecognitionAudio) MarshalJSON ¶
func (s *RecognitionAudio) MarshalJSON() ([]byte, error)
type RecognitionConfig ¶
type RecognitionConfig struct { // Encoding: [Required] Encoding of audio data sent in all // `RecognitionAudio` messages. // // Possible values: // "ENCODING_UNSPECIFIED" - Not specified. Will return result // google.rpc.Code.INVALID_ARGUMENT. // "LINEAR16" - Uncompressed 16-bit signed little-endian samples // (Linear PCM). // This is the only encoding that may be used by `AsyncRecognize`. // "FLAC" - This is the recommended encoding for `SyncRecognize` // and // `StreamingRecognize` because it uses lossless compression; // therefore // recognition accuracy is not compromised by a lossy codec. // // The stream FLAC (Free Lossless Audio Codec) encoding is specified // at: // http://flac.sourceforge.net/documentation.html. // 16-bit and 24-bit samples are supported. // Not all fields in STREAMINFO are supported. // "MULAW" - 8-bit samples that compand 14-bit audio samples using // G.711 PCMU/mu-law. // "AMR" - Adaptive Multi-Rate Narrowband codec. `sample_rate` must be // 8000 Hz. // "AMR_WB" - Adaptive Multi-Rate Wideband codec. `sample_rate` must // be 16000 Hz. Encoding string `json:"encoding,omitempty"` // LanguageCode: [Optional] The language of the supplied audio as a // BCP-47 language tag. // Example: "en-GB" https://www.rfc-editor.org/rfc/bcp/bcp47.txt // If omitted, defaults to "en-US". See // [Language // Support](https://cloud.google.com/speech/docs/languages) // for a list of the currently supported language codes. LanguageCode string `json:"languageCode,omitempty"` // MaxAlternatives: [Optional] Maximum number of recognition hypotheses // to be returned. // Specifically, the maximum number of `SpeechRecognitionAlternative` // messages // within each `SpeechRecognitionResult`. // The server may return fewer than `max_alternatives`. // Valid values are `0`-`30`. A value of `0` or `1` will return a // maximum of // `1`. If omitted, defaults to `1`. MaxAlternatives int64 `json:"maxAlternatives,omitempty"` // ProfanityFilter: [Optional] If set to `true`, the server will attempt // to filter out // profanities, replacing all but the initial character in each filtered // word // with asterisks, e.g. "f***". If set to `false` or omitted, // profanities // won't be filtered out. ProfanityFilter bool `json:"profanityFilter,omitempty"` // SampleRate: [Required] Sample rate in Hertz of the audio data sent in // all // `RecognitionAudio` messages. Valid values are: 8000-48000. // 16000 is optimal. For best results, set the sampling rate of the // audio // source to 16000 Hz. If that's not possible, use the native sample // rate of // the audio source (instead of re-sampling). SampleRate int64 `json:"sampleRate,omitempty"` // SpeechContext: [Optional] A means to provide context to assist the // speech recognition. SpeechContext *SpeechContext `json:"speechContext,omitempty"` // ForceSendFields is a list of field names (e.g. "Encoding") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Encoding") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
RecognitionConfig: The `RecognitionConfig` message provides information to the recognizer that specifies how to process the request.
func (*RecognitionConfig) MarshalJSON ¶
func (s *RecognitionConfig) MarshalJSON() ([]byte, error)
type Service ¶
type Service struct { BasePath string // API endpoint base URL UserAgent string // optional additional User-Agent fragment Operations *OperationsService Speech *SpeechService // contains filtered or unexported fields }
type SpeechAsyncrecognizeCall ¶
type SpeechAsyncrecognizeCall struct {
// contains filtered or unexported fields
}
func (*SpeechAsyncrecognizeCall) Context ¶
func (c *SpeechAsyncrecognizeCall) Context(ctx context.Context) *SpeechAsyncrecognizeCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*SpeechAsyncrecognizeCall) Do ¶
func (c *SpeechAsyncrecognizeCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "speech.speech.asyncrecognize" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*SpeechAsyncrecognizeCall) Fields ¶
func (c *SpeechAsyncrecognizeCall) Fields(s ...googleapi.Field) *SpeechAsyncrecognizeCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type SpeechContext ¶
type SpeechContext struct { // Phrases: [Optional] A list of strings containing words and phrases // "hints" so that // the speech recognition is more likely to recognize them. This can be // used // to improve the accuracy for specific words and phrases, for example, // if // specific commands are typically spoken by the user. This can also be // used // to add additional words to the vocabulary of the recognizer. // See // [usage limits](https://cloud.google.com/speech/limits#content). Phrases []string `json:"phrases,omitempty"` // ForceSendFields is a list of field names (e.g. "Phrases") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Phrases") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
SpeechContext: Provides "hints" to the speech recognizer to favor specific words and phrases in the results.
func (*SpeechContext) MarshalJSON ¶
func (s *SpeechContext) MarshalJSON() ([]byte, error)
type SpeechRecognitionAlternative ¶
type SpeechRecognitionAlternative struct { // Confidence: [Output-only] The confidence estimate between 0.0 and // 1.0. A higher number // means the system is more confident that the recognition is // correct. // This field is typically provided only for the top hypothesis, and // only for // `is_final=true` results. // The default of 0.0 is a sentinel value indicating confidence was not // set. Confidence float64 `json:"confidence,omitempty"` // Transcript: [Output-only] Transcript text representing the words that // the user spoke. Transcript string `json:"transcript,omitempty"` // ForceSendFields is a list of field names (e.g. "Confidence") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Confidence") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
SpeechRecognitionAlternative: Alternative hypotheses (a.k.a. n-best list).
func (*SpeechRecognitionAlternative) MarshalJSON ¶
func (s *SpeechRecognitionAlternative) MarshalJSON() ([]byte, error)
type SpeechRecognitionResult ¶
type SpeechRecognitionResult struct { // Alternatives: [Output-only] May contain one or more recognition // hypotheses (up to the // maximum specified in `max_alternatives`). Alternatives []*SpeechRecognitionAlternative `json:"alternatives,omitempty"` // ForceSendFields is a list of field names (e.g. "Alternatives") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Alternatives") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
SpeechRecognitionResult: A speech recognition result corresponding to a portion of the audio.
func (*SpeechRecognitionResult) MarshalJSON ¶
func (s *SpeechRecognitionResult) MarshalJSON() ([]byte, error)
type SpeechService ¶
type SpeechService struct {
// contains filtered or unexported fields
}
func NewSpeechService ¶
func NewSpeechService(s *Service) *SpeechService
func (*SpeechService) Asyncrecognize ¶
func (r *SpeechService) Asyncrecognize(asyncrecognizerequest *AsyncRecognizeRequest) *SpeechAsyncrecognizeCall
Asyncrecognize: Perform asynchronous speech-recognition: receive results via the google.longrunning.Operations interface. Returns either an `Operation.error` or an `Operation.response` which contains an `AsyncRecognizeResponse` message.
func (*SpeechService) Syncrecognize ¶
func (r *SpeechService) Syncrecognize(syncrecognizerequest *SyncRecognizeRequest) *SpeechSyncrecognizeCall
Syncrecognize: Perform synchronous speech-recognition: receive results after all audio has been sent and processed.
type SpeechSyncrecognizeCall ¶
type SpeechSyncrecognizeCall struct {
// contains filtered or unexported fields
}
func (*SpeechSyncrecognizeCall) Context ¶
func (c *SpeechSyncrecognizeCall) Context(ctx context.Context) *SpeechSyncrecognizeCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*SpeechSyncrecognizeCall) Do ¶
func (c *SpeechSyncrecognizeCall) Do(opts ...googleapi.CallOption) (*SyncRecognizeResponse, error)
Do executes the "speech.speech.syncrecognize" call. Exactly one of *SyncRecognizeResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *SyncRecognizeResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*SpeechSyncrecognizeCall) Fields ¶
func (c *SpeechSyncrecognizeCall) Fields(s ...googleapi.Field) *SpeechSyncrecognizeCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type Status ¶
type Status struct { // Code: The status code, which should be an enum value of // google.rpc.Code. Code int64 `json:"code,omitempty"` // Details: A list of messages that carry the error details. There will // be a // common set of message types for APIs to use. Details []StatusDetails `json:"details,omitempty"` // Message: A developer-facing error message, which should be in // English. Any // user-facing error message should be localized and sent in // the // google.rpc.Status.details field, or localized by the client. Message string `json:"message,omitempty"` // ForceSendFields is a list of field names (e.g. "Code") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Code") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be:
- Simple to use and understand for most users - Flexible enough to meet unexpected needs
Overview ¶
The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions.
Language mapping ¶
The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.
Other uses ¶
The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.
Example uses of this error model include:
- Partial errors. If a service needs to return partial errors to the client,
it may embed the `Status` in the normal response to indicate the
partial
errors.
- Workflow errors. A typical workflow has multiple steps. Each step may
have a `Status` message for error reporting purpose.
- Batch operations. If a client uses batch request and batch response, the
`Status` message should be used directly inside batch response,
one for
each error sub-response.
- Asynchronous operations. If an API call embeds asynchronous operation
results in its response, the status of those operations should
be
represented directly using the `Status` message.
- Logging. If some API errors are stored in logs, the message `Status` could
be used directly after any stripping needed for security/privacy
reasons.
func (*Status) MarshalJSON ¶
type StatusDetails ¶
type StatusDetails interface{}
type SyncRecognizeRequest ¶
type SyncRecognizeRequest struct { // Audio: [Required] The audio data to be recognized. Audio *RecognitionAudio `json:"audio,omitempty"` // Config: [Required] The `config` message provides information to the // recognizer // that specifies how to process the request. Config *RecognitionConfig `json:"config,omitempty"` // ForceSendFields is a list of field names (e.g. "Audio") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Audio") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
SyncRecognizeRequest: `SyncRecognizeRequest` is the top-level message sent by the client for the `SyncRecognize` method.
func (*SyncRecognizeRequest) MarshalJSON ¶
func (s *SyncRecognizeRequest) MarshalJSON() ([]byte, error)
type SyncRecognizeResponse ¶
type SyncRecognizeResponse struct { // Results: [Output-only] Sequential list of transcription results // corresponding to // sequential portions of audio. Results []*SpeechRecognitionResult `json:"results,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Results") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Results") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
SyncRecognizeResponse: `SyncRecognizeResponse` is the only message returned to the client by `SyncRecognize`. It contains the result as zero or more sequential `SpeechRecognitionResult` messages.
func (*SyncRecognizeResponse) MarshalJSON ¶
func (s *SyncRecognizeResponse) MarshalJSON() ([]byte, error)