ContextualRetrieval_智能媒体管理_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 加入钉钉群进行反馈。

使用限制

  • 历史对话长度最长限制为 100,包括用户消息和助手消息。

  • 每条消息长度不超过 1000 个汉字。

流控信息

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

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
imm:ContextualRetrieval
None
全部资源
*

请求参数

字段名称字段详情
ProjectNamestring

项目名称,获取方式请参见创建项目

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

用于检索的 Dataset 数据集。

示例值:test-dataset参考取值来源:
    UpdateDataset
    CreateDataset
    ListDatasets
Messagesarray<ContextualMessage>

对话历史以及工具调用历史。最新的消息在最尾(index 为 n-1),最旧的消息在最头(index 为 0)。展开详情

RecallOnlyboolean

是否只开启召回过程(Embedding 搜索),如果该配置为 true,意味着拿到的数据返回没有经过 Rerank,可以支持用户自定义 Rerank 过程。展开详情

示例值:false
SmartClusterIdsarray<string>

智能分组 ID 的列表,用于在特定智能分组内检索文件。

返回参数

字段名称字段详情
RequestIdstring

当次请求的 Request ID。

示例值:6E93D6C9-5AC0-49F9-914D-E02678D3****
Resultsarray<File>

返回的被检索到的文件列表,文档相关结构内容会包含在 File.Elements 内。

返回示例

变更历史

变更时间变更内容概要操作
2024-12-25
新增OpenAPI,AI助手中的检索API

相关示例