writinwaters
commited on
Commit
·
d685b9e
1
Parent(s):
1fa04f3
Minor editorial updates to the HTTP API reference (#3027)
Browse files### What problem does this PR solve?
### Type of change
- [x] Documentation Update
- api/http_api_reference.md +13 -11
api/http_api_reference.md
CHANGED
|
@@ -91,7 +91,7 @@ curl --request POST \
|
|
| 91 |
- `"email"`: Email
|
| 92 |
|
| 93 |
- `"parser_config"`: (*Body parameter*), `object`
|
| 94 |
-
The configuration settings for the dataset parser
|
| 95 |
- `"chunk_token_count"`: Defaults to `128`.
|
| 96 |
- `"layout_recognize"`: Defaults to `true`.
|
| 97 |
- `"delimiter"`: Defaults to `"\n!?。;!?"`.
|
|
@@ -236,11 +236,13 @@ curl --request PUT \
|
|
| 236 |
|
| 237 |
- `dataset_id`: (*Path parameter*)
|
| 238 |
The ID of the dataset to update.
|
| 239 |
-
- `"name"`: `string`
|
| 240 |
The revised name of the dataset.
|
| 241 |
-
- `"embedding_model"`: `string`
|
|
|
|
| 242 |
- Ensure that `"chunk_count"` is `0` before updating `"embedding_model"`.
|
| 243 |
-
- `"chunk_method"`: `enum<string>`
|
|
|
|
| 244 |
- `"naive"`: General
|
| 245 |
- `"manual`: Manual
|
| 246 |
- `"qa"`: Q&A
|
|
@@ -298,19 +300,19 @@ curl --request GET \
|
|
| 298 |
|
| 299 |
#### Request parameters
|
| 300 |
|
| 301 |
-
- `page`: (*
|
| 302 |
Specifies the page on which the datasets will be displayed. Defaults to `1`.
|
| 303 |
-
- `page_size`: (*
|
| 304 |
The number of datasets on each page. Defaults to `1024`.
|
| 305 |
-
- `orderby`: (*
|
| 306 |
The field by which datasets should be sorted. Available options:
|
| 307 |
- `create_time` (default)
|
| 308 |
- `update_time`
|
| 309 |
-
- `desc`: (*
|
| 310 |
Indicates whether the retrieved datasets should be sorted in descending order. Defaults to `true`.
|
| 311 |
-
- `name`: (*
|
| 312 |
The name of the dataset to retrieve.
|
| 313 |
-
- `id`: (*
|
| 314 |
The ID of the dataset to retrieve.
|
| 315 |
|
| 316 |
### Response
|
|
@@ -1220,7 +1222,7 @@ curl --request POST \
|
|
| 1220 |
The maximum number of chunks to retrieve. Defaults to `1024`.
|
| 1221 |
- `"similarity_threshold"`: (*Body parameter*)
|
| 1222 |
The minimum similarity score. Defaults to `0.2`.
|
| 1223 |
-
- `"vector_similarity_weight"`: (*Body parameter*), `
|
| 1224 |
The weight of vector cosine similarity. Defaults to `0.3`. If x represents the vector cosine similarity, then (1 - x) is the term similarity weight.
|
| 1225 |
- `"top_k"`: (*Body parameter*), `integer`
|
| 1226 |
The number of chunks engaged in vector cosine computaton. Defaults to `1024`.
|
|
|
|
| 91 |
- `"email"`: Email
|
| 92 |
|
| 93 |
- `"parser_config"`: (*Body parameter*), `object`
|
| 94 |
+
The configuration settings for the dataset parser, a JSON object containing the following attributes:
|
| 95 |
- `"chunk_token_count"`: Defaults to `128`.
|
| 96 |
- `"layout_recognize"`: Defaults to `true`.
|
| 97 |
- `"delimiter"`: Defaults to `"\n!?。;!?"`.
|
|
|
|
| 236 |
|
| 237 |
- `dataset_id`: (*Path parameter*)
|
| 238 |
The ID of the dataset to update.
|
| 239 |
+
- `"name"`: (*Body parameter*), `string`
|
| 240 |
The revised name of the dataset.
|
| 241 |
+
- `"embedding_model"`: (*Body parameter*), `string`
|
| 242 |
+
The updated embedding model name.
|
| 243 |
- Ensure that `"chunk_count"` is `0` before updating `"embedding_model"`.
|
| 244 |
+
- `"chunk_method"`: (*Body parameter*), `enum<string>`
|
| 245 |
+
The chunking method for the dataset. Available options:
|
| 246 |
- `"naive"`: General
|
| 247 |
- `"manual`: Manual
|
| 248 |
- `"qa"`: Q&A
|
|
|
|
| 300 |
|
| 301 |
#### Request parameters
|
| 302 |
|
| 303 |
+
- `page`: (*Filter parameter*)
|
| 304 |
Specifies the page on which the datasets will be displayed. Defaults to `1`.
|
| 305 |
+
- `page_size`: (*Filter parameter*)
|
| 306 |
The number of datasets on each page. Defaults to `1024`.
|
| 307 |
+
- `orderby`: (*Filter parameter*)
|
| 308 |
The field by which datasets should be sorted. Available options:
|
| 309 |
- `create_time` (default)
|
| 310 |
- `update_time`
|
| 311 |
+
- `desc`: (*Filter parameter*)
|
| 312 |
Indicates whether the retrieved datasets should be sorted in descending order. Defaults to `true`.
|
| 313 |
+
- `name`: (*Filter parameter*)
|
| 314 |
The name of the dataset to retrieve.
|
| 315 |
+
- `id`: (*Filter parameter*)
|
| 316 |
The ID of the dataset to retrieve.
|
| 317 |
|
| 318 |
### Response
|
|
|
|
| 1222 |
The maximum number of chunks to retrieve. Defaults to `1024`.
|
| 1223 |
- `"similarity_threshold"`: (*Body parameter*)
|
| 1224 |
The minimum similarity score. Defaults to `0.2`.
|
| 1225 |
+
- `"vector_similarity_weight"`: (*Body parameter*), `float`
|
| 1226 |
The weight of vector cosine similarity. Defaults to `0.3`. If x represents the vector cosine similarity, then (1 - x) is the term similarity weight.
|
| 1227 |
- `"top_k"`: (*Body parameter*), `integer`
|
| 1228 |
The number of chunks engaged in vector cosine computaton. Defaults to `1024`.
|