找不到 API ? 点击 反馈吧
- Data API
- Secret
- RAG Service
- 初始化向量数据库InitVectorDatabase
- 管理命名空间
- 管理向量集
- 管理文档
- 管理向量
- 上传向量数据
- 检索
- 管理向量数据
- 索引管理
- Embedding
- Rerank
- 实时数据消费
- 插件管理
- 外部数据管理
- 创建实例
- 实例管理
- 实例变配
- 查询实例
- 参数管理
- 备份管理
- 账号管理
- 数据共享
- 诊断与优化
- 计划管理
- 标签管理
- 安全管理
- 日志管理
- 网络管理
- 资源管理
- 样本数据集
- 资源组
- 其他
- 其它
QueryCollectionData
召回向量数据
服务地址:
华东1 金融云
参数配置
高级配置
输入参数
只看必填
DBInstanceId实例ID
Collection集合名
Namespace命名空间
NamespacePassword命名空间对应的密码
Content用于全文检索的内容
Filter要查询的数据的过滤条件
TopK设置返回top结果数量
Vector向量数据
RegionId实例所在地域ID
Metrics检索时的相似度算法
IncludeValues是否返回向量数据
请选择布尔值
HybridSearch双路召回算法
OrderBy默认为空
Offset默认为空
IncludeMetadataFields默认为空
WorkspaceId多数据库实例组成的Workspace的Id
RelationalTableFilter使用另外一张关系表实现向量数据过滤(类...
CollectionMetadataField向量集的Metadata字段
TableField关系表的字段
TableName关系表的名称
Condition关系表的过滤条件
文档
调用结果
SDK 示例
CLI示例
相关示例 (1)
调用历史
错误码
流控
插件下载了解更多
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 IDE安装插件之前,确保已安装 JetBrains IDE
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
请求参数
字段名称 | 字段详情 |
---|---|
DBInstanceIdstring | 实例 ID。展开详情 示例值:gp-xxxxxxxxx参考取值来源: UpgradeDBInstance CreateDBInstance UpdateDBInstancePlan DescribeDBInstances PauseInstance ModifyDBInstancePayType ResumeInstance UploadDocumentAsync DownloadDiagnosisRecords UnloadSampleData |
Collectionstring | 集合名。展开详情 示例值:document参考取值来源: ListCollections CreateCollection UpsertCollectionData |
Namespacestring | 命名空间。展开详情 示例值:mynamespace参考取值来源: ListNamespaces CreateNamespace |
NamespacePasswordstring | 命名空间对应的密码。 示例值:testpassword |
Contentstring | 用于全文检索的内容。即此值为空时,仅使用向量检索;不为空时,使用向量和全文双路检索。展开详情 示例值:hello_world |
Filterstring | 要查询的数据的过滤条件,格式为 SQL 的 WHERE 格式。是一个返回布尔值(真或假)的表达式,条件可以是简单的比较运算符,如等于(=)、不等于(<>或!=)、大于(>), 小于(<)、大于等于(>=)、小于等于(<=),也可以是逻辑运算符(AND, OR, NOT)组合的更复杂的表达式,以及使用 IN、BETWEEN、LIKE 等关键字的条件。展开详情 示例值:response > 200 |
TopKinteger<int64> | 设置返回 top 结果数量。 注意
该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。 示例值:10取值 >= 0 |
Vectorarray<number<double>> | 向量数据,长度和 CreateCollection 接口的维度一致。展开详情 |
SparseVectorobject | 稀疏向量数据列表。 |
RegionIdstring | 实例所在地域 ID。 示例值:cn-hangzhou参考取值来源: DescribeRegions |
Metricsstring | 检索时的相似度算法。取值说明:展开详情 示例值:cosine枚举值:ipl2cosine |
IncludeValuesboolean | 是否返回向量数据。取值说明:展开详情 示例值:true |
HybridSearchstring | 双路召回算法,默认为空(即直接将向量和全文的分数比较并排序)。展开详情 示例值:RRF |
HybridSearchArgsmap<map<any>> | 双路召回的算法参数。目前支持 RRF 和 Weight 两种:展开详情 |
OrderBystring | 默认为空,表示排序的依据字段。不支持双路召回场景。展开详情 示例值:chunk_id |
Offsetinteger<int32> | 默认为空,表示分页查询时的检索起点。不支持双路召回场景。展开详情 示例值:0 |
IncludeMetadataFieldsstring | 默认为空,表示要返回的 metadata 字段,多个字段用逗号分隔。 示例值:title,content |
WorkspaceIdstring | 多数据库实例组成的 Workspace 的 Id。此参数和 DBInstanceId 参数不能同时为空,当和 DBInstanceId 同时指定时以此参数为准。 示例值:gp-ws-***** |
RelationalTableFilterobject | 使用另外一张关系表实现向量数据过滤(类似 Join 的功能)。展开详情 |
返回参数
字段名称 | 字段详情 |
---|---|
Matchesobject | |
RequestIdstring | 请求 ID。 示例值:ABB39CC3-4488-4857-905D-2E4A051D0521 |
Statusstring | 状态,取值说明:展开详情 示例值:success |
Messagestring | 请求失败时的详细信息。 示例值:0.1234 |
Totalinteger<int32> | 当请求 Offset 不为 0 时才返回,返回值为该检索条件的命中总数。 示例值:100 |
变更历史
变更时间 | 变更内容概要 | 操作 | |
---|---|---|---|
2025-03-11 | 新增请求参数SparseVector | ||
2024-08-28 | 新增请求参数RelationalTableFilter | ||
2024-08-04 | 变更请求参数DBInstanceId 新增请求参数WorkspaceId | ||
2024-04-29 | 新增请求参数OrderBy 新增请求参数Offset 新增请求参数IncludeMetadataFields 变更返回参数 | ||
2024-04-22 | 新增请求参数HybridSearch 新增请求参数HybridSearchArgs | ||
2023-11-07 | 变更请求参数RegionId | ||
2023-08-17 | 新增请求参数Metrics 新增请求参数IncludeValues | ||
2023-08-08 | 变更返回参数 |