Documentation ¶
Index ¶
- Constants
- type AppStatisticsItem
- type ApplicationDataStatistics
- type AudioTextStatisticsItem
- type Client
- func (c *Client) CreateApp(request *CreateAppRequest) (response *CreateAppResponse, err error)
- func (c *Client) CreateAppWithContext(ctx context.Context, request *CreateAppRequest) (response *CreateAppResponse, err error)
- func (c *Client) DeleteRoomMember(request *DeleteRoomMemberRequest) (response *DeleteRoomMemberResponse, err error)
- func (c *Client) DeleteRoomMemberWithContext(ctx context.Context, request *DeleteRoomMemberRequest) (response *DeleteRoomMemberResponse, err error)
- func (c *Client) DescribeAppStatistics(request *DescribeAppStatisticsRequest) (response *DescribeAppStatisticsResponse, err error)
- func (c *Client) DescribeAppStatisticsWithContext(ctx context.Context, request *DescribeAppStatisticsRequest) (response *DescribeAppStatisticsResponse, err error)
- func (c *Client) DescribeApplicationData(request *DescribeApplicationDataRequest) (response *DescribeApplicationDataResponse, err error)
- func (c *Client) DescribeApplicationDataWithContext(ctx context.Context, request *DescribeApplicationDataRequest) (response *DescribeApplicationDataResponse, err error)
- func (c *Client) DescribeScanResultList(request *DescribeScanResultListRequest) (response *DescribeScanResultListResponse, err error)
- func (c *Client) DescribeScanResultListWithContext(ctx context.Context, request *DescribeScanResultListRequest) (response *DescribeScanResultListResponse, err error)
- func (c *Client) ModifyAppStatus(request *ModifyAppStatusRequest) (response *ModifyAppStatusResponse, err error)
- func (c *Client) ModifyAppStatusWithContext(ctx context.Context, request *ModifyAppStatusRequest) (response *ModifyAppStatusResponse, err error)
- func (c *Client) ScanVoice(request *ScanVoiceRequest) (response *ScanVoiceResponse, err error)
- func (c *Client) ScanVoiceWithContext(ctx context.Context, request *ScanVoiceRequest) (response *ScanVoiceResponse, err error)
- type CreateAppRequest
- type CreateAppRequestParams
- type CreateAppResp
- type CreateAppResponse
- type CreateAppResponseParams
- type DeleteResult
- type DeleteRoomMemberRequest
- type DeleteRoomMemberRequestParams
- type DeleteRoomMemberResponse
- type DeleteRoomMemberResponseParams
- type DescribeAppStatisticsRequest
- type DescribeAppStatisticsRequestParams
- type DescribeAppStatisticsResp
- type DescribeAppStatisticsResponse
- type DescribeAppStatisticsResponseParams
- type DescribeApplicationDataRequest
- type DescribeApplicationDataRequestParams
- type DescribeApplicationDataResponse
- type DescribeApplicationDataResponseParams
- type DescribeScanResult
- type DescribeScanResultListRequest
- type DescribeScanResultListRequestParams
- type DescribeScanResultListResponse
- type DescribeScanResultListResponseParams
- type ModifyAppStatusRequest
- type ModifyAppStatusRequestParams
- type ModifyAppStatusResp
- type ModifyAppStatusResponse
- type ModifyAppStatusResponseParams
- type OverseaTextStatisticsItem
- type RealTimeSpeechStatisticsItem
- type RealtimeSpeechConf
- type RealtimeTextStatisticsItem
- type ScanDetail
- type ScanPiece
- type ScanVoiceRequest
- type ScanVoiceRequestParams
- type ScanVoiceResponse
- type ScanVoiceResponseParams
- type ScanVoiceResult
- type StatisticsItem
- type StreamTextStatisticsItem
- type Tag
- type Task
- type VoiceFilterConf
- type VoiceFilterStatisticsItem
- type VoiceMessageConf
- type VoiceMessageStatisticsItem
Constants ¶
const ( // Operation failed. FAILEDOPERATION = "FailedOperation" // Operation not allowed as your account is in arrears. FAILEDOPERATION_USERFEENEGATIVE = "FailedOperation.UserFeeNegative" // Internal error. INTERNALERROR = "InternalError" // Incorrect parameter. INVALIDPARAMETER = "InvalidParameter" // Incorrect callback URL. INVALIDPARAMETER_CALLBACKADDRESS = "InvalidParameter.CallbackAddress" // Invalid date. INVALIDPARAMETER_DATEINVALID = "InvalidParameter.DateInvalid" // Incorrect tag. INVALIDPARAMETER_TAGKEY = "InvalidParameter.TagKey" // Incorrect query time range. INVALIDPARAMETER_TIMERANGEERROR = "InvalidParameter.TimeRangeError" // The number of created applications has reached the upper limit. LIMITEXCEEDED_APPLICATION = "LimitExceeded.Application" // Parameter missing. MISSINGPARAMETER = "MissingParameter" // Operation denied. OPERATIONDENIED = "OperationDenied" // The resource does not exist. RESOURCENOTFOUND = "ResourceNotFound" // Incorrect application ID. RESOURCENOTFOUND_BIZIDISNOTFOUND = "ResourceNotFound.BizidIsNotFound" // The resource is unavailable. RESOURCEUNAVAILABLE = "ResourceUnavailable" // Unauthorized operation. UNAUTHORIZEDOPERATION = "UnauthorizedOperation" // Application creation is not authorized. UNAUTHORIZEDOPERATION_CREATEAPPDENIED = "UnauthorizedOperation.CreateAppDenied" // Unverified user. UNAUTHORIZEDOPERATION_UNREALNAMEAUTH = "UnauthorizedOperation.UnRealNameAuth" // Unknown parameter error. UNKNOWNPARAMETER = "UnknownParameter" // Operation unsupported. UNSUPPORTEDOPERATION = "UnsupportedOperation" )
const APIVersion = "2018-07-11"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AppStatisticsItem ¶
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 Message 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"` // Reference period Date *string `json:"Date,omitempty" name:"Date"` // Recording-to-Text usage statistics // Note: This field may return `null`, indicating that no valid values can be obtained. AudioTextStatisticsItem *AudioTextStatisticsItem `json:"AudioTextStatisticsItem,omitempty" name:"AudioTextStatisticsItem"` // Stream-to-Text usage statistics // Note: This field may return `null`, indicating that no valid values can be obtained. StreamTextStatisticsItem *StreamTextStatisticsItem `json:"StreamTextStatisticsItem,omitempty" name:"StreamTextStatisticsItem"` // Usage statistics of Voice-to-Text of outside-MLC requests // Note: This field may return `null`, indicating that no valid values can be obtained. OverseaTextStatisticsItem *OverseaTextStatisticsItem `json:"OverseaTextStatisticsItem,omitempty" name:"OverseaTextStatisticsItem"` // Real-time Voice-to-Text usage statistics // Note: This field may return `null`, indicating that no valid values can be obtained. RealtimeTextStatisticsItem *RealtimeTextStatisticsItem `json:"RealtimeTextStatisticsItem,omitempty" name:"RealtimeTextStatisticsItem"` }
type ApplicationDataStatistics ¶
type ApplicationDataStatistics struct { // Application ID BizId *uint64 `json:"BizId,omitempty" name:"BizId"` // Number of DAU metrics DauDataNum *uint64 `json:"DauDataNum,omitempty" name:"DauDataNum"` // DAUs in the Chinese mainland DauDataMainland []*StatisticsItem `json:"DauDataMainland,omitempty" name:"DauDataMainland"` // DAUs outside the Chinese mainland DauDataOversea []*StatisticsItem `json:"DauDataOversea,omitempty" name:"DauDataOversea"` // Total DAUs DauDataSum []*StatisticsItem `json:"DauDataSum,omitempty" name:"DauDataSum"` // Number of Voice Chat metrics DurationDataNum *uint64 `json:"DurationDataNum,omitempty" name:"DurationDataNum"` // Duration of Voice Chat in the Chinese mainland (in minutes) DurationDataMainland []*StatisticsItem `json:"DurationDataMainland,omitempty" name:"DurationDataMainland"` // Duration of Voice Chat outside the 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"` // Number of PCU metrics PcuDataNum *uint64 `json:"PcuDataNum,omitempty" name:"PcuDataNum"` // PCUs in the Chinese mainland PcuDataMainland []*StatisticsItem `json:"PcuDataMainland,omitempty" name:"PcuDataMainland"` // PCUs outside the Chinese mainland PcuDataOversea []*StatisticsItem `json:"PcuDataOversea,omitempty" name:"PcuDataOversea"` // Total PCUs PcuDataSum []*StatisticsItem `json:"PcuDataSum,omitempty" name:"PcuDataSum"` }
type AudioTextStatisticsItem ¶
type AudioTextStatisticsItem struct { // Statistical value (in seconds) // Note: This field may return `null`, indicating that no valid values can be obtained. Data *float64 `json:"Data,omitempty" name:"Data"` }
type Client ¶
func NewClient ¶
func NewClient(credential common.CredentialIface, region string, clientProfile *profile.ClientProfile) (client *Client, err error)
func NewClientWithSecretId ¶
Deprecated
func (*Client) CreateApp ¶
func (c *Client) CreateApp(request *CreateAppRequest) (response *CreateAppResponse, err error)
CreateApp This API is used to create a GME application.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_USERFEENEGATIVE = "FailedOperation.UserFeeNegative" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_TAGKEY = "InvalidParameter.TagKey" LIMITEXCEEDED_APPLICATION = "LimitExceeded.Application" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNAUTHORIZEDOPERATION_CREATEAPPDENIED = "UnauthorizedOperation.CreateAppDenied" UNAUTHORIZEDOPERATION_UNREALNAMEAUTH = "UnauthorizedOperation.UnRealNameAuth" UNKNOWNPARAMETER = "UnknownParameter" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) CreateAppWithContext ¶
func (c *Client) CreateAppWithContext(ctx context.Context, request *CreateAppRequest) (response *CreateAppResponse, err error)
CreateApp This API is used to create a GME application.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_USERFEENEGATIVE = "FailedOperation.UserFeeNegative" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_TAGKEY = "InvalidParameter.TagKey" LIMITEXCEEDED_APPLICATION = "LimitExceeded.Application" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNAUTHORIZEDOPERATION_CREATEAPPDENIED = "UnauthorizedOperation.CreateAppDenied" UNAUTHORIZEDOPERATION_UNREALNAMEAUTH = "UnauthorizedOperation.UnRealNameAuth" UNKNOWNPARAMETER = "UnknownParameter" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) DeleteRoomMember ¶
func (c *Client) DeleteRoomMember(request *DeleteRoomMemberRequest) (response *DeleteRoomMemberResponse, err error)
DeleteRoomMember This API is used to delete a room or remove members from the room.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" RESOURCENOTFOUND = "ResourceNotFound" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) DeleteRoomMemberWithContext ¶
func (c *Client) DeleteRoomMemberWithContext(ctx context.Context, request *DeleteRoomMemberRequest) (response *DeleteRoomMemberResponse, err error)
DeleteRoomMember This API is used to delete a room or remove members from the room.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" RESOURCENOTFOUND = "ResourceNotFound" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) DescribeAppStatistics ¶
func (c *Client) DescribeAppStatistics(request *DescribeAppStatisticsRequest) (response *DescribeAppStatisticsResponse, err error)
DescribeAppStatistics This API is used to query the usage statistics of a GME application, including those of Voice Chat, Voice Message Service, Voice Analysis, etc. The maximum query period is the past 30 days.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_DATEINVALID = "InvalidParameter.DateInvalid" INVALIDPARAMETER_TIMERANGEERROR = "InvalidParameter.TimeRangeError" RESOURCENOTFOUND = "ResourceNotFound" RESOURCENOTFOUND_BIZIDISNOTFOUND = "ResourceNotFound.BizidIsNotFound" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNKNOWNPARAMETER = "UnknownParameter" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) DescribeAppStatisticsWithContext ¶
func (c *Client) DescribeAppStatisticsWithContext(ctx context.Context, request *DescribeAppStatisticsRequest) (response *DescribeAppStatisticsResponse, err error)
DescribeAppStatistics This API is used to query the usage statistics of a GME application, including those of Voice Chat, Voice Message Service, Voice Analysis, etc. The maximum query period is the past 30 days.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_DATEINVALID = "InvalidParameter.DateInvalid" INVALIDPARAMETER_TIMERANGEERROR = "InvalidParameter.TimeRangeError" RESOURCENOTFOUND = "ResourceNotFound" RESOURCENOTFOUND_BIZIDISNOTFOUND = "ResourceNotFound.BizidIsNotFound" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNKNOWNPARAMETER = "UnknownParameter" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) DescribeApplicationData ¶
func (c *Client) DescribeApplicationData(request *DescribeApplicationDataRequest) (response *DescribeApplicationDataResponse, err error)
DescribeApplicationData This API is used to query data details for up to the past 90 days.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" RESOURCENOTFOUND = "ResourceNotFound" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) DescribeApplicationDataWithContext ¶
func (c *Client) DescribeApplicationDataWithContext(ctx context.Context, request *DescribeApplicationDataRequest) (response *DescribeApplicationDataResponse, err error)
DescribeApplicationData This API is used to query data details for up to the past 90 days.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" RESOURCENOTFOUND = "ResourceNotFound" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) DescribeScanResultList ¶
func (c *Client) DescribeScanResultList(request *DescribeScanResultListRequest) (response *DescribeScanResultListResponse, err error)
DescribeScanResultList This API is used to query the result of voice moderation tasks. Up to 100 tasks can be queried in one time.
<p style="color:red">If the `Callback` field is not set when a voice moderation task is submitted, this API is called to query the moderation result.</p>
error code that may be returned:
FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_TAGKEY = "InvalidParameter.TagKey" MISSINGPARAMETER = "MissingParameter" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNKNOWNPARAMETER = "UnknownParameter" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) DescribeScanResultListWithContext ¶
func (c *Client) DescribeScanResultListWithContext(ctx context.Context, request *DescribeScanResultListRequest) (response *DescribeScanResultListResponse, err error)
DescribeScanResultList This API is used to query the result of voice moderation tasks. Up to 100 tasks can be queried in one time.
<p style="color:red">If the `Callback` field is not set when a voice moderation task is submitted, this API is called to query the moderation result.</p>
error code that may be returned:
FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_TAGKEY = "InvalidParameter.TagKey" MISSINGPARAMETER = "MissingParameter" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNKNOWNPARAMETER = "UnknownParameter" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) ModifyAppStatus ¶
func (c *Client) ModifyAppStatus(request *ModifyAppStatusRequest) (response *ModifyAppStatusResponse, err error)
ModifyAppStatus This API is used to change the status of an application.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_USERFEENEGATIVE = "FailedOperation.UserFeeNegative" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" MISSINGPARAMETER = "MissingParameter" RESOURCENOTFOUND = "ResourceNotFound" RESOURCENOTFOUND_BIZIDISNOTFOUND = "ResourceNotFound.BizidIsNotFound" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNKNOWNPARAMETER = "UnknownParameter" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) ModifyAppStatusWithContext ¶
func (c *Client) ModifyAppStatusWithContext(ctx context.Context, request *ModifyAppStatusRequest) (response *ModifyAppStatusResponse, err error)
ModifyAppStatus This API is used to change the status of an application.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_USERFEENEGATIVE = "FailedOperation.UserFeeNegative" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" MISSINGPARAMETER = "MissingParameter" RESOURCENOTFOUND = "ResourceNotFound" RESOURCENOTFOUND_BIZIDISNOTFOUND = "ResourceNotFound.BizidIsNotFound" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNKNOWNPARAMETER = "UnknownParameter" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) ScanVoice ¶
func (c *Client) ScanVoice(request *ScanVoiceRequest) (response *ScanVoiceResponse, err error)
ScanVoice This API is used to submit a voice detection task. Up to 100 tasks can be added in the detection task list. Before using this API, please activate the Voice Content Moderation Service in [GME Console > Voice Content Moderation > Service Configuration](https://console.cloud.tencent.com/gamegme/conf).
</br></br>
<h4><b>About the trial:</b></h4>
<li>You can try out the Voice Content Moderation Service free of charge in <a href="https://console.cloud.tencent.com/gamegme/tryout">GME Console > Voice Content Moderation > Product Trial</a>.</li>
</br>
<h4><b>API feature description:</b></h4>
<li>This API checks voice streams or files for non-compliant content.</li>
<li>The detection result can be queried by setting the callback address (`Callback`) or calling the `DescribeScanResultList` API for polling.</li>
<li>The scenario can be specified, such as abusive or pornographic.</li>
<li>Detection tasks can be submitted in batches. Up to 100 tasks can be added in the detection task list.</li>
</br>
<h4><b>Audio file limits:</b></h4>
<li>Audio file size limit: 100 MB</li>
<li>Audio file duration limit: 30 minutes</li>
<li>Supported audio file formats: .wav, .m4a, .amr, .mp3, .aac, .wma, .ogg</li>
</br>
<h4><b>Voice stream limits:</b></h4>
<li>Supported voice stream formats: .m3u8, .flv</li>
<li>Supported voice stream transfer protocols: RTMP, HTTP, HTTPS</li>
<li>Voice stream duration limit: 4 hours</li>
<li>Audio/video stream separation and audio stream analysis are supported</li>
</br>
<h4 id="Label_Value"><b>`Scenes` and `Label` parameter description:</b></h4>
<p>When submitting a voice detection task, you need to specify the `Scenes` parameter. <font color="red">You are currently required to set the `Scenes` parameter to `["default"]`</font>. The detection result will contain the scenario specified at the time of request and detection result in the corresponding type.</p>
<table>
<thread>
<tr>
<th>Scenario</th>
<th>Description</th>
<th>Label</th>
</tr>
</thread>
<tbody>
<tr>
<td>Voice detection</td>
<td>Voice detection type</td>
<td>
<p>normal: Normal</p>
<p>porn: Pornographic</p>
<p>abuse: Abusive</p>
<p>ad: Advertising</p>
<p>illegal: Illegal</p>
<p>moan: Moaning </p>
<p>customized: Custom dictionary</p>
</td>
</tr>
</tbody>
</table>
</br>
<h4 id="Callback_Declare"><b>Callback description:</b></h4>
<li>If the callback address parameter `Callback` (i.e., the URL of an HTTP(S) API) is specified in the request parameters, then the POST method should be supported and transferred data should be encoded with UTF-8.</li>
<li>After the callback data is pushed, if the HTTP status code received is 200, the push is successful.</li>
<li>HTTP header parameter description:</li>
<table>
<thread>
<tr>
<th>Item</th>
<th>Type</th>
<th>Required</th>
<th>Description</th>
</tr>
</thread>
<tbody>
<tr>
<td>Signatue</td>
<td>string</td>
<td>Yes</td>
<td>Signature. For more information, please see <a href="#Callback_Signatue">Signature generation description</a>.</td>
</tr>
</tbody>
</table>
<ul id="Callback_Signatue">
<li>Signature generation description:</li> <ul> <li>The HMAC-SH1 algorithm should be used, and the result should be encoded with Base64;</li> <li>The original signature string is the entire JSON content of POST and body (the length is subject to `Content-Length`);</li> <li>The signature key is the `SecretKey` of the application, which can be viewed in the console.</li> </ul>
</ul>
<li>Sample callback <font color="red">(for more information on the fields, please see the structure:
<a href="https://intl.cloud.tencent.com/document/api/607/35375?from_cn_redirect=1#DescribeScanResult" target="_blank">DescribeScanResult</a>)</font>:</li>
<pre><code>{
"Code": 0, "DataId": "1400000000_test_data_id", "ScanFinishTime": 1566720906, "HitFlag": true, "Live": false, "Msg": "", "ScanPiece": [{ "DumpUrl": "", "HitFlag": true, "MainType": "abuse", "RoomId": "123", "OpenId": "xxx", "Info":"", "Offset": 0, "Duration": 3400, "PieceStartTime":1574684231, "ScanDetail": [{ "EndTime": 1110, "KeyWord": "xxx", "Label": "abuse", "Rate": "90.00", "StartTime": 1110 }, { "EndTime": 1380, "KeyWord": "xxx", "Label": "abuse", "Rate": "90.00", "StartTime": 930 }, { "EndTime": 1560, "KeyWord": "xxx", "Label": "abuse", "Rate": "90.00", "StartTime": 930 }, { "EndTime": 2820, "KeyWord": "xxx", "Label": "abuse", "Rate": "90.00", "StartTime": 2490 }] }], "ScanStartTime": 1566720905, "Scenes": [ "default" ], "Status": "Success", "TaskId": "xxx", "Url": "https://xxx/xxx.m4a"
}
</code></pre>
error code that may be returned:
FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_CALLBACKADDRESS = "InvalidParameter.CallbackAddress" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNKNOWNPARAMETER = "UnknownParameter" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) ScanVoiceWithContext ¶
func (c *Client) ScanVoiceWithContext(ctx context.Context, request *ScanVoiceRequest) (response *ScanVoiceResponse, err error)
ScanVoice This API is used to submit a voice detection task. Up to 100 tasks can be added in the detection task list. Before using this API, please activate the Voice Content Moderation Service in [GME Console > Voice Content Moderation > Service Configuration](https://console.cloud.tencent.com/gamegme/conf).
</br></br>
<h4><b>About the trial:</b></h4>
<li>You can try out the Voice Content Moderation Service free of charge in <a href="https://console.cloud.tencent.com/gamegme/tryout">GME Console > Voice Content Moderation > Product Trial</a>.</li>
</br>
<h4><b>API feature description:</b></h4>
<li>This API checks voice streams or files for non-compliant content.</li>
<li>The detection result can be queried by setting the callback address (`Callback`) or calling the `DescribeScanResultList` API for polling.</li>
<li>The scenario can be specified, such as abusive or pornographic.</li>
<li>Detection tasks can be submitted in batches. Up to 100 tasks can be added in the detection task list.</li>
</br>
<h4><b>Audio file limits:</b></h4>
<li>Audio file size limit: 100 MB</li>
<li>Audio file duration limit: 30 minutes</li>
<li>Supported audio file formats: .wav, .m4a, .amr, .mp3, .aac, .wma, .ogg</li>
</br>
<h4><b>Voice stream limits:</b></h4>
<li>Supported voice stream formats: .m3u8, .flv</li>
<li>Supported voice stream transfer protocols: RTMP, HTTP, HTTPS</li>
<li>Voice stream duration limit: 4 hours</li>
<li>Audio/video stream separation and audio stream analysis are supported</li>
</br>
<h4 id="Label_Value"><b>`Scenes` and `Label` parameter description:</b></h4>
<p>When submitting a voice detection task, you need to specify the `Scenes` parameter. <font color="red">You are currently required to set the `Scenes` parameter to `["default"]`</font>. The detection result will contain the scenario specified at the time of request and detection result in the corresponding type.</p>
<table>
<thread>
<tr>
<th>Scenario</th>
<th>Description</th>
<th>Label</th>
</tr>
</thread>
<tbody>
<tr>
<td>Voice detection</td>
<td>Voice detection type</td>
<td>
<p>normal: Normal</p>
<p>porn: Pornographic</p>
<p>abuse: Abusive</p>
<p>ad: Advertising</p>
<p>illegal: Illegal</p>
<p>moan: Moaning </p>
<p>customized: Custom dictionary</p>
</td>
</tr>
</tbody>
</table>
</br>
<h4 id="Callback_Declare"><b>Callback description:</b></h4>
<li>If the callback address parameter `Callback` (i.e., the URL of an HTTP(S) API) is specified in the request parameters, then the POST method should be supported and transferred data should be encoded with UTF-8.</li>
<li>After the callback data is pushed, if the HTTP status code received is 200, the push is successful.</li>
<li>HTTP header parameter description:</li>
<table>
<thread>
<tr>
<th>Item</th>
<th>Type</th>
<th>Required</th>
<th>Description</th>
</tr>
</thread>
<tbody>
<tr>
<td>Signatue</td>
<td>string</td>
<td>Yes</td>
<td>Signature. For more information, please see <a href="#Callback_Signatue">Signature generation description</a>.</td>
</tr>
</tbody>
</table>
<ul id="Callback_Signatue">
<li>Signature generation description:</li> <ul> <li>The HMAC-SH1 algorithm should be used, and the result should be encoded with Base64;</li> <li>The original signature string is the entire JSON content of POST and body (the length is subject to `Content-Length`);</li> <li>The signature key is the `SecretKey` of the application, which can be viewed in the console.</li> </ul>
</ul>
<li>Sample callback <font color="red">(for more information on the fields, please see the structure:
<a href="https://intl.cloud.tencent.com/document/api/607/35375?from_cn_redirect=1#DescribeScanResult" target="_blank">DescribeScanResult</a>)</font>:</li>
<pre><code>{
"Code": 0, "DataId": "1400000000_test_data_id", "ScanFinishTime": 1566720906, "HitFlag": true, "Live": false, "Msg": "", "ScanPiece": [{ "DumpUrl": "", "HitFlag": true, "MainType": "abuse", "RoomId": "123", "OpenId": "xxx", "Info":"", "Offset": 0, "Duration": 3400, "PieceStartTime":1574684231, "ScanDetail": [{ "EndTime": 1110, "KeyWord": "xxx", "Label": "abuse", "Rate": "90.00", "StartTime": 1110 }, { "EndTime": 1380, "KeyWord": "xxx", "Label": "abuse", "Rate": "90.00", "StartTime": 930 }, { "EndTime": 1560, "KeyWord": "xxx", "Label": "abuse", "Rate": "90.00", "StartTime": 930 }, { "EndTime": 2820, "KeyWord": "xxx", "Label": "abuse", "Rate": "90.00", "StartTime": 2490 }] }], "ScanStartTime": 1566720905, "Scenes": [ "default" ], "Status": "Success", "TaskId": "xxx", "Url": "https://xxx/xxx.m4a"
}
</code></pre>
error code that may be returned:
FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_CALLBACKADDRESS = "InvalidParameter.CallbackAddress" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNKNOWNPARAMETER = "UnknownParameter" UNSUPPORTEDOPERATION = "UnsupportedOperation"
type CreateAppRequest ¶
type CreateAppRequest struct { *tchttp.BaseRequest // Application name AppName *string `json:"AppName,omitempty" name:"AppName"` // Tencent Cloud project ID. Default value: 0, which means that the default project is used. 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 Message Service VoiceMessageConf *VoiceMessageConf `json:"VoiceMessageConf,omitempty" name:"VoiceMessageConf"` // Configuration information of Voice Analysis Service VoiceFilterConf *VoiceFilterConf `json:"VoiceFilterConf,omitempty" name:"VoiceFilterConf"` // List of tags to be added Tags []*Tag `json:"Tags,omitempty" name:"Tags"` }
func NewCreateAppRequest ¶
func NewCreateAppRequest() (request *CreateAppRequest)
func (*CreateAppRequest) FromJsonString ¶
func (r *CreateAppRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateAppRequest) ToJsonString ¶
func (r *CreateAppRequest) ToJsonString() string
type CreateAppRequestParams ¶
type CreateAppRequestParams struct { // Application name AppName *string `json:"AppName,omitempty" name:"AppName"` // Tencent Cloud project ID. Default value: 0, which means that the default project is used. 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 Message Service VoiceMessageConf *VoiceMessageConf `json:"VoiceMessageConf,omitempty" name:"VoiceMessageConf"` // Configuration information of Voice Analysis Service VoiceFilterConf *VoiceFilterConf `json:"VoiceFilterConf,omitempty" name:"VoiceFilterConf"` // List of tags to be added Tags []*Tag `json:"Tags,omitempty" name:"Tags"` }
Predefined struct for user
type CreateAppResp ¶
type CreateAppResp struct { // Application ID, automatically generated by the backend. BizId *uint64 `json:"BizId,omitempty" name:"BizId"` // Application 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"` // Application 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 Message Service VoiceMessageConf *VoiceMessageConf `json:"VoiceMessageConf,omitempty" name:"VoiceMessageConf"` // Configuration information of Voice Analysis Service VoiceFilterConf *VoiceFilterConf `json:"VoiceFilterConf,omitempty" name:"VoiceFilterConf"` }
type CreateAppResponse ¶
type CreateAppResponse struct { *tchttp.BaseResponse Response *CreateAppResponseParams `json:"Response"` }
func NewCreateAppResponse ¶
func NewCreateAppResponse() (response *CreateAppResponse)
func (*CreateAppResponse) FromJsonString ¶
func (r *CreateAppResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateAppResponse) ToJsonString ¶
func (r *CreateAppResponse) ToJsonString() string
type CreateAppResponseParams ¶
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"` }
Predefined struct for user
type DeleteResult ¶
type DeleteRoomMemberRequest ¶
type DeleteRoomMemberRequest struct { *tchttp.BaseRequest // ID of the target room RoomId *string `json:"RoomId,omitempty" name:"RoomId"` // List of the members to remove Uids []*string `json:"Uids,omitempty" name:"Uids"` // Operation type. `1`: Delete a room; `2`: Remove members DeleteType *uint64 `json:"DeleteType,omitempty" name:"DeleteType"` // Application ID BizId *uint64 `json:"BizId,omitempty" name:"BizId"` }
func NewDeleteRoomMemberRequest ¶
func NewDeleteRoomMemberRequest() (request *DeleteRoomMemberRequest)
func (*DeleteRoomMemberRequest) FromJsonString ¶
func (r *DeleteRoomMemberRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteRoomMemberRequest) ToJsonString ¶
func (r *DeleteRoomMemberRequest) ToJsonString() string
type DeleteRoomMemberRequestParams ¶
type DeleteRoomMemberRequestParams struct { // ID of the target room RoomId *string `json:"RoomId,omitempty" name:"RoomId"` // List of the members to remove Uids []*string `json:"Uids,omitempty" name:"Uids"` // Operation type. `1`: Delete a room; `2`: Remove members DeleteType *uint64 `json:"DeleteType,omitempty" name:"DeleteType"` // Application ID BizId *uint64 `json:"BizId,omitempty" name:"BizId"` }
Predefined struct for user
type DeleteRoomMemberResponse ¶
type DeleteRoomMemberResponse struct { *tchttp.BaseResponse Response *DeleteRoomMemberResponseParams `json:"Response"` }
func NewDeleteRoomMemberResponse ¶
func NewDeleteRoomMemberResponse() (response *DeleteRoomMemberResponse)
func (*DeleteRoomMemberResponse) FromJsonString ¶
func (r *DeleteRoomMemberResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteRoomMemberResponse) ToJsonString ¶
func (r *DeleteRoomMemberResponse) ToJsonString() string
type DeleteRoomMemberResponseParams ¶
type DeleteRoomMemberResponseParams struct { // Result of the operation to delete a room or remove a member DeleteResult *DeleteResult `json:"DeleteResult,omitempty" name:"DeleteResult"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` }
Predefined struct for user
type DescribeAppStatisticsRequest ¶
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`, `SpeechToText`. Services []*string `json:"Services,omitempty" name:"Services"` }
func NewDescribeAppStatisticsRequest ¶
func NewDescribeAppStatisticsRequest() (request *DescribeAppStatisticsRequest)
func (*DescribeAppStatisticsRequest) FromJsonString ¶
func (r *DescribeAppStatisticsRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeAppStatisticsRequest) ToJsonString ¶
func (r *DescribeAppStatisticsRequest) ToJsonString() string
type DescribeAppStatisticsRequestParams ¶
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`, `SpeechToText`. Services []*string `json:"Services,omitempty" name:"Services"` }
Predefined struct for user
type DescribeAppStatisticsResp ¶
type DescribeAppStatisticsResp struct { // Application usage statistics AppStatistics []*AppStatisticsItem `json:"AppStatistics,omitempty" name:"AppStatistics"` }
type DescribeAppStatisticsResponse ¶
type DescribeAppStatisticsResponse struct { *tchttp.BaseResponse Response *DescribeAppStatisticsResponseParams `json:"Response"` }
func NewDescribeAppStatisticsResponse ¶
func NewDescribeAppStatisticsResponse() (response *DescribeAppStatisticsResponse)
func (*DescribeAppStatisticsResponse) FromJsonString ¶
func (r *DescribeAppStatisticsResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeAppStatisticsResponse) ToJsonString ¶
func (r *DescribeAppStatisticsResponse) ToJsonString() string
type DescribeAppStatisticsResponseParams ¶
type DescribeAppStatisticsResponseParams struct { // Application 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"` }
Predefined struct for user
type DescribeApplicationDataRequest ¶
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"` }
func NewDescribeApplicationDataRequest ¶
func NewDescribeApplicationDataRequest() (request *DescribeApplicationDataRequest)
func (*DescribeApplicationDataRequest) FromJsonString ¶
func (r *DescribeApplicationDataRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeApplicationDataRequest) ToJsonString ¶
func (r *DescribeApplicationDataRequest) ToJsonString() string
type DescribeApplicationDataRequestParams ¶
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"` }
Predefined struct for user
type DescribeApplicationDataResponse ¶
type DescribeApplicationDataResponse struct { *tchttp.BaseResponse Response *DescribeApplicationDataResponseParams `json:"Response"` }
func NewDescribeApplicationDataResponse ¶
func NewDescribeApplicationDataResponse() (response *DescribeApplicationDataResponse)
func (*DescribeApplicationDataResponse) FromJsonString ¶
func (r *DescribeApplicationDataResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeApplicationDataResponse) ToJsonString ¶
func (r *DescribeApplicationDataResponse) ToJsonString() string
type DescribeApplicationDataResponseParams ¶
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"` }
Predefined struct for user
type DescribeScanResult ¶
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"` // Voice detection scenario, which corresponds to the `Scene` at the time of request Scenes []*string `json:"Scenes,omitempty" name:"Scenes"` // Voice 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 status. Valid values: // <li>Start: Task started</li> // <li>Success: Task ended successfully</li> // <li>Error: An exception occurs</li> Status *string `json:"Status,omitempty" name:"Status"` // ID of the application submitted for detection BizId *uint64 `json:"BizId,omitempty" name:"BizId"` }
type DescribeScanResultListRequest ¶
type DescribeScanResultListRequest struct { *tchttp.BaseRequest // Application ID, which is obtained when you create an application in the [GME 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"` }
func NewDescribeScanResultListRequest ¶
func NewDescribeScanResultListRequest() (request *DescribeScanResultListRequest)
func (*DescribeScanResultListRequest) FromJsonString ¶
func (r *DescribeScanResultListRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeScanResultListRequest) ToJsonString ¶
func (r *DescribeScanResultListRequest) ToJsonString() string
type DescribeScanResultListRequestParams ¶
type DescribeScanResultListRequestParams struct { // Application ID, which is obtained when you create an application in the [GME 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"` }
Predefined struct for user
type DescribeScanResultListResponse ¶
type DescribeScanResultListResponse struct { *tchttp.BaseResponse Response *DescribeScanResultListResponseParams `json:"Response"` }
func NewDescribeScanResultListResponse ¶
func NewDescribeScanResultListResponse() (response *DescribeScanResultListResponse)
func (*DescribeScanResultListResponse) FromJsonString ¶
func (r *DescribeScanResultListResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeScanResultListResponse) ToJsonString ¶
func (r *DescribeScanResultListResponse) ToJsonString() string
type DescribeScanResultListResponseParams ¶
type DescribeScanResultListResponseParams struct { // Result of the voice 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"` }
Predefined struct for user
type ModifyAppStatusRequest ¶
type ModifyAppStatusRequest struct { *tchttp.BaseRequest // Application ID, which is generated and returned by the backend after the application creation. BizId *uint64 `json:"BizId,omitempty" name:"BizId"` // Application status. Valid values: `open`, `close`. Status *string `json:"Status,omitempty" name:"Status"` }
func NewModifyAppStatusRequest ¶
func NewModifyAppStatusRequest() (request *ModifyAppStatusRequest)
func (*ModifyAppStatusRequest) FromJsonString ¶
func (r *ModifyAppStatusRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifyAppStatusRequest) ToJsonString ¶
func (r *ModifyAppStatusRequest) ToJsonString() string
type ModifyAppStatusRequestParams ¶
type ModifyAppStatusRequestParams struct { // Application ID, which is generated and returned by the backend after the application creation. BizId *uint64 `json:"BizId,omitempty" name:"BizId"` // Application status. Valid values: `open`, `close`. Status *string `json:"Status,omitempty" name:"Status"` }
Predefined struct for user
type ModifyAppStatusResp ¶
type ModifyAppStatusResponse ¶
type ModifyAppStatusResponse struct { *tchttp.BaseResponse Response *ModifyAppStatusResponseParams `json:"Response"` }
func NewModifyAppStatusResponse ¶
func NewModifyAppStatusResponse() (response *ModifyAppStatusResponse)
func (*ModifyAppStatusResponse) FromJsonString ¶
func (r *ModifyAppStatusResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifyAppStatusResponse) ToJsonString ¶
func (r *ModifyAppStatusResponse) ToJsonString() string
type ModifyAppStatusResponseParams ¶
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"` }
Predefined struct for user
type OverseaTextStatisticsItem ¶
type OverseaTextStatisticsItem struct { // Statistical value (in seconds) // Note: This field may return `null`, indicating that no valid values can be obtained. Data *float64 `json:"Data,omitempty" name:"Data"` }
type RealTimeSpeechStatisticsItem ¶
type RealTimeSpeechStatisticsItem struct { // DAUs in the Chinese mainland MainLandDau *uint64 `json:"MainLandDau,omitempty" name:"MainLandDau"` // PCUs in the Chinese mainland MainLandPcu *uint64 `json:"MainLandPcu,omitempty" name:"MainLandPcu"` // Total duration of use in the Chinese mainland (in minutes) MainLandDuration *uint64 `json:"MainLandDuration,omitempty" name:"MainLandDuration"` // DAUs outside the Chinese mainland OverseaDau *uint64 `json:"OverseaDau,omitempty" name:"OverseaDau"` // PCUs outside the Chinese mainland OverseaPcu *uint64 `json:"OverseaPcu,omitempty" name:"OverseaPcu"` // Total duration of use outside the Chinese mainland (in minutes) OverseaDuration *uint64 `json:"OverseaDuration,omitempty" name:"OverseaDuration"` }
type RealtimeSpeechConf ¶
type RealtimeTextStatisticsItem ¶
type RealtimeTextStatisticsItem struct { // Statistical value (in seconds) // Note: This field may return `null`, indicating that no valid values can be obtained. Data *float64 `json:"Data,omitempty" name:"Data"` }
type ScanDetail ¶
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 of keyword from 0 in audio (in milliseconds) StartTime *uint64 `json:"StartTime,omitempty" name:"StartTime"` // End time offset of keyword from 0 in audio (in milliseconds) EndTime *uint64 `json:"EndTime,omitempty" name:"EndTime"` }
type ScanPiece ¶
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"` // Voice 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 of multipart in stream during stream detection (in milliseconds) // Note: This field may return `null`, indicating that no valid values can be obtained. Offset *uint64 `json:"Offset,omitempty" name:"Offset"` // Multipart 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"` // Multipart 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 ¶
type ScanVoiceRequest struct { *tchttp.BaseRequest // Application ID, which is obtained when you create an application in the [GME console - Service Management](https://console.cloud.tencent.com/gamegme). BizId *uint64 `json:"BizId,omitempty" name:"BizId"` // Voice detection scenario. It must be `default`. See the <a href="#Label_Value">Label description</a> as the result. Scenes []*string `json:"Scenes,omitempty" name:"Scenes"` // Whether it is a live stream. Values: `false` (voice file), `true` (live stream). Live *bool `json:"Live,omitempty" name:"Live"` // Voice detection task list. Up to 100 tasks can be added in the list. // <li>`DataId`: Unique data ID</li> // <li>`Url`: URL-encoded data file URL, which is a pull address if the detected voice 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 queried by calling the `DescribeScanResultList` API.) Callback *string `json:"Callback,omitempty" name:"Callback"` // Language. Chinese will be used if it is left empty. Lang *string `json:"Lang,omitempty" name:"Lang"` }
func NewScanVoiceRequest ¶
func NewScanVoiceRequest() (request *ScanVoiceRequest)
func (*ScanVoiceRequest) FromJsonString ¶
func (r *ScanVoiceRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ScanVoiceRequest) ToJsonString ¶
func (r *ScanVoiceRequest) ToJsonString() string
type ScanVoiceRequestParams ¶
type ScanVoiceRequestParams struct { // Application ID, which is obtained when you create an application in the [GME console - Service Management](https://console.cloud.tencent.com/gamegme). BizId *uint64 `json:"BizId,omitempty" name:"BizId"` // Voice detection scenario. It must be `default`. See the <a href="#Label_Value">Label description</a> as the result. Scenes []*string `json:"Scenes,omitempty" name:"Scenes"` // Whether it is a live stream. Values: `false` (voice file), `true` (live stream). Live *bool `json:"Live,omitempty" name:"Live"` // Voice detection task list. Up to 100 tasks can be added in the list. // <li>`DataId`: Unique data ID</li> // <li>`Url`: URL-encoded data file URL, which is a pull address if the detected voice 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 queried by calling the `DescribeScanResultList` API.) Callback *string `json:"Callback,omitempty" name:"Callback"` // Language. Chinese will be used if it is left empty. Lang *string `json:"Lang,omitempty" name:"Lang"` }
Predefined struct for user
type ScanVoiceResponse ¶
type ScanVoiceResponse struct { *tchttp.BaseResponse Response *ScanVoiceResponseParams `json:"Response"` }
func NewScanVoiceResponse ¶
func NewScanVoiceResponse() (response *ScanVoiceResponse)
func (*ScanVoiceResponse) FromJsonString ¶
func (r *ScanVoiceResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ScanVoiceResponse) ToJsonString ¶
func (r *ScanVoiceResponse) ToJsonString() string
type ScanVoiceResponseParams ¶
type ScanVoiceResponseParams struct { // Voice moderation result. <li>`DataId`: Corresponding `DataId` in request.</li> // <li>`TaskID`: Moderation task ID, which is used to poll the voice 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"` }
Predefined struct for user
type ScanVoiceResult ¶
type StatisticsItem ¶
type StreamTextStatisticsItem ¶
type StreamTextStatisticsItem struct { // Usage of the service (in seconds) // Note: This field may return `null`, indicating that no valid values can be obtained. Data *float64 `json:"Data,omitempty" name:"Data"` }
type Tag ¶
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 ¶
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 voice is a stream. Url *string `json:"Url,omitempty" name:"Url"` // GME Voice Chat room ID, which is entered during voice analysis by GME Voice Chat. RoomId *string `json:"RoomId,omitempty" name:"RoomId"` // GME Voice Chat user ID, which is entered during voice analysis by GME Voice Chat. OpenId *string `json:"OpenId,omitempty" name:"OpenId"` }
type VoiceFilterConf ¶
type VoiceFilterConf struct { // Phrase Filtering status. Valid values: `open`, `close`. Status *string `json:"Status,omitempty" name:"Status"` }
type VoiceFilterStatisticsItem ¶
type VoiceFilterStatisticsItem struct { // Total duration of phrase filtering (in minutes) Duration *uint64 `json:"Duration,omitempty" name:"Duration"` }
type VoiceMessageConf ¶
type VoiceMessageConf struct { // Voice Message Service status. Valid values: `open`, `close`. Status *string `json:"Status,omitempty" name:"Status"` // Language supported for Voice Message Service. Valid values: `all` (all languages), `cnen` (Chinese and English). Default value: `cnen`. Language *string `json:"Language,omitempty" name:"Language"` }
type VoiceMessageStatisticsItem ¶
type VoiceMessageStatisticsItem struct { // DAUs of Voice Message Service Dau *uint64 `json:"Dau,omitempty" name:"Dau"` }