sluv2beta1

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

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
}

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
}

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
}

type HttpResource_Method int32

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
}

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
}

type OperationResult_ResultType int32

type Operation_ErrorCode int32

type Operation_Status int32

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}

type UnimplementedBatchAPIServer struct {
}

type UnsafeBatchAPIServer interface {
	// contains filtered or unexported methods
}