云点播按语义搜索媒体

1. 接口描述

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

使用自然语言对媒体进行语义搜索。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：SearchMediaBySemantics。
Version	是	String	公共参数，本接口取值：2018-07-17。
Region	否	String	公共参数，此参数为可选参数。
SubAppId	是	Integer	点播应用 ID。从2023年12月25日起开通点播的客户，如访问点播应用中的资源（无论是默认应用还是新创建的应用），必须将该字段填写为应用 ID。示例值：1500035838
Text	是	String	需要进行搜索的内容示例值：包含夕阳的海边视频
Limit	否	Integer	返回的记录条数，默认值：20。示例值：10
Categories.N	否	Array of String	文件类型。匹配集合中的任意元素： Video: 视频文件 Audio: 音频文件 Image: 图片文件示例值：["Video"]
Tags.N	否	Array of String	标签集合，匹配集合中任意元素。单个标签长度限制：32个字符。数组长度限制：16。示例值：["Sports", "Food"]
TaskTypes.N	否	Array of String	搜索的任务类型，可选值有： - AiAnalysis.DescriptionTask - SmartSubtitle.AsrFullTextTask 示例值：["AiAnalysis.DescriptionTask "]

3. 输出参数

参数名称	类型	描述
SearchResults	Array of SemanticsSearchResult	媒体列表。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 搜索

输入示例

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

{
    "SubAppId": 1500035838,
    "Text": "包含夕阳的海边视频"
}

输出示例

{
    "Response": {
        "RequestId": "1e7aa7b9-0f92-4fbb-9ca2-6aebdfb31543",
        "SearchResults": [
            {
                "EndTimeOffset": 159.07,
                "FileId": "966263618841114024",
                "Score": 0.58276,
                "StartTimeOffset": 109.908
            },
            {
                "EndTimeOffset": 109.708,
                "FileId": "966263618841114024",
                "Score": 0.58201,
                "StartTimeOffset": 83.141
            },
            {
                "EndTimeOffset": 82.741,
                "FileId": "966263618841114024",
                "Score": 0.46496,
                "StartTimeOffset": 10.222
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。

按语义搜索媒体

本页目录：