v20180711

type AppStatisticsItem struct {
	// Voice chat statistics
	// Note: This field may return null, indicating that no valid values can be obtained.
	RealtimeSpeechStatisticsItem *RealTimeSpeechStatisticsItem `json:"RealtimeSpeechStatisticsItem,omitempty" name:"RealtimeSpeechStatisticsItem"`

	// Voice messaging statistics
	// Note: This field may return null, indicating that no valid values can be obtained.
	VoiceMessageStatisticsItem *VoiceMessageStatisticsItem `json:"VoiceMessageStatisticsItem,omitempty" name:"VoiceMessageStatisticsItem"`

	// Phrase filtering statistics
	// Note: This field may return null, indicating that no valid values can be obtained.
	VoiceFilterStatisticsItem *VoiceFilterStatisticsItem `json:"VoiceFilterStatisticsItem,omitempty" name:"VoiceFilterStatisticsItem"`

	// Statistical period
	Date *string `json:"Date,omitempty" name:"Date"`
}

type ApplicationDataStatistics struct {
	// Application ID
	BizId *uint64 `json:"BizId,omitempty" name:"BizId"`

	// DAU data
	DauDataNum *uint64 `json:"DauDataNum,omitempty" name:"DauDataNum"`

	// DAU in Chinese mainland
	DauDataMainland []*StatisticsItem `json:"DauDataMainland,omitempty" name:"DauDataMainland"`

	// DAU outside Chinese mainland
	DauDataOversea []*StatisticsItem `json:"DauDataOversea,omitempty" name:"DauDataOversea"`

	// Total DAU
	DauDataSum []*StatisticsItem `json:"DauDataSum,omitempty" name:"DauDataSum"`

	// Number of voice chat metrics
	DurationDataNum *uint64 `json:"DurationDataNum,omitempty" name:"DurationDataNum"`

	// Duration of voice chat in Chinese mainland in minutes
	DurationDataMainland []*StatisticsItem `json:"DurationDataMainland,omitempty" name:"DurationDataMainland"`

	// Duration of voice chat outside Chinese mainland in minutes
	DurationDataOversea []*StatisticsItem `json:"DurationDataOversea,omitempty" name:"DurationDataOversea"`

	// Total duration of voice chat in minutes
	DurationDataSum []*StatisticsItem `json:"DurationDataSum,omitempty" name:"DurationDataSum"`

	// PCU data
	PcuDataNum *uint64 `json:"PcuDataNum,omitempty" name:"PcuDataNum"`

	// PCU in Chinese mainland
	PcuDataMainland []*StatisticsItem `json:"PcuDataMainland,omitempty" name:"PcuDataMainland"`

	// PCU outside Chinese mainland
	PcuDataOversea []*StatisticsItem `json:"PcuDataOversea,omitempty" name:"PcuDataOversea"`

	// Total PCU
	PcuDataSum []*StatisticsItem `json:"PcuDataSum,omitempty" name:"PcuDataSum"`
}

type Client struct {
	common.Client
}

type CreateAppRequest struct {
	*tchttp.BaseRequest

	// Application name
	AppName *string `json:"AppName,omitempty" name:"AppName"`

	// Tencent Cloud project ID. Default value: 0, which means the default project
	ProjectId *uint64 `json:"ProjectId,omitempty" name:"ProjectId"`

	// List of engines to be supported. All values are selected by default.
	EngineList []*string `json:"EngineList,omitempty" name:"EngineList"`

	// Service region list. All values are selected by default.
	RegionList []*string `json:"RegionList,omitempty" name:"RegionList"`

	// Configuration information of voice chat
	RealtimeSpeechConf *RealtimeSpeechConf `json:"RealtimeSpeechConf,omitempty" name:"RealtimeSpeechConf"`

	// Configuration information of voice messaging and speech-to-text
	VoiceMessageConf *VoiceMessageConf `json:"VoiceMessageConf,omitempty" name:"VoiceMessageConf"`

	// Configuration information of phrase analysis
	VoiceFilterConf *VoiceFilterConf `json:"VoiceFilterConf,omitempty" name:"VoiceFilterConf"`

	// List of tags to be added
	Tags []*Tag `json:"Tags,omitempty" name:"Tags"`
}

type CreateAppRequestParams struct {
	// Application name
	AppName *string `json:"AppName,omitempty" name:"AppName"`

	// Tencent Cloud project ID. Default value: 0, which means the default project
	ProjectId *uint64 `json:"ProjectId,omitempty" name:"ProjectId"`

	// List of engines to be supported. All values are selected by default.
	EngineList []*string `json:"EngineList,omitempty" name:"EngineList"`

	// Service region list. All values are selected by default.
	RegionList []*string `json:"RegionList,omitempty" name:"RegionList"`

	// Configuration information of voice chat
	RealtimeSpeechConf *RealtimeSpeechConf `json:"RealtimeSpeechConf,omitempty" name:"RealtimeSpeechConf"`

	// Configuration information of voice messaging and speech-to-text
	VoiceMessageConf *VoiceMessageConf `json:"VoiceMessageConf,omitempty" name:"VoiceMessageConf"`

	// Configuration information of phrase analysis
	VoiceFilterConf *VoiceFilterConf `json:"VoiceFilterConf,omitempty" name:"VoiceFilterConf"`

	// List of tags to be added
	Tags []*Tag `json:"Tags,omitempty" name:"Tags"`
}

type CreateAppResp struct {
	// App ID, automatically generated by the backend.
	BizId *uint64 `json:"BizId,omitempty" name:"BizId"`

	// App name, the input of `AppName`.
	AppName *string `json:"AppName,omitempty" name:"AppName"`

	// Project ID, the input of `ProjectId`.
	ProjectId *uint64 `json:"ProjectId,omitempty" name:"ProjectId"`

	// App key, used to initialize GME SDK.
	SecretKey *string `json:"SecretKey,omitempty" name:"SecretKey"`

	// Timestamp, indicating when the service is created.
	CreateTime *uint64 `json:"CreateTime,omitempty" name:"CreateTime"`

	// Configuration information of voice chat
	RealtimeSpeechConf *RealtimeSpeechConf `json:"RealtimeSpeechConf,omitempty" name:"RealtimeSpeechConf"`

	// Configuration information of voice messaging and speech-to-text
	VoiceMessageConf *VoiceMessageConf `json:"VoiceMessageConf,omitempty" name:"VoiceMessageConf"`

	// Configuration information of phrase analysis
	VoiceFilterConf *VoiceFilterConf `json:"VoiceFilterConf,omitempty" name:"VoiceFilterConf"`
}

type CreateAppResponse struct {
	*tchttp.BaseResponse
	Response *CreateAppResponseParams `json:"Response"`
}

type CreateAppResponseParams struct {
	// Returned data
	Data *CreateAppResp `json:"Data,omitempty" name:"Data"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

type DescribeAppStatisticsRequest struct {
	*tchttp.BaseRequest

	// GME application ID
	BizId *uint64 `json:"BizId,omitempty" name:"BizId"`

	// Data start date (GMT+8) in the format of yyyy-mm-dd, such as 2018-07-13
	StartDate *string `json:"StartDate,omitempty" name:"StartDate"`

	// Data end date (GMT+8) in the format of yyyy-mm-dd, such as 2018-07-13
	EndDate *string `json:"EndDate,omitempty" name:"EndDate"`

	// List of services to be queried. Valid values: RealTimeSpeech, VoiceMessage, VoiceFilter
	Services []*string `json:"Services,omitempty" name:"Services"`
}

type DescribeAppStatisticsRequestParams struct {
	// GME application ID
	BizId *uint64 `json:"BizId,omitempty" name:"BizId"`

	// Data start date (GMT+8) in the format of yyyy-mm-dd, such as 2018-07-13
	StartDate *string `json:"StartDate,omitempty" name:"StartDate"`

	// Data end date (GMT+8) in the format of yyyy-mm-dd, such as 2018-07-13
	EndDate *string `json:"EndDate,omitempty" name:"EndDate"`

	// List of services to be queried. Valid values: RealTimeSpeech, VoiceMessage, VoiceFilter
	Services []*string `json:"Services,omitempty" name:"Services"`
}

type DescribeAppStatisticsResp struct {
	// App usage statistics
	AppStatistics []*AppStatisticsItem `json:"AppStatistics,omitempty" name:"AppStatistics"`
}

type DescribeAppStatisticsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeAppStatisticsResponseParams `json:"Response"`
}

type DescribeAppStatisticsResponseParams struct {
	// App usage statistics
	Data *DescribeAppStatisticsResp `json:"Data,omitempty" name:"Data"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

type DescribeApplicationDataRequest struct {
	*tchttp.BaseRequest

	// Application ID
	BizId *uint64 `json:"BizId,omitempty" name:"BizId"`

	// Data start date in the format of yyyy-mm-dd, such as 2018-07-13
	StartDate *string `json:"StartDate,omitempty" name:"StartDate"`

	// Data end date in the format of yyyy-mm-dd, such as 2018-07-13
	EndDate *string `json:"EndDate,omitempty" name:"EndDate"`
}

type DescribeApplicationDataRequestParams struct {
	// Application ID
	BizId *uint64 `json:"BizId,omitempty" name:"BizId"`

	// Data start date in the format of yyyy-mm-dd, such as 2018-07-13
	StartDate *string `json:"StartDate,omitempty" name:"StartDate"`

	// Data end date in the format of yyyy-mm-dd, such as 2018-07-13
	EndDate *string `json:"EndDate,omitempty" name:"EndDate"`
}

type DescribeApplicationDataResponse struct {
	*tchttp.BaseResponse
	Response *DescribeApplicationDataResponseParams `json:"Response"`
}

type DescribeApplicationDataResponseParams struct {
	// Application statistics
	Data *ApplicationDataStatistics `json:"Data,omitempty" name:"Data"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

type DescribeScanResult struct {
	// Business return code
	Code *int64 `json:"Code,omitempty" name:"Code"`

	// Unique data ID
	DataId *string `json:"DataId,omitempty" name:"DataId"`

	// Detection completion timestamp
	ScanFinishTime *uint64 `json:"ScanFinishTime,omitempty" name:"ScanFinishTime"`

	// Whether non-compliant information is detected
	HitFlag *bool `json:"HitFlag,omitempty" name:"HitFlag"`

	// Whether it is a stream
	Live *bool `json:"Live,omitempty" name:"Live"`

	// Business return description
	// Note: this field may return null, indicating that no valid values can be obtained.
	Msg *string `json:"Msg,omitempty" name:"Msg"`

	// Detection result, which will be returned if `Code` is 0
	// Note: this field may return null, indicating that no valid values can be obtained.
	ScanPiece []*ScanPiece `json:"ScanPiece,omitempty" name:"ScanPiece"`

	// Detection task submission timestamp
	ScanStartTime *uint64 `json:"ScanStartTime,omitempty" name:"ScanStartTime"`

	// Speech detection scenario, which corresponds to the `Scene` at the time of request
	Scenes []*string `json:"Scenes,omitempty" name:"Scenes"`

	// Speech detection task ID, which is assigned by the backend
	TaskId *string `json:"TaskId,omitempty" name:"TaskId"`

	// File or stream address
	Url *string `json:"Url,omitempty" name:"Url"`

	// Detection task execution result task. Valid values:
	// <li>Start: task started</li>
	// <li>Success: task ended successfully</li>
	// <li>Error: exceptional</li>
	Status *string `json:"Status,omitempty" name:"Status"`

	// ID of the application submitted for detection
	BizId *uint64 `json:"BizId,omitempty" name:"BizId"`
}

type DescribeScanResultListRequest struct {
	*tchttp.BaseRequest

	// Application ID, which is the `AppID` obtained when you create an application in the [console](https://console.cloud.tencent.com/gamegme)
	BizId *uint64 `json:"BizId,omitempty" name:"BizId"`

	// List of IDs of the tasks to be queried. Up to 100 entries can be added in the ID list.
	TaskIdList []*string `json:"TaskIdList,omitempty" name:"TaskIdList"`

	// Number of task results to be returned. Default value: 10. Maximum value: 500. This parameter will be ignored for large file tasks where all results will be returned
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`
}

type DescribeScanResultListRequestParams struct {
	// Application ID, which is the `AppID` obtained when you create an application in the [console](https://console.cloud.tencent.com/gamegme)
	BizId *uint64 `json:"BizId,omitempty" name:"BizId"`

	// List of IDs of the tasks to be queried. Up to 100 entries can be added in the ID list.
	TaskIdList []*string `json:"TaskIdList,omitempty" name:"TaskIdList"`

	// Number of task results to be returned. Default value: 10. Maximum value: 500. This parameter will be ignored for large file tasks where all results will be returned
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`
}

type DescribeScanResultListResponse struct {
	*tchttp.BaseResponse
	Response *DescribeScanResultListResponseParams `json:"Response"`
}

type DescribeScanResultListResponseParams struct {
	// Result of the speech detection task to be queried
	// Note: this field may return null, indicating that no valid values can be obtained.
	Data []*DescribeScanResult `json:"Data,omitempty" name:"Data"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

type ModifyAppStatusRequest struct {
	*tchttp.BaseRequest

	// Application ID, which is generated and returned by the backend after application creation.
	BizId *uint64 `json:"BizId,omitempty" name:"BizId"`

	// Application status. Valid values: open, close
	Status *string `json:"Status,omitempty" name:"Status"`
}

type ModifyAppStatusRequestParams struct {
	// Application ID, which is generated and returned by the backend after application creation.
	BizId *uint64 `json:"BizId,omitempty" name:"BizId"`

	// Application status. Valid values: open, close
	Status *string `json:"Status,omitempty" name:"Status"`
}

type ModifyAppStatusResp struct {
	// GME app ID
	BizId *uint64 `json:"BizId,omitempty" name:"BizId"`

	// App status. Valid values: `open`, `close`
	Status *string `json:"Status,omitempty" name:"Status"`
}

type ModifyAppStatusResponse struct {
	*tchttp.BaseResponse
	Response *ModifyAppStatusResponseParams `json:"Response"`
}

type ModifyAppStatusResponseParams struct {
	// Returned data
	Data *ModifyAppStatusResp `json:"Data,omitempty" name:"Data"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

type RealTimeSpeechStatisticsItem struct {
	// DAU in Mainland China
	MainLandDau *uint64 `json:"MainLandDau,omitempty" name:"MainLandDau"`

	// PCU in Mainland China
	MainLandPcu *uint64 `json:"MainLandPcu,omitempty" name:"MainLandPcu"`

	// Total duration of use in Mainland China in minutes
	MainLandDuration *uint64 `json:"MainLandDuration,omitempty" name:"MainLandDuration"`

	// DAU outside Mainland China
	OverseaDau *uint64 `json:"OverseaDau,omitempty" name:"OverseaDau"`

	// PCU outside Mainland China
	OverseaPcu *uint64 `json:"OverseaPcu,omitempty" name:"OverseaPcu"`

	// Total duration of use outside Mainland China in minutes
	OverseaDuration *uint64 `json:"OverseaDuration,omitempty" name:"OverseaDuration"`
}

type RealtimeSpeechConf struct {
	// Voice chat status. Valid values: open, close
	Status *string `json:"Status,omitempty" name:"Status"`

	// Voice chat sound quality. Valid value: `high`
	Quality *string `json:"Quality,omitempty" name:"Quality"`
}

type ScanDetail struct {
	// Violation scenario. For more information, please see the definition of <a href="https://intl.cloud.tencent.com/document/product/607/37622?from_cn_redirect=1#Label_Value">Label</a>
	Label *string `json:"Label,omitempty" name:"Label"`

	// Confidence score in scenario. Value range: [0.00,100.00]. The higher the score, the more likely the content is non-compliant
	Rate *string `json:"Rate,omitempty" name:"Rate"`

	// Non-compliant keyword
	KeyWord *string `json:"KeyWord,omitempty" name:"KeyWord"`

	// Start time offset in milliseconds from 0 of keyword in audio
	StartTime *uint64 `json:"StartTime,omitempty" name:"StartTime"`

	// End time offset in milliseconds from 0 of keyword in audio
	EndTime *uint64 `json:"EndTime,omitempty" name:"EndTime"`
}

type ScanPiece struct {
	// Audio retention address, which will be returned for stream detection. The audio will be retained for 30 minutes
	// Note: this field may return null, indicating that no valid values can be obtained.
	DumpUrl *string `json:"DumpUrl,omitempty" name:"DumpUrl"`

	// Whether non-compliant information is detected
	HitFlag *bool `json:"HitFlag,omitempty" name:"HitFlag"`

	// Main non-compliant content type
	// Note: this field may return null, indicating that no valid values can be obtained.
	MainType *string `json:"MainType,omitempty" name:"MainType"`

	// Speech detection details
	ScanDetail []*ScanDetail `json:"ScanDetail,omitempty" name:"ScanDetail"`

	// GME voice chat room ID, which is the `RoomId` passed through when the task was submitted
	// Note: this field may return null, indicating that no valid values can be obtained.
	RoomId *string `json:"RoomId,omitempty" name:"RoomId"`

	// GME voice chat user ID, which is the `OpenId` passed through when the task was submitted
	// Note: this field may return null, indicating that no valid values can be obtained.
	OpenId *string `json:"OpenId,omitempty" name:"OpenId"`

	// Remarks
	// Note: this field may return null, indicating that no valid values can be obtained.
	Info *string `json:"Info,omitempty" name:"Info"`

	// Offset time in milliseconds of segment in stream during stream detection
	// Note: this field may return null, indicating that no valid values can be obtained.
	Offset *uint64 `json:"Offset,omitempty" name:"Offset"`

	// Segment duration during stream detection
	// Note: this field may return null, indicating that no valid values can be obtained.
	Duration *uint64 `json:"Duration,omitempty" name:"Duration"`

	// Segment detection start time
	// Note: this field may return null, indicating that no valid values can be obtained.
	PieceStartTime *uint64 `json:"PieceStartTime,omitempty" name:"PieceStartTime"`
}

type ScanVoiceRequest struct {
	*tchttp.BaseRequest

	// Application ID, which is the `AppID` obtained when you create an application in [Console > Service Management](https://console.cloud.tencent.com/gamegme)
	BizId *uint64 `json:"BizId,omitempty" name:"BizId"`

	// Speech detection scenario. The value of this parameter is currently required to be `default`. Preset scenarios: abusive, pornographic, advertising, and other prohibited scenarios. For specific values, please see the <a href="#Label_Value">Label description</a> above.
	Scenes []*string `json:"Scenes,omitempty" name:"Scenes"`

	// Whether it is a live stream. false: audio file detection, true: audio stream detection.
	Live *bool `json:"Live,omitempty" name:"Live"`

	// Speech detection task list. Up to 100 tasks can be added in the list. The structure contains:
	// <li>DataId: unique data ID</li>
	// <li>Url: URL-encoded data file URL, which is a pull address if the detected speech is a stream</li>
	Tasks []*Task `json:"Tasks,omitempty" name:"Tasks"`

	// Async callback address for detection result. For more information, please see the <a href="#Callback_Declare">callback description</a> above. (Note: if this field is empty, the detection result can only be obtained by calling the `DescribeScanResultList` API.)
	Callback *string `json:"Callback,omitempty" name:"Callback"`

	// The language. `jp` represents Japanese
	Lang *string `json:"Lang,omitempty" name:"Lang"`
}

type ScanVoiceRequestParams struct {
	// Application ID, which is the `AppID` obtained when you create an application in [Console > Service Management](https://console.cloud.tencent.com/gamegme)
	BizId *uint64 `json:"BizId,omitempty" name:"BizId"`

	// Speech detection scenario. The value of this parameter is currently required to be `default`. Preset scenarios: abusive, pornographic, advertising, and other prohibited scenarios. For specific values, please see the <a href="#Label_Value">Label description</a> above.
	Scenes []*string `json:"Scenes,omitempty" name:"Scenes"`

	// Whether it is a live stream. false: audio file detection, true: audio stream detection.
	Live *bool `json:"Live,omitempty" name:"Live"`

	// Speech detection task list. Up to 100 tasks can be added in the list. The structure contains:
	// <li>DataId: unique data ID</li>
	// <li>Url: URL-encoded data file URL, which is a pull address if the detected speech is a stream</li>
	Tasks []*Task `json:"Tasks,omitempty" name:"Tasks"`

	// Async callback address for detection result. For more information, please see the <a href="#Callback_Declare">callback description</a> above. (Note: if this field is empty, the detection result can only be obtained by calling the `DescribeScanResultList` API.)
	Callback *string `json:"Callback,omitempty" name:"Callback"`

	// The language. `jp` represents Japanese
	Lang *string `json:"Lang,omitempty" name:"Lang"`
}

type ScanVoiceResponse struct {
	*tchttp.BaseResponse
	Response *ScanVoiceResponseParams `json:"Response"`
}

type ScanVoiceResponseParams struct {
	// Speech detection return. The `Data` field is a JSON array where each element contains: <li>DataId: corresponding `DataId` in request.</li>
	// <li>TaskID: detection task ID, which is used to poll the speech detection result.</li>
	Data []*ScanVoiceResult `json:"Data,omitempty" name:"Data"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

type ScanVoiceResult struct {
	// Data ID
	DataId *string `json:"DataId,omitempty" name:"DataId"`

	// Task ID
	TaskId *string `json:"TaskId,omitempty" name:"TaskId"`
}

type StatisticsItem struct {
	// Date in the format of yyyy-mm-dd, such as 2018-07-13
	StatDate *string `json:"StatDate,omitempty" name:"StatDate"`

	// Statistics
	Data *uint64 `json:"Data,omitempty" name:"Data"`
}

type Tag struct {
	// Tag key
	// Note: This field may return null, indicating that no valid values can be obtained.
	TagKey *string `json:"TagKey,omitempty" name:"TagKey"`

	// Tag value
	// Note: This field may return null, indicating that no valid values can be obtained.
	TagValue *string `json:"TagValue,omitempty" name:"TagValue"`
}

type Task struct {
	// Unique data ID
	DataId *string `json:"DataId,omitempty" name:"DataId"`

	// URL-encoded data file URL, which is a pull address if the detected speech is a stream
	Url *string `json:"Url,omitempty" name:"Url"`

	// GME voice chat room ID, which is entered during speech detection by GME voice chat
	RoomId *string `json:"RoomId,omitempty" name:"RoomId"`

	// GME voice chat user ID, which is entered during speech detection by GME voice chat
	OpenId *string `json:"OpenId,omitempty" name:"OpenId"`
}

type VoiceFilterConf struct {
	// Phrase filtering status. Valid values: open, close
	Status *string `json:"Status,omitempty" name:"Status"`
}

type VoiceFilterStatisticsItem struct {
	// Total duration of phrase filtering
	Duration *uint64 `json:"Duration,omitempty" name:"Duration"`
}

type VoiceMessageConf struct {
	// Voice messaging and speech-to-text status. Valid values: open, close
	Status *string `json:"Status,omitempty" name:"Status"`

	// Language supported for voice messaging and speech-to-text. Valid values: all (all languages), cnen (Chinese and English). Default value: cnen
	Language *string `json:"Language,omitempty" name:"Language"`
}

type VoiceMessageStatisticsItem struct {
	// DAU of voice messaging and speech-to-text
	Dau *uint64 `json:"Dau,omitempty" name:"Dau"`
}