使用SemanticQuery通过自然语言查询数据集-智能媒体管理-阿里云-智能媒体管理(IMM)-阿里云帮助中心

通过输入自然语言，对数据集内的元数据进行基于语义的查询搜索。

接口说明

注意事项

请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和价格。该接口每次请求，会产生语义理解费用和查询费用两种计费项各一次。
调用该接口前，请确保您已通过绑定方式（ CreateBinding ）或者主动索引（ IndexFileMeta 或者 BatchIndexFileMeta ）方式将文件索引到数据集（Dataset）中。
返回结果仅为示例，根据工作流模板配置不同，获取到的文件元数据信息的类别和包含的内容均有可能与示例不同。如果有疑问，请加入钉钉群进行反馈，钉钉群号请参见联系我们。

使用限制

每次查询最多返回 100 个文件信息。
不支持翻页查询。
自然语言理解不保证完全准确。
该功能在美国（硅谷），美国（弗吉尼亚）地域下不支持。

使用方式

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

ProduceTime：2023 年 1 月 1 日零点起到 2023 年 12 月 31 日结束止
Address.AddressLine：包含杭州关键词
Labels.LabelName：包含风景标签

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

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

imm:SemanticQuery

list

*Dataset

acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}

无

请求参数

名称	类型	必填	描述	示例值
NextToken	string	否	目前不再提供该参数。	预留，暂不支持
MaxResults	integer	否	本次读取的最大数据记录数量。范围(0,100]。	20
ProjectName	string	是	项目名称。	test-project
DatasetName	string	是	数据集名称。	test-dataset
Query	string	否	重要该参数与 SourceURI 参数必须有一个为非空值。需要进行语义搜索的内容。	2021年4月杭州的风景
WithFields	array	否	仅返回特定字段的值，而不是全部已有的元信息字段。可用于降低返回的结构体大小。不填或留空则返回所有字段。
	string	否	仅返回特定字段的值，而不是全部已有的元信息字段。可用于降低返回的结构体大小。不填或留空则返回所有字段。	["URI", "Filename"]
MediaTypes	array	否	搜索的媒体类型。如留空则默认值为： ["image"]
	string	否	枚举值，当前仅支持： image	["image"]
SourceURI	string	否	重要该参数与 Query 参数必须有一个为非空值。该参数目前仅在指定搜索类型为图片且数据集配置了以图搜图相关工作流模板时有效。用于检索的源数据的存储地址，存储地址支持 OSS 的 URI 地址。 OSS 地址规则为 oss://${Bucket}/${Object}，其中${Bucket}为和当前项目处于同一区域(Region)的 OSS Bucket 名称，${Object}为包含文件扩展名的文件完整路径。如您需要配置对应工作流模板，欢迎联系我们。	oss://test-bucket/test-object

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	当次请求的 Request ID。	2C5C1E0F-D8B8-4DA0-8127-EC32C771****
Files	array	文件列表。
	File	文件信息。

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。