/ai/documentSet/get 接口用于获取文件完整内容,以及系统分配的文件 ID、关键字、文件大小、预处理进度与状态等信息。
请求示例
注意:
如下示例可直接复制,在 CVM 运行之前,您需在文本编辑器将 api_key=A5VOgsMpGWJhUI0WmUbY******************** 与 10.0.X.X 依据实际情况进行替换。
curl -i -X POST \\-H 'Content-Type: application/json' \\-H 'Authorization: Bearer account=root&api_key=A5VOgsMpGWJhUI0WmUbY********************' \\http://10.0.X.X:80/ai/documentSet/get \\-d '{"database": "db-test-ai","collectionView": "coll-ai-files","documentSetName":"腾讯云向量数据库.md"}'
curl -i -X POST \\-H 'Content-Type: application/json' \\-H 'Authorization: Bearer account=root&api_key=A5VOgsMpGWJhUI0WmUbY********************' \\http://10.0.X.X:80/ai/documentSet/get \\-d '{"database": "db-test-ai","collectionView": "coll-ai-files","documentSetId": "11790179945********"}'
请求参数
参数名 | 是否必选 | 参数含义 | 获取方式 |
database | 是 | 文件所存储的数据库名 | |
collectionView | 是 | 文件所存储的集合名 | |
documentSetId | 否 | 文件上传在数据库之后,系统分配的文件 ID | 使用文件名查找文件内容,可获取文件 ID。 |
documnetSetName | 否 | 文件名 | - |
返回参数
参数名 | 子参数(一级) | 子参数(二级) | 参数含义 |
count | - | - | 获取的数量。 |
documentSet | documnetSetId | - | 文件 ID。 |
| documnetSetName | - | 文件名。 |
| textPrefix | - | 文件内容前 200个字符。 |
| text | - | 文件完整内容。 |
| documentSetInfo | textLength | 文件的字符数。 |
| | byteLength | 文件的字节数。 |
| | indexedProgress | 文件被预处理、Embedding 向量化的进度。 |
| |
indexedStatus
| 文件预处理、Embedding 向量化的状态。 New:等待解析。 Loading:文件解析中。 Failure:文件解析、写入出错。 Ready:文件解析、写入完成。 |
| | createTime | 文件创建时间。 |
| | lastUpdateTime | 文件最后更新时间。 |
| | keywords | 文件关键字。 |
| splitterPreprocess | appendTitleToChunk | 在对文件拆分时,配置是否将 Title 追加到切分后的段落后面一并 Embedding。取值如下所示: false:不追加。 true:将段落 Title 追加到切分后的段落。 |
| | appendKeywordsToChunk | 在对文件拆分时,配置是否将关键字 keywords 追加到切分后的段落一并 Embedding。取值如下所示: false:不追加。 true:将全文的 keywords 追加到切分后的段落。 |
author | - | - | 自定义的文件 Meta 信息字段。 |