Documentation ¶
Index ¶
- Constants
- Variables
- func RegisterBatchAPIServer(s grpc.ServiceRegistrar, srv BatchAPIServer)
- type BatchAPIClient
- type BatchAPIServer
- type HttpResource
- func (*HttpResource) Descriptor() ([]byte, []int)deprecated
- func (x *HttpResource) GetHeaders() []*HttpResource_Header
- func (x *HttpResource) GetMethod() HttpResource_Method
- func (x *HttpResource) GetUrl() string
- func (*HttpResource) ProtoMessage()
- func (x *HttpResource) ProtoReflect() protoreflect.Message
- func (x *HttpResource) Reset()
- func (x *HttpResource) String() string
- type HttpResource_Header
- func (*HttpResource_Header) Descriptor() ([]byte, []int)deprecated
- func (x *HttpResource_Header) GetName() string
- func (x *HttpResource_Header) GetValue() string
- func (*HttpResource_Header) ProtoMessage()
- func (x *HttpResource_Header) ProtoReflect() protoreflect.Message
- func (x *HttpResource_Header) Reset()
- func (x *HttpResource_Header) String() string
- type HttpResource_Method
- func (HttpResource_Method) Descriptor() protoreflect.EnumDescriptor
- func (x HttpResource_Method) Enum() *HttpResource_Method
- func (HttpResource_Method) EnumDescriptor() ([]byte, []int)deprecated
- func (x HttpResource_Method) Number() protoreflect.EnumNumber
- func (x HttpResource_Method) String() string
- func (HttpResource_Method) Type() protoreflect.EnumType
- type Operation
- func (*Operation) Descriptor() ([]byte, []int)deprecated
- func (x *Operation) GetAppId() string
- func (x *Operation) GetBatchId() string
- func (x *Operation) GetBatchReference() string
- func (x *Operation) GetDestinationUrl() string
- func (x *Operation) GetDuration() *durationpb.Duration
- func (x *Operation) GetErrorCode() Operation_ErrorCode
- func (x *Operation) GetErrorDescription() string
- func (x *Operation) GetId() string
- func (x *Operation) GetLanguageCode() string
- func (x *Operation) GetReference() string
- func (x *Operation) GetResult() []*OperationResult
- func (x *Operation) GetSourceUrl() string
- func (x *Operation) GetStatus() Operation_Status
- func (*Operation) ProtoMessage()
- func (x *Operation) ProtoReflect() protoreflect.Message
- func (x *Operation) Reset()
- func (x *Operation) String() string
- type OperationResult
- func (*OperationResult) Descriptor() ([]byte, []int)deprecated
- func (x *OperationResult) GetText() string
- func (x *OperationResult) GetTokens() []*Token
- func (x *OperationResult) GetType() OperationResult_ResultType
- func (*OperationResult) ProtoMessage()
- func (x *OperationResult) ProtoReflect() protoreflect.Message
- func (x *OperationResult) Reset()
- func (x *OperationResult) String() string
- type OperationResult_ResultType
- func (OperationResult_ResultType) Descriptor() protoreflect.EnumDescriptor
- func (x OperationResult_ResultType) Enum() *OperationResult_ResultType
- func (OperationResult_ResultType) EnumDescriptor() ([]byte, []int)deprecated
- func (x OperationResult_ResultType) Number() protoreflect.EnumNumber
- func (x OperationResult_ResultType) String() string
- func (OperationResult_ResultType) Type() protoreflect.EnumType
- type Operation_ErrorCode
- func (Operation_ErrorCode) Descriptor() protoreflect.EnumDescriptor
- func (x Operation_ErrorCode) Enum() *Operation_ErrorCode
- func (Operation_ErrorCode) EnumDescriptor() ([]byte, []int)deprecated
- func (x Operation_ErrorCode) Number() protoreflect.EnumNumber
- func (x Operation_ErrorCode) String() string
- func (Operation_ErrorCode) Type() protoreflect.EnumType
- type Operation_Status
- func (Operation_Status) Descriptor() protoreflect.EnumDescriptor
- func (x Operation_Status) Enum() *Operation_Status
- func (Operation_Status) EnumDescriptor() ([]byte, []int)deprecated
- func (x Operation_Status) Number() protoreflect.EnumNumber
- func (x Operation_Status) String() string
- func (Operation_Status) Type() protoreflect.EnumType
- type Option
- type ProcessAudioBatchConfig
- func (*ProcessAudioBatchConfig) Descriptor() ([]byte, []int)deprecated
- func (x *ProcessAudioBatchConfig) GetAppId() string
- func (x *ProcessAudioBatchConfig) GetBatchReference() string
- func (x *ProcessAudioBatchConfig) GetLanguageCodes() []string
- func (x *ProcessAudioBatchConfig) GetOptions() []*Option
- func (x *ProcessAudioBatchConfig) GetProcessingConfig() *ProcessingConfiguration
- func (*ProcessAudioBatchConfig) ProtoMessage()
- func (x *ProcessAudioBatchConfig) ProtoReflect() protoreflect.Message
- func (x *ProcessAudioBatchConfig) Reset()
- func (x *ProcessAudioBatchConfig) String() string
- type ProcessAudioSourceRequest
- func (*ProcessAudioSourceRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ProcessAudioSourceRequest) GetConfig() *ProcessAudioBatchConfig
- func (x *ProcessAudioSourceRequest) GetSource() []*ProcessAudioSourceRequestItem
- func (*ProcessAudioSourceRequest) ProtoMessage()
- func (x *ProcessAudioSourceRequest) ProtoReflect() protoreflect.Message
- func (x *ProcessAudioSourceRequest) Reset()
- func (x *ProcessAudioSourceRequest) String() string
- type ProcessAudioSourceRequestItem
- func (*ProcessAudioSourceRequestItem) Descriptor() ([]byte, []int)deprecated
- func (x *ProcessAudioSourceRequestItem) GetCompletionWebhook() *HttpResource
- func (x *ProcessAudioSourceRequestItem) GetDestinationUrl() string
- func (x *ProcessAudioSourceRequestItem) GetDeviceId() string
- func (x *ProcessAudioSourceRequestItem) GetReference() string
- func (x *ProcessAudioSourceRequestItem) GetSourceUrl() string
- func (*ProcessAudioSourceRequestItem) ProtoMessage()
- func (x *ProcessAudioSourceRequestItem) ProtoReflect() protoreflect.Message
- func (x *ProcessAudioSourceRequestItem) Reset()
- func (x *ProcessAudioSourceRequestItem) String() string
- type ProcessAudioSourceResponse
- func (*ProcessAudioSourceResponse) Descriptor() ([]byte, []int)deprecated
- func (x *ProcessAudioSourceResponse) GetOperation() []*Operation
- func (*ProcessAudioSourceResponse) ProtoMessage()
- func (x *ProcessAudioSourceResponse) ProtoReflect() protoreflect.Message
- func (x *ProcessAudioSourceResponse) Reset()
- func (x *ProcessAudioSourceResponse) String() string
- type ProcessingConfiguration
- func (*ProcessingConfiguration) Descriptor() ([]byte, []int)deprecated
- func (x *ProcessingConfiguration) GetSkipTranscribe() bool
- func (x *ProcessingConfiguration) GetTokenize() bool
- func (x *ProcessingConfiguration) GetTranslate() bool
- func (*ProcessingConfiguration) ProtoMessage()
- func (x *ProcessingConfiguration) ProtoReflect() protoreflect.Message
- func (x *ProcessingConfiguration) Reset()
- func (x *ProcessingConfiguration) String() string
- type QueryStatusRequest
- func (*QueryStatusRequest) Descriptor() ([]byte, []int)deprecated
- func (x *QueryStatusRequest) GetBatchId() string
- func (x *QueryStatusRequest) GetBatchReference() string
- func (x *QueryStatusRequest) GetOperationIds() []string
- func (x *QueryStatusRequest) GetOperationReferences() []string
- func (*QueryStatusRequest) ProtoMessage()
- func (x *QueryStatusRequest) ProtoReflect() protoreflect.Message
- func (x *QueryStatusRequest) Reset()
- func (x *QueryStatusRequest) String() string
- type QueryStatusResponse
- func (*QueryStatusResponse) Descriptor() ([]byte, []int)deprecated
- func (x *QueryStatusResponse) GetOperation() []*Operation
- func (*QueryStatusResponse) ProtoMessage()
- func (x *QueryStatusResponse) ProtoReflect() protoreflect.Message
- func (x *QueryStatusResponse) Reset()
- func (x *QueryStatusResponse) String() string
- type Token
- func (*Token) Descriptor() ([]byte, []int)deprecated
- func (x *Token) GetEndTime() int32
- func (x *Token) GetIndex() int32
- func (x *Token) GetStartTime() int32
- func (x *Token) GetToken() string
- func (*Token) ProtoMessage()
- func (x *Token) ProtoReflect() protoreflect.Message
- func (x *Token) Reset()
- func (x *Token) String() string
- type UnimplementedBatchAPIServer
- type UnsafeBatchAPIServer
Constants ¶
const ( BatchAPI_ProcessAudioSource_FullMethodName = "/speechly.slu.v2beta1.BatchAPI/ProcessAudioSource" BatchAPI_QueryStatus_FullMethodName = "/speechly.slu.v2beta1.BatchAPI/QueryStatus" )
Variables ¶
var ( HttpResource_Method_name = map[int32]string{ 0: "METHOD_UNSPECIFIED", 1: "METHOD_GET", 2: "METHOD_POST", 3: "METHOD_PUT", } HttpResource_Method_value = map[string]int32{ "METHOD_UNSPECIFIED": 0, "METHOD_GET": 1, "METHOD_POST": 2, "METHOD_PUT": 3, } )
Enum value maps for HttpResource_Method.
var ( Operation_Status_name = map[int32]string{ 0: "STATUS_UNSPECIFIED", 1: "STATUS_PENDING", 2: "STATUS_DONE", 3: "STATUS_ERROR", } Operation_Status_value = map[string]int32{ "STATUS_UNSPECIFIED": 0, "STATUS_PENDING": 1, "STATUS_DONE": 2, "STATUS_ERROR": 3, } )
Enum value maps for Operation_Status.
var ( Operation_ErrorCode_name = map[int32]string{ 0: "ERROR_UNSPECIFIED", 1: "ERROR_UNSUPPORTED_LANGUAGE", 2: "ERROR_INTERNAL", 3: "ERROR_INVALID_PARAMETERS", 4: "ERROR_INVALID_SOURCE", 5: "ERROR_INVALID_DESTINATION", 6: "ERROR_INVALID_AUDIO", } Operation_ErrorCode_value = map[string]int32{ "ERROR_UNSPECIFIED": 0, "ERROR_UNSUPPORTED_LANGUAGE": 1, "ERROR_INTERNAL": 2, "ERROR_INVALID_PARAMETERS": 3, "ERROR_INVALID_SOURCE": 4, "ERROR_INVALID_DESTINATION": 5, "ERROR_INVALID_AUDIO": 6, } )
Enum value maps for Operation_ErrorCode.
var ( OperationResult_ResultType_name = map[int32]string{ 0: "RESULT_TYPE_UNSPECIFIED", 1: "RESULT_TYPE_TRANSCRIPT_LEXICAL", 2: "RESULT_TYPE_TRANSCRIPT_DISPLAY", 3: "RESULT_TYPE_TRANSCRIPT_TRANSLATION", } OperationResult_ResultType_value = map[string]int32{ "RESULT_TYPE_UNSPECIFIED": 0, "RESULT_TYPE_TRANSCRIPT_LEXICAL": 1, "RESULT_TYPE_TRANSCRIPT_DISPLAY": 2, "RESULT_TYPE_TRANSCRIPT_TRANSLATION": 3, } )
Enum value maps for OperationResult_ResultType.
var BatchAPI_ServiceDesc = grpc.ServiceDesc{ ServiceName: "speechly.slu.v2beta1.BatchAPI", HandlerType: (*BatchAPIServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "ProcessAudioSource", Handler: _BatchAPI_ProcessAudioSource_Handler, }, { MethodName: "QueryStatus", Handler: _BatchAPI_QueryStatus_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "speechly/slu/v2beta1/batch_api.proto", }
BatchAPI_ServiceDesc is the grpc.ServiceDesc for BatchAPI service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
var File_speechly_slu_v2beta1_batch_api_proto protoreflect.FileDescriptor
var File_speechly_slu_v2beta1_batch_proto protoreflect.FileDescriptor
Functions ¶
func RegisterBatchAPIServer ¶
func RegisterBatchAPIServer(s grpc.ServiceRegistrar, srv BatchAPIServer)
Types ¶
type BatchAPIClient ¶
type BatchAPIClient interface { // Create a new background Speechly Batch API operation for a one or more audio sources. // Audio sources must be URIs of a files, reachable from the API // The response includes an `id` that is used to match the operation to the // results. A `reference` identifier can also be set. // Also a `batch_reference` can be set to mark that multiple audio sources form a // logical batch. In that case, the response will include a `batch_id`. ProcessAudioSource(ctx context.Context, in *ProcessAudioSourceRequest, opts ...grpc.CallOption) (*ProcessAudioSourceResponse, error) // Query the status of given operations. // If the `ProcessAudioSourceRequest` did not define a `destination` or `completion_webhook` // as a destination, the results are returned in the `QueryStatusResponse`. QueryStatus(ctx context.Context, in *QueryStatusRequest, opts ...grpc.CallOption) (*QueryStatusResponse, error) }
BatchAPIClient is the client API for BatchAPI service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewBatchAPIClient ¶
func NewBatchAPIClient(cc grpc.ClientConnInterface) BatchAPIClient
type BatchAPIServer ¶
type BatchAPIServer interface { // Create a new background Speechly Batch API operation for a one or more audio sources. // Audio sources must be URIs of a files, reachable from the API // The response includes an `id` that is used to match the operation to the // results. A `reference` identifier can also be set. // Also a `batch_reference` can be set to mark that multiple audio sources form a // logical batch. In that case, the response will include a `batch_id`. ProcessAudioSource(context.Context, *ProcessAudioSourceRequest) (*ProcessAudioSourceResponse, error) // Query the status of given operations. // If the `ProcessAudioSourceRequest` did not define a `destination` or `completion_webhook` // as a destination, the results are returned in the `QueryStatusResponse`. QueryStatus(context.Context, *QueryStatusRequest) (*QueryStatusResponse, error) // contains filtered or unexported methods }
BatchAPIServer is the server API for BatchAPI service. All implementations must embed UnimplementedBatchAPIServer for forward compatibility
type HttpResource ¶
type HttpResource struct { // URL of the endpoint (protocol://server/path) // Required. Url string `protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"` // method to use in connection. // Optional. Method HttpResource_Method `protobuf:"varint,2,opt,name=method,proto3,enum=speechly.slu.v2beta1.HttpResource_Method" json:"method,omitempty"` // Possible additional headers to include in the connection. // Optional. Headers []*HttpResource_Header `protobuf:"bytes,3,rep,name=headers,proto3" json:"headers,omitempty"` // contains filtered or unexported fields }
Describes full properties of an HTTP endpoint.
func (*HttpResource) Descriptor
deprecated
func (*HttpResource) Descriptor() ([]byte, []int)
Deprecated: Use HttpResource.ProtoReflect.Descriptor instead.
func (*HttpResource) GetHeaders ¶
func (x *HttpResource) GetHeaders() []*HttpResource_Header
func (*HttpResource) GetMethod ¶
func (x *HttpResource) GetMethod() HttpResource_Method
func (*HttpResource) GetUrl ¶
func (x *HttpResource) GetUrl() string
func (*HttpResource) ProtoMessage ¶
func (*HttpResource) ProtoMessage()
func (*HttpResource) ProtoReflect ¶
func (x *HttpResource) ProtoReflect() protoreflect.Message
func (*HttpResource) Reset ¶
func (x *HttpResource) Reset()
func (*HttpResource) String ¶
func (x *HttpResource) String() string
type HttpResource_Header ¶
type HttpResource_Header struct { // Name of the header to set in request. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Value of the given header in request. Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"` // contains filtered or unexported fields }
A single header value in an HTTP request.
func (*HttpResource_Header) Descriptor
deprecated
func (*HttpResource_Header) Descriptor() ([]byte, []int)
Deprecated: Use HttpResource_Header.ProtoReflect.Descriptor instead.
func (*HttpResource_Header) GetName ¶
func (x *HttpResource_Header) GetName() string
func (*HttpResource_Header) GetValue ¶
func (x *HttpResource_Header) GetValue() string
func (*HttpResource_Header) ProtoMessage ¶
func (*HttpResource_Header) ProtoMessage()
func (*HttpResource_Header) ProtoReflect ¶
func (x *HttpResource_Header) ProtoReflect() protoreflect.Message
func (*HttpResource_Header) Reset ¶
func (x *HttpResource_Header) Reset()
func (*HttpResource_Header) String ¶
func (x *HttpResource_Header) String() string
type HttpResource_Method ¶
type HttpResource_Method int32
The HTTP method to use when accessing an HTTP resource.
const ( // Method is not given, and default method is used for requests. // Data fetches use GET, and result sending POST. HttpResource_METHOD_UNSPECIFIED HttpResource_Method = 0 // Use HTTP GET. HttpResource_METHOD_GET HttpResource_Method = 1 // Use HTTP POST. HttpResource_METHOD_POST HttpResource_Method = 2 // Use HTTP PUT. HttpResource_METHOD_PUT HttpResource_Method = 3 )
func (HttpResource_Method) Descriptor ¶
func (HttpResource_Method) Descriptor() protoreflect.EnumDescriptor
func (HttpResource_Method) Enum ¶
func (x HttpResource_Method) Enum() *HttpResource_Method
func (HttpResource_Method) EnumDescriptor
deprecated
func (HttpResource_Method) EnumDescriptor() ([]byte, []int)
Deprecated: Use HttpResource_Method.Descriptor instead.
func (HttpResource_Method) Number ¶
func (x HttpResource_Method) Number() protoreflect.EnumNumber
func (HttpResource_Method) String ¶
func (x HttpResource_Method) String() string
func (HttpResource_Method) Type ¶
func (HttpResource_Method) Type() protoreflect.EnumType
type Operation ¶
type Operation struct { // The id of the operation. Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` // The reference id of the operation, if given. Reference string `protobuf:"bytes,2,opt,name=reference,proto3" json:"reference,omitempty"` // The id of the batch the operation belongs to. BatchId string `protobuf:"bytes,16,opt,name=batch_id,json=batchId,proto3" json:"batch_id,omitempty"` // The reference id of the operation, if given. BatchReference string `protobuf:"bytes,17,opt,name=batch_reference,json=batchReference,proto3" json:"batch_reference,omitempty"` // The current status of the operation. Status Operation_Status `protobuf:"varint,3,opt,name=status,proto3,enum=speechly.slu.v2beta1.Operation_Status" json:"status,omitempty"` // The language code of the detected language. LanguageCode string `protobuf:"bytes,4,opt,name=language_code,json=languageCode,proto3" json:"language_code,omitempty"` // The application context for the operation. AppId string `protobuf:"bytes,5,opt,name=app_id,json=appId,proto3" json:"app_id,omitempty"` // If the operation status is STATUS_DONE and the destination is not set, // the results of the processing. Result []*OperationResult `protobuf:"bytes,6,rep,name=result,proto3" json:"result,omitempty"` // The duration of the audio. Duration *durationpb.Duration `protobuf:"bytes,7,opt,name=duration,proto3" json:"duration,omitempty"` // Machine-readable status for the operation. // Only set if operation status is STATUS_ERROR. ErrorCode Operation_ErrorCode `` /* 136-byte string literal not displayed */ // Contains a human readable description of the error. // Only set if operation status is STATUS_ERROR. ErrorDescription string `protobuf:"bytes,19,opt,name=error_description,json=errorDescription,proto3" json:"error_description,omitempty"` // The locator to the source audio. SourceUrl string `protobuf:"bytes,20,opt,name=source_url,json=sourceUrl,proto3" json:"source_url,omitempty"` // The locator to the result target. DestinationUrl string `protobuf:"bytes,21,opt,name=destination_url,json=destinationUrl,proto3" json:"destination_url,omitempty"` // contains filtered or unexported fields }
Describes a single batch operation.
func (*Operation) Descriptor
deprecated
func (*Operation) GetBatchId ¶
func (*Operation) GetBatchReference ¶
func (*Operation) GetDestinationUrl ¶
func (*Operation) GetDuration ¶
func (x *Operation) GetDuration() *durationpb.Duration
func (*Operation) GetErrorCode ¶
func (x *Operation) GetErrorCode() Operation_ErrorCode
func (*Operation) GetErrorDescription ¶
func (*Operation) GetLanguageCode ¶
func (*Operation) GetReference ¶
func (*Operation) GetResult ¶
func (x *Operation) GetResult() []*OperationResult
func (*Operation) GetSourceUrl ¶
func (*Operation) GetStatus ¶
func (x *Operation) GetStatus() Operation_Status
func (*Operation) ProtoMessage ¶
func (*Operation) ProtoMessage()
func (*Operation) ProtoReflect ¶
func (x *Operation) ProtoReflect() protoreflect.Message
type OperationResult ¶
type OperationResult struct { // The type of this result. Type OperationResult_ResultType `protobuf:"varint,1,opt,name=type,proto3,enum=speechly.slu.v2beta1.OperationResult_ResultType" json:"type,omitempty"` // The textual representation of the results. Text string `protobuf:"bytes,2,opt,name=text,proto3" json:"text,omitempty"` // The tokenized representation of the result. Only available if requested in // the `ProcessingConfiguration`. Tokens []*Token `protobuf:"bytes,3,rep,name=tokens,proto3" json:"tokens,omitempty"` // contains filtered or unexported fields }
Describes the results of the processing that took place.
func (*OperationResult) Descriptor
deprecated
func (*OperationResult) Descriptor() ([]byte, []int)
Deprecated: Use OperationResult.ProtoReflect.Descriptor instead.
func (*OperationResult) GetText ¶
func (x *OperationResult) GetText() string
func (*OperationResult) GetTokens ¶
func (x *OperationResult) GetTokens() []*Token
func (*OperationResult) GetType ¶
func (x *OperationResult) GetType() OperationResult_ResultType
func (*OperationResult) ProtoMessage ¶
func (*OperationResult) ProtoMessage()
func (*OperationResult) ProtoReflect ¶
func (x *OperationResult) ProtoReflect() protoreflect.Message
func (*OperationResult) Reset ¶
func (x *OperationResult) Reset()
func (*OperationResult) String ¶
func (x *OperationResult) String() string
type OperationResult_ResultType ¶
type OperationResult_ResultType int32
The possible types for the operation result.
const ( // Result type is not set. OperationResult_RESULT_TYPE_UNSPECIFIED OperationResult_ResultType = 0 // The actual words of the audio with no additional processing applied. OperationResult_RESULT_TYPE_TRANSCRIPT_LEXICAL OperationResult_ResultType = 1 // The content of the audio formatted to be displayed on screen, with eg. // punctuation and capitalization included. OperationResult_RESULT_TYPE_TRANSCRIPT_DISPLAY OperationResult_ResultType = 2 // The content of the audio translated to English. OperationResult_RESULT_TYPE_TRANSCRIPT_TRANSLATION OperationResult_ResultType = 3 )
func (OperationResult_ResultType) Descriptor ¶
func (OperationResult_ResultType) Descriptor() protoreflect.EnumDescriptor
func (OperationResult_ResultType) Enum ¶
func (x OperationResult_ResultType) Enum() *OperationResult_ResultType
func (OperationResult_ResultType) EnumDescriptor
deprecated
func (OperationResult_ResultType) EnumDescriptor() ([]byte, []int)
Deprecated: Use OperationResult_ResultType.Descriptor instead.
func (OperationResult_ResultType) Number ¶
func (x OperationResult_ResultType) Number() protoreflect.EnumNumber
func (OperationResult_ResultType) String ¶
func (x OperationResult_ResultType) String() string
func (OperationResult_ResultType) Type ¶
func (OperationResult_ResultType) Type() protoreflect.EnumType
type Operation_ErrorCode ¶
type Operation_ErrorCode int32
Contains a machine readable error type if the operation status is STATUS_ERROR.
const ( // No error is set. Operation_ERROR_UNSPECIFIED Operation_ErrorCode = 0 // The input was in a language that was not supported in this context. Operation_ERROR_UNSUPPORTED_LANGUAGE Operation_ErrorCode = 1 // An internal error occurred. Operation_ERROR_INTERNAL Operation_ErrorCode = 2 // Given parameters cannot be used to process the given input. Operation_ERROR_INVALID_PARAMETERS Operation_ErrorCode = 3 // The source could not be read or understood. Operation_ERROR_INVALID_SOURCE Operation_ErrorCode = 4 // The results could not be written to the destination. Operation_ERROR_INVALID_DESTINATION Operation_ErrorCode = 5 // The provided audio was not in a supported format. Operation_ERROR_INVALID_AUDIO Operation_ErrorCode = 6 )
func (Operation_ErrorCode) Descriptor ¶
func (Operation_ErrorCode) Descriptor() protoreflect.EnumDescriptor
func (Operation_ErrorCode) Enum ¶
func (x Operation_ErrorCode) Enum() *Operation_ErrorCode
func (Operation_ErrorCode) EnumDescriptor
deprecated
func (Operation_ErrorCode) EnumDescriptor() ([]byte, []int)
Deprecated: Use Operation_ErrorCode.Descriptor instead.
func (Operation_ErrorCode) Number ¶
func (x Operation_ErrorCode) Number() protoreflect.EnumNumber
func (Operation_ErrorCode) String ¶
func (x Operation_ErrorCode) String() string
func (Operation_ErrorCode) Type ¶
func (Operation_ErrorCode) Type() protoreflect.EnumType
type Operation_Status ¶
type Operation_Status int32
The status of the operation.
const ( // Default status is empty. Operation_STATUS_UNSPECIFIED Operation_Status = 0 // The operation is queued for processing. Operation_STATUS_PENDING Operation_Status = 1 // The operation is complete and transcript is available. Operation_STATUS_DONE Operation_Status = 2 // The processing failed. Error reason is available. Operation_STATUS_ERROR Operation_Status = 3 )
func (Operation_Status) Descriptor ¶
func (Operation_Status) Descriptor() protoreflect.EnumDescriptor
func (Operation_Status) Enum ¶
func (x Operation_Status) Enum() *Operation_Status
func (Operation_Status) EnumDescriptor
deprecated
func (Operation_Status) EnumDescriptor() ([]byte, []int)
Deprecated: Use Operation_Status.Descriptor instead.
func (Operation_Status) Number ¶
func (x Operation_Status) Number() protoreflect.EnumNumber
func (Operation_Status) String ¶
func (x Operation_Status) String() string
func (Operation_Status) Type ¶
func (Operation_Status) Type() protoreflect.EnumType
type Option ¶
type Option struct { // The key of the option to be set. Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"` // The values to set the option to. Value []string `protobuf:"bytes,2,rep,name=value,proto3" json:"value,omitempty"` // contains filtered or unexported fields }
Option to change the default behaviour of the SLU.
func (*Option) Descriptor
deprecated
func (*Option) ProtoMessage ¶
func (*Option) ProtoMessage()
func (*Option) ProtoReflect ¶
func (x *Option) ProtoReflect() protoreflect.Message
type ProcessAudioBatchConfig ¶
type ProcessAudioBatchConfig struct { // The processing context, Speechly Application ID. // Optional. If not provided, the processing context will be determined // from the login information. AppId string `protobuf:"bytes,1,opt,name=app_id,json=appId,proto3" json:"app_id,omitempty"` // The language(s) of the audio sent in the request as a BCP-47 language tag // (e.g. "en-US"). Defaults to the target application language(s). // Optional. LanguageCodes []string `protobuf:"bytes,2,rep,name=language_codes,json=languageCodes,proto3" json:"language_codes,omitempty"` // Processing configuration. // Optional, defaults to transcribe. ProcessingConfig *ProcessingConfiguration `protobuf:"bytes,3,opt,name=processing_config,json=processingConfig,proto3" json:"processing_config,omitempty"` // Reference id for a set of related operations. For example an identifier of // the source system. // Optional. BatchReference string `protobuf:"bytes,4,opt,name=batch_reference,json=batchReference,proto3" json:"batch_reference,omitempty"` // Additional batch specific options. // Optional. Options []*Option `protobuf:"bytes,5,rep,name=options,proto3" json:"options,omitempty"` // contains filtered or unexported fields }
Describes the configuration options common for the input batch.
func (*ProcessAudioBatchConfig) Descriptor
deprecated
func (*ProcessAudioBatchConfig) Descriptor() ([]byte, []int)
Deprecated: Use ProcessAudioBatchConfig.ProtoReflect.Descriptor instead.
func (*ProcessAudioBatchConfig) GetAppId ¶
func (x *ProcessAudioBatchConfig) GetAppId() string
func (*ProcessAudioBatchConfig) GetBatchReference ¶
func (x *ProcessAudioBatchConfig) GetBatchReference() string
func (*ProcessAudioBatchConfig) GetLanguageCodes ¶
func (x *ProcessAudioBatchConfig) GetLanguageCodes() []string
func (*ProcessAudioBatchConfig) GetOptions ¶
func (x *ProcessAudioBatchConfig) GetOptions() []*Option
func (*ProcessAudioBatchConfig) GetProcessingConfig ¶
func (x *ProcessAudioBatchConfig) GetProcessingConfig() *ProcessingConfiguration
func (*ProcessAudioBatchConfig) ProtoMessage ¶
func (*ProcessAudioBatchConfig) ProtoMessage()
func (*ProcessAudioBatchConfig) ProtoReflect ¶
func (x *ProcessAudioBatchConfig) ProtoReflect() protoreflect.Message
func (*ProcessAudioBatchConfig) Reset ¶
func (x *ProcessAudioBatchConfig) Reset()
func (*ProcessAudioBatchConfig) String ¶
func (x *ProcessAudioBatchConfig) String() string
type ProcessAudioSourceRequest ¶
type ProcessAudioSourceRequest struct { // The options shared by all of the source audios. Config *ProcessAudioBatchConfig `protobuf:"bytes,1,opt,name=config,proto3" json:"config,omitempty"` // The source audios, and their unique options. Source []*ProcessAudioSourceRequestItem `protobuf:"bytes,2,rep,name=source,proto3" json:"source,omitempty"` // contains filtered or unexported fields }
Describes a request to process audio from a pre-existing source.
func (*ProcessAudioSourceRequest) Descriptor
deprecated
func (*ProcessAudioSourceRequest) Descriptor() ([]byte, []int)
Deprecated: Use ProcessAudioSourceRequest.ProtoReflect.Descriptor instead.
func (*ProcessAudioSourceRequest) GetConfig ¶
func (x *ProcessAudioSourceRequest) GetConfig() *ProcessAudioBatchConfig
func (*ProcessAudioSourceRequest) GetSource ¶
func (x *ProcessAudioSourceRequest) GetSource() []*ProcessAudioSourceRequestItem
func (*ProcessAudioSourceRequest) ProtoMessage ¶
func (*ProcessAudioSourceRequest) ProtoMessage()
func (*ProcessAudioSourceRequest) ProtoReflect ¶
func (x *ProcessAudioSourceRequest) ProtoReflect() protoreflect.Message
func (*ProcessAudioSourceRequest) Reset ¶
func (x *ProcessAudioSourceRequest) Reset()
func (*ProcessAudioSourceRequest) String ¶
func (x *ProcessAudioSourceRequest) String() string
type ProcessAudioSourceRequestItem ¶
type ProcessAudioSourceRequestItem struct { // The locator to the source audio. // Required. SourceUrl string `protobuf:"bytes,1,opt,name=source_url,json=sourceUrl,proto3" json:"source_url,omitempty"` // The locator to the result target. The payload will be `Operation` as JSON. // Optional. DestinationUrl string `protobuf:"bytes,2,opt,name=destination_url,json=destinationUrl,proto3" json:"destination_url,omitempty"` // HTTP endpoint to be notified on completion of the processing. The payload // will be `Operation` as JSON. // Optional. CompletionWebhook *HttpResource `protobuf:"bytes,3,opt,name=completion_webhook,json=completionWebhook,proto3" json:"completion_webhook,omitempty"` // Reference id for the operation. For example an identifier of the source // system. // Optional. Reference string `protobuf:"bytes,4,opt,name=reference,proto3" json:"reference,omitempty"` // The device ID of the audio source, for example a microphone identifier as // UUID. // Optional. DeviceId string `protobuf:"bytes,5,opt,name=device_id,json=deviceId,proto3" json:"device_id,omitempty"` // contains filtered or unexported fields }
Describes the configuration options unique to a single audio source.
func (*ProcessAudioSourceRequestItem) Descriptor
deprecated
func (*ProcessAudioSourceRequestItem) Descriptor() ([]byte, []int)
Deprecated: Use ProcessAudioSourceRequestItem.ProtoReflect.Descriptor instead.
func (*ProcessAudioSourceRequestItem) GetCompletionWebhook ¶
func (x *ProcessAudioSourceRequestItem) GetCompletionWebhook() *HttpResource
func (*ProcessAudioSourceRequestItem) GetDestinationUrl ¶
func (x *ProcessAudioSourceRequestItem) GetDestinationUrl() string
func (*ProcessAudioSourceRequestItem) GetDeviceId ¶
func (x *ProcessAudioSourceRequestItem) GetDeviceId() string
func (*ProcessAudioSourceRequestItem) GetReference ¶
func (x *ProcessAudioSourceRequestItem) GetReference() string
func (*ProcessAudioSourceRequestItem) GetSourceUrl ¶
func (x *ProcessAudioSourceRequestItem) GetSourceUrl() string
func (*ProcessAudioSourceRequestItem) ProtoMessage ¶
func (*ProcessAudioSourceRequestItem) ProtoMessage()
func (*ProcessAudioSourceRequestItem) ProtoReflect ¶
func (x *ProcessAudioSourceRequestItem) ProtoReflect() protoreflect.Message
func (*ProcessAudioSourceRequestItem) Reset ¶
func (x *ProcessAudioSourceRequestItem) Reset()
func (*ProcessAudioSourceRequestItem) String ¶
func (x *ProcessAudioSourceRequestItem) String() string
type ProcessAudioSourceResponse ¶
type ProcessAudioSourceResponse struct { // The details of the created operations. Operation []*Operation `protobuf:"bytes,1,rep,name=operation,proto3" json:"operation,omitempty"` // contains filtered or unexported fields }
Describes a response to request to process audio from a pre-existing source.
func (*ProcessAudioSourceResponse) Descriptor
deprecated
func (*ProcessAudioSourceResponse) Descriptor() ([]byte, []int)
Deprecated: Use ProcessAudioSourceResponse.ProtoReflect.Descriptor instead.
func (*ProcessAudioSourceResponse) GetOperation ¶
func (x *ProcessAudioSourceResponse) GetOperation() []*Operation
func (*ProcessAudioSourceResponse) ProtoMessage ¶
func (*ProcessAudioSourceResponse) ProtoMessage()
func (*ProcessAudioSourceResponse) ProtoReflect ¶
func (x *ProcessAudioSourceResponse) ProtoReflect() protoreflect.Message
func (*ProcessAudioSourceResponse) Reset ¶
func (x *ProcessAudioSourceResponse) Reset()
func (*ProcessAudioSourceResponse) String ¶
func (x *ProcessAudioSourceResponse) String() string
type ProcessingConfiguration ¶
type ProcessingConfiguration struct { // The processing should include the token level transcription and // determination of time stamps for tokens. // Optional, defaults to false. Tokenize bool `protobuf:"varint,1,opt,name=tokenize,proto3" json:"tokenize,omitempty"` // The processing should include translating the audio to English. // Optional, defaults to false. Translate bool `protobuf:"varint,2,opt,name=translate,proto3" json:"translate,omitempty"` // The processing should not include transcribing the audio to the source // language. This option should be used with translate (or other similar // option) to suppress the normal Speech Recognition processing. // Optional, defaults to false. SkipTranscribe bool `protobuf:"varint,3,opt,name=skip_transcribe,json=skipTranscribe,proto3" json:"skip_transcribe,omitempty"` // contains filtered or unexported fields }
Describes the processing options for the audio. Note that not all options are available for all languages or on all Payment Plans.
func (*ProcessingConfiguration) Descriptor
deprecated
func (*ProcessingConfiguration) Descriptor() ([]byte, []int)
Deprecated: Use ProcessingConfiguration.ProtoReflect.Descriptor instead.
func (*ProcessingConfiguration) GetSkipTranscribe ¶
func (x *ProcessingConfiguration) GetSkipTranscribe() bool
func (*ProcessingConfiguration) GetTokenize ¶
func (x *ProcessingConfiguration) GetTokenize() bool
func (*ProcessingConfiguration) GetTranslate ¶
func (x *ProcessingConfiguration) GetTranslate() bool
func (*ProcessingConfiguration) ProtoMessage ¶
func (*ProcessingConfiguration) ProtoMessage()
func (*ProcessingConfiguration) ProtoReflect ¶
func (x *ProcessingConfiguration) ProtoReflect() protoreflect.Message
func (*ProcessingConfiguration) Reset ¶
func (x *ProcessingConfiguration) Reset()
func (*ProcessingConfiguration) String ¶
func (x *ProcessingConfiguration) String() string
type QueryStatusRequest ¶
type QueryStatusRequest struct { // ID of an audio processing operation. OperationIds []string `protobuf:"bytes,1,rep,name=operation_ids,json=operationIds,proto3" json:"operation_ids,omitempty"` // Reference ID of an operation. OperationReferences []string `protobuf:"bytes,2,rep,name=operation_references,json=operationReferences,proto3" json:"operation_references,omitempty"` // ID of an audio processing batch. BatchId string `protobuf:"bytes,3,opt,name=batch_id,json=batchId,proto3" json:"batch_id,omitempty"` // Reference ID of a batch. BatchReference string `protobuf:"bytes,4,opt,name=batch_reference,json=batchReference,proto3" json:"batch_reference,omitempty"` // contains filtered or unexported fields }
Query the status of an operation. At least one of these must be given.
func (*QueryStatusRequest) Descriptor
deprecated
func (*QueryStatusRequest) Descriptor() ([]byte, []int)
Deprecated: Use QueryStatusRequest.ProtoReflect.Descriptor instead.
func (*QueryStatusRequest) GetBatchId ¶
func (x *QueryStatusRequest) GetBatchId() string
func (*QueryStatusRequest) GetBatchReference ¶
func (x *QueryStatusRequest) GetBatchReference() string
func (*QueryStatusRequest) GetOperationIds ¶
func (x *QueryStatusRequest) GetOperationIds() []string
func (*QueryStatusRequest) GetOperationReferences ¶
func (x *QueryStatusRequest) GetOperationReferences() []string
func (*QueryStatusRequest) ProtoMessage ¶
func (*QueryStatusRequest) ProtoMessage()
func (*QueryStatusRequest) ProtoReflect ¶
func (x *QueryStatusRequest) ProtoReflect() protoreflect.Message
func (*QueryStatusRequest) Reset ¶
func (x *QueryStatusRequest) Reset()
func (*QueryStatusRequest) String ¶
func (x *QueryStatusRequest) String() string
type QueryStatusResponse ¶
type QueryStatusResponse struct { // The details of the audio processing operation. Operation []*Operation `protobuf:"bytes,1,rep,name=operation,proto3" json:"operation,omitempty"` // contains filtered or unexported fields }
Describes the statuses of the queried operations.
func (*QueryStatusResponse) Descriptor
deprecated
func (*QueryStatusResponse) Descriptor() ([]byte, []int)
Deprecated: Use QueryStatusResponse.ProtoReflect.Descriptor instead.
func (*QueryStatusResponse) GetOperation ¶
func (x *QueryStatusResponse) GetOperation() []*Operation
func (*QueryStatusResponse) ProtoMessage ¶
func (*QueryStatusResponse) ProtoMessage()
func (*QueryStatusResponse) ProtoReflect ¶
func (x *QueryStatusResponse) ProtoReflect() protoreflect.Message
func (*QueryStatusResponse) Reset ¶
func (x *QueryStatusResponse) Reset()
func (*QueryStatusResponse) String ¶
func (x *QueryStatusResponse) String() string
type Token ¶
type Token struct { // The token described. Token string `protobuf:"bytes,1,opt,name=token,proto3" json:"token,omitempty"` // The position of the token in the whole phrase, zero-based. Index int32 `protobuf:"varint,2,opt,name=index,proto3" json:"index,omitempty"` // The end time of the token in the audio, in milliseconds from the beginning // of the audio. StartTime int32 `protobuf:"varint,3,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"` // The end time of the token in the audio, in milliseconds from the beginning // of the audio. EndTime int32 `protobuf:"varint,4,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"` // contains filtered or unexported fields }
Describes a single meaningful unit of speech. In languages that use spaces to separate words, closely maps to those words.
func (*Token) Descriptor
deprecated
func (*Token) GetEndTime ¶
func (*Token) GetStartTime ¶
func (*Token) ProtoMessage ¶
func (*Token) ProtoMessage()
func (*Token) ProtoReflect ¶
func (x *Token) ProtoReflect() protoreflect.Message
type UnimplementedBatchAPIServer ¶
type UnimplementedBatchAPIServer struct { }
UnimplementedBatchAPIServer must be embedded to have forward compatible implementations.
func (UnimplementedBatchAPIServer) ProcessAudioSource ¶
func (UnimplementedBatchAPIServer) ProcessAudioSource(context.Context, *ProcessAudioSourceRequest) (*ProcessAudioSourceResponse, error)
func (UnimplementedBatchAPIServer) QueryStatus ¶
func (UnimplementedBatchAPIServer) QueryStatus(context.Context, *QueryStatusRequest) (*QueryStatusResponse, error)
type UnsafeBatchAPIServer ¶
type UnsafeBatchAPIServer interface {
// contains filtered or unexported methods
}
UnsafeBatchAPIServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to BatchAPIServer will result in compilation errors.