QueryContent_云原生数据仓库 AnalyticDB PostgreSQL版_API文档

2016-05-03

获取元数据获取 SDK

找不到 API ? 点击反馈吧

插件下载了解更多

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

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

请求速率为3000/1(s)。

授权信息

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

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

gpdb:QueryContent	Create	Document acs:gpdb:{#regionId}:{#accountId}:document/{#DBInstanceId}	无	无

请求参数

字段名称	字段详情
DBInstanceIdstring	实例 ID。展开详情示例值:gp-xxxxxxxxx参考取值来源: UpgradeDBInstance CreateDBInstance UpdateDBInstancePlan DescribeDBInstances PauseInstance ModifyDBInstancePayType ResumeInstance UploadDocumentAsync DownloadDiagnosisRecords UnloadSampleData
Namespacestring	命名空间，默认为 public。展开详情示例值:mynamespace参考取值来源: ListNamespaces CreateNamespace
Collectionstring	文档库名称。展开详情示例值:document参考取值来源: ListCollections CreateCollection UpsertCollectionData
RegionIdstring	实例所在的地域 ID。示例值:cn-hangzhou参考取值来源: DescribeRegions
NamespacePasswordstring	命名空间对应的密码。展开详情示例值:testpassword
Contentstring	用于检索的文本内容。示例值:ADBPG是什么？
Filterstring	要查询的数据的过滤条件，格式为 SQL 的 WHERE 格式。是一个返回布尔值（真或假）的表达式，条件可以是简单的比较运算符，如等于(=)、不等于(<>或!=)、大于(>), 小于(<)、大于等于(>=)、小于等于(<=)，也可以是逻辑运算符（AND, OR, NOT）组合的更复杂的表达式，以及使用 IN、BETWEEN、LIKE 等关键字的条件。展开详情示例值:title = 'test' AND name like 'test%'
RecallWindowarray<integer<int32>>	召回窗口。当该值不为空时，增加返回检索结果的上下文。格式为 2 个元素的数组：List<A, B>，其中-10<=A<=0，0<=B<=10。展开详情
TopKinteger<int32>	设置返回 top 结果数量。示例值:10取值 <= 2147483647
RerankFactornumber<double>	重排因子。当该值不为空时，会对向量检索结果再做一次重排。取值范围：1<RerankFactor<=5。展开详情示例值:2
UseFullTextRetrievalboolean	是否使用全文检索（双路召回）。默认为 false，仅采用向量检索。示例值:true
Metricsstring	检索时的相似度算法。此值为空时则采用创建知识库时指定的算法，建议如无特殊需求不需设置。展开详情示例值:cosine
FileNamestring	以图搜图场景中，待搜索的图片源文件名。展开详情示例值:test.jpg
FileUrlstring	以图搜图场景中，公网可访问的图片文件 URL 地址。展开详情示例值:https://xx/myImage.jpg
IncludeVectorboolean	是否返回向量。默认为 false。展开详情示例值:true
HybridSearchstring	双路召回算法，默认为空(即直接将向量和全文的分数比较并排序)。展开详情示例值:RRF
HybridSearchArgsmap<map<any>>	双路召回的算法参数。目前支持 RRF 和 Weight 两种：展开详情
IncludeMetadataFieldsstring	默认为空，表示要返回的 metadata 字段，多个字段用逗号分隔。示例值:title,page
IncludeFileUrlboolean	是否同步返回文档的链接地址，默认不返回。示例值:false

返回参数

字段名称	字段详情
RequestIdstring	请求 ID。示例值:ABB39CC3-4488-4857-905D-2E4A051D0521
Messagestring	返回信息。示例值:success
Statusstring	状态，取值如下：展开详情示例值:success
Matchesobject
WindowMatchesobject
EmbeddingTokensstring	向量化时使用的 token 数。展开详情示例值:100
Usageobject	本次查询的资源使用量

返回示例

变更历史

	变更时间	变更内容概要	操作
	2025-03-25	变更请求参数Content
	2024-07-18	新增请求参数IncludeFileUrl
	2024-04-29	新增请求参数IncludeMetadataFields
	2024-04-22	新增请求参数HybridSearch 新增请求参数HybridSearchArgs
	2024-02-19	新增请求参数RerankFactor 新增请求参数IncludeVector 新增请求参数RecallWindow 变更返回参数
	2024-01-17	变更请求参数Content 变更请求参数TopK 新增请求参数FileName 新增请求参数FileUrl 变更返回参数

相关示例

查询文档内容

2023-11-30