diff --git a/web/app/(commonLayout)/datasets/template/template.en.mdx b/web/app/(commonLayout)/datasets/template/template.en.mdx index 7e109f897f..e227323694 100644 --- a/web/app/(commonLayout)/datasets/template/template.en.mdx +++ b/web/app/(commonLayout)/datasets/template/template.en.mdx @@ -1,7 +1,7 @@ import { CodeGroup } from '@/app/components/develop/code.tsx' import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from '@/app/components/develop/md.tsx' -# Dataset API +# Knowledge API
content
(text) Text content/question content, required
- - answer
(text) Answer content, if the mode of the data set is qa mode, pass the value(optional)
+ - answer
(text) Answer content, if the mode of the Knowledge is qa mode, pass the value(optional)
- keywords
(list) Keywords(optional)
content
(text) text content/question content,required
- - answer
(text) Answer content, not required, passed if the data set is in qa mode
+ - answer
(text) Answer content, not required, passed if the Knowledge is in qa mode
- keywords
(list) keyword, not required
- enabled
(bool) false/true, not required
code | -status | -message | +code | +status | +message |
---|---|---|---|---|---|
no_file_uploaded | -400 | -Please upload your file. | +no_file_uploaded | +400 | +Please upload your file. |
too_many_files | -400 | -Only one file is allowed. | +too_many_files | +400 | +Only one file is allowed. |
file_too_large | -413 | -File size exceeded. | +file_too_large | +413 | +File size exceeded. |
unsupported_file_type | -415 | -File type not allowed. | +unsupported_file_type | +415 | +File type not allowed. |
high_quality_dataset_only | -400 | -Current operation only supports 'high-quality' datasets. | +high_quality_dataset_only | +400 | +Current operation only supports 'high-quality' datasets. |
dataset_not_initialized | -400 | -The dataset is still being initialized or indexing. Please wait a moment. | +dataset_not_initialized | +400 | +The dataset is still being initialized or indexing. Please wait a moment. |
archived_document_immutable | -403 | -The archived document is not editable. | +archived_document_immutable | +403 | +The archived document is not editable. |
dataset_name_duplicate | -409 | -The dataset name already exists. Please modify your dataset name. | +dataset_name_duplicate | +409 | +The dataset name already exists. Please modify your dataset name. |
invalid_action | -400 | -Invalid action. | +invalid_action | +400 | +Invalid action. |
document_already_finished | -400 | -The document has been processed. Please refresh the page or go to the document details. | +document_already_finished | +400 | +The document has been processed. Please refresh the page or go to the document details. |
document_indexing | -400 | -The document is being processed and cannot be edited. | +document_indexing | +400 | +The document is being processed and cannot be edited. |
invalid_metadata | -400 | -The metadata content is incorrect. Please check and verify. | +invalid_metadata | +400 | +The metadata content is incorrect. Please check and verify. |
content
(text) 文本内容/问题内容,必填
- - answer
(text) 答案内容,非必填,如果数据集的模式为qa模式则传值
+ - answer
(text) 答案内容,非必填,如果知识库的模式为qa模式则传值
- keywords
(list) 关键字,非必填
content
(text) 文本内容/问题内容,必填
- - answer
(text) 答案内容,非必填,如果数据集的模式为qa模式则传值
+ - answer
(text) 答案内容,非必填,如果知识库的模式为qa模式则传值
- keywords
(list) 关键字,非必填
- enabled
(bool) false/true,非必填
code | -status | -message | +code | +status | +message |
---|---|---|---|---|---|
no_file_uploaded | -400 | -Please upload your file. | +no_file_uploaded | +400 | +Please upload your file. |
too_many_files | -400 | -Only one file is allowed. | +too_many_files | +400 | +Only one file is allowed. |
file_too_large | -413 | -File size exceeded. | +file_too_large | +413 | +File size exceeded. |
unsupported_file_type | -415 | -File type not allowed. | +unsupported_file_type | +415 | +File type not allowed. |
high_quality_dataset_only | -400 | -Current operation only supports 'high-quality' datasets. | +high_quality_dataset_only | +400 | +Current operation only supports 'high-quality' datasets. |
dataset_not_initialized | -400 | -The dataset is still being initialized or indexing. Please wait a moment. | +dataset_not_initialized | +400 | +The dataset is still being initialized or indexing. Please wait a moment. |
archived_document_immutable | -403 | -The archived document is not editable. | +archived_document_immutable | +403 | +The archived document is not editable. |
dataset_name_duplicate | -409 | -The dataset name already exists. Please modify your dataset name. | +dataset_name_duplicate | +409 | +The dataset name already exists. Please modify your dataset name. |
invalid_action | -400 | -Invalid action. | +invalid_action | +400 | +Invalid action. |
document_already_finished | -400 | -The document has been processed. Please refresh the page or go to the document details. | +document_already_finished | +400 | +The document has been processed. Please refresh the page or go to the document details. |
document_indexing | -400 | -The document is being processed and cannot be edited. | +document_indexing | +400 | +The document is being processed and cannot be edited. |
invalid_metadata | -400 | -The metadata content is incorrect. Please check and verify. | +invalid_metadata | +400 | +The metadata content is incorrect. Please check and verify. |