analyticsv1

package
v0.0.0-...-260d154 Latest Latest
Warning

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

Go to latest
Published: Oct 12, 2023 License: MIT Imports: 9 Imported by: 2

Documentation

Index

Constants

View Source
const (
	AnalyticsAPI_UtteranceStatistics_FullMethodName  = "/speechly.analytics.v1.AnalyticsAPI/UtteranceStatistics"
	AnalyticsAPI_Utterances_FullMethodName           = "/speechly.analytics.v1.AnalyticsAPI/Utterances"
	AnalyticsAPI_RegisterUtterance_FullMethodName    = "/speechly.analytics.v1.AnalyticsAPI/RegisterUtterance"
	AnalyticsAPI_RegisterUtterances_FullMethodName   = "/speechly.analytics.v1.AnalyticsAPI/RegisterUtterances"
	AnalyticsAPI_ModerationStatistics_FullMethodName = "/speechly.analytics.v1.AnalyticsAPI/ModerationStatistics"
	AnalyticsAPI_UserStatistics_FullMethodName       = "/speechly.analytics.v1.AnalyticsAPI/UserStatistics"
)

Variables

View Source
var (
	Aggregation_name = map[int32]string{
		0: "AGGREGATION_INVALID",
		1: "AGGREGATION_MONTHLY",
		2: "AGGREGATION_DAILY",
		3: "AGGREGATION_HOURLY",
	}
	Aggregation_value = map[string]int32{
		"AGGREGATION_INVALID": 0,
		"AGGREGATION_MONTHLY": 1,
		"AGGREGATION_DAILY":   2,
		"AGGREGATION_HOURLY":  3,
	}
)

Enum value maps for Aggregation.

View Source
var (
	ProcessingType_name = map[int32]string{
		0: "PROCESSING_TYPE_INVALID",
		1: "PROCESSING_TYPE_TRANSCRIPTION",
		2: "PROCESSING_TYPE_NLU",
		3: "PROCESSING_TYPE_LANGUAGE_DETECTION",
		4: "PROCESSING_TYPE_VAD",
		5: "PROCESSING_TYPE_TRANSLATION",
		6: "PROCESSING_TYPE_AUDIO_EVENT_DETECTION",
		7: "PROCESSING_TYPE_TONE_OF_VOICE_LABELLING",
		8: "PROCESSING_TYPE_SHALLOW_FUSION",
	}
	ProcessingType_value = map[string]int32{
		"PROCESSING_TYPE_INVALID":                 0,
		"PROCESSING_TYPE_TRANSCRIPTION":           1,
		"PROCESSING_TYPE_NLU":                     2,
		"PROCESSING_TYPE_LANGUAGE_DETECTION":      3,
		"PROCESSING_TYPE_VAD":                     4,
		"PROCESSING_TYPE_TRANSLATION":             5,
		"PROCESSING_TYPE_AUDIO_EVENT_DETECTION":   6,
		"PROCESSING_TYPE_TONE_OF_VOICE_LABELLING": 7,
		"PROCESSING_TYPE_SHALLOW_FUSION":          8,
	}
)

Enum value maps for ProcessingType.

View Source
var (
	UtteranceStatisticsRequest_Scope_name = map[int32]string{
		0: "SCOPE_INVALID",
		1: "SCOPE_UTTERANCES",
		2: "SCOPE_ANNOTATIONS",
		3: "SCOPE_ALL",
	}
	UtteranceStatisticsRequest_Scope_value = map[string]int32{
		"SCOPE_INVALID":     0,
		"SCOPE_UTTERANCES":  1,
		"SCOPE_ANNOTATIONS": 2,
		"SCOPE_ALL":         3,
	}
)

Enum value maps for UtteranceStatisticsRequest_Scope.

View Source
var (
	RegisterUtteranceRequest_Status_name = map[int32]string{
		0: "STATUS_INVALID",
		1: "STATUS_SUCCESS",
		2: "STATUS_ERROR",
	}
	RegisterUtteranceRequest_Status_value = map[string]int32{
		"STATUS_INVALID": 0,
		"STATUS_SUCCESS": 1,
		"STATUS_ERROR":   2,
	}
)

Enum value maps for RegisterUtteranceRequest_Status.

View Source
var AnalyticsAPI_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "speechly.analytics.v1.AnalyticsAPI",
	HandlerType: (*AnalyticsAPIServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "UtteranceStatistics",
			Handler:    _AnalyticsAPI_UtteranceStatistics_Handler,
		},
		{
			MethodName: "Utterances",
			Handler:    _AnalyticsAPI_Utterances_Handler,
		},
		{
			MethodName: "RegisterUtterance",
			Handler:    _AnalyticsAPI_RegisterUtterance_Handler,
		},
		{
			MethodName: "RegisterUtterances",
			Handler:    _AnalyticsAPI_RegisterUtterances_Handler,
		},
		{
			MethodName: "ModerationStatistics",
			Handler:    _AnalyticsAPI_ModerationStatistics_Handler,
		},
		{
			MethodName: "UserStatistics",
			Handler:    _AnalyticsAPI_UserStatistics_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "speechly/analytics/v1/analytics_api.proto",
}

AnalyticsAPI_ServiceDesc is the grpc.ServiceDesc for AnalyticsAPI service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source
var File_speechly_analytics_v1_analytics_api_proto protoreflect.FileDescriptor
View Source
var File_speechly_analytics_v1_analytics_proto protoreflect.FileDescriptor

Functions

func RegisterAnalyticsAPIServer

func RegisterAnalyticsAPIServer(s grpc.ServiceRegistrar, srv AnalyticsAPIServer)

Types

type Aggregation

type Aggregation int32

Aggregation granularity.

const (
	Aggregation_AGGREGATION_INVALID Aggregation = 0
	Aggregation_AGGREGATION_MONTHLY Aggregation = 1
	Aggregation_AGGREGATION_DAILY   Aggregation = 2
	Aggregation_AGGREGATION_HOURLY  Aggregation = 3
)

func (Aggregation) Descriptor

func (Aggregation) Enum

func (x Aggregation) Enum() *Aggregation

func (Aggregation) EnumDescriptor deprecated

func (Aggregation) EnumDescriptor() ([]byte, []int)

Deprecated: Use Aggregation.Descriptor instead.

func (Aggregation) Number

func (x Aggregation) Number() protoreflect.EnumNumber

func (Aggregation) String

func (x Aggregation) String() string

func (Aggregation) Type

type AnalyticsAPIClient

type AnalyticsAPIClient interface {
	// Get a summary of utterances for a given time period.
	UtteranceStatistics(ctx context.Context, in *UtteranceStatisticsRequest, opts ...grpc.CallOption) (*UtteranceStatisticsResponse, error)
	// Get a sample of recent utterances.
	Utterances(ctx context.Context, in *UtterancesRequest, opts ...grpc.CallOption) (*UtterancesResponse, error)
	// Register a data point of an on-device or on-premise utterance.
	RegisterUtterance(ctx context.Context, in *RegisterUtteranceRequest, opts ...grpc.CallOption) (*RegisterUtteranceResponse, error)
	// Register multiple utterances in a single request.
	RegisterUtterances(ctx context.Context, in *RegisterUtterancesRequest, opts ...grpc.CallOption) (*RegisterUtterancesResponse, error)
	// Get moderation event statistics for a project.
	ModerationStatistics(ctx context.Context, in *ModerationStatisticsRequest, opts ...grpc.CallOption) (*ModerationStatisticsResponse, error)
	// Get statistics about user behaviour.
	UserStatistics(ctx context.Context, in *UserStatisticsRequest, opts ...grpc.CallOption) (*UserStatisticsResponse, error)
}

AnalyticsAPIClient is the client API for AnalyticsAPI 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.

type AnalyticsAPIServer

type AnalyticsAPIServer interface {
	// Get a summary of utterances for a given time period.
	UtteranceStatistics(context.Context, *UtteranceStatisticsRequest) (*UtteranceStatisticsResponse, error)
	// Get a sample of recent utterances.
	Utterances(context.Context, *UtterancesRequest) (*UtterancesResponse, error)
	// Register a data point of an on-device or on-premise utterance.
	RegisterUtterance(context.Context, *RegisterUtteranceRequest) (*RegisterUtteranceResponse, error)
	// Register multiple utterances in a single request.
	RegisterUtterances(context.Context, *RegisterUtterancesRequest) (*RegisterUtterancesResponse, error)
	// Get moderation event statistics for a project.
	ModerationStatistics(context.Context, *ModerationStatisticsRequest) (*ModerationStatisticsResponse, error)
	// Get statistics about user behaviour.
	UserStatistics(context.Context, *UserStatisticsRequest) (*UserStatisticsResponse, error)
	// contains filtered or unexported methods
}

AnalyticsAPIServer is the server API for AnalyticsAPI service. All implementations must embed UnimplementedAnalyticsAPIServer for forward compatibility

type DecoderInfo

type DecoderInfo struct {

	// Version of the Speechly on-device decoder.
	Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`
	// Number of utterances the decoder has transcribed.
	UtteranceCount int32 `protobuf:"varint,2,opt,name=utterance_count,json=utteranceCount,proto3" json:"utterance_count,omitempty"`
	// Cumulative sum of the utterance length in seconds for the decoder.
	TotalSecondsTranscribed int32 `` /* 133-byte string literal not displayed */
	// contains filtered or unexported fields
}

Information about the on-device decoder.

func (*DecoderInfo) Descriptor deprecated

func (*DecoderInfo) Descriptor() ([]byte, []int)

Deprecated: Use DecoderInfo.ProtoReflect.Descriptor instead.

func (*DecoderInfo) GetTotalSecondsTranscribed

func (x *DecoderInfo) GetTotalSecondsTranscribed() int32

func (*DecoderInfo) GetUtteranceCount

func (x *DecoderInfo) GetUtteranceCount() int32

func (*DecoderInfo) GetVersion

func (x *DecoderInfo) GetVersion() string

func (*DecoderInfo) ProtoMessage

func (*DecoderInfo) ProtoMessage()

func (*DecoderInfo) ProtoReflect

func (x *DecoderInfo) ProtoReflect() protoreflect.Message

func (*DecoderInfo) Reset

func (x *DecoderInfo) Reset()

func (*DecoderInfo) String

func (x *DecoderInfo) String() string

type ModerationStatisticsPeriod

type ModerationStatisticsPeriod struct {

	// period start time
	StartTime string `protobuf:"bytes,1,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// if grouping by users, the user id, or "OTHER"
	UserId string `protobuf:"bytes,2,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	// total amount of moderation events for this period.
	Count int32 `protobuf:"varint,3,opt,name=count,proto3" json:"count,omitempty"`
	// total amount of flagged events.
	Flagged int32 `protobuf:"varint,4,opt,name=flagged,proto3" json:"flagged,omitempty"`
	// total amount of not flagged (OK) events for this period.
	NotFlagged int32 `protobuf:"varint,5,opt,name=not_flagged,json=notFlagged,proto3" json:"not_flagged,omitempty"`
	// amount of moderation decisions made.
	Decisions int32 `protobuf:"varint,6,opt,name=decisions,proto3" json:"decisions,omitempty"`
	// contains filtered or unexported fields
}

A single time series entry for moderation statistics.

func (*ModerationStatisticsPeriod) Descriptor deprecated

func (*ModerationStatisticsPeriod) Descriptor() ([]byte, []int)

Deprecated: Use ModerationStatisticsPeriod.ProtoReflect.Descriptor instead.

func (*ModerationStatisticsPeriod) GetCount

func (x *ModerationStatisticsPeriod) GetCount() int32

func (*ModerationStatisticsPeriod) GetDecisions

func (x *ModerationStatisticsPeriod) GetDecisions() int32

func (*ModerationStatisticsPeriod) GetFlagged

func (x *ModerationStatisticsPeriod) GetFlagged() int32

func (*ModerationStatisticsPeriod) GetNotFlagged

func (x *ModerationStatisticsPeriod) GetNotFlagged() int32

func (*ModerationStatisticsPeriod) GetStartTime

func (x *ModerationStatisticsPeriod) GetStartTime() string

func (*ModerationStatisticsPeriod) GetUserId

func (x *ModerationStatisticsPeriod) GetUserId() string

func (*ModerationStatisticsPeriod) ProtoMessage

func (*ModerationStatisticsPeriod) ProtoMessage()

func (*ModerationStatisticsPeriod) ProtoReflect

func (*ModerationStatisticsPeriod) Reset

func (x *ModerationStatisticsPeriod) Reset()

func (*ModerationStatisticsPeriod) String

func (x *ModerationStatisticsPeriod) String() string

type ModerationStatisticsRequest

type ModerationStatisticsRequest struct {

	// the project to return statistics for.
	// Required when there are multiple projects to choose from.
	ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// Limit statistics to a single app_id.
	// Default is none, returning statistics for the project in scope.
	AppId string `protobuf:"bytes,2,opt,name=app_id,json=appId,proto3" json:"app_id,omitempty"`
	// Start of requested statistics period.
	// Default is 15 days ago.
	// Must be YYYY-mm-DD formatted string if given.
	StartDate string `protobuf:"bytes,3,opt,name=start_date,json=startDate,proto3" json:"start_date,omitempty"`
	// End of requested statistics period.
	// Default is 1 day ago, resulting in two full weeks.
	// Must be YYYY-mm-DD formatted string if given.
	EndDate string `protobuf:"bytes,4,opt,name=end_date,json=endDate,proto3" json:"end_date,omitempty"`
	// Aggregation of the data.
	// Default is DAILY
	Aggregation Aggregation `protobuf:"varint,5,opt,name=aggregation,proto3,enum=speechly.analytics.v1.Aggregation" json:"aggregation,omitempty"`
	// contains filtered or unexported fields
}

Request time series statistics about moderation events.

func (*ModerationStatisticsRequest) Descriptor deprecated

func (*ModerationStatisticsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ModerationStatisticsRequest.ProtoReflect.Descriptor instead.

func (*ModerationStatisticsRequest) GetAggregation

func (x *ModerationStatisticsRequest) GetAggregation() Aggregation

func (*ModerationStatisticsRequest) GetAppId

func (x *ModerationStatisticsRequest) GetAppId() string

func (*ModerationStatisticsRequest) GetEndDate

func (x *ModerationStatisticsRequest) GetEndDate() string

func (*ModerationStatisticsRequest) GetProjectId

func (x *ModerationStatisticsRequest) GetProjectId() string

func (*ModerationStatisticsRequest) GetStartDate

func (x *ModerationStatisticsRequest) GetStartDate() string

func (*ModerationStatisticsRequest) ProtoMessage

func (*ModerationStatisticsRequest) ProtoMessage()

func (*ModerationStatisticsRequest) ProtoReflect

func (*ModerationStatisticsRequest) Reset

func (x *ModerationStatisticsRequest) Reset()

func (*ModerationStatisticsRequest) String

func (x *ModerationStatisticsRequest) String() string

type ModerationStatisticsResponse

type ModerationStatisticsResponse struct {
	ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	AppId     string `protobuf:"bytes,2,opt,name=app_id,json=appId,proto3" json:"app_id,omitempty"`
	// Start of this statistics period.
	// YYYY-mm-DD formatted string.
	StartDate string `protobuf:"bytes,3,opt,name=start_date,json=startDate,proto3" json:"start_date,omitempty"`
	// End of this statistics period.
	// YYYY-mm-DD formatted string.
	EndDate string `protobuf:"bytes,4,opt,name=end_date,json=endDate,proto3" json:"end_date,omitempty"`
	// Time period length.
	Aggregation Aggregation `protobuf:"varint,5,opt,name=aggregation,proto3,enum=speechly.analytics.v1.Aggregation" json:"aggregation,omitempty"`
	// Aggregated results.
	Items []*ModerationStatisticsPeriod `protobuf:"bytes,6,rep,name=items,proto3" json:"items,omitempty"`
	// Total number of events in this response.
	TotalEvents int32 `protobuf:"varint,7,opt,name=total_events,json=totalEvents,proto3" json:"total_events,omitempty"`
	// Total number of flagged events in this response.
	TotalFlagged int32 `protobuf:"varint,8,opt,name=total_flagged,json=totalFlagged,proto3" json:"total_flagged,omitempty"`
	// Total number of non-flagged (OK) events in this response.
	TotalNotFlagged int32 `protobuf:"varint,9,opt,name=total_not_flagged,json=totalNotFlagged,proto3" json:"total_not_flagged,omitempty"`
	// contains filtered or unexported fields
}

Contains the time series data for moderation events.

func (*ModerationStatisticsResponse) Descriptor deprecated

func (*ModerationStatisticsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ModerationStatisticsResponse.ProtoReflect.Descriptor instead.

func (*ModerationStatisticsResponse) GetAggregation

func (x *ModerationStatisticsResponse) GetAggregation() Aggregation

func (*ModerationStatisticsResponse) GetAppId

func (x *ModerationStatisticsResponse) GetAppId() string

func (*ModerationStatisticsResponse) GetEndDate

func (x *ModerationStatisticsResponse) GetEndDate() string

func (*ModerationStatisticsResponse) GetItems

func (*ModerationStatisticsResponse) GetProjectId

func (x *ModerationStatisticsResponse) GetProjectId() string

func (*ModerationStatisticsResponse) GetStartDate

func (x *ModerationStatisticsResponse) GetStartDate() string

func (*ModerationStatisticsResponse) GetTotalEvents

func (x *ModerationStatisticsResponse) GetTotalEvents() int32

func (*ModerationStatisticsResponse) GetTotalFlagged

func (x *ModerationStatisticsResponse) GetTotalFlagged() int32

func (*ModerationStatisticsResponse) GetTotalNotFlagged

func (x *ModerationStatisticsResponse) GetTotalNotFlagged() int32

func (*ModerationStatisticsResponse) ProtoMessage

func (*ModerationStatisticsResponse) ProtoMessage()

func (*ModerationStatisticsResponse) ProtoReflect

func (*ModerationStatisticsResponse) Reset

func (x *ModerationStatisticsResponse) Reset()

func (*ModerationStatisticsResponse) String

type ProcessingInfo

type ProcessingInfo struct {

	// The processing types that were applied
	ProcessingTypes []ProcessingType `` /* 156-byte string literal not displayed */
	// id of the model that was used for processing
	ModelId string `protobuf:"bytes,2,opt,name=model_id,json=modelId,proto3" json:"model_id,omitempty"`
	// contains filtered or unexported fields
}

Specifies what processing has been applied to an utterance.

func (*ProcessingInfo) Descriptor deprecated

func (*ProcessingInfo) Descriptor() ([]byte, []int)

Deprecated: Use ProcessingInfo.ProtoReflect.Descriptor instead.

func (*ProcessingInfo) GetModelId

func (x *ProcessingInfo) GetModelId() string

func (*ProcessingInfo) GetProcessingTypes

func (x *ProcessingInfo) GetProcessingTypes() []ProcessingType

func (*ProcessingInfo) ProtoMessage

func (*ProcessingInfo) ProtoMessage()

func (*ProcessingInfo) ProtoReflect

func (x *ProcessingInfo) ProtoReflect() protoreflect.Message

func (*ProcessingInfo) Reset

func (x *ProcessingInfo) Reset()

func (*ProcessingInfo) String

func (x *ProcessingInfo) String() string

type ProcessingType

type ProcessingType int32

The various types of processing that can be applied to the audio.

const (
	ProcessingType_PROCESSING_TYPE_INVALID                 ProcessingType = 0
	ProcessingType_PROCESSING_TYPE_TRANSCRIPTION           ProcessingType = 1
	ProcessingType_PROCESSING_TYPE_NLU                     ProcessingType = 2
	ProcessingType_PROCESSING_TYPE_LANGUAGE_DETECTION      ProcessingType = 3
	ProcessingType_PROCESSING_TYPE_VAD                     ProcessingType = 4
	ProcessingType_PROCESSING_TYPE_TRANSLATION             ProcessingType = 5
	ProcessingType_PROCESSING_TYPE_AUDIO_EVENT_DETECTION   ProcessingType = 6
	ProcessingType_PROCESSING_TYPE_TONE_OF_VOICE_LABELLING ProcessingType = 7
	ProcessingType_PROCESSING_TYPE_SHALLOW_FUSION          ProcessingType = 8
)

func (ProcessingType) Descriptor

func (ProcessingType) Enum

func (x ProcessingType) Enum() *ProcessingType

func (ProcessingType) EnumDescriptor deprecated

func (ProcessingType) EnumDescriptor() ([]byte, []int)

Deprecated: Use ProcessingType.Descriptor instead.

func (ProcessingType) Number

func (ProcessingType) String

func (x ProcessingType) String() string

func (ProcessingType) Type

type RegisterUtteranceRequest

type RegisterUtteranceRequest struct {

	// id of the application the operation belongs to
	AppId string `protobuf:"bytes,1,opt,name=app_id,json=appId,proto3" json:"app_id,omitempty"`
	// device_id of the utterance.
	DeviceId string `protobuf:"bytes,2,opt,name=device_id,json=deviceId,proto3" json:"device_id,omitempty"`
	// Length of the recognized utterance in seconds.
	UtteranceLengthSeconds int32 `` /* 130-byte string literal not displayed */
	// Length of the recognized utterance in characters.
	UtteranceLengthChars int32 `protobuf:"varint,4,opt,name=utterance_length_chars,json=utteranceLengthChars,proto3" json:"utterance_length_chars,omitempty"`
	// Information about the on-device decoder.
	DecoderInfo *DecoderInfo `protobuf:"bytes,5,opt,name=decoder_info,json=decoderInfo,proto3" json:"decoder_info,omitempty"`
	// When the processing was initially requested.
	CreatedTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=created_time,json=createdTime,proto3" json:"created_time,omitempty"`
	// When the processing was finished.
	FinishedTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=finished_time,json=finishedTime,proto3" json:"finished_time,omitempty"`
	// The status of the processing.
	Status RegisterUtteranceRequest_Status `protobuf:"varint,8,opt,name=status,proto3,enum=speechly.analytics.v1.RegisterUtteranceRequest_Status" json:"status,omitempty"`
	// batch api operation id of the utterance
	OperationId string `protobuf:"bytes,9,opt,name=operation_id,json=operationId,proto3" json:"operation_id,omitempty"`
	// id of the batch the operation belongs to
	BatchId string `protobuf:"bytes,10,opt,name=batch_id,json=batchId,proto3" json:"batch_id,omitempty"`
	// id of the project the operation belongs to
	ProjectId string `protobuf:"bytes,11,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// language of the utterance (BCP-47)
	Language string `protobuf:"bytes,12,opt,name=language,proto3" json:"language,omitempty"`
	// Information about the processing applied to the utterance
	ProcessingInfo *ProcessingInfo `protobuf:"bytes,13,opt,name=processing_info,json=processingInfo,proto3" json:"processing_info,omitempty"`
	// contains filtered or unexported fields
}

A single data point of an utterance recognized by Speechly On Device or Speechly On Premise.

func (*RegisterUtteranceRequest) Descriptor deprecated

func (*RegisterUtteranceRequest) Descriptor() ([]byte, []int)

Deprecated: Use RegisterUtteranceRequest.ProtoReflect.Descriptor instead.

func (*RegisterUtteranceRequest) GetAppId

func (x *RegisterUtteranceRequest) GetAppId() string

func (*RegisterUtteranceRequest) GetBatchId

func (x *RegisterUtteranceRequest) GetBatchId() string

func (*RegisterUtteranceRequest) GetCreatedTime

func (x *RegisterUtteranceRequest) GetCreatedTime() *timestamppb.Timestamp

func (*RegisterUtteranceRequest) GetDecoderInfo

func (x *RegisterUtteranceRequest) GetDecoderInfo() *DecoderInfo

func (*RegisterUtteranceRequest) GetDeviceId

func (x *RegisterUtteranceRequest) GetDeviceId() string

func (*RegisterUtteranceRequest) GetFinishedTime

func (x *RegisterUtteranceRequest) GetFinishedTime() *timestamppb.Timestamp

func (*RegisterUtteranceRequest) GetLanguage

func (x *RegisterUtteranceRequest) GetLanguage() string

func (*RegisterUtteranceRequest) GetOperationId

func (x *RegisterUtteranceRequest) GetOperationId() string

func (*RegisterUtteranceRequest) GetProcessingInfo

func (x *RegisterUtteranceRequest) GetProcessingInfo() *ProcessingInfo

func (*RegisterUtteranceRequest) GetProjectId

func (x *RegisterUtteranceRequest) GetProjectId() string

func (*RegisterUtteranceRequest) GetStatus

func (*RegisterUtteranceRequest) GetUtteranceLengthChars

func (x *RegisterUtteranceRequest) GetUtteranceLengthChars() int32

func (*RegisterUtteranceRequest) GetUtteranceLengthSeconds

func (x *RegisterUtteranceRequest) GetUtteranceLengthSeconds() int32

func (*RegisterUtteranceRequest) ProtoMessage

func (*RegisterUtteranceRequest) ProtoMessage()

func (*RegisterUtteranceRequest) ProtoReflect

func (x *RegisterUtteranceRequest) ProtoReflect() protoreflect.Message

func (*RegisterUtteranceRequest) Reset

func (x *RegisterUtteranceRequest) Reset()

func (*RegisterUtteranceRequest) String

func (x *RegisterUtteranceRequest) String() string

type RegisterUtteranceRequest_Status

type RegisterUtteranceRequest_Status int32

The status of the processing.

const (
	// Default status is empty
	RegisterUtteranceRequest_STATUS_INVALID RegisterUtteranceRequest_Status = 0
	// Processing completed successfully.
	RegisterUtteranceRequest_STATUS_SUCCESS RegisterUtteranceRequest_Status = 1
	// The processing failed.
	RegisterUtteranceRequest_STATUS_ERROR RegisterUtteranceRequest_Status = 2
)

func (RegisterUtteranceRequest_Status) Descriptor

func (RegisterUtteranceRequest_Status) Enum

func (RegisterUtteranceRequest_Status) EnumDescriptor deprecated

func (RegisterUtteranceRequest_Status) EnumDescriptor() ([]byte, []int)

Deprecated: Use RegisterUtteranceRequest_Status.Descriptor instead.

func (RegisterUtteranceRequest_Status) Number

func (RegisterUtteranceRequest_Status) String

func (RegisterUtteranceRequest_Status) Type

type RegisterUtteranceResponse

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

Default empty response.

func (*RegisterUtteranceResponse) Descriptor deprecated

func (*RegisterUtteranceResponse) Descriptor() ([]byte, []int)

Deprecated: Use RegisterUtteranceResponse.ProtoReflect.Descriptor instead.

func (*RegisterUtteranceResponse) ProtoMessage

func (*RegisterUtteranceResponse) ProtoMessage()

func (*RegisterUtteranceResponse) ProtoReflect

func (*RegisterUtteranceResponse) Reset

func (x *RegisterUtteranceResponse) Reset()

func (*RegisterUtteranceResponse) String

func (x *RegisterUtteranceResponse) String() string

type RegisterUtterancesRequest

type RegisterUtterancesRequest struct {
	Requests []*RegisterUtteranceRequest `protobuf:"bytes,1,rep,name=requests,proto3" json:"requests,omitempty"`
	// contains filtered or unexported fields
}

Register multiple utterances in the same request.

func (*RegisterUtterancesRequest) Descriptor deprecated

func (*RegisterUtterancesRequest) Descriptor() ([]byte, []int)

Deprecated: Use RegisterUtterancesRequest.ProtoReflect.Descriptor instead.

func (*RegisterUtterancesRequest) GetRequests

func (*RegisterUtterancesRequest) ProtoMessage

func (*RegisterUtterancesRequest) ProtoMessage()

func (*RegisterUtterancesRequest) ProtoReflect

func (*RegisterUtterancesRequest) Reset

func (x *RegisterUtterancesRequest) Reset()

func (*RegisterUtterancesRequest) String

func (x *RegisterUtterancesRequest) String() string

type RegisterUtterancesResponse

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

func (*RegisterUtterancesResponse) Descriptor deprecated

func (*RegisterUtterancesResponse) Descriptor() ([]byte, []int)

Deprecated: Use RegisterUtterancesResponse.ProtoReflect.Descriptor instead.

func (*RegisterUtterancesResponse) ProtoMessage

func (*RegisterUtterancesResponse) ProtoMessage()

func (*RegisterUtterancesResponse) ProtoReflect

func (*RegisterUtterancesResponse) Reset

func (x *RegisterUtterancesResponse) Reset()

func (*RegisterUtterancesResponse) String

func (x *RegisterUtterancesResponse) String() string

type UnimplementedAnalyticsAPIServer

type UnimplementedAnalyticsAPIServer struct {
}

UnimplementedAnalyticsAPIServer must be embedded to have forward compatible implementations.

func (UnimplementedAnalyticsAPIServer) RegisterUtterance

func (UnimplementedAnalyticsAPIServer) RegisterUtterances

func (UnimplementedAnalyticsAPIServer) UserStatistics

func (UnimplementedAnalyticsAPIServer) Utterances

type UnsafeAnalyticsAPIServer

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

UnsafeAnalyticsAPIServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to AnalyticsAPIServer will result in compilation errors.

type UserStatisticsPeriod

type UserStatisticsPeriod struct {
	StartTime    string `protobuf:"bytes,1,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	ActiveUsers  int32  `protobuf:"varint,2,opt,name=active_users,json=activeUsers,proto3" json:"active_users,omitempty"`
	ToxicUsers   int32  `protobuf:"varint,3,opt,name=toxic_users,json=toxicUsers,proto3" json:"toxic_users,omitempty"`
	ExposedUsers int32  `protobuf:"varint,4,opt,name=exposed_users,json=exposedUsers,proto3" json:"exposed_users,omitempty"`
	// contains filtered or unexported fields
}

A single time series entry for user statistics.

func (*UserStatisticsPeriod) Descriptor deprecated

func (*UserStatisticsPeriod) Descriptor() ([]byte, []int)

Deprecated: Use UserStatisticsPeriod.ProtoReflect.Descriptor instead.

func (*UserStatisticsPeriod) GetActiveUsers

func (x *UserStatisticsPeriod) GetActiveUsers() int32

func (*UserStatisticsPeriod) GetExposedUsers

func (x *UserStatisticsPeriod) GetExposedUsers() int32

func (*UserStatisticsPeriod) GetStartTime

func (x *UserStatisticsPeriod) GetStartTime() string

func (*UserStatisticsPeriod) GetToxicUsers

func (x *UserStatisticsPeriod) GetToxicUsers() int32

func (*UserStatisticsPeriod) ProtoMessage

func (*UserStatisticsPeriod) ProtoMessage()

func (*UserStatisticsPeriod) ProtoReflect

func (x *UserStatisticsPeriod) ProtoReflect() protoreflect.Message

func (*UserStatisticsPeriod) Reset

func (x *UserStatisticsPeriod) Reset()

func (*UserStatisticsPeriod) String

func (x *UserStatisticsPeriod) String() string

type UserStatisticsRequest

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

Request for getting user statistics.

func (*UserStatisticsRequest) Descriptor deprecated

func (*UserStatisticsRequest) Descriptor() ([]byte, []int)

Deprecated: Use UserStatisticsRequest.ProtoReflect.Descriptor instead.

func (*UserStatisticsRequest) ProtoMessage

func (*UserStatisticsRequest) ProtoMessage()

func (*UserStatisticsRequest) ProtoReflect

func (x *UserStatisticsRequest) ProtoReflect() protoreflect.Message

func (*UserStatisticsRequest) Reset

func (x *UserStatisticsRequest) Reset()

func (*UserStatisticsRequest) String

func (x *UserStatisticsRequest) String() string

type UserStatisticsResponse

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

Contains the user statistics requested.

func (*UserStatisticsResponse) Descriptor deprecated

func (*UserStatisticsResponse) Descriptor() ([]byte, []int)

Deprecated: Use UserStatisticsResponse.ProtoReflect.Descriptor instead.

func (*UserStatisticsResponse) ProtoMessage

func (*UserStatisticsResponse) ProtoMessage()

func (*UserStatisticsResponse) ProtoReflect

func (x *UserStatisticsResponse) ProtoReflect() protoreflect.Message

func (*UserStatisticsResponse) Reset

func (x *UserStatisticsResponse) Reset()

func (*UserStatisticsResponse) String

func (x *UserStatisticsResponse) String() string

type Utterance

type Utterance struct {

	// The ASR transcript of the utterance.
	Transcript string `protobuf:"bytes,1,opt,name=transcript,proto3" json:"transcript,omitempty"`
	// The SAL-annotated transcript of the utterance.
	Annotated string `protobuf:"bytes,2,opt,name=annotated,proto3" json:"annotated,omitempty"`
	// ISO-formatted UTC date of the utterance.
	Date string `protobuf:"bytes,3,opt,name=date,proto3" json:"date,omitempty"`
	// contains filtered or unexported fields
}

A single utterances recognized by Speechly API.

func (*Utterance) Descriptor deprecated

func (*Utterance) Descriptor() ([]byte, []int)

Deprecated: Use Utterance.ProtoReflect.Descriptor instead.

func (*Utterance) GetAnnotated

func (x *Utterance) GetAnnotated() string

func (*Utterance) GetDate

func (x *Utterance) GetDate() string

func (*Utterance) GetTranscript

func (x *Utterance) GetTranscript() string

func (*Utterance) ProtoMessage

func (*Utterance) ProtoMessage()

func (*Utterance) ProtoReflect

func (x *Utterance) ProtoReflect() protoreflect.Message

func (*Utterance) Reset

func (x *Utterance) Reset()

func (*Utterance) String

func (x *Utterance) String() string

type UtteranceStatisticsPeriod

type UtteranceStatisticsPeriod struct {

	// app_id or empty, if aggregating over project.
	AppId string `protobuf:"bytes,2,opt,name=app_id,json=appId,proto3" json:"app_id,omitempty"`
	// ISO-formatted UTC timestamp of the start time of the period.
	StartTime string `protobuf:"bytes,3,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// Count (sum) of utterances in the current period.
	Count int32 `protobuf:"varint,4,opt,name=count,proto3" json:"count,omitempty"`
	// Total duration of the utterances in the current period.
	UtterancesSeconds int32 `protobuf:"varint,5,opt,name=utterances_seconds,json=utterancesSeconds,proto3" json:"utterances_seconds,omitempty"`
	// Total duration of annotated utterances in the current period.
	AnnotatedSeconds int32 `protobuf:"varint,6,opt,name=annotated_seconds,json=annotatedSeconds,proto3" json:"annotated_seconds,omitempty"`
	// project_id or empty, if specifying a project.
	ProjectId string `protobuf:"bytes,7,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// the id of the model used, if applicable.
	ModelId string `protobuf:"bytes,8,opt,name=model_id,json=modelId,proto3" json:"model_id,omitempty"`
	// contains filtered or unexported fields
}

Single row of statistics response.

func (*UtteranceStatisticsPeriod) Descriptor deprecated

func (*UtteranceStatisticsPeriod) Descriptor() ([]byte, []int)

Deprecated: Use UtteranceStatisticsPeriod.ProtoReflect.Descriptor instead.

func (*UtteranceStatisticsPeriod) GetAnnotatedSeconds

func (x *UtteranceStatisticsPeriod) GetAnnotatedSeconds() int32

func (*UtteranceStatisticsPeriod) GetAppId

func (x *UtteranceStatisticsPeriod) GetAppId() string

func (*UtteranceStatisticsPeriod) GetCount

func (x *UtteranceStatisticsPeriod) GetCount() int32

func (*UtteranceStatisticsPeriod) GetModelId

func (x *UtteranceStatisticsPeriod) GetModelId() string

func (*UtteranceStatisticsPeriod) GetProjectId

func (x *UtteranceStatisticsPeriod) GetProjectId() string

func (*UtteranceStatisticsPeriod) GetStartTime

func (x *UtteranceStatisticsPeriod) GetStartTime() string

func (*UtteranceStatisticsPeriod) GetUtterancesSeconds

func (x *UtteranceStatisticsPeriod) GetUtterancesSeconds() int32

func (*UtteranceStatisticsPeriod) ProtoMessage

func (*UtteranceStatisticsPeriod) ProtoMessage()

func (*UtteranceStatisticsPeriod) ProtoReflect

func (*UtteranceStatisticsPeriod) Reset

func (x *UtteranceStatisticsPeriod) Reset()

func (*UtteranceStatisticsPeriod) String

func (x *UtteranceStatisticsPeriod) String() string

type UtteranceStatisticsRequest

type UtteranceStatisticsRequest struct {

	// Limit statistics to a single app_id.
	// Default is none, returning statistics for all apps in the project.
	AppId string `protobuf:"bytes,1,opt,name=app_id,json=appId,proto3" json:"app_id,omitempty"`
	// Amount of days to include in the result.
	// Default is 14 days.
	Days int32 `protobuf:"varint,2,opt,name=days,proto3" json:"days,omitempty"`
	// Scope of returned data.
	// Default is UTTERANCES.
	Scope UtteranceStatisticsRequest_Scope `protobuf:"varint,3,opt,name=scope,proto3,enum=speechly.analytics.v1.UtteranceStatisticsRequest_Scope" json:"scope,omitempty"`
	// Aggregation of the data.
	// Default is DAILY
	Aggregation Aggregation `protobuf:"varint,4,opt,name=aggregation,proto3,enum=speechly.analytics.v1.Aggregation" json:"aggregation,omitempty"`
	// Start of requested statistics period.
	// Default is 15 days ago.
	// Must be YYYY-mm-DD formatted string if given.
	StartDate string `protobuf:"bytes,5,opt,name=start_date,json=startDate,proto3" json:"start_date,omitempty"`
	// End of requested statistics period.
	// Default is 1 day ago, resulting in two full weeks.
	// Must be YYYY-mm-DD formatted string if given.
	EndDate string `protobuf:"bytes,6,opt,name=end_date,json=endDate,proto3" json:"end_date,omitempty"`
	// Limit statisticts to a single project_id
	// Default is none, returning statistics for the project in the given scope.
	ProjectId string `protobuf:"bytes,7,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// contains filtered or unexported fields
}

Includes keys for the UtteranceStatistics method. If no keys are given, the token's project is used. Token needs to have access to the given app / project.

func (*UtteranceStatisticsRequest) Descriptor deprecated

func (*UtteranceStatisticsRequest) Descriptor() ([]byte, []int)

Deprecated: Use UtteranceStatisticsRequest.ProtoReflect.Descriptor instead.

func (*UtteranceStatisticsRequest) GetAggregation

func (x *UtteranceStatisticsRequest) GetAggregation() Aggregation

func (*UtteranceStatisticsRequest) GetAppId

func (x *UtteranceStatisticsRequest) GetAppId() string

func (*UtteranceStatisticsRequest) GetDays

func (x *UtteranceStatisticsRequest) GetDays() int32

func (*UtteranceStatisticsRequest) GetEndDate

func (x *UtteranceStatisticsRequest) GetEndDate() string

func (*UtteranceStatisticsRequest) GetProjectId

func (x *UtteranceStatisticsRequest) GetProjectId() string

func (*UtteranceStatisticsRequest) GetScope

func (*UtteranceStatisticsRequest) GetStartDate

func (x *UtteranceStatisticsRequest) GetStartDate() string

func (*UtteranceStatisticsRequest) ProtoMessage

func (*UtteranceStatisticsRequest) ProtoMessage()

func (*UtteranceStatisticsRequest) ProtoReflect

func (*UtteranceStatisticsRequest) Reset

func (x *UtteranceStatisticsRequest) Reset()

func (*UtteranceStatisticsRequest) String

func (x *UtteranceStatisticsRequest) String() string

type UtteranceStatisticsRequest_Scope

type UtteranceStatisticsRequest_Scope int32

The scope of the returned items.

const (
	UtteranceStatisticsRequest_SCOPE_INVALID UtteranceStatisticsRequest_Scope = 0
	// Include only utterance data.
	UtteranceStatisticsRequest_SCOPE_UTTERANCES UtteranceStatisticsRequest_Scope = 1
	// Include annotated data.
	UtteranceStatisticsRequest_SCOPE_ANNOTATIONS UtteranceStatisticsRequest_Scope = 2
	// Include both utterance and annotated data.
	UtteranceStatisticsRequest_SCOPE_ALL UtteranceStatisticsRequest_Scope = 3
)

func (UtteranceStatisticsRequest_Scope) Descriptor

func (UtteranceStatisticsRequest_Scope) Enum

func (UtteranceStatisticsRequest_Scope) EnumDescriptor deprecated

func (UtteranceStatisticsRequest_Scope) EnumDescriptor() ([]byte, []int)

Deprecated: Use UtteranceStatisticsRequest_Scope.Descriptor instead.

func (UtteranceStatisticsRequest_Scope) Number

func (UtteranceStatisticsRequest_Scope) String

func (UtteranceStatisticsRequest_Scope) Type

type UtteranceStatisticsResponse

type UtteranceStatisticsResponse struct {

	// Start of this statistics period.
	// YYYY-mm-DD formatted string.
	StartDate string `protobuf:"bytes,1,opt,name=start_date,json=startDate,proto3" json:"start_date,omitempty"`
	// End of this statistics period.
	// YYYY-mm-DD formatted string.
	EndDate string `protobuf:"bytes,2,opt,name=end_date,json=endDate,proto3" json:"end_date,omitempty"`
	// Time period length.
	Aggregation Aggregation `protobuf:"varint,3,opt,name=aggregation,proto3,enum=speechly.analytics.v1.Aggregation" json:"aggregation,omitempty"`
	// Aggregated results.
	Items []*UtteranceStatisticsPeriod `protobuf:"bytes,4,rep,name=items,proto3" json:"items,omitempty"`
	// Amount of utterances in this response
	TotalUtterances int32 `protobuf:"varint,5,opt,name=total_utterances,json=totalUtterances,proto3" json:"total_utterances,omitempty"`
	// Total duration of utterances in seconds.
	TotalDurationSeconds int32 `protobuf:"varint,6,opt,name=total_duration_seconds,json=totalDurationSeconds,proto3" json:"total_duration_seconds,omitempty"`
	// Total duration of annotated utterances in seconds.
	TotalAnnotatedSeconds int32 `` /* 127-byte string literal not displayed */
	// contains filtered or unexported fields
}

Contains a list of statistics entries for utterances, based on the requested scope.

func (*UtteranceStatisticsResponse) Descriptor deprecated

func (*UtteranceStatisticsResponse) Descriptor() ([]byte, []int)

Deprecated: Use UtteranceStatisticsResponse.ProtoReflect.Descriptor instead.

func (*UtteranceStatisticsResponse) GetAggregation

func (x *UtteranceStatisticsResponse) GetAggregation() Aggregation

func (*UtteranceStatisticsResponse) GetEndDate

func (x *UtteranceStatisticsResponse) GetEndDate() string

func (*UtteranceStatisticsResponse) GetItems

func (*UtteranceStatisticsResponse) GetStartDate

func (x *UtteranceStatisticsResponse) GetStartDate() string

func (*UtteranceStatisticsResponse) GetTotalAnnotatedSeconds

func (x *UtteranceStatisticsResponse) GetTotalAnnotatedSeconds() int32

func (*UtteranceStatisticsResponse) GetTotalDurationSeconds

func (x *UtteranceStatisticsResponse) GetTotalDurationSeconds() int32

func (*UtteranceStatisticsResponse) GetTotalUtterances

func (x *UtteranceStatisticsResponse) GetTotalUtterances() int32

func (*UtteranceStatisticsResponse) ProtoMessage

func (*UtteranceStatisticsResponse) ProtoMessage()

func (*UtteranceStatisticsResponse) ProtoReflect

func (*UtteranceStatisticsResponse) Reset

func (x *UtteranceStatisticsResponse) Reset()

func (*UtteranceStatisticsResponse) String

func (x *UtteranceStatisticsResponse) String() string

type UtterancesRequest

type UtterancesRequest struct {

	// The app_id to show the utterances for.
	AppId string `protobuf:"bytes,1,opt,name=app_id,json=appId,proto3" json:"app_id,omitempty"`
	// contains filtered or unexported fields
}

func (*UtterancesRequest) Descriptor deprecated

func (*UtterancesRequest) Descriptor() ([]byte, []int)

Deprecated: Use UtterancesRequest.ProtoReflect.Descriptor instead.

func (*UtterancesRequest) GetAppId

func (x *UtterancesRequest) GetAppId() string

func (*UtterancesRequest) ProtoMessage

func (*UtterancesRequest) ProtoMessage()

func (*UtterancesRequest) ProtoReflect

func (x *UtterancesRequest) ProtoReflect() protoreflect.Message

func (*UtterancesRequest) Reset

func (x *UtterancesRequest) Reset()

func (*UtterancesRequest) String

func (x *UtterancesRequest) String() string

type UtterancesResponse

type UtterancesResponse struct {

	// Sample of utterances.
	Utterances []*Utterance `protobuf:"bytes,1,rep,name=utterances,proto3" json:"utterances,omitempty"`
	// contains filtered or unexported fields
}

func (*UtterancesResponse) Descriptor deprecated

func (*UtterancesResponse) Descriptor() ([]byte, []int)

Deprecated: Use UtterancesResponse.ProtoReflect.Descriptor instead.

func (*UtterancesResponse) GetUtterances

func (x *UtterancesResponse) GetUtterances() []*Utterance

func (*UtterancesResponse) ProtoMessage

func (*UtterancesResponse) ProtoMessage()

func (*UtterancesResponse) ProtoReflect

func (x *UtterancesResponse) ProtoReflect() protoreflect.Message

func (*UtterancesResponse) Reset

func (x *UtterancesResponse) Reset()

func (*UtterancesResponse) String

func (x *UtterancesResponse) String() string

Jump to

Keyboard shortcuts

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