1. 接口描述
接口请求域名： vod.tencentcloudapi.com 。
使用自然语言对媒体进行语义搜索。
仅支持文搜视频、文搜图、图搜图，图搜视频请使用SearchMediaBySemanticsAsync.
默认接口请求频率限制：20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：SearchMediaBySemantics。 |
| Version | 是 | String | 公共参数，本接口取值：2018-07-17。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| SubAppId | 是 | Integer | 点播应用 ID。从2023年12月25日起开通点播的客户，如访问点播应用中的资源（无论是默认应用还是新创建的应用），必须将该字段填写为应用 ID。 示例值：1000000000 |
| Text | 否 | String | 需要进行搜索的文本内容。 入参限制：与 示例值：包含夕阳的海边视频 |
| FileId | 否 | String | 需要进行搜索的图片FileId。 入参限制：必须是图片类型媒资，且与 示例值：9****1 |
| Url | 否 | String | 需要进行搜索的图片Url。 入参限制：必须是图片Url，且与 示例值：https://**.cos.ap-shanghai.myqcloud.com/***.png |
| KnowledgeBaseId | 否 | String | 知识库ID，留空时将使用默认知识库。 示例值：kb-** |
| Limit | 否 | Integer | 返回的记录条数，默认值：20。 取值范围：[1, 100] 示例值：10 |
| Categories.N | 否 | Array of String | 文件类型。匹配集合中的任意元素： 示例值：["Video"] |
| Tags.N | 否 | Array of String | 标签集合，匹配集合中任意元素。 入参限制：单个标签长度限制：32个字符。数组长度限制：16。 示例值：["Sports", "Food"] |
| Persons.N | 否 | Array of String | 人物集合，匹配出现了所有传入人物的片段 入参限制：数组长度限制：16 示例值：["张三"] |
| TaskTypes.N | 否 | Array of String | 搜索的任务类型，可选值有：
示例值：["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": 1000000000,
"Text": "关于冬天的视频",
"KnowledgeBaseId": "kb-**********"
}输出示例
{
"Response": {
"SearchResults": [
{
"EndTimeOffset": 46.758,
"FileId": "966263618988054694",
"Score": 0.17525,
"StartTimeOffset": 1.9729999999999999
}
],
"RequestId": "c82ee200-498a-4def-9985-809e43b7e16b"
}
}示例2 按图片FileId在知识库中进行搜索
注意：KnowledgeBaseId对应的知识库必须为图片知识库
输入示例
POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SearchMediaBySemantics
<公共请求参数>
{
"SubAppId": 200000,
"FileId": "9****************1",
"KnowledgeBaseId": "kb-**********"
}输出示例
{
"Response": {
"SearchResults": [
{
"EndTimeOffset": 0,
"FileId": "9****************1",
"Score": 1,
"StartTimeOffset": 0,
"Title": ""
}
],
"RequestId": "71e66da3-abd4-4024-91e1-a596df4f719b"
}
}示例3 按图片Url在知识库中进行搜索
注意：KnowledgeBaseId对应的知识库必须为图片知识库
输入示例
POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SearchMediaBySemantics
<公共请求参数>
{
"SubAppId": 200000,
"Url": "https://******************.cos.ap-shanghai.myqcloud.com/***********.png",
"KnowledgeBaseId": "kb-**********"
}输出示例
{
"Response": {
"SearchResults": [
{
"EndTimeOffset": 0,
"FileId": "9****************1",
"Score": 1,
"StartTimeOffset": 0,
"Title": ""
}
],
"RequestId": "dccae516-7f4e-4972-90dc-36a5c22361d3"
}
}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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| ResourceNotFound.UserNotExist | 用户不存在。 |
