API 中心
用户之声——提建议·赢好礼> HOT
文档中心 > API 中心 > 智能视图计算平台 > AI 分析相关接口 > 获取AI任务识别结果

获取AI任务识别结果

最近更新时间：2024-04-22 01:19:15

我的收藏

本页目录：

1. 接口描述

接口请求域名： iss.tencentcloudapi.com 。

获取AI任务识别结果

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeAITaskResult。
Version 是 String 公共参数，本接口取值：2023-05-17。
Region 否 String 公共参数，此参数为可选参数。
TaskId 是 String AI 任务 ID
示例值：at0251f55fd5fe4adba237**
ChannelId 是 String 通道ID
示例值：f8656fa3-e7fa-4cad-a4cc-****
Object 否 String 桶内文件的路径。
示例值：要查看 bucket-id/a/b/c/dog.ts 的识别结果，此时传的值为"a/b/c/dog.ts"
DetectType 否 String AI 任务识别类型。可选值为 Facemask(口罩识别)、Chefhat(厨师帽识别)、Smoking(抽烟检测)、Chefcloth(厨师服识别)、PhoneCall(接打电话识别)、Pet(宠物识别)、Body(人体识别)和 Car(车辆车牌识别)
示例值：Pet
BeginTime 否 String 开始时间时间。秒级时间戳。开始时间和结束时间跨度小于等于30天
示例值：1703124000
EndTime 否 String 结束时间时间。秒级时间戳。开始时间和结束时间跨度小于等于30天
示例值：1703127600
PageNumber 否 Integer 页码。默认为1
示例值：1
PageSize 否 Integer 每页 AI 识别结果数量。可选值1～100，默认为10（按时间倒序显示识别结果）
示例值：20

3. 输出参数

参数名称 类型 描述
Data AITaskResultData AI识别结果
注意：此字段可能返回 null，表示取不到有效值。
TotalCount Integer AI识别结果数量
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 失败示例

AI任务不存在

输入示例

POST / HTTP/1.1
Host: iss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAITaskResult
<公共请求参数>

{
    "TaskId": "at**********************1",
    "ChannelId": "**********************",
    "DetectType": "Pet"
}

输出示例

{
    "Response": {
        "Error": {
            "Code": "ResourceNotFound.AITaskNotExisted",
            "Message": "AI任务不存在"
        },
        "RequestId": "1bd31583-6bd4-486c-8ae3-1844cf4e6d1e"
    }
}

示例2 成功示例

无

输入示例

POST / HTTP/1.1
Host: iss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAITaskResult
<公共请求参数>

{
    "TaskId": "at**********************8",
    "ChannelId": "**********************",
    "DetectType": "Pet"
}

输出示例

{
    "Response": {
        "Data": {
            "AIResultCount": 1,
            "AIResults": {
                "Body": null,
                "Car": null,
                "ChefCloth": null,
                "ChefHat": null,
                "FaceMask": null,
                "Pet": [
                    {
                        "PetInfo": [
                            {
                                "Location": {
                                    "Height": 854,
                                    "Width": 1142,
                                    "X": 567,
                                    "Y": 87
                                },
                                "Name": "dog",
                                "Score": 91
                            }
                        ],
                        "Time": "0.000000",
                        "Url": "https://****************************************************"
                    }
                ],
                "PhoneCall": null,
                "Smoking": null
            },
            "TaskId": "at**********************8"
        },
        "RequestId": "45e68b99-dec9-46f4-81e7-bc4a3c768536",
        "TotalCount": 1
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
InvalidParameterValue.ChannelIdMustBeNotEmpty ChannelId不能为空
InvalidParameterValue.ContainInvalidChannelId 包含无效的ChannelId
InvalidParameterValue.InvalidAITaskID 无效的AI任务ID
InvalidParameterValue.InvalidBeginAndEndTime 无效的开始或结束时间
InvalidParameterValue.InvalidDetectType 无效的AI分析类型
InvalidParameterValue.InvalidPageNumber 无效的PageNumber
InvalidParameterValue.InvalidPageSize 无效的PageSize
InvalidParameterValue.ObjectContainIllegalCharacter Object包含非法字符
ResourceNotFound.AITaskNotExisted AI任务不存在
中国站