speech

package
v0.125.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 30, 2023 License: BSD-3-Clause Imports: 16 Imported by: 0

Documentation

Overview

Package speech provides access to the Cloud Speech-to-Text API.

This package is DEPRECATED. Use package cloud.google.com/go/speech/apiv1 instead.

For product documentation, see: https://cloud.google.com/speech-to-text/docs/quickstart-protocol

Creating a client

Usage example:

import "google.golang.org/api/speech/v1p1beta1"
...
ctx := context.Background()
speechService, err := speech.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication.

For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:

speechService, err := speech.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
speechService, err := speech.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See https://godoc.org/google.golang.org/api/option/ for details on options.

Index

Constants

View Source
const (
	// See, edit, configure, and delete your Google Cloud data and see the
	// email address for your Google Account.
	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 ABNFGrammar added in v0.105.0

type ABNFGrammar struct {
	// AbnfStrings: All declarations and rules of an ABNF grammar broken up
	// into multiple strings that will end up concatenated.
	AbnfStrings []string `json:"abnfStrings,omitempty"`

	// ForceSendFields is a list of field names (e.g. "AbnfStrings") to
	// unconditionally include in API requests. By default, fields with
	// empty or default 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. "AbnfStrings") 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:"-"`
}

func (*ABNFGrammar) MarshalJSON added in v0.105.0

func (s *ABNFGrammar) MarshalJSON() ([]byte, error)

type ClassItem added in v0.23.0

type ClassItem struct {
	// Value: The class item's value.
	Value string `json:"value,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Value") to
	// unconditionally include in API requests. By default, fields with
	// empty or default 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. "Value") 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:"-"`
}

ClassItem: An item of the class.

func (*ClassItem) MarshalJSON added in v0.23.0

func (s *ClassItem) MarshalJSON() ([]byte, error)

type CreateCustomClassRequest added in v0.41.0

type CreateCustomClassRequest struct {
	// CustomClass: Required. The custom class to create.
	CustomClass *CustomClass `json:"customClass,omitempty"`

	// CustomClassId: Required. The ID to use for the custom class, which
	// will become the final component of the custom class' resource name.
	// This value should restrict to letters, numbers, and hyphens, with the
	// first character a letter, the last a letter or a number, and be 4-63
	// characters.
	CustomClassId string `json:"customClassId,omitempty"`

	// ForceSendFields is a list of field names (e.g. "CustomClass") to
	// unconditionally include in API requests. By default, fields with
	// empty or default 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. "CustomClass") 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:"-"`
}

CreateCustomClassRequest: Message sent by the client for the `CreateCustomClass` method.

func (*CreateCustomClassRequest) MarshalJSON added in v0.41.0

func (s *CreateCustomClassRequest) MarshalJSON() ([]byte, error)

type CreatePhraseSetRequest added in v0.41.0

type CreatePhraseSetRequest struct {
	// PhraseSet: Required. The phrase set to create.
	PhraseSet *PhraseSet `json:"phraseSet,omitempty"`

	// PhraseSetId: Required. The ID to use for the phrase set, which will
	// become the final component of the phrase set's resource name. This
	// value should restrict to letters, numbers, and hyphens, with the
	// first character a letter, the last a letter or a number, and be 4-63
	// characters.
	PhraseSetId string `json:"phraseSetId,omitempty"`

	// ForceSendFields is a list of field names (e.g. "PhraseSet") to
	// unconditionally include in API requests. By default, fields with
	// empty or default 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. "PhraseSet") 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:"-"`
}

CreatePhraseSetRequest: Message sent by the client for the `CreatePhraseSet` method.

func (*CreatePhraseSetRequest) MarshalJSON added in v0.41.0

func (s *CreatePhraseSetRequest) MarshalJSON() ([]byte, error)

type CustomClass added in v0.23.0

type CustomClass struct {
	// CustomClassId: If this custom class is a resource, the
	// custom_class_id is the resource id of the CustomClass. Case
	// sensitive.
	CustomClassId string `json:"customClassId,omitempty"`

	// Items: A collection of class items.
	Items []*ClassItem `json:"items,omitempty"`

	// KmsKeyName: Output only. The KMS key name
	// (https://cloud.google.com/kms/docs/resource-hierarchy#keys) with
	// which the content of the ClassItem is encrypted. The expected format
	// is
	// `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKey
	// s/{crypto_key}`.
	KmsKeyName string `json:"kmsKeyName,omitempty"`

	// KmsKeyVersionName: Output only. The KMS key version name
	// (https://cloud.google.com/kms/docs/resource-hierarchy#key_versions)
	// with which content of the ClassItem is encrypted. The expected format
	// is
	// `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKey
	// s/{crypto_key}/cryptoKeyVersions/{crypto_key_version}`.
	KmsKeyVersionName string `json:"kmsKeyVersionName,omitempty"`

	// Name: The resource name of the custom class.
	Name string `json:"name,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "CustomClassId") to
	// unconditionally include in API requests. By default, fields with
	// empty or default 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. "CustomClassId") 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:"-"`
}

CustomClass: A set of words or phrases that represents a common concept likely to appear in your audio, for example a list of passenger ship names. CustomClass items can be substituted into placeholders that you set in PhraseSet phrases.

func (*CustomClass) MarshalJSON added in v0.23.0

func (s *CustomClass) MarshalJSON() ([]byte, error)

type Empty added in v0.41.0

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); }

type Entry added in v0.51.0

type Entry struct {
	// CaseSensitive: Whether the search is case sensitive.
	CaseSensitive bool `json:"caseSensitive,omitempty"`

	// Replace: What to replace with. Max length is 100 characters.
	Replace string `json:"replace,omitempty"`

	// Search: What to replace. Max length is 100 characters.
	Search string `json:"search,omitempty"`

	// ForceSendFields is a list of field names (e.g. "CaseSensitive") to
	// unconditionally include in API requests. By default, fields with
	// empty or default 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. "CaseSensitive") 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:"-"`
}

Entry: A single replacement configuration.

func (*Entry) MarshalJSON added in v0.51.0

func (s *Entry) MarshalJSON() ([]byte, error)

type ListCustomClassesResponse added in v0.41.0

type ListCustomClassesResponse struct {
	// CustomClasses: The custom classes.
	CustomClasses []*CustomClass `json:"customClasses,omitempty"`

	// NextPageToken: A token, which can be sent as `page_token` to retrieve
	// the next page. If this field is omitted, there are no subsequent
	// pages.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "CustomClasses") to
	// unconditionally include in API requests. By default, fields with
	// empty or default 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. "CustomClasses") 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:"-"`
}

ListCustomClassesResponse: Message returned to the client by the `ListCustomClasses` method.

func (*ListCustomClassesResponse) MarshalJSON added in v0.41.0

func (s *ListCustomClassesResponse) MarshalJSON() ([]byte, error)

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 or default 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 ListPhraseSetResponse added in v0.41.0

type ListPhraseSetResponse struct {
	// NextPageToken: A token, which can be sent as `page_token` to retrieve
	// the next page. If this field is omitted, there are no subsequent
	// pages.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// PhraseSets: The phrase set.
	PhraseSets []*PhraseSet `json:"phraseSets,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 or default 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:"-"`
}

ListPhraseSetResponse: Message returned to the client by the `ListPhraseSet` method.

func (*ListPhraseSetResponse) MarshalJSON added in v0.41.0

func (s *ListPhraseSetResponse) MarshalJSON() ([]byte, error)

type LongRunningRecognizeMetadata

type LongRunningRecognizeMetadata struct {
	// LastUpdateTime: Time of the most recent processing update.
	LastUpdateTime string `json:"lastUpdateTime,omitempty"`

	// OutputConfig: Output only. A copy of the TranscriptOutputConfig if it
	// was set in the request.
	OutputConfig *TranscriptOutputConfig `json:"outputConfig,omitempty"`

	// ProgressPercent: Approximate percentage of audio processed thus far.
	// Guaranteed to be 100 when the audio is fully processed and the
	// results are available.
	ProgressPercent int64 `json:"progressPercent,omitempty"`

	// StartTime: Time when the request was received.
	StartTime string `json:"startTime,omitempty"`

	// Uri: Output only. The URI of the audio file being transcribed. Empty
	// if the audio was sent as byte content.
	Uri string `json:"uri,omitempty"`

	// ForceSendFields is a list of field names (e.g. "LastUpdateTime") to
	// unconditionally include in API requests. By default, fields with
	// empty or default 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. "LastUpdateTime") 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:"-"`
}

LongRunningRecognizeMetadata: Describes the progress of a long-running `LongRunningRecognize` call. It is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service.

func (*LongRunningRecognizeMetadata) MarshalJSON

func (s *LongRunningRecognizeMetadata) MarshalJSON() ([]byte, error)

type LongRunningRecognizeRequest

type LongRunningRecognizeRequest struct {
	// Audio: Required. The audio data to be recognized.
	Audio *RecognitionAudio `json:"audio,omitempty"`

	// Config: Required. Provides information to the recognizer that
	// specifies how to process the request.
	Config *RecognitionConfig `json:"config,omitempty"`

	// OutputConfig: Optional. Specifies an optional destination for the
	// recognition results.
	OutputConfig *TranscriptOutputConfig `json:"outputConfig,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Audio") to
	// unconditionally include in API requests. By default, fields with
	// empty or default 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:"-"`
}

LongRunningRecognizeRequest: The top-level message sent by the client for the `LongRunningRecognize` method.

func (*LongRunningRecognizeRequest) MarshalJSON

func (s *LongRunningRecognizeRequest) MarshalJSON() ([]byte, error)

type LongRunningRecognizeResponse

type LongRunningRecognizeResponse struct {
	// OutputConfig: Original output config if present in the request.
	OutputConfig *TranscriptOutputConfig `json:"outputConfig,omitempty"`

	// OutputError: If the transcript output fails this field contains the
	// relevant error.
	OutputError *Status `json:"outputError,omitempty"`

	// RequestId: The ID associated with the request. This is a unique ID
	// specific only to the given request.
	RequestId int64 `json:"requestId,omitempty,string"`

	// Results: Sequential list of transcription results corresponding to
	// sequential portions of audio.
	Results []*SpeechRecognitionResult `json:"results,omitempty"`

	// SpeechAdaptationInfo: Provides information on speech adaptation
	// behavior in response
	SpeechAdaptationInfo *SpeechAdaptationInfo `json:"speechAdaptationInfo,omitempty"`

	// TotalBilledTime: When available, billed audio seconds for the
	// corresponding request.
	TotalBilledTime string `json:"totalBilledTime,omitempty"`

	// ForceSendFields is a list of field names (e.g. "OutputConfig") to
	// unconditionally include in API requests. By default, fields with
	// empty or default 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. "OutputConfig") 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:"-"`
}

LongRunningRecognizeResponse: The only message returned to the client by the `LongRunningRecognize` method. It contains the result as zero or more sequential `SpeechRecognitionResult` messages. It is included in the `result.response` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service.

func (*LongRunningRecognizeResponse) MarshalJSON

func (s *LongRunningRecognizeResponse) 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 googleapi.RawMessage `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 be a resource name ending with
	// `operations/{unique_id}`.
	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 googleapi.RawMessage `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 or default 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

func (s *Operation) MarshalJSON() ([]byte, error)

type OperationsGetCall

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

func (*OperationsGetCall) Context

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

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

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*OperationsGetCall) Header

func (c *OperationsGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

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

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

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

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

func (c *OperationsListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

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

Name sets the optional parameter "name": The name of the operation's parent resource.

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

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

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.

- name: The name of the operation resource.

func (*OperationsService) List

List: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

type Phrase added in v0.23.0

type Phrase struct {
	// Boost: Hint Boost. Overrides the boost set at the phrase set level.
	// Positive value will increase the probability that a specific phrase
	// will be recognized over other similar sounding phrases. The higher
	// the boost, the higher the chance of false positive recognition as
	// well. Negative boost will simply be ignored. Though `boost` can
	// accept a wide range of positive values, most use cases are best
	// served with values between 0 and 20. We recommend using a binary
	// search approach to finding the optimal value for your use case as
	// well as adding phrases both with and without boost to your requests.
	Boost float64 `json:"boost,omitempty"`

	// Value: The phrase itself.
	Value string `json:"value,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Boost") to
	// unconditionally include in API requests. By default, fields with
	// empty or default 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. "Boost") 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:"-"`
}

Phrase: A phrases containing words and phrase "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-to-text/quotas#content). List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. "i was born in january", "i was born in febuary", ...), use the pre-built `$MONTH` class improves the likelihood of correctly transcribing audio that includes months (e.g. "i was born in $month"). To refer to pre-built classes, use the class' symbol prepended with `$` e.g. `$MONTH`. To refer to custom classes that were defined inline in the request, set the class's `custom_class_id` to a string unique to all class resources and inline classes. Then use the class' id wrapped in $`{...}` e.g. "${my-months}". To refer to custom classes resources, use the class' id wrapped in `${}` (e.g. `${my-months}`). Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a regional endpoint (https://cloud.google.com/speech-to-text/docs/endpoints) with matching `us` or `eu` location value.

func (*Phrase) MarshalJSON added in v0.23.0

func (s *Phrase) MarshalJSON() ([]byte, error)

func (*Phrase) UnmarshalJSON added in v0.23.0

func (s *Phrase) UnmarshalJSON(data []byte) error

type PhraseSet added in v0.23.0

type PhraseSet struct {
	// Boost: Hint Boost. Positive value will increase the probability that
	// a specific phrase will be recognized over other similar sounding
	// phrases. The higher the boost, the higher the chance of false
	// positive recognition as well. Negative boost values would correspond
	// to anti-biasing. Anti-biasing is not enabled, so negative boost will
	// simply be ignored. Though `boost` can accept a wide range of positive
	// values, most use cases are best served with values between 0
	// (exclusive) and 20. We recommend using a binary search approach to
	// finding the optimal value for your use case as well as adding phrases
	// both with and without boost to your requests.
	Boost float64 `json:"boost,omitempty"`

	// KmsKeyName: Output only. The KMS key name
	// (https://cloud.google.com/kms/docs/resource-hierarchy#keys) with
	// which the content of the PhraseSet is encrypted. The expected format
	// is
	// `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKey
	// s/{crypto_key}`.
	KmsKeyName string `json:"kmsKeyName,omitempty"`

	// KmsKeyVersionName: Output only. The KMS key version name
	// (https://cloud.google.com/kms/docs/resource-hierarchy#key_versions)
	// with which content of the PhraseSet is encrypted. The expected format
	// is
	// `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKey
	// s/{crypto_key}/cryptoKeyVersions/{crypto_key_version}`.
	KmsKeyVersionName string `json:"kmsKeyVersionName,omitempty"`

	// Name: The resource name of the phrase set.
	Name string `json:"name,omitempty"`

	// Phrases: A list of word and phrases.
	Phrases []*Phrase `json:"phrases,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Boost") to
	// unconditionally include in API requests. By default, fields with
	// empty or default 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. "Boost") 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:"-"`
}

PhraseSet: Provides "hints" to the speech recognizer to favor specific words and phrases in the results.

func (*PhraseSet) MarshalJSON added in v0.23.0

func (s *PhraseSet) MarshalJSON() ([]byte, error)

func (*PhraseSet) UnmarshalJSON added in v0.23.0

func (s *PhraseSet) UnmarshalJSON(data []byte) error

type ProjectsLocationsCustomClassesCreateCall added in v0.41.0

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

func (*ProjectsLocationsCustomClassesCreateCall) Context added in v0.41.0

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 (*ProjectsLocationsCustomClassesCreateCall) Do added in v0.41.0

Do executes the "speech.projects.locations.customClasses.create" call. Exactly one of *CustomClass or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *CustomClass.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 (*ProjectsLocationsCustomClassesCreateCall) Fields added in v0.41.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsCustomClassesCreateCall) Header added in v0.41.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsCustomClassesDeleteCall added in v0.41.0

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

func (*ProjectsLocationsCustomClassesDeleteCall) Context added in v0.41.0

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 (*ProjectsLocationsCustomClassesDeleteCall) Do added in v0.41.0

Do executes the "speech.projects.locations.customClasses.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 (*ProjectsLocationsCustomClassesDeleteCall) Fields added in v0.41.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsCustomClassesDeleteCall) Header added in v0.41.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsCustomClassesGetCall added in v0.41.0

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

func (*ProjectsLocationsCustomClassesGetCall) Context added in v0.41.0

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 (*ProjectsLocationsCustomClassesGetCall) Do added in v0.41.0

Do executes the "speech.projects.locations.customClasses.get" call. Exactly one of *CustomClass or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *CustomClass.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 (*ProjectsLocationsCustomClassesGetCall) Fields added in v0.41.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsCustomClassesGetCall) Header added in v0.41.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsCustomClassesGetCall) IfNoneMatch added in v0.41.0

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 ProjectsLocationsCustomClassesListCall added in v0.41.0

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

func (*ProjectsLocationsCustomClassesListCall) Context added in v0.41.0

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 (*ProjectsLocationsCustomClassesListCall) Do added in v0.41.0

Do executes the "speech.projects.locations.customClasses.list" call. Exactly one of *ListCustomClassesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListCustomClassesResponse.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 (*ProjectsLocationsCustomClassesListCall) Fields added in v0.41.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsCustomClassesListCall) Header added in v0.41.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsCustomClassesListCall) IfNoneMatch added in v0.41.0

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 (*ProjectsLocationsCustomClassesListCall) PageSize added in v0.41.0

PageSize sets the optional parameter "pageSize": The maximum number of custom classes to return. The service may return fewer than this value. If unspecified, at most 50 custom classes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

func (*ProjectsLocationsCustomClassesListCall) PageToken added in v0.41.0

PageToken sets the optional parameter "pageToken": A page token, received from a previous `ListCustomClass` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCustomClass` must match the call that provided the page token.

func (*ProjectsLocationsCustomClassesListCall) Pages added in v0.41.0

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 ProjectsLocationsCustomClassesPatchCall added in v0.41.0

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

func (*ProjectsLocationsCustomClassesPatchCall) Context added in v0.41.0

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 (*ProjectsLocationsCustomClassesPatchCall) Do added in v0.41.0

Do executes the "speech.projects.locations.customClasses.patch" call. Exactly one of *CustomClass or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *CustomClass.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 (*ProjectsLocationsCustomClassesPatchCall) Fields added in v0.41.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsCustomClassesPatchCall) Header added in v0.41.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsCustomClassesPatchCall) UpdateMask added in v0.41.0

UpdateMask sets the optional parameter "updateMask": The list of fields to be updated.

type ProjectsLocationsCustomClassesService added in v0.41.0

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

func NewProjectsLocationsCustomClassesService added in v0.41.0

func NewProjectsLocationsCustomClassesService(s *Service) *ProjectsLocationsCustomClassesService

func (*ProjectsLocationsCustomClassesService) Create added in v0.41.0

Create: Create a custom class.

  • parent: The parent resource where this custom class will be created. Format: `projects/{project}/locations/{location}/customClasses` Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a regional endpoint (https://cloud.google.com/speech-to-text/docs/endpoints) with matching `us` or `eu` location value.

func (*ProjectsLocationsCustomClassesService) Delete added in v0.41.0

Delete: Delete a custom class.

  • name: The name of the custom class to delete. Format: `projects/{project}/locations/{location}/customClasses/{custom_class }` Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a regional endpoint (https://cloud.google.com/speech-to-text/docs/endpoints) with matching `us` or `eu` location value.

func (*ProjectsLocationsCustomClassesService) Get added in v0.41.0

Get: Get a custom class.

  • name: The name of the custom class to retrieve. Format: `projects/{project}/locations/{location}/customClasses/{custom_class }`.

func (*ProjectsLocationsCustomClassesService) List added in v0.41.0

List: List custom classes.

  • parent: The parent, which owns this collection of custom classes. Format: `projects/{project}/locations/{location}/customClasses` Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a regional endpoint (https://cloud.google.com/speech-to-text/docs/endpoints) with matching `us` or `eu` location value.

func (*ProjectsLocationsCustomClassesService) Patch added in v0.41.0

Patch: Update a custom class.

- name: The resource name of the custom class.

type ProjectsLocationsPhraseSetsCreateCall added in v0.41.0

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

func (*ProjectsLocationsPhraseSetsCreateCall) Context added in v0.41.0

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 (*ProjectsLocationsPhraseSetsCreateCall) Do added in v0.41.0

Do executes the "speech.projects.locations.phraseSets.create" call. Exactly one of *PhraseSet or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *PhraseSet.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 (*ProjectsLocationsPhraseSetsCreateCall) Fields added in v0.41.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsPhraseSetsCreateCall) Header added in v0.41.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsPhraseSetsDeleteCall added in v0.41.0

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

func (*ProjectsLocationsPhraseSetsDeleteCall) Context added in v0.41.0

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 (*ProjectsLocationsPhraseSetsDeleteCall) Do added in v0.41.0

Do executes the "speech.projects.locations.phraseSets.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 (*ProjectsLocationsPhraseSetsDeleteCall) Fields added in v0.41.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsPhraseSetsDeleteCall) Header added in v0.41.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsPhraseSetsGetCall added in v0.41.0

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

func (*ProjectsLocationsPhraseSetsGetCall) Context added in v0.41.0

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 (*ProjectsLocationsPhraseSetsGetCall) Do added in v0.41.0

Do executes the "speech.projects.locations.phraseSets.get" call. Exactly one of *PhraseSet or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *PhraseSet.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 (*ProjectsLocationsPhraseSetsGetCall) Fields added in v0.41.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsPhraseSetsGetCall) Header added in v0.41.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsPhraseSetsGetCall) IfNoneMatch added in v0.41.0

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 ProjectsLocationsPhraseSetsListCall added in v0.41.0

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

func (*ProjectsLocationsPhraseSetsListCall) Context added in v0.41.0

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 (*ProjectsLocationsPhraseSetsListCall) Do added in v0.41.0

Do executes the "speech.projects.locations.phraseSets.list" call. Exactly one of *ListPhraseSetResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListPhraseSetResponse.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 (*ProjectsLocationsPhraseSetsListCall) Fields added in v0.41.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsPhraseSetsListCall) Header added in v0.41.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsPhraseSetsListCall) IfNoneMatch added in v0.41.0

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 (*ProjectsLocationsPhraseSetsListCall) PageSize added in v0.41.0

PageSize sets the optional parameter "pageSize": The maximum number of phrase sets to return. The service may return fewer than this value. If unspecified, at most 50 phrase sets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

func (*ProjectsLocationsPhraseSetsListCall) PageToken added in v0.41.0

PageToken sets the optional parameter "pageToken": A page token, received from a previous `ListPhraseSet` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPhraseSet` must match the call that provided the page token.

func (*ProjectsLocationsPhraseSetsListCall) Pages added in v0.41.0

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 ProjectsLocationsPhraseSetsPatchCall added in v0.41.0

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

func (*ProjectsLocationsPhraseSetsPatchCall) Context added in v0.41.0

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 (*ProjectsLocationsPhraseSetsPatchCall) Do added in v0.41.0

Do executes the "speech.projects.locations.phraseSets.patch" call. Exactly one of *PhraseSet or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *PhraseSet.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 (*ProjectsLocationsPhraseSetsPatchCall) Fields added in v0.41.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsPhraseSetsPatchCall) Header added in v0.41.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsPhraseSetsPatchCall) UpdateMask added in v0.41.0

UpdateMask sets the optional parameter "updateMask": The list of fields to be updated.

type ProjectsLocationsPhraseSetsService added in v0.41.0

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

func NewProjectsLocationsPhraseSetsService added in v0.41.0

func NewProjectsLocationsPhraseSetsService(s *Service) *ProjectsLocationsPhraseSetsService

func (*ProjectsLocationsPhraseSetsService) Create added in v0.41.0

Create: 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.

  • parent: The parent resource where this phrase set will be created. Format: `projects/{project}/locations/{location}` Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a regional endpoint (https://cloud.google.com/speech-to-text/docs/endpoints) with matching `us` or `eu` location value.

func (*ProjectsLocationsPhraseSetsService) Delete added in v0.41.0

Delete: Delete a phrase set.

  • name: The name of the phrase set to delete. Format: `projects/{project}/locations/{location}/phraseSets/{phrase_set}`.

func (*ProjectsLocationsPhraseSetsService) Get added in v0.41.0

Get: Get a phrase set.

  • name: The name of the phrase set to retrieve. Format: `projects/{project}/locations/{location}/phraseSets/{phrase_set}` Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a regional endpoint (https://cloud.google.com/speech-to-text/docs/endpoints) with matching `us` or `eu` location value.

func (*ProjectsLocationsPhraseSetsService) List added in v0.41.0

List: List phrase sets.

  • parent: The parent, which owns this collection of phrase set. Format: `projects/{project}/locations/{location}` Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a regional endpoint (https://cloud.google.com/speech-to-text/docs/endpoints) with matching `us` or `eu` location value.

func (*ProjectsLocationsPhraseSetsService) Patch added in v0.41.0

Patch: Update a phrase set.

- name: The resource name of the phrase set.

type ProjectsLocationsService added in v0.2.0

type ProjectsLocationsService struct {
	CustomClasses *ProjectsLocationsCustomClassesService

	PhraseSets *ProjectsLocationsPhraseSetsService
	// contains filtered or unexported fields
}

func NewProjectsLocationsService added in v0.2.0

func NewProjectsLocationsService(s *Service) *ProjectsLocationsService

type ProjectsService added in v0.2.0

type ProjectsService struct {
	Locations *ProjectsLocationsService
	// contains filtered or unexported fields
}

func NewProjectsService added in v0.2.0

func NewProjectsService(s *Service) *ProjectsService

type RecognitionAudio

type RecognitionAudio struct {
	// Content: The audio data bytes encoded as specified in
	// `RecognitionConfig`. Note: as with all bytes fields, proto buffers
	// 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`. The file must not be compressed
	// (for example, gzip). 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 or default 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 content limits (https://cloud.google.com/speech-to-text/quotas#content).

func (*RecognitionAudio) MarshalJSON

func (s *RecognitionAudio) MarshalJSON() ([]byte, error)

type RecognitionConfig

type RecognitionConfig struct {
	// Adaptation: Speech adaptation configuration improves the accuracy of
	// speech recognition. For more information, see the speech adaptation
	// (https://cloud.google.com/speech-to-text/docs/adaptation)
	// documentation. When speech adaptation is set it supersedes the
	// `speech_contexts` field.
	Adaptation *SpeechAdaptation `json:"adaptation,omitempty"`

	// AlternativeLanguageCodes: A list of up to 3 additional BCP-47
	// (https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tags, listing
	// possible alternative languages of the supplied audio. See Language
	// Support (https://cloud.google.com/speech-to-text/docs/languages) for
	// a list of the currently supported language codes. If alternative
	// languages are listed, recognition result will contain recognition in
	// the most likely language detected including the main language_code.
	// The recognition result will include the language tag of the language
	// detected in the audio. Note: This feature is only supported for Voice
	// Command and Voice Search use cases and performance may vary for other
	// use cases (e.g., phone call transcription).
	AlternativeLanguageCodes []string `json:"alternativeLanguageCodes,omitempty"`

	// AudioChannelCount: The number of channels in the input audio data.
	// ONLY set this for MULTI-CHANNEL recognition. Valid values for
	// LINEAR16, OGG_OPUS and FLAC are `1`-`8`. Valid value for MULAW, AMR,
	// AMR_WB and SPEEX_WITH_HEADER_BYTE is only `1`. If `0` or omitted,
	// defaults to one channel (mono). Note: We only recognize the first
	// channel by default. To perform independent recognition on each
	// channel set `enable_separate_recognition_per_channel` to 'true'.
	AudioChannelCount int64 `json:"audioChannelCount,omitempty"`

	// DiarizationConfig: Config to enable speaker diarization and set
	// additional parameters to make diarization better suited for your
	// application. Note: When this is enabled, we send all the words from
	// the beginning of the audio for the top alternative in every
	// consecutive STREAMING responses. This is done in order to improve our
	// speaker tags as our models learn to identify the speakers in the
	// conversation over time. For non-streaming requests, the diarization
	// results will be provided only in the top alternative of the FINAL
	// SpeechRecognitionResult.
	DiarizationConfig *SpeakerDiarizationConfig `json:"diarizationConfig,omitempty"`

	// DiarizationSpeakerCount: If set, specifies the estimated number of
	// speakers in the conversation. Defaults to '2'. Ignored unless
	// enable_speaker_diarization is set to true. Note: Use
	// diarization_config instead.
	DiarizationSpeakerCount int64 `json:"diarizationSpeakerCount,omitempty"`

	// EnableAutomaticPunctuation: If 'true', adds punctuation to
	// recognition result hypotheses. This feature is only available in
	// select languages. Setting this for requests in other languages has no
	// effect at all. The default 'false' value does not add punctuation to
	// result hypotheses.
	EnableAutomaticPunctuation bool `json:"enableAutomaticPunctuation,omitempty"`

	// EnableSeparateRecognitionPerChannel: This needs to be set to `true`
	// explicitly and `audio_channel_count` > 1 to get each channel
	// recognized separately. The recognition result will contain a
	// `channel_tag` field to state which channel that result belongs to. If
	// this is not true, we will only recognize the first channel. The
	// request is billed cumulatively for all channels recognized:
	// `audio_channel_count` multiplied by the length of the audio.
	EnableSeparateRecognitionPerChannel bool `json:"enableSeparateRecognitionPerChannel,omitempty"`

	// EnableSpeakerDiarization: If 'true', enables speaker detection for
	// each recognized word in the top alternative of the recognition result
	// using a speaker_label provided in the WordInfo. Note: Use
	// diarization_config instead.
	EnableSpeakerDiarization bool `json:"enableSpeakerDiarization,omitempty"`

	// EnableSpokenEmojis: The spoken emoji behavior for the call If not
	// set, uses default behavior based on model of choice If 'true', adds
	// spoken emoji formatting for the request. This will replace spoken
	// emojis with the corresponding Unicode symbols in the final
	// transcript. If 'false', spoken emojis are not replaced.
	EnableSpokenEmojis bool `json:"enableSpokenEmojis,omitempty"`

	// EnableSpokenPunctuation: The spoken punctuation behavior for the call
	// If not set, uses default behavior based on model of choice e.g.
	// command_and_search will enable spoken punctuation by default If
	// 'true', replaces spoken punctuation with the corresponding symbols in
	// the request. For example, "how are you question mark" becomes "how
	// are you?". See
	// https://cloud.google.com/speech-to-text/docs/spoken-punctuation for
	// support. If 'false', spoken punctuation is not replaced.
	EnableSpokenPunctuation bool `json:"enableSpokenPunctuation,omitempty"`

	// EnableWordConfidence: If `true`, the top result includes a list of
	// words and the confidence for those words. If `false`, no word-level
	// confidence information is returned. The default is `false`.
	EnableWordConfidence bool `json:"enableWordConfidence,omitempty"`

	// EnableWordTimeOffsets: If `true`, the top result includes a list of
	// words and the start and end time offsets (timestamps) for those
	// words. If `false`, no word-level time offset information is returned.
	// The default is `false`.
	EnableWordTimeOffsets bool `json:"enableWordTimeOffsets,omitempty"`

	// Encoding: Encoding of audio data sent in all `RecognitionAudio`
	// messages. This field is optional for `FLAC` and `WAV` audio files and
	// required for all other audio formats. For details, see AudioEncoding.
	//
	// Possible values:
	//   "ENCODING_UNSPECIFIED" - Not specified.
	//   "LINEAR16" - Uncompressed 16-bit signed little-endian samples
	// (Linear PCM).
	//   "FLAC" - `FLAC` (Free Lossless Audio Codec) is the recommended
	// encoding because it is lossless--therefore recognition is not
	// compromised--and requires only about half the bandwidth of
	// `LINEAR16`. `FLAC` stream encoding supports 16-bit and 24-bit
	// samples, however, 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_hertz`
	// must be 8000.
	//   "AMR_WB" - Adaptive Multi-Rate Wideband codec. `sample_rate_hertz`
	// must be 16000.
	//   "OGG_OPUS" - Opus encoded audio frames in Ogg container
	// ([OggOpus](https://wiki.xiph.org/OggOpus)). `sample_rate_hertz` must
	// be one of 8000, 12000, 16000, 24000, or 48000.
	//   "SPEEX_WITH_HEADER_BYTE" - Although the use of lossy encodings is
	// not recommended, if a very low bitrate encoding is required,
	// `OGG_OPUS` is highly preferred over Speex encoding. The
	// [Speex](https://speex.org/) encoding supported by Cloud Speech API
	// has a header byte in each block, as in MIME type
	// `audio/x-speex-with-header-byte`. It is a variant of the RTP Speex
	// encoding defined in [RFC 5574](https://tools.ietf.org/html/rfc5574).
	// The stream is a sequence of blocks, one block per RTP packet. Each
	// block starts with a byte containing the length of the block, in
	// bytes, followed by one or more frames of Speex data, padded to an
	// integral number of bytes (octets) as specified in RFC 5574. In other
	// words, each RTP header is replaced with a single byte containing the
	// block length. Only Speex wideband is supported. `sample_rate_hertz`
	// must be 16000.
	//   "MP3" - MP3 audio. MP3 encoding is a Beta feature and only
	// available in v1p1beta1. Support all standard MP3 bitrates (which
	// range from 32-320 kbps). When using this encoding,
	// `sample_rate_hertz` has to match the sample rate of the file being
	// used.
	//   "WEBM_OPUS" - Opus encoded audio frames in WebM container
	// ([OggOpus](https://wiki.xiph.org/OggOpus)). `sample_rate_hertz` must
	// be one of 8000, 12000, 16000, 24000, or 48000.
	Encoding string `json:"encoding,omitempty"`

	// LanguageCode: Required. The language of the supplied audio as a
	// BCP-47 (https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
	// Example: "en-US". See Language Support
	// (https://cloud.google.com/speech-to-text/docs/languages) for a list
	// of the currently supported language codes.
	LanguageCode string `json:"languageCode,omitempty"`

	// MaxAlternatives: 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 one. If omitted, will return a maximum of
	// one.
	MaxAlternatives int64 `json:"maxAlternatives,omitempty"`

	// Metadata: Metadata regarding this request.
	Metadata *RecognitionMetadata `json:"metadata,omitempty"`

	// Model: Which model to select for the given request. Select the model
	// best suited to your domain to get best results. If a model is not
	// explicitly specified, then we auto-select a model based on the
	// parameters in the RecognitionConfig. *Model* *Description*
	// latest_long Best for long form content like media or conversation.
	// latest_short Best for short form content like commands or single shot
	// directed speech. command_and_search Best for short queries such as
	// voice commands or voice search. phone_call Best for audio that
	// originated from a phone call (typically recorded at an 8khz sampling
	// rate). video Best for audio that originated from video or includes
	// multiple speakers. Ideally the audio is recorded at a 16khz or
	// greater sampling rate. This is a premium model that costs more than
	// the standard rate. default Best for audio that is not one of the
	// specific audio models. For example, long-form audio. Ideally the
	// audio is high-fidelity, recorded at a 16khz or greater sampling rate.
	// medical_conversation Best for audio that originated from a
	// conversation between a medical provider and patient.
	// medical_dictation Best for audio that originated from dictation notes
	// by a medical provider.
	Model string `json:"model,omitempty"`

	// ProfanityFilter: 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"`

	// SampleRateHertz: 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). This field is optional for
	// FLAC and WAV audio files, but is required for all other audio
	// formats. For details, see AudioEncoding.
	SampleRateHertz int64 `json:"sampleRateHertz,omitempty"`

	// SpeechContexts: Array of SpeechContext. A means to provide context to
	// assist the speech recognition. For more information, see speech
	// adaptation (https://cloud.google.com/speech-to-text/docs/adaptation).
	SpeechContexts []*SpeechContext `json:"speechContexts,omitempty"`

	// TranscriptNormalization: Use transcription normalization to
	// automatically replace parts of the transcript with phrases of your
	// choosing. For StreamingRecognize, this normalization only applies to
	// stable partial transcripts (stability > 0.8) and final transcripts.
	TranscriptNormalization *TranscriptNormalization `json:"transcriptNormalization,omitempty"`

	// UseEnhanced: Set to true to use an enhanced model for speech
	// recognition. If `use_enhanced` is set to true and the `model` field
	// is not set, then an appropriate enhanced model is chosen if an
	// enhanced model exists for the audio. If `use_enhanced` is true and an
	// enhanced version of the specified model does not exist, then the
	// speech is recognized using the standard version of the specified
	// model.
	UseEnhanced bool `json:"useEnhanced,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Adaptation") to
	// unconditionally include in API requests. By default, fields with
	// empty or default 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. "Adaptation") 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: Provides information to the recognizer that specifies how to process the request.

func (*RecognitionConfig) MarshalJSON

func (s *RecognitionConfig) MarshalJSON() ([]byte, error)

type RecognitionMetadata

type RecognitionMetadata struct {
	// AudioTopic: Description of the content. Eg. "Recordings of federal
	// supreme court hearings from 2012".
	AudioTopic string `json:"audioTopic,omitempty"`

	// IndustryNaicsCodeOfAudio: The industry vertical to which this speech
	// recognition request most closely applies. This is most indicative of
	// the topics contained in the audio. Use the 6-digit NAICS code to
	// identify the industry vertical - see https://www.naics.com/search/.
	IndustryNaicsCodeOfAudio int64 `json:"industryNaicsCodeOfAudio,omitempty"`

	// InteractionType: The use case most closely describing the audio
	// content to be recognized.
	//
	// Possible values:
	//   "INTERACTION_TYPE_UNSPECIFIED" - Use case is either unknown or is
	// something other than one of the other values below.
	//   "DISCUSSION" - Multiple people in a conversation or discussion. For
	// example in a meeting with two or more people actively participating.
	// Typically all the primary people speaking would be in the same room
	// (if not, see PHONE_CALL)
	//   "PRESENTATION" - One or more persons lecturing or presenting to
	// others, mostly uninterrupted.
	//   "PHONE_CALL" - A phone-call or video-conference in which two or
	// more people, who are not in the same room, are actively
	// participating.
	//   "VOICEMAIL" - A recorded message intended for another person to
	// listen to.
	//   "PROFESSIONALLY_PRODUCED" - Professionally produced audio (eg. TV
	// Show, Podcast).
	//   "VOICE_SEARCH" - Transcribe spoken questions and queries into text.
	//   "VOICE_COMMAND" - Transcribe voice commands, such as for
	// controlling a device.
	//   "DICTATION" - Transcribe speech to text to create a written
	// document, such as a text-message, email or report.
	InteractionType string `json:"interactionType,omitempty"`

	// MicrophoneDistance: The audio type that most closely describes the
	// audio being recognized.
	//
	// Possible values:
	//   "MICROPHONE_DISTANCE_UNSPECIFIED" - Audio type is not known.
	//   "NEARFIELD" - The audio was captured from a closely placed
	// microphone. Eg. phone, dictaphone, or handheld microphone. Generally
	// if there speaker is within 1 meter of the microphone.
	//   "MIDFIELD" - The speaker if within 3 meters of the microphone.
	//   "FARFIELD" - The speaker is more than 3 meters away from the
	// microphone.
	MicrophoneDistance string `json:"microphoneDistance,omitempty"`

	// ObfuscatedId: Obfuscated (privacy-protected) ID of the user, to
	// identify number of unique users using the service.
	ObfuscatedId int64 `json:"obfuscatedId,omitempty,string"`

	// OriginalMediaType: The original media the speech was recorded on.
	//
	// Possible values:
	//   "ORIGINAL_MEDIA_TYPE_UNSPECIFIED" - Unknown original media type.
	//   "AUDIO" - The speech data is an audio recording.
	//   "VIDEO" - The speech data originally recorded on a video.
	OriginalMediaType string `json:"originalMediaType,omitempty"`

	// OriginalMimeType: Mime type of the original audio file. For example
	// `audio/m4a`, `audio/x-alaw-basic`, `audio/mp3`, `audio/3gpp`. A list
	// of possible audio mime types is maintained at
	// http://www.iana.org/assignments/media-types/media-types.xhtml#audio
	OriginalMimeType string `json:"originalMimeType,omitempty"`

	// RecordingDeviceName: The device used to make the recording. Examples
	// 'Nexus 5X' or 'Polycom SoundStation IP 6000' or 'POTS' or 'VoIP' or
	// 'Cardioid Microphone'.
	RecordingDeviceName string `json:"recordingDeviceName,omitempty"`

	// RecordingDeviceType: The type of device the speech was recorded with.
	//
	// Possible values:
	//   "RECORDING_DEVICE_TYPE_UNSPECIFIED" - The recording device is
	// unknown.
	//   "SMARTPHONE" - Speech was recorded on a smartphone.
	//   "PC" - Speech was recorded using a personal computer or tablet.
	//   "PHONE_LINE" - Speech was recorded over a phone line.
	//   "VEHICLE" - Speech was recorded in a vehicle.
	//   "OTHER_OUTDOOR_DEVICE" - Speech was recorded outdoors.
	//   "OTHER_INDOOR_DEVICE" - Speech was recorded indoors.
	RecordingDeviceType string `json:"recordingDeviceType,omitempty"`

	// ForceSendFields is a list of field names (e.g. "AudioTopic") to
	// unconditionally include in API requests. By default, fields with
	// empty or default 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. "AudioTopic") 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:"-"`
}

RecognitionMetadata: Description of audio data to be recognized.

func (*RecognitionMetadata) MarshalJSON

func (s *RecognitionMetadata) MarshalJSON() ([]byte, error)

type RecognizeRequest

type RecognizeRequest struct {
	// Audio: Required. The audio data to be recognized.
	Audio *RecognitionAudio `json:"audio,omitempty"`

	// Config: Required. 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 or default 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:"-"`
}

RecognizeRequest: The top-level message sent by the client for the `Recognize` method.

func (*RecognizeRequest) MarshalJSON

func (s *RecognizeRequest) MarshalJSON() ([]byte, error)

type RecognizeResponse

type RecognizeResponse struct {
	// RequestId: The ID associated with the request. This is a unique ID
	// specific only to the given request.
	RequestId int64 `json:"requestId,omitempty,string"`

	// Results: Sequential list of transcription results corresponding to
	// sequential portions of audio.
	Results []*SpeechRecognitionResult `json:"results,omitempty"`

	// SpeechAdaptationInfo: Provides information on adaptation behavior in
	// response
	SpeechAdaptationInfo *SpeechAdaptationInfo `json:"speechAdaptationInfo,omitempty"`

	// TotalBilledTime: When available, billed audio seconds for the
	// corresponding request.
	TotalBilledTime string `json:"totalBilledTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "RequestId") to
	// unconditionally include in API requests. By default, fields with
	// empty or default 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. "RequestId") 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:"-"`
}

RecognizeResponse: The only message returned to the client by the `Recognize` method. It contains the result as zero or more sequential `SpeechRecognitionResult` messages.

func (*RecognizeResponse) MarshalJSON

func (s *RecognizeResponse) MarshalJSON() ([]byte, error)

type Service

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Operations *OperationsService

	Projects *ProjectsService

	Speech *SpeechService
	// contains filtered or unexported fields
}

func New deprecated

func New(client *http.Client) (*Service, error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService added in v0.3.0

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

type SpeakerDiarizationConfig

type SpeakerDiarizationConfig struct {
	// EnableSpeakerDiarization: If 'true', enables speaker detection for
	// each recognized word in the top alternative of the recognition result
	// using a speaker_label provided in the WordInfo.
	EnableSpeakerDiarization bool `json:"enableSpeakerDiarization,omitempty"`

	// MaxSpeakerCount: Maximum number of speakers in the conversation. This
	// range gives you more flexibility by allowing the system to
	// automatically determine the correct number of speakers. If not set,
	// the default value is 6.
	MaxSpeakerCount int64 `json:"maxSpeakerCount,omitempty"`

	// MinSpeakerCount: Minimum number of speakers in the conversation. This
	// range gives you more flexibility by allowing the system to
	// automatically determine the correct number of speakers. If not set,
	// the default value is 2.
	MinSpeakerCount int64 `json:"minSpeakerCount,omitempty"`

	// SpeakerTag: Output only. Unused.
	SpeakerTag int64 `json:"speakerTag,omitempty"`

	// ForceSendFields is a list of field names (e.g.
	// "EnableSpeakerDiarization") to unconditionally include in API
	// requests. By default, fields with empty or default 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. "EnableSpeakerDiarization")
	// 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:"-"`
}

SpeakerDiarizationConfig: Config to enable speaker diarization.

func (*SpeakerDiarizationConfig) MarshalJSON

func (s *SpeakerDiarizationConfig) MarshalJSON() ([]byte, error)

type SpeechAdaptation added in v0.23.0

type SpeechAdaptation struct {
	// AbnfGrammar: Augmented Backus-Naur form (ABNF) is a standardized
	// grammar notation comprised by a set of derivation rules. See
	// specifications: https://www.w3.org/TR/speech-grammar
	AbnfGrammar *ABNFGrammar `json:"abnfGrammar,omitempty"`

	// CustomClasses: A collection of custom classes. To specify the classes
	// inline, leave the class' `name` blank and fill in the rest of its
	// fields, giving it a unique `custom_class_id`. Refer to the inline
	// defined class in phrase hints by its `custom_class_id`.
	CustomClasses []*CustomClass `json:"customClasses,omitempty"`

	// PhraseSetReferences: A collection of phrase set resource names to
	// use.
	PhraseSetReferences []string `json:"phraseSetReferences,omitempty"`

	// PhraseSets: A collection of phrase sets. To specify the hints inline,
	// leave the phrase set's `name` blank and fill in the rest of its
	// fields. Any phrase set can use any custom class.
	PhraseSets []*PhraseSet `json:"phraseSets,omitempty"`

	// ForceSendFields is a list of field names (e.g. "AbnfGrammar") to
	// unconditionally include in API requests. By default, fields with
	// empty or default 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. "AbnfGrammar") 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:"-"`
}

SpeechAdaptation: Speech adaptation configuration.

func (*SpeechAdaptation) MarshalJSON added in v0.23.0

func (s *SpeechAdaptation) MarshalJSON() ([]byte, error)

type SpeechAdaptationInfo added in v0.102.0

type SpeechAdaptationInfo struct {
	// AdaptationTimeout: Whether there was a timeout when applying speech
	// adaptation. If true, adaptation had no effect in the response
	// transcript.
	AdaptationTimeout bool `json:"adaptationTimeout,omitempty"`

	// TimeoutMessage: If set, returns a message specifying which part of
	// the speech adaptation request timed out.
	TimeoutMessage string `json:"timeoutMessage,omitempty"`

	// ForceSendFields is a list of field names (e.g. "AdaptationTimeout")
	// to unconditionally include in API requests. By default, fields with
	// empty or default 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. "AdaptationTimeout") 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:"-"`
}

SpeechAdaptationInfo: Information on speech adaptation use in results

func (*SpeechAdaptationInfo) MarshalJSON added in v0.102.0

func (s *SpeechAdaptationInfo) MarshalJSON() ([]byte, error)

type SpeechContext

type SpeechContext struct {
	// Boost: Hint Boost. Positive value will increase the probability that
	// a specific phrase will be recognized over other similar sounding
	// phrases. The higher the boost, the higher the chance of false
	// positive recognition as well. Negative boost values would correspond
	// to anti-biasing. Anti-biasing is not enabled, so negative boost will
	// simply be ignored. Though `boost` can accept a wide range of positive
	// values, most use cases are best served with values between 0 and 20.
	// We recommend using a binary search approach to finding the optimal
	// value for your use case.
	Boost float64 `json:"boost,omitempty"`

	// Phrases: 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-to-text/quotas#content). List items
	// can also be set to classes for groups of words that represent common
	// concepts that occur in natural language. For example, rather than
	// providing phrase hints for every month of the year, using the $MONTH
	// class improves the likelihood of correctly transcribing audio that
	// includes months.
	Phrases []string `json:"phrases,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Boost") to
	// unconditionally include in API requests. By default, fields with
	// empty or default 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. "Boost") 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)

func (*SpeechContext) UnmarshalJSON added in v0.6.0

func (s *SpeechContext) UnmarshalJSON(data []byte) error

type SpeechLongrunningrecognizeCall

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

func (*SpeechLongrunningrecognizeCall) Context

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 (*SpeechLongrunningrecognizeCall) Do

Do executes the "speech.speech.longrunningrecognize" 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 (*SpeechLongrunningrecognizeCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*SpeechLongrunningrecognizeCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type SpeechRecognitionAlternative

type SpeechRecognitionAlternative struct {
	// Confidence: The confidence estimate between 0.0 and 1.0. A higher
	// number indicates an estimated greater likelihood that the recognized
	// words are correct. This field is set only for the top alternative of
	// a non-streaming result or, of a streaming result where
	// `is_final=true`. This field is not guaranteed to be accurate and
	// users should not rely on it to be always provided. The default of 0.0
	// is a sentinel value indicating `confidence` was not set.
	Confidence float64 `json:"confidence,omitempty"`

	// Transcript: Transcript text representing the words that the user
	// spoke. In languages that use spaces to separate words, the transcript
	// might have a leading space if it isn't the first result. You can
	// concatenate each result to obtain the full transcript without using a
	// separator.
	Transcript string `json:"transcript,omitempty"`

	// Words: A list of word-specific information for each recognized word.
	// Note: When `enable_speaker_diarization` is true, you will see all the
	// words from the beginning of the audio.
	Words []*WordInfo `json:"words,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Confidence") to
	// unconditionally include in API requests. By default, fields with
	// empty or default 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)

func (*SpeechRecognitionAlternative) UnmarshalJSON

func (s *SpeechRecognitionAlternative) UnmarshalJSON(data []byte) error

type SpeechRecognitionResult

type SpeechRecognitionResult struct {
	// Alternatives: May contain one or more recognition hypotheses (up to
	// the maximum specified in `max_alternatives`). These alternatives are
	// ordered in terms of accuracy, with the top (first) alternative being
	// the most probable, as ranked by the recognizer.
	Alternatives []*SpeechRecognitionAlternative `json:"alternatives,omitempty"`

	// ChannelTag: For multi-channel audio, this is the channel number
	// corresponding to the recognized result for the audio from that
	// channel. For audio_channel_count = N, its output values can range
	// from '1' to 'N'.
	ChannelTag int64 `json:"channelTag,omitempty"`

	// LanguageCode: Output only. The BCP-47
	// (https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag of the
	// language in this result. This language code was detected to have the
	// most likelihood of being spoken in the audio.
	LanguageCode string `json:"languageCode,omitempty"`

	// ResultEndTime: Time offset of the end of this result relative to the
	// beginning of the audio.
	ResultEndTime string `json:"resultEndTime,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Alternatives") to
	// unconditionally include in API requests. By default, fields with
	// empty or default 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 SpeechRecognizeCall

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

func (*SpeechRecognizeCall) Context

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 (*SpeechRecognizeCall) Do

Do executes the "speech.speech.recognize" call. Exactly one of *RecognizeResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *RecognizeResponse.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 (*SpeechRecognizeCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*SpeechRecognizeCall) Header

func (c *SpeechRecognizeCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type SpeechService

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

func NewSpeechService

func NewSpeechService(s *Service) *SpeechService

func (*SpeechService) Longrunningrecognize

func (r *SpeechService) Longrunningrecognize(longrunningrecognizerequest *LongRunningRecognizeRequest) *SpeechLongrunningrecognizeCall

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 (https://cloud.google.com/speech-to-text/docs/async-recognize).

func (*SpeechService) Recognize

func (r *SpeechService) Recognize(recognizerequest *RecognizeRequest) *SpeechRecognizeCall

Recognize: Performs synchronous speech recognition: receive results after all audio has been sent and processed.

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 is a
	// common set of message types for APIs to use.
	Details []googleapi.RawMessage `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 or default 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).

func (*Status) MarshalJSON

func (s *Status) MarshalJSON() ([]byte, error)

type TranscriptNormalization added in v0.51.0

type TranscriptNormalization struct {
	// Entries: A list of replacement entries. We will perform replacement
	// with one entry at a time. For example, the second entry in ["cat" =>
	// "dog", "mountain cat" => "mountain dog"] will never be applied
	// because we will always process the first entry before it. At most 100
	// entries.
	Entries []*Entry `json:"entries,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Entries") to
	// unconditionally include in API requests. By default, fields with
	// empty or default 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. "Entries") 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:"-"`
}

TranscriptNormalization: Transcription normalization configuration. Use transcription normalization to automatically replace parts of the transcript with phrases of your choosing. For StreamingRecognize, this normalization only applies to stable partial transcripts (stability > 0.8) and final transcripts.

func (*TranscriptNormalization) MarshalJSON added in v0.51.0

func (s *TranscriptNormalization) MarshalJSON() ([]byte, error)

type TranscriptOutputConfig added in v0.43.0

type TranscriptOutputConfig struct {
	// GcsUri: Specifies a Cloud Storage URI for the recognition results.
	// Must be specified in the format: `gs://bucket_name/object_name`, and
	// the bucket must already exist.
	GcsUri string `json:"gcsUri,omitempty"`

	// ForceSendFields is a list of field names (e.g. "GcsUri") to
	// unconditionally include in API requests. By default, fields with
	// empty or default 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. "GcsUri") 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:"-"`
}

TranscriptOutputConfig: Specifies an optional destination for the recognition results.

func (*TranscriptOutputConfig) MarshalJSON added in v0.43.0

func (s *TranscriptOutputConfig) MarshalJSON() ([]byte, error)

type WordInfo

type WordInfo struct {
	// Confidence: The confidence estimate between 0.0 and 1.0. A higher
	// number indicates an estimated greater likelihood that the recognized
	// words are correct. This field is set only for the top alternative of
	// a non-streaming result or, of a streaming result where
	// `is_final=true`. This field is not guaranteed to be accurate and
	// users should not rely on it to be always provided. The default of 0.0
	// is a sentinel value indicating `confidence` was not set.
	Confidence float64 `json:"confidence,omitempty"`

	// EndTime: Time offset relative to the beginning of the audio, and
	// corresponding to the end of the spoken word. This field is only set
	// if `enable_word_time_offsets=true` and only in the top hypothesis.
	// This is an experimental feature and the accuracy of the time offset
	// can vary.
	EndTime string `json:"endTime,omitempty"`

	// SpeakerLabel: Output only. A label value assigned for every unique
	// speaker within the audio. This field specifies which speaker was
	// detected to have spoken this word. For some models, like
	// medical_conversation this can be actual speaker role, for example
	// "patient" or "provider", but generally this would be a number
	// identifying a speaker. This field is only set if
	// enable_speaker_diarization = 'true' and only for the top alternative.
	SpeakerLabel string `json:"speakerLabel,omitempty"`

	// SpeakerTag: Output only. A distinct integer value is assigned for
	// every speaker within the audio. This field specifies which one of
	// those speakers was detected to have spoken this word. Value ranges
	// from '1' to diarization_speaker_count. speaker_tag is set if
	// enable_speaker_diarization = 'true' and only for the top alternative.
	// Note: Use speaker_label instead.
	SpeakerTag int64 `json:"speakerTag,omitempty"`

	// StartTime: Time offset relative to the beginning of the audio, and
	// corresponding to the start of the spoken word. This field is only set
	// if `enable_word_time_offsets=true` and only in the top hypothesis.
	// This is an experimental feature and the accuracy of the time offset
	// can vary.
	StartTime string `json:"startTime,omitempty"`

	// Word: The word corresponding to this set of information.
	Word string `json:"word,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Confidence") to
	// unconditionally include in API requests. By default, fields with
	// empty or default 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:"-"`
}

WordInfo: Word-specific information for recognized words.

func (*WordInfo) MarshalJSON

func (s *WordInfo) MarshalJSON() ([]byte, error)

func (*WordInfo) UnmarshalJSON

func (s *WordInfo) UnmarshalJSON(data []byte) error

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL