检索知识库。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| pailangstudio:RetrieveKnowledgeBase | none | *全部资源 * |
| 无 |
请求语法
POST /api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/action/retrieve HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| KnowledgeBaseId | string | 否 | 知识库 ID。 | d-ksicx823d |
| body | object | 否 | 请求体。 | |
| WorkspaceId | string | 是 | 知识库所在工作空间 ID。 | 174*** |
| Query | string | 是 | 检索内容。 | red car |
| TopK | integer | 否 | 返回排名最高的结果数。 | 5 |
| ScoreThreshold | float | 否 | 相似度分数阈值。浮点型，取值范围[0, 1]。 | 0.5 |
| MetaDataFilterConditions | string | 否 | 选填。元数据过滤检索条件。格式为 JSON 格式字符串，JSON 字段定义如下：
| { "FilterCondition": "and", "MetaDataFilters": [ { "Key": "key1", "Value": "value1", "Operator": "==" }, { "Key": "key2", "Value": "value2", "Operator": "!=" }, { "Key": "file_name", "Value": "prefix", "Operator": "contains" } ] } |
| QueryMode | string | 否 | 检索模式。
| dense |
| VersionName | string | 否 | 知识库版本。默认 v1。 | v1 |
| RerankConfig | string | 否 | Rerank 配置，选填。JSON 格式字符串，JSON 字段定义如下：
| { "ConnectionId":"conn-xxx", "Model": "qwen-max", "TopK": 5 } |
| RewriteConfig | string | 否 | Rewrite 配置，选填。JSON 格式字符串，JSON 字段定义如下：
| { "ConnectionId":"conn-xxx", "Model": "qwen-max", "Temperature": 0.7, "TopP": 0.9, "PresencePenalty": 0.5, "FrequencyPenalty": 0.5, "Seed": 0, "MaxTokens": 1024, "Stop": [], "EnableThinking": true } |
| HybridStrategyConfig | string | 否 | 混合检索策略配置，选填。JSON 格式字符串，JSON 字段定义如下：
| { "Strategy": "rrf", "RRFK":60, "Weight": 0.5 } |
返回参数
示例
正常返回示例
JSON格式
{
"KnowledgeBaseFileChunks": [
{
"Score": 0.9832,
"ChunkId": "7fjs******90fs",
"ChunkStart": 0,
"ChunkEnd": 30000,
"ChunkSequence": 0,
"ChunkContent": "content of chunk",
"ChunkSize": 3452,
"ChunkStatus": "Enable",
"DownloadUrl": "https://cas-documents-service.oss-cn-shanghai.aliyuncs.com/5743962650c522fd54620fb9868d8c4c?Expires=1735092238&OSSAccessKeyId=LTAIgoNm******",
"ThumbnailUrl": "https://cas-documents-service.oss-cn-shanghai.aliyuncs.com/5743962650c522fd54620fb9868d8c4c?Expires=1735092238&OSSAccessKeyId=LTAIgoNm******",
"ChunkAttachment": [
{
"PlaceholderId": "IMAGE_PLACEHOLDER_0",
"Type": "image",
"Uri": "oss://mybucket/file1/img1.jpg",
"DownloadUrl": "https://cas-documents-service.oss-cn-shanghai.aliyuncs.com/Batch_Upload_Monitor_Domain.xlsx?Expires=1737338736&OSSAccessKeyId=LTAIgoNm******"
}
],
"MetaData": {
"FileName": "abc.txt",
"FileUri": "oss://mybucket/path/abc.txt",
"FileMetaId": "sd8c******67ux"
}
}
]
}错误码
访问错误中心查看更多错误码。