SemanticQuery_智能媒体管理_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

注意事项

  • 请确保在使用该接口前,已充分了解智能媒体管理产品的收费方式和价格。该接口每次请求,会产生语义理解费用和查询费用两种计费项各一次。

  • 调用该接口前,请确保您已通过绑定方式( CreateBinding )或者主动索引( IndexFileMeta 或者 BatchIndexFileMeta )方式将文件索引到数据集(Dataset)中。

  • 返回结果仅为示例,根据工作流模板配置不同,获取到的文件元数据信息的类别和包含的内容均有可能与示例不同。如果有疑问,请使用钉钉搜索钉钉群号 21714099 加入钉钉群进行反馈。

使用限制

  • 每次查询最多返回 1000 个文件信息。

  • 不支持翻页查询。

  • 自然语言理解不保证完全准确。

使用方式

使用自然语言关键词对数据集内的文件进行搜索查询。目前支持理解的关键信息包括标签(Labels.LabelName)、时间(ProduceTime)和地点(Address.AddressLine)等。例如,以2023 年杭州的风景为条件进行查询,会被智能拆分为如下三个条件,并查找出同时满足这些条件的文件:

  • ProduceTime:2023 年 1 月 1 日零点起到 2023 年 12 月 31 日结束止

  • Address.AddressLine:包含杭州关键词

  • Labels.LabelName:包含风景标签

配合工作流模板配置,当模板中包含ImageEmbeddingExtraction算子时,该搜索请求会提供基于图片内容的搜索,即您输入的Query内容会同时被理解为图片内包含的内容,从而实现对图片的智能检索。

流控信息

当前云产品API请求速率暂未透出。

授权信息

当前云产品暂无权限信息透出。

请求参数

字段名称字段详情
NextTokenstring

目前不再提供该参数。

MaxResultsinteger<int32>

本次读取的最大数据记录数量。范围(0,1000]。

示例值:20
ProjectNamestring

项目名称。

示例值:test-project参考取值来源:
    CreateProject
    UpdateProject
    ListProjects
DatasetNamestring

数据集名称。

示例值:test-dataset参考取值来源:
    CreateDataset
    UpdateDataset
    ListDatasets
Querystring

需要进行语义搜索的内容。

示例值:2021年4月杭州的风景
WithFieldsarray<string>

仅返回特定字段的值,而不是全部已有的元信息字段。可用于降低返回的结构体大小。展开详情

MediaTypesarray<string>

搜索的媒体类型。如留空则默认值为:展开详情

返回参数

字段名称字段详情
RequestIdstring

当次请求的 Request ID。

示例值:2C5C1E0F-D8B8-4DA0-8127-EC32C771****
Filesarray<File>

文件列表。

返回示例

变更历史

变更时间变更内容概要操作
2024-09-05
删除请求参数SmartClusterIds
2024-09-04
新增请求参数SmartClusterIds
2023-11-20
新增请求参数WithFields
新增请求参数MediaTypes
变更返回参数
2023-09-04
变更返回参数
2022-12-13
变更返回参数

相关示例