浏览代码

Docs: Updated knowledge graph-specific APIs (#8927)

### What problem does this PR solve?

### Type of change

- [x] Documentation Update
tags/v0.20.0
writinwaters 3 个月前
父节点
当前提交
fca9203f18
没有帐户链接到提交者的电子邮件
共有 2 个文件被更改,包括 9 次插入5 次删除
  1. 5
    1
      docs/quickstart.mdx
  2. 4
    4
      docs/references/http_api_reference.md

+ 5
- 1
docs/quickstart.mdx 查看文件

@@ -222,7 +222,11 @@ The embedding models included in `v0.19.1` and `nightly` are:
- BAAI/bge-large-zh-v1.5
- maidalun1020/bce-embedding-base_v1

These two embedding models are optimized specifically for English and Chinese, so performance may be compromised if you use them to embed documents in other languages.
These two embedding models are optimized specifically for English and Chinese, so performance will be compromised if you use them to embed documents in other languages.
:::

:::tip NOTE
The image size shown refers to the size of the *downloaded* Docker image, which is compressed. When Docker runs the image, it unpacks it, resulting in significantly greater disk usage. For example, a slim edition image will expand to around 7 GB once unpacked.
:::

4. Check the server status after having the server up and running:

+ 4
- 4
docs/references/http_api_reference.md 查看文件

@@ -772,7 +772,7 @@ Failure:

**GET** `/api/v1/datasets/{dataset_id}/knowledge_graph`

Gets the knowledge graph of a specific datasets.
Retrieves the knowledge graph of a specified dataset.

#### Request

@@ -792,7 +792,7 @@ curl --request GET \
##### Request parameters

- `dataset_id`: (*Path parameter*)
The ID of the dataset.
The ID of the target dataset.

#### Response

@@ -851,7 +851,7 @@ Failure:

**DELETE** `/api/v1/datasets/{dataset_id}/knowledge_graph`

Deletes the knowledge graph of a specific datasets.
Removes the knowledge graph of a specified dataset.

#### Request

@@ -871,7 +871,7 @@ curl --request DELETE \
##### Request parameters

- `dataset_id`: (*Path parameter*)
The ID of the dataset.
The ID of the target dataset.

#### Response


正在加载...
取消
保存