视频索引器 （预览版）
轻松从视频中提取见解，并快速丰富应用程序以增强发现和参与度。 使用视频索引器连接器将视频转换为见解。
此连接器在以下产品和区域中可用：
| Service | Class | 区域 |
|---|---|---|
| 逻辑应用程序 | 标准 | 除以下各项外的所有 逻辑应用区域 ： - Azure中国区域 - 美国国防部（DoD） |
| 连接器元数据 | |
|---|---|
| 发布者 | Microsoft |
正在创建连接
连接器支持以下身份验证类型：
| 默认 | 用于创建连接的参数。 | 所有区域 | 可共享 |
违约
适用：所有区域
用于创建连接的参数。
这是可共享的连接。 如果 Power App 与其他用户共享，则连接也会共享。 有关详细信息，请参阅画布应用的 Connectors 概述 - Power Apps |Microsoft Docs
| 名称 | 类型 | 说明 | 必需 |
|---|---|---|---|
| API 密钥 | securestring | 此 API 的 API 密钥 | 真 实 |
限制
| 名称 | 调用 | 续订期 |
|---|---|---|
| 每个连接的 API 调用数 | 1200 | 60 秒 |
操作
| 上传视频和索引 |
此操作上传给定的视频，开始为其编制索引，并返回新的细分 ID。 |
| 上传视频和索引（使用 URL） |
此操作上传给定的视频，开始为其编制索引，并返回新的细分 ID。 |
| 删除视频及其见解 |
此操作将删除上传的视频，如果 deleteInsights=true，则也会删除生成的见解。 |
| 搜索文本或人脸 |
此操作执行搜索并返回结果。 如果可用，则返回结果中搜索筛选器的匹配项。 |
| 更新人脸名称 |
此作更新给定人脸的名称并训练人脸模型，以便在将来的视频中识别该人脸。 |
| 获取处理状态 |
此操作检索给定明细 ID 的处理状态，如果处理它返回进度（例如 30%）。 |
| 获取帐户 |
返回用户帐户的详细信息。 |
| 获取播放器小组件 URL |
此操作返回播放器小组件的 URL，包括访问令牌。 |
| 获取脚本 （VTT） URL |
此操作返回具有给定细分标题的 VTT 文件的 URL。 |
| 获取见解小组件 URL |
此操作返回认知见解小组件的 URL，包括访问令牌。 |
| 获取见解小组件 URL（使用外部 ID） |
此操作基于给定的外部 ID 返回认知见解小组件的 URL，包括访问令牌。 |
| 获取视频细分 |
此操作返回给定明细的完整详细信息，包括所有见解（脚本、OCR、人员等）。 |
| 重新为视频细分编制索引 |
此操作重新为给定细分编制索引。 |
| 重新为视频细分编制索引（使用外部 ID） |
此操作重新为给定外部 ID 的视频编制索引。 |
上传视频和索引
此操作上传给定的视频，开始为其编制索引，并返回新的细分 ID。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
文件内容
|
fileContent | True | binary |
多部分形式的视频。 |
|
语言
|
language | string |
生成脚本时要使用的视频语言。 |
|
|
外部 ID
|
externalId | string |
要与视频关联的外部 ID（稍后可以搜索）。 |
|
|
元数据
|
metadata | string |
要与视频关联的元数据（将在查询中返回）。 |
|
|
说明
|
description | string |
视频说明。 |
|
|
Partition
|
partition | string |
用于对视频进行分区的分区（用于搜索特定分区）。 |
|
|
视频名称
|
name | True | string |
视频名称。 |
|
隐私
|
privacy | True | string |
专用、组织或公共。 |
|
回调 URL
|
callbackUrl | string |
完成索引编制时要通知的 URL。 |
返回
与视频及其细分关联的 ID。
上传视频和索引（使用 URL）
此操作上传给定的视频，开始为其编制索引，并返回新的细分 ID。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
视频 URL
|
videoUrl | True | string |
视频的公共 URL。 |
|
语言
|
language | string |
生成脚本时要使用的视频语言。 |
|
|
外部 ID
|
externalId | string |
要与视频关联的外部 ID（稍后可以搜索）。 |
|
|
元数据
|
metadata | string |
要与视频关联的元数据（将在查询中返回）。 |
|
|
说明
|
description | string |
视频说明。 |
|
|
Partition
|
partition | string |
用于对视频进行分区的分区（用于搜索特定分区）。 |
|
|
视频名称
|
name | True | string |
视频名称。 |
|
隐私
|
privacy | True | string |
专用、组织或公共。 |
|
回调 URL
|
callbackUrl | string |
完成索引编制时要通知的 URL。 |
返回
与视频及其细分关联的 ID。
删除视频及其见解
此操作将删除上传的视频，如果 deleteInsights=true，则也会删除生成的见解。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
视频 ID
|
id | True | string |
与视频及其细分关联的 ID。 |
|
删除见解
|
deleteInsights | boolean |
是否同时删除生成的见解（True 或 False）。 |
返回
- 响应
- object
搜索文本或人脸
此操作执行搜索并返回结果。 如果可用，则返回结果中搜索筛选器的匹配项。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
人脸查询
|
face | string |
要搜索的人脸。 |
|
|
文本查询
|
query | string |
要搜索的免费文本。 |
|
|
搜索公共帐户
|
searchInPublicAccount | string |
如此 在公共帐户中查找。 |
|
|
隐私
|
privacy | string |
专用、组织或公共。 |
|
|
文本范围
|
textScope | string |
搜索范围。 |
|
|
语言
|
language | string |
搜索。 |
|
|
视频 ID
|
id | string |
要搜索的视频细分 ID。 |
|
|
Partition
|
partition | string |
要搜索的分区。 |
|
|
Owner
|
owner | string |
要搜索的所有者。 |
|
|
页面大小
|
pageSize | number |
要返回的结果数。 |
|
|
跳过
|
skip | number |
要跳过的结果数（用于分页）。 |
|
|
外部 ID
|
externalId | string |
要搜索的外部 ID（与上传时的视频关联）。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Results
|
results | array of object | |
|
账户 ID
|
results.accountId | string |
上传视频的帐户。 |
|
视频 ID
|
results.id | string |
与视频及其细分关联的 ID。 |
|
Partition
|
results.partition | string |
视频分区。 |
|
外部 ID
|
results.externalId | string |
视频的外部 ID（上传时提供的用户）。 |
|
元数据
|
results.metadata | string |
视频的元数据。 |
|
名称
|
results.name | string |
视频的名称。 |
|
说明
|
results.description | string |
视频的说明。 |
|
创建时间
|
results.createTime | date-time |
创建视频的时间。 |
|
组织
|
results.organization | string |
组织帐户属于。 |
|
隐私模式
|
results.privacyMode | string |
组织帐户属于。 |
|
用户名
|
results.userName | string |
视频帐户的用户名。 |
|
拥有
|
results.isOwned | boolean |
如此 如果视频由用户拥有。 |
|
是基数
|
results.isBase | boolean |
如果视频是基本视频，则为 True。 |
|
州
|
results.state | string |
上传、处理、处理或失败。 |
|
处理进度
|
results.processingProgress | string |
正在处理状态时视频的进度百分比。 |
|
持续时间（以秒为单位）
|
results.durationInSeconds | integer |
视频持续时间（以秒为单位）。 |
|
缩略图 URL
|
results.thumbnailUrl | string |
视频的缩略图 URL。 |
|
用户赞
|
results.social.likedByUser | boolean |
如果用户喜欢视频，则为 True。 否则为 false。 |
|
喜欢
|
results.social.likes | integer |
视频的赞数。 |
|
Views
|
results.social.views | integer |
视频的视图数。 |
|
搜索匹配项
|
results.searchMatches | string |
匹配项的数组，以及匹配项的详细信息。 |
更新人脸名称
此作更新给定人脸的名称并训练人脸模型，以便在将来的视频中识别该人脸。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
视频 ID
|
id | True | string |
视频细分 ID。 |
|
人脸 ID
|
faceId | True | number |
人脸 ID（来自视频的 json）。 |
|
新名称
|
newName | True | string |
人脸的新名称（使用“未知 #1/2/3...”进行匿名）。 |
返回
- 响应
- object
获取处理状态
此操作检索给定明细 ID 的处理状态，如果处理它返回进度（例如 30%）。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
视频 ID
|
id | True | string |
与视频及其细分关联的 ID。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
州
|
state | string |
上传、处理、处理或失败。 |
|
进展
|
progress | string |
如果状态正在处理，则视频的百分比。 |
获取帐户
返回用户帐户的详细信息。
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
|
array of object | ||
|
账户 ID
|
id | string | |
|
帐户名
|
name | string |
获取播放器小组件 URL
获取脚本 （VTT） URL
此操作返回具有给定细分标题的 VTT 文件的 URL。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
视频 ID
|
id | True | string |
与视频及其细分关联的 ID。 |
|
语言
|
language | string |
请求的文本语言。 |
返回
视频的 VTT 文件的 URL。
- 网址
- string
获取见解小组件 URL
此操作返回认知见解小组件的 URL，包括访问令牌。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
视频 ID
|
id | True | string |
与视频及其细分关联的 ID。 |
|
小组件类型
|
widgetType | string |
人员、情绪、关键字或搜索。 |
返回
认知见解小组件的 URL。
- 网址
- string
获取见解小组件 URL（使用外部 ID）
此操作基于给定的外部 ID 返回认知见解小组件的 URL，包括访问令牌。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
外部 ID
|
externalId | True | string |
要搜索的外部 ID（与上传时此订阅的视频相关联）。 |
|
小组件类型
|
widgetType | string |
要包含的子小组件类型（人员、情绪、关键字、搜索）。 |
返回
认知见解小组件的 URL。
- 网址
- string
获取视频细分
此操作返回给定明细的完整详细信息，包括所有见解（脚本、OCR、人员等）。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
视频 ID
|
id | True | string |
上传或搜索 API 返回的细分 ID。 |
|
语言
|
language | string |
请求的文本语言。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
账户 ID
|
accountId | string |
与帐户关联的唯一 ID。 |
|
视频 ID
|
id | string |
与视频及其细分关联的唯一 ID。 |
|
Partition
|
partition | string |
视频分区。 |
|
名称
|
name | date-time |
视频的名称。 |
|
说明
|
description | string |
视频的说明。 |
|
用户名
|
userName | string |
视频帐户的用户名。 |
|
创建时间
|
createTime | date-time |
创建视频的时间。 |
|
组织
|
organization | string |
组织帐户属于。 |
|
隐私模式
|
privacyMode | string |
视频的隐私模式。 |
|
州
|
state | string |
上传、处理、处理或失败）。 |
|
拥有
|
isOwned | boolean |
如此 如果视频由用户拥有。 |
|
是基数
|
isBase | boolean |
如果视频是基本视频，则为 True。 |
|
Summarized Insights
|
summarizedInsights | string |
视频细分中获取的见解摘要 |
|
细目数组
|
breakdowns | string |
视频细分的数组。 |
|
用户赞
|
social.likedByUser | boolean |
如此 如果视频已被用户喜欢。 否则为 false。 |
|
喜欢
|
social.likes | integer |
视频中的赞数。 |
|
Views
|
social.views | integer |
视频的视图数。 |
重新为视频细分编制索引
此操作重新为给定细分编制索引。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
视频 ID
|
id | True | string |
视频细分 ID。 |
|
回调 URL
|
callbackUrl | string |
在重新编制索引完成后通知的 URL。 |
返回
- 响应
- object
重新为视频细分编制索引（使用外部 ID）
此操作重新为给定外部 ID 的视频编制索引。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
外部 ID
|
externalId | True | string |
外部 ID（与上传时此订阅的视频相关联）。 |
|
回调 URL
|
callbackUrl | string |
在重新编制索引完成后通知的 URL。 |
返回
- 响应
- object
定义
videoResponse
对象
这是 'object' 类型。
字符串
这是基本数据类型“string”。