tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

Reporting Text Moderation Result

Last updated: 2024-11-22 10:18:01

    Overview

    This API is used to report moderation results that are not as expected. For example, when pornographic text is moderated and determined as normal, or normal text is determined as pornographic, you can directly report the result through this API.
    This API will not directly modify the moderation result. The incorrect moderation result you report will be confirmed on the backend, and the confirmed result will take effect in subsequent moderation jobs.

    SDK Recommendation

    CI SDK provides complete capabilities of demo, automatic integration, and signature calculation. You can easily and quickly call APIs through the SDK. For more information, see SDK Overview.

    Request

    Sample request

    POST /report/badcase HTTP/1.1
    Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
    Date: <GMT Date>
    Authorization: <Auth String>
    Content-Length: <length>
    Content-Type: application/xml
    
    <body>
    Note:
    Authorization: Auth String (See Request Signature for details.)
    When this feature is used by a sub-account, relevant permissions must be granted as instructed in Authorization Granularity Details.

    Request headers

    This API only uses Common Request Headers.

    Request body

    This request requires the following request body:
    <Request>
        <ContentType></ContentType>
        <JobId></JobId>
        <ModerationTime></ModerationTime>
        <Text></Text>
        <SuggestedLabel></SuggestedLabel>
        <Label></Label>
    </Request>
    The nodes are described as follows:
    Node Name (Keyword)
    Parent Node
    Description
    Type
    Required
    Request
    None
    Specific parameters for reporting incorrect moderation results
    Container
    Yes
    Request has the following sub-nodes:
    Node Name (Keyword)
    Parent Node
    Description
    Type
    Required
    ContentType
    Request
    Type of the data to be reported. The value for incorrect text sample is 1.
    Integer
    Yes
    Text
    Request
    Text sample. You need to enter Base64-encoded text content, which is required if ContentType is 1.
    String
    No
    Label
    Request
    Tag of the moderation result returned by CI, such as Porn.
    String
    Yes
    SuggestedLabel
    Request
    Tag of the correct moderation result you expect, such as Normal.
    String
    Yes
    JobId
    Request
    Moderation job ID corresponding to the data sample, which is helpful for locating moderation records.
    String
    No
    ModerationTime
    Request
    The time when the data sample was moderated, which is helpful for locating moderation records. The value format is 2021-08-07T12:12:12+08:00.
    String
    No

    Response

    Response headers

    This API only returns Common Response Headers.

    Response body

    The response body returns application/xml data. The following contains all the nodes:
    <Response>
        <RequestId></RequestId>
    </Response>
    The nodes are described as follows:
    Node Name (Keyword)
    Parent Node
    Description
    Type
    Response
    None
    Specific response content.
    Container
    Response has the following sub-nodes:
    Node Name (Keyword)
    Parent Node
    Description
    Type
    RequestId
    Response
    The ID automatically generated by the server for a request when the request is sent, which can help locate problems faster.
    String

    Error codes

    No special error message will be returned for this request. For the common error messages, please see Error Codes.

    Examples

    Request

    POST /report/badcase HTTP/1.1
    Authorization: q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0a1********&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff9050055********
    Host: examplebucket-1250000000.ci.ap-beijing.myqcloud.com
    Content-Length: 66
    Content-Type: application/xml
    <Request>
        <ContentType>1</ContentType>
        <Text>6L+Z5piv5Li65LuA5LmI</Text>
        <Label>Porn</Label>
        <SuggestedLabel>Normal</SuggestedLabel>
    </Request>

    Response

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Content-Length: 230
    Connection: keep-alive
    Date: Thu, 15 May 2022 12:37:29 GMT
    Server: tencent-ci
    x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYz********
    
    <Response>
        <RequestId>xxxxxxxxxxxxxx</RequestId>
    </Response>
    
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy