GITBOOK-12: joshua's Oct 12 changes

pull/22/head
joshua 2023-10-12 10:04:40 +00:00 committed by gitbook-bot
parent 38961fb4f9
commit 74a08d07c2
No known key found for this signature in database
GPG Key ID: 07D2180C7B12D0FF
1 changed files with 12 additions and 17 deletions

View File

@ -1,19 +1,17 @@
# 通过 API 维护数据集
> 鉴权、调用方式与应用 Service API 保持一致,不同的是一个数据集 API token 可操作所有数据集
### 使用数据集API的优势
* 将您的数据系统同步至 Dify 数据集,创建强大的工作流程。
* 提供数据集列表,文档列表及详情查询,方便构建您自己的数据管理页。
* 同时支持纯文本和文件两种上传和更新文档的接口,并支持分段级的批量新增和修改,便捷您的同步方式。
* 减少文档手动处理同步的时间,提高您对 Dify 的软件和服务的可见性。
### 如何使用
进入数据集页面,你可以在左侧的导航中切换至 **API** 页面. 在该页面中你可以查看 Dify 提供的 数据集 API 文档,并可以在 **API 秘钥** 中管理可访问数据集 API 的凭据。
进入数据集页面,你可以在左侧的导航中切换至 **API** 页面。在该页面中你可以查看 Dify 提供的数据集 API 文档,并可以在 **API 密钥** 中管理可访问数据集 API 的凭据。
<figure><img src="../../.gitbook/assets/dataset-api-token.png" alt=""><figcaption><p>Dataset API Document</p></figcaption></figure>
@ -35,7 +33,6 @@ curl --location --request POST 'https://api.dify.ai/v1/datasets' \
#### **数据集列表**
```
curl --location --request GET 'https://api.dify.ai/v1/datasets?page=1&limit=20' \
--header 'Authorization: Bearer {api_key}'
@ -109,7 +106,6 @@ curl --location --request GET 'https://api.dify.ai/v1/datasets/{dataset_id}/docu
--header 'Authorization: Bearer {api_key}'
```
#### **删除文档**
```
@ -140,16 +136,15 @@ curl 'https://api.dify.ai/v1/datasets/aac47674-31a8-4f12-aab2-9603964c4789/docum
```
### 错误信息
- `document_indexing`,文档索引失败
- `provider_not_initialize` Embedding 模型未配置
- `not_found`,文档不存在
- `dataset_name_duplicate` ,数据集名称重复
- `provider_quota_exceeded`,模型额度超过限制
- `dataset_not_initialized`,数据集还未初始化
- `unsupported_file_type`,不支持的文件类型
- 目前只支持txt, markdown, md, pdf, html, htm, xlsx, docx, csv
- `too_many_files`,文件数量过多,暂时只支持单一文件上传
- `file_too_large`文件太大支持15M以下
* `document_indexing`,文档索引失败
* `provider_not_initialize` Embedding 模型未配置
* `not_found`,文档不存在
* `dataset_name_duplicate` ,数据集名称重复
* `provider_quota_exceeded`,模型额度超过限制
* `dataset_not_initialized`,数据集还未初始化
* `unsupported_file_type`,不支持的文件类型
* 目前只支持txt, markdown, md, pdf, html, htm, xlsx, docx, csv
* `too_many_files`,文件数量过多,暂时只支持单一文件上传
* `file_too_large`文件太大支持15M以下