ContextualRetrieval
检索API专为多轮对话场景设计，能够处理包含对话历史的消息输入，精准检索语义相近文档。通过深度解析上下文信息，该接口确保检索结果与当前对话内容高度相关，适用于复杂交互环境，为多轮对话提供一致且高效的信息检索服务
服务地址：
华东1（杭州）
输入参数
只看必填
ProjectName项目名称
DatasetName用于检索的 Dataset 数据集
Messages对话历史以及工具调用历史
0AI 助手二期中
Role对话角色
Content消息内容
Files对话中的文件列表
0文件
OwnerIdOwnerId
ProjectNameProjectName
DatasetNameDatasetName
ObjectIdObjectId
URIURI
OSSURIOSSURI
MediaTypeMediaType
ContentTypeContentType
ElementsElements
0文档分析生成的文档元素信息
ElementContents元素内容列表
0文档分析生成的元素的内容信息
Type元素内容的类型
Content元素的内容
URL元素内容的链接
TimeRange持续的时间范围
0
添加
添加
ObjectId文档片段的唯一ID
ElementType文档片段的类型
SemanticSimilarity当前文件和语义匹配的相似度
ElementRelations当前文档片段和其他文档片段的关系
0当前文档片段和其他文档片段的关系
Type类型
ObjectId文档片段的ID
添加
添加
添加
添加
RecallOnly是否只开启召回过程（Embedding搜索）
请选择布尔值
SmartClusterIds智能分组ID的列表
0智能分组ID
添加
插件下载了解更多
VS Code 插件
安装插件之前，确保已安装 VS Code安装插件之前，确保已安装 VS Code
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
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
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
安 装

接口说明

注意事项

  • 请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和价格。

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

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

使用限制

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

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

请求参数

字段名称字段详情
ProjectNamestring

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

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

用于检索的 Dataset 数据集。

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

对话历史以及工具调用历史。最新的消息在最尾（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