From a430284aa21e3ae1f0d5654e55b2ad2852519cc2 Mon Sep 17 00:00:00 2001
From: wwf <yearningwang@iqtogether.com>
Date: 星期三, 04 六月 2025 15:17:49 +0800
Subject: [PATCH] 初始化
---
app/(commonLayout)/datasets/template/template.zh.mdx | 1181 +++++++++++------------------------------------------------
1 files changed, 221 insertions(+), 960 deletions(-)
diff --git "a/app/\050commonLayout\051/datasets/template/template.zh.mdx" "b/app/\050commonLayout\051/datasets/template/template.zh.mdx"
index e3c716e..0e5857c 100644
--- "a/app/\050commonLayout\051/datasets/template/template.zh.mdx"
+++ "b/app/\050commonLayout\051/datasets/template/template.zh.mdx"
@@ -1,8 +1,3 @@
-{/**
- * @typedef Props
- * @property {string} apiBaseUrl
- */}
-
import { CodeGroup } from '@/app/components/develop/code.tsx'
import { Row, Col, Properties, Property, Heading, SubProperty, PropertyInstruction, Paragraph } from '@/app/components/develop/md.tsx'
@@ -52,10 +47,49 @@
<Property name='text' type='string' key='text'>
鏂囨。鍐呭
</Property>
+ <Property name='doc_type' type='string' key='doc_type'>
+ 鏂囨。绫诲瀷锛堥�夊～锛�
+ - <code>book</code> 鍥句功 Book
+ - <code>web_page</code> 缃戦〉 Web page
+ - <code>paper</code> 瀛︽湳璁烘枃/鏂囩珷 Academic paper/article
+ - <code>social_media_post</code> 绀句氦濯掍綋甯栧瓙 Social media post
+ - <code>wikipedia_entry</code> 缁村熀鐧剧鏉＄洰 Wikipedia entry
+ - <code>personal_document</code> 涓汉鏂囨。 Personal document
+ - <code>business_document</code> 鍟嗕笟鏂囨。 Business document
+ - <code>im_chat_log</code> 鍗虫椂閫氳璁板綍 Chat log
+ - <code>synced_from_notion</code> Notion鍚屾鏂囨。 Notion document
+ - <code>synced_from_github</code> GitHub鍚屾鏂囨。 GitHub document
+ - <code>others</code> 鍏朵粬鏂囨。绫诲瀷 Other document types
+ </Property>
+ <Property name='doc_metadata' type='object' key='doc_metadata'>
+
+ 鏂囨。鍏冩暟鎹紙濡傛彁渚涙枃妗ｇ被鍨嬪垯蹇呭～锛夈�傚瓧娈靛洜鏂囨。绫诲瀷鑰屽紓锛�
+
+ 閽堝鍥句功 For <code>book</code>:
+ - <code>title</code> 涔﹀悕 Book title
+ - <code>language</code> 鍥句功璇█ Book language
+ - <code>author</code> 浣滆�� Book author
+ - <code>publisher</code> 鍑虹増绀� Publisher name
+ - <code>publication_date</code> 鍑虹増鏃ユ湡 Publication date
+ - <code>isbn</code> ISBN鍙风爜 ISBN number
+ - <code>category</code> 鍥句功鍒嗙被 Book category
+
+ 閽堝缃戦〉 For <code>web_page</code>:
+ - <code>title</code> 椤甸潰鏍囬 Page title
+ - <code>url</code> 椤甸潰缃戝潃 Page URL
+ - <code>language</code> 椤甸潰璇█ Page language
+ - <code>publish_date</code> 鍙戝竷鏃ユ湡 Publish date
+ - <code>author/publisher</code> 浣滆��/鍙戝竷鑰� Author or publisher
+ - <code>topic/keywords</code> 涓婚/鍏抽敭璇� Topic or keywords
+ - <code>description</code> 椤甸潰鎻忚堪 Page description
+
+ 璇锋煡鐪� [api/services/dataset_service.py](https://github.com/langgenius/dify/blob/main/api/services/dataset_service.py#L475) 浜嗚В鍚勬枃妗ｇ被鍨嬫墍闇�瀛楁鐨勮缁嗕俊鎭��
+
+ 閽堝"鍏朵粬"绫诲瀷鏂囨。锛屾帴鍙椾换浣曟湁鏁堢殑JSON瀵硅薄
+ </Property>
<Property name='indexing_technique' type='string' key='indexing_technique'>
绱㈠紩鏂瑰紡
- - <code>high_quality</code> 楂樿川閲忥細浣跨敤
- ding 妯″瀷杩涜宓屽叆锛屾瀯寤轰负鍚戦噺鏁版嵁搴撶储寮�
+ - <code>high_quality</code> 楂樿川閲忥細浣跨敤 embedding 妯″瀷杩涜宓屽叆锛屾瀯寤轰负鍚戦噺鏁版嵁搴撶储寮�
- <code>economy</code> 缁忔祹锛氫娇鐢� keyword table index 鐨勫�掓帓绱㈠紩杩涜鏋勫缓
</Property>
<Property name='doc_form' type='string' key='doc_form'>
@@ -94,9 +128,6 @@
- <code>semantic_search</code> 璇箟妫�绱�
- <code>full_text_search</code> 鍏ㄦ枃妫�绱�
- <code>reranking_enable</code> (bool) 鏄惁寮�鍚痳erank
- - <code>reranking_mode</code> (String) 娣峰悎妫�绱�
- - <code>weighted_score</code> 鏉冮噸璁剧疆
- - <code>reranking_model</code> Rerank 妯″瀷
- <code>reranking_model</code> (object) Rerank 妯″瀷閰嶇疆
- <code>reranking_provider_name</code> (string) Rerank 妯″瀷鐨勬彁渚涘晢
- <code>reranking_model_name</code> (string) Rerank 妯″瀷鐨勫悕绉�
@@ -203,6 +234,68 @@
- <code>text_model</code> text 鏂囨。鐩存帴 embedding锛岀粡娴庢ā寮忛粯璁や负璇ユā寮�
- <code>hierarchical_model</code> parent-child 妯″紡
- <code>qa_model</code> Q&A 妯″紡锛氫负鍒嗙墖鏂囨。鐢熸垚 Q&A 瀵癸紝鐒跺悗瀵归棶棰樿繘琛� embedding
+ - <code>doc_type</code> 鏂囨。绫诲瀷锛堥�夊～锛塗ype of document (optional)
+ - <code>book</code> 鍥句功
+ 鏂囨。璁板綍涓�鏈功绫嶆垨鍑虹増鐗�
+ - <code>web_page</code> 缃戦〉
+ 缃戦〉鍐呭鐨勬枃妗ｈ褰�
+ - <code>paper</code> 瀛︽湳璁烘枃/鏂囩珷
+ 瀛︽湳璁烘枃鎴栫爺绌舵枃绔犵殑璁板綍
+ - <code>social_media_post</code> 绀句氦濯掍綋甯栧瓙
+ 绀句氦濯掍綋涓婄殑甯栧瓙鍐呭
+ - <code>wikipedia_entry</code> 缁村熀鐧剧鏉＄洰
+ 缁村熀鐧剧鐨勮瘝鏉″唴瀹�
+ - <code>personal_document</code> 涓汉鏂囨。
+ 涓汉鐩稿叧鐨勬枃妗ｈ褰�
+ - <code>business_document</code> 鍟嗕笟鏂囨。
+ 鍟嗕笟鐩稿叧鐨勬枃妗ｈ褰�
+ - <code>im_chat_log</code> 鍗虫椂閫氳璁板綍
+ 鍗虫椂閫氳鐨勮亰澶╄褰�
+ - <code>synced_from_notion</code> Notion鍚屾鏂囨。
+ 浠嶯otion鍚屾鐨勬枃妗ｅ唴瀹�
+ - <code>synced_from_github</code> GitHub鍚屾鏂囨。
+ 浠嶨itHub鍚屾鐨勬枃妗ｅ唴瀹�
+ - <code>others</code> 鍏朵粬鏂囨。绫诲瀷
+ 鍏朵粬鏈垪鍑虹殑鏂囨。绫诲瀷
+
+ - <code>doc_metadata</code> 鏂囨。鍏冩暟鎹紙濡傛彁渚涙枃妗ｇ被鍨嬪垯蹇呭～
+ 瀛楁鍥犳枃妗ｇ被鍨嬭�屽紓
+
+ 閽堝鍥句功绫诲瀷 For <code>book</code>:
+ - <code>title</code> 涔﹀悕
+ 涔︾睄鐨勬爣棰�
+ - <code>language</code> 鍥句功璇█
+ 涔︾睄鐨勮瑷�
+ - <code>author</code> 浣滆��
+ 涔︾睄鐨勪綔鑰�
+ - <code>publisher</code> 鍑虹増绀�
+ 鍑虹増绀剧殑鍚嶇О
+ - <code>publication_date</code> 鍑虹増鏃ユ湡
+ 涔︾睄鐨勫嚭鐗堟棩鏈�
+ - <code>isbn</code> ISBN鍙风爜
+ 涔︾睄鐨処SBN缂栧彿
+ - <code>category</code> 鍥句功鍒嗙被
+ 涔︾睄鐨勫垎绫荤被鍒�
+
+ 閽堝缃戦〉绫诲瀷 For <code>web_page</code>:
+ - <code>title</code> 椤甸潰鏍囬
+ 缃戦〉鐨勬爣棰�
+ - <code>url</code> 椤甸潰缃戝潃
+ 缃戦〉鐨刄RL鍦板潃
+ - <code>language</code> 椤甸潰璇█
+ 缃戦〉鐨勮瑷�
+ - <code>publish_date</code> 鍙戝竷鏃ユ湡
+ 缃戦〉鐨勫彂甯冩棩鏈�
+ - <code>author/publisher</code> 浣滆��/鍙戝竷鑰�
+ 缃戦〉鐨勪綔鑰呮垨鍙戝竷鑰�
+ - <code>topic/keywords</code> 涓婚/鍏抽敭璇�
+ 缃戦〉鐨勪富棰樻垨鍏抽敭璇�
+ - <code>description</code> 椤甸潰鎻忚堪
+ 缃戦〉鐨勬弿杩颁俊鎭�
+
+ 璇锋煡鐪� [api/services/dataset_service.py](https://github.com/langgenius/dify/blob/main/api/services/dataset_service.py#L475) 浜嗚В鍚勬枃妗ｇ被鍨嬫墍闇�瀛楁鐨勮缁嗕俊鎭��
+
+ 閽堝"鍏朵粬"绫诲瀷鏂囨。锛屾帴鍙椾换浣曟湁鏁堢殑JSON瀵硅薄
- <code>doc_language</code> 鍦� Q&A 妯″紡涓嬶紝鎸囧畾鏂囨。鐨勮瑷�锛屼緥濡傦細<code>English</code>銆�<code>Chinese</code>
@@ -338,26 +431,6 @@
<Property name='external_knowledge_id' type='str' key='external_knowledge_id'>
澶栭儴鐭ヨ瘑搴� ID锛堥�夊～锛�
</Property>
- <Property name='embedding_model' type='str' key='embedding_model'>
- Embedding 妯″瀷鍚嶇О
- </Property>
- <Property name='embedding_model_provider' type='str' key='embedding_model_provider'>
- Embedding 妯″瀷渚涘簲鍟�
- </Property>
- <Property name='retrieval_model' type='object' key='retrieval_model'>
- 妫�绱㈡ā寮�
- - <code>search_method</code> (string) 妫�绱㈡柟娉�
- - <code>hybrid_search</code> 娣峰悎妫�绱�
- - <code>semantic_search</code> 璇箟妫�绱�
- - <code>full_text_search</code> 鍏ㄦ枃妫�绱�
- - <code>reranking_enable</code> (bool) 鏄惁寮�鍚痳erank
- - <code>reranking_model</code> (object) Rerank 妯″瀷閰嶇疆
- - <code>reranking_provider_name</code> (string) Rerank 妯″瀷鐨勬彁渚涘晢
- - <code>reranking_model_name</code> (string) Rerank 妯″瀷鐨勫悕绉�
- - <code>top_k</code> (int) 鍙洖鏉℃暟
- - <code>score_threshold_enabled</code> (bool)鏄惁寮�鍚彫鍥炲垎鏁伴檺鍒�
- - <code>score_threshold</code> (float) 鍙洖鍒嗘暟闄愬埗
- </Property>
</Properties>
</Col>
<Col sticky>
@@ -415,20 +488,11 @@
<Col>
### Query
<Properties>
- <Property name='keyword' type='string' key='keyword'>
- 鎼滅储鍏抽敭璇嶏紝鍙��
- </Property>
- <Property name='tag_ids' type='array[string]' key='tag_ids'>
- 鏍囩 ID 鍒楄〃锛屽彲閫�
- </Property>
- <Property name='page' type='integer' key='page'>
- 椤电爜锛屽彲閫夛紝榛樿涓� 1
+ <Property name='page' type='string' key='page'>
+ 椤电爜
</Property>
<Property name='limit' type='string' key='limit'>
- 杩斿洖鏉℃暟锛屽彲閫夛紝榛樿 20锛岃寖鍥� 1-100
- </Property>
- <Property name='include_all' type='boolean' key='include_all'>
- 鏄惁鍖呭惈鎵�鏈夋暟鎹泦锛堜粎瀵规墍鏈夎�呯敓鏁堬級锛屽彲閫夛紝榛樿涓� false
+ 杩斿洖鏉℃暟锛岄粯璁� 20锛岃寖鍥� 1-100
</Property>
</Properties>
</Col>
@@ -469,252 +533,6 @@
"limit": 20,
"total": 50,
"page": 1
- }
- ```
- </CodeGroup>
- </Col>
-</Row>
-
-<hr className='ml-0 mr-0' />
-
-<Heading
- url='/datasets/{dataset_id}'
- method='GET'
- title='鏌ョ湅鐭ヨ瘑搴撹鎯�'
- name='#view_dataset'
-/>
-<Row>
- <Col>
- ### Path
- <Properties>
- <Property name='dataset_id' type='string' key='dataset_id'>
- 鐭ヨ瘑搴� ID
- </Property>
- </Properties>
- </Col>
- <Col sticky>
- <CodeGroup
- title="Request"
- tag="GET"
- label="/datasets/{dataset_id}"
- targetCode={`curl --location --request GET '${props.apiBaseUrl}/datasets/{dataset_id}' \\\n--header 'Authorization: Bearer {api_key}'`}
- >
- ```bash {{ title: 'cURL' }}
- curl --location --request GET '${props.apiBaseUrl}/datasets/{dataset_id}' \
- --header 'Authorization: Bearer {api_key}'
- ```
- </CodeGroup>
- <CodeGroup title="Response">
- ```json {{ title: 'Response' }}
- {
- "id": "eaedb485-95ac-4ffd-ab1e-18da6d676a2f",
- "name": "Test Knowledge Base",
- "description": "",
- "provider": "vendor",
- "permission": "only_me",
- "data_source_type": null,
- "indexing_technique": null,
- "app_count": 0,
- "document_count": 0,
- "word_count": 0,
- "created_by": "e99a1635-f725-4951-a99a-1daaaa76cfc6",
- "created_at": 1735620612,
- "updated_by": "e99a1635-f725-4951-a99a-1daaaa76cfc6",
- "updated_at": 1735620612,
- "embedding_model": null,
- "embedding_model_provider": null,
- "embedding_available": true,
- "retrieval_model_dict": {
- "search_method": "semantic_search",
- "reranking_enable": false,
- "reranking_mode": null,
- "reranking_model": {
- "reranking_provider_name": "",
- "reranking_model_name": ""
- },
- "weights": null,
- "top_k": 2,
- "score_threshold_enabled": false,
- "score_threshold": null
- },
- "tags": [],
- "doc_form": null,
- "external_knowledge_info": {
- "external_knowledge_id": null,
- "external_knowledge_api_id": null,
- "external_knowledge_api_name": null,
- "external_knowledge_api_endpoint": null
- },
- "external_retrieval_model": {
- "top_k": 2,
- "score_threshold": 0.0,
- "score_threshold_enabled": null
- }
- }
- ```
- </CodeGroup>
- </Col>
-</Row>
-
-<hr className='ml-0 mr-0' />
-
-<Heading
- url='/datasets/{dataset_id}'
- method='PATCH'
- title='淇敼鐭ヨ瘑搴撹鎯�'
- name='#update_dataset'
-/>
-<Row>
- <Col>
- ### Path
- <Properties>
- <Property name='dataset_id' type='string' key='dataset_id'>
- 鐭ヨ瘑搴� ID
- </Property>
- </Properties>
-
- ### Request Body
- <Properties>
- <Property name='indexing_technique' type='string' key='indexing_technique'>
- 绱㈠紩妯″紡锛堥�夊～锛屽缓璁～鍐欙級
- - <code>high_quality</code> 楂樿川閲�
- - <code>economy</code> 缁忔祹
- </Property>
- <Property name='permission' type='string' key='permission'>
- 鏉冮檺锛堥�夊～锛岄粯璁� only_me锛�
- - <code>only_me</code> 浠呰嚜宸�
- - <code>all_team_members</code> 鎵�鏈夊洟闃熸垚鍛�
- - <code>partial_members</code> 閮ㄥ垎鍥㈤槦鎴愬憳
- </Property>
- <Property name='embedding_model_provider' type='string' key='embedding_model_provider'>
- 宓屽叆妯″瀷鎻愪緵鍟嗭紙閫夊～锛�, 蹇呴』鍏堝湪绯荤粺鍐呰瀹氬ソ鎺ュ叆鐨勬ā鍨嬶紝瀵瑰簲鐨勬槸provider瀛楁
- </Property>
- <Property name='embedding_model' type='string' key='embedding_model'>
- 宓屽叆妯″瀷锛堥�夊～锛�
- </Property>
- <Property name='retrieval_model' type='object' key='retrieval_model'>
- 妫�绱㈠弬鏁帮紙閫夊～锛屽涓嶅～锛屾寜鐓ч粯璁ゆ柟寮忓彫鍥烇級
- - <code>search_method</code> (text) 妫�绱㈡柟娉曪細浠ヤ笅鍥涗釜鍏抽敭瀛椾箣涓�锛屽繀濉�
- - <code>keyword_search</code> 鍏抽敭瀛楁绱�
- - <code>semantic_search</code> 璇箟妫�绱�
- - <code>full_text_search</code> 鍏ㄦ枃妫�绱�
- - <code>hybrid_search</code> 娣峰悎妫�绱�
- - <code>reranking_enable</code> (bool) 鏄惁鍚敤 Reranking锛岄潪蹇呭～锛屽鏋滄绱㈡ā寮忎负 semantic_search 妯″紡鎴栬�� hybrid_search 鍒欎紶鍊�
- - <code>reranking_mode</code> (object) Rerank 妯″瀷閰嶇疆锛岄潪蹇呭～锛屽鏋滃惎鐢ㄤ簡 reranking 鍒欎紶鍊�
- - <code>reranking_provider_name</code> (string) Rerank 妯″瀷鎻愪緵鍟�
- - <code>reranking_model_name</code> (string) Rerank 妯″瀷鍚嶇О
- - <code>weights</code> (float) 娣峰悎妫�绱㈡ā寮忎笅璇剰妫�绱㈢殑鏉冮噸璁剧疆
- - <code>top_k</code> (integer) 杩斿洖缁撴灉鏁伴噺锛岄潪蹇呭～
- - <code>score_threshold_enabled</code> (bool) 鏄惁寮�鍚� score 闃堝��
- - <code>score_threshold</code> (float) Score 闃堝��
- </Property>
- <Property name='partial_member_list' type='array' key='partial_member_list'>
- 閮ㄥ垎鍥㈤槦鎴愬憳 ID 鍒楄〃锛堥�夊～锛�
- </Property>
- </Properties>
- </Col>
- <Col sticky>
- <CodeGroup
- title="Request"
- tag="PATCH"
- label="/datasets/{dataset_id}"
- targetCode={`curl --location --request PATCH '${props.apiBaseUrl}/datasets/{dataset_id}' \\\n--header 'Authorization: Bearer {api_key}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{
- "name": "Test Knowledge Base",
- "indexing_technique": "high_quality",
- "permission": "only_me",
- "embedding_model_provider": "zhipuai",
- "embedding_model": "embedding-3",
- "retrieval_model": {
- "search_method": "keyword_search",
- "reranking_enable": false,
- "reranking_mode": null,
- "reranking_model": {
- "reranking_provider_name": "",
- "reranking_model_name": ""
- },
- "weights": null,
- "top_k": 1,
- "score_threshold_enabled": false,
- "score_threshold": null
- },
- "partial_member_list": []
- }'
- `}
- >
- ```bash {{ title: 'cURL' }}
- curl --location --request PATCH '${props.apiBaseUrl}/datasets/{dataset_id}' \
- --header 'Authorization: Bearer {api_key}' \
- --header 'Content-Type: application/json' \
- --data-raw '{
- "name": "Test Knowledge Base",
- "indexing_technique": "high_quality",
- "permission": "only_me",
- "embedding_model_provider": "zhipuai",
- "embedding_model": "embedding-3",
- "retrieval_model": {
- "search_method": "keyword_search",
- "reranking_enable": false,
- "reranking_mode": null,
- "reranking_model": {
- "reranking_provider_name": "",
- "reranking_model_name": ""
- },
- "weights": null,
- "top_k": 1,
- "score_threshold_enabled": false,
- "score_threshold": null
- },
- "partial_member_list": []
- }'
- ```
- </CodeGroup>
- <CodeGroup title="Response">
- ```json {{ title: 'Response' }}
- {
- "id": "eaedb485-95ac-4ffd-ab1e-18da6d676a2f",
- "name": "Test Knowledge Base",
- "description": "",
- "provider": "vendor",
- "permission": "only_me",
- "data_source_type": null,
- "indexing_technique": "high_quality",
- "app_count": 0,
- "document_count": 0,
- "word_count": 0,
- "created_by": "e99a1635-f725-4951-a99a-1daaaa76cfc6",
- "created_at": 1735620612,
- "updated_by": "e99a1635-f725-4951-a99a-1daaaa76cfc6",
- "updated_at": 1735622679,
- "embedding_model": "embedding-3",
- "embedding_model_provider": "zhipuai",
- "embedding_available": null,
- "retrieval_model_dict": {
- "search_method": "semantic_search",
- "reranking_enable": false,
- "reranking_mode": null,
- "reranking_model": {
- "reranking_provider_name": "",
- "reranking_model_name": ""
- },
- "weights": null,
- "top_k": 2,
- "score_threshold_enabled": false,
- "score_threshold": null
- },
- "tags": [],
- "doc_form": null,
- "external_knowledge_info": {
- "external_knowledge_id": null,
- "external_knowledge_api_id": null,
- "external_knowledge_api_name": null,
- "external_knowledge_api_endpoint": null
- },
- "external_retrieval_model": {
- "top_k": 2,
- "score_threshold": 0.0,
- "score_threshold_enabled": null
- },
- "partial_member_list": []
}
```
</CodeGroup>
@@ -787,6 +605,46 @@
</Property>
<Property name='text' type='string' key='text'>
鏂囨。鍐呭锛堥�夊～锛�
+ </Property>
+ <Property name='doc_type' type='string' key='doc_type'>
+ 鏂囨。绫诲瀷锛堥�夊～锛�
+ - <code>book</code> 鍥句功 Book
+ - <code>web_page</code> 缃戦〉 Web page
+ - <code>paper</code> 瀛︽湳璁烘枃/鏂囩珷 Academic paper/article
+ - <code>social_media_post</code> 绀句氦濯掍綋甯栧瓙 Social media post
+ - <code>wikipedia_entry</code> 缁村熀鐧剧鏉＄洰 Wikipedia entry
+ - <code>personal_document</code> 涓汉鏂囨。 Personal document
+ - <code>business_document</code> 鍟嗕笟鏂囨。 Business document
+ - <code>im_chat_log</code> 鍗虫椂閫氳璁板綍 Chat log
+ - <code>synced_from_notion</code> Notion鍚屾鏂囨。 Notion document
+ - <code>synced_from_github</code> GitHub鍚屾鏂囨。 GitHub document
+ - <code>others</code> 鍏朵粬鏂囨。绫诲瀷 Other document types
+ </Property>
+ <Property name='doc_metadata' type='object' key='doc_metadata'>
+
+ 鏂囨。鍏冩暟鎹紙濡傛彁渚涙枃妗ｇ被鍨嬪垯蹇呭～锛夈�傚瓧娈靛洜鏂囨。绫诲瀷鑰屽紓锛�
+
+ 閽堝鍥句功 For <code>book</code>:
+ - <code>title</code> 涔﹀悕 Book title
+ - <code>language</code> 鍥句功璇█ Book language
+ - <code>author</code> 浣滆�� Book author
+ - <code>publisher</code> 鍑虹増绀� Publisher name
+ - <code>publication_date</code> 鍑虹増鏃ユ湡 Publication date
+ - <code>isbn</code> ISBN鍙风爜 ISBN number
+ - <code>category</code> 鍥句功鍒嗙被 Book category
+
+ 閽堝缃戦〉 For <code>web_page</code>:
+ - <code>title</code> 椤甸潰鏍囬 Page title
+ - <code>url</code> 椤甸潰缃戝潃 Page URL
+ - <code>language</code> 椤甸潰璇█ Page language
+ - <code>publish_date</code> 鍙戝竷鏃ユ湡 Publish date
+ - <code>author/publisher</code> 浣滆��/鍙戝竷鑰� Author or publisher
+ - <code>topic/keywords</code> 涓婚/鍏抽敭璇� Topic or keywords
+ - <code>description</code> 椤甸潰鎻忚堪 Page description
+
+ 璇锋煡鐪� [api/services/dataset_service.py](https://github.com/langgenius/dify/blob/main/api/services/dataset_service.py#L475) 浜嗚В鍚勬枃妗ｇ被鍨嬫墍闇�瀛楁鐨勮缁嗕俊鎭��
+
+ 閽堝"鍏朵粬"绫诲瀷鏂囨。锛屾帴鍙椾换浣曟湁鏁堢殑JSON瀵硅薄
</Property>
<Property name='process_rule' type='object' key='process_rule'>
澶勭悊瑙勫垯锛堥�夊～锛�
@@ -908,6 +766,68 @@
- <code>separator</code> 鍒嗘鏍囪瘑绗︼紝鐩墠浠呭厑璁歌缃竴涓垎闅旂銆傞粯璁や负 <code>***</code>
- <code>max_tokens</code> 鏈�澶ч暱搴� (token) 闇�瑕佹牎楠屽皬浜庣埗绾х殑闀垮害
- <code>chunk_overlap</code> 鍒嗘閲嶅彔鎸囩殑鏄湪瀵规暟鎹繘琛屽垎娈垫椂锛屾涓庢涔嬮棿瀛樺湪涓�瀹氱殑閲嶅彔閮ㄥ垎锛堥�夊～锛�
+ - <code>doc_type</code> 鏂囨。绫诲瀷锛堥�夊～锛塗ype of document (optional)
+ - <code>book</code> 鍥句功
+ 鏂囨。璁板綍涓�鏈功绫嶆垨鍑虹増鐗�
+ - <code>web_page</code> 缃戦〉
+ 缃戦〉鍐呭鐨勬枃妗ｈ褰�
+ - <code>paper</code> 瀛︽湳璁烘枃/鏂囩珷
+ 瀛︽湳璁烘枃鎴栫爺绌舵枃绔犵殑璁板綍
+ - <code>social_media_post</code> 绀句氦濯掍綋甯栧瓙
+ 绀句氦濯掍綋涓婄殑甯栧瓙鍐呭
+ - <code>wikipedia_entry</code> 缁村熀鐧剧鏉＄洰
+ 缁村熀鐧剧鐨勮瘝鏉″唴瀹�
+ - <code>personal_document</code> 涓汉鏂囨。
+ 涓汉鐩稿叧鐨勬枃妗ｈ褰�
+ - <code>business_document</code> 鍟嗕笟鏂囨。
+ 鍟嗕笟鐩稿叧鐨勬枃妗ｈ褰�
+ - <code>im_chat_log</code> 鍗虫椂閫氳璁板綍
+ 鍗虫椂閫氳鐨勮亰澶╄褰�
+ - <code>synced_from_notion</code> Notion鍚屾鏂囨。
+ 浠嶯otion鍚屾鐨勬枃妗ｅ唴瀹�
+ - <code>synced_from_github</code> GitHub鍚屾鏂囨。
+ 浠嶨itHub鍚屾鐨勬枃妗ｅ唴瀹�
+ - <code>others</code> 鍏朵粬鏂囨。绫诲瀷
+ 鍏朵粬鏈垪鍑虹殑鏂囨。绫诲瀷
+
+ - <code>doc_metadata</code> 鏂囨。鍏冩暟鎹紙濡傛彁渚涙枃妗ｇ被鍨嬪垯蹇呭～
+ 瀛楁鍥犳枃妗ｇ被鍨嬭�屽紓
+
+ 閽堝鍥句功绫诲瀷 For <code>book</code>:
+ - <code>title</code> 涔﹀悕
+ 涔︾睄鐨勬爣棰�
+ - <code>language</code> 鍥句功璇█
+ 涔︾睄鐨勮瑷�
+ - <code>author</code> 浣滆��
+ 涔︾睄鐨勪綔鑰�
+ - <code>publisher</code> 鍑虹増绀�
+ 鍑虹増绀剧殑鍚嶇О
+ - <code>publication_date</code> 鍑虹増鏃ユ湡
+ 涔︾睄鐨勫嚭鐗堟棩鏈�
+ - <code>isbn</code> ISBN鍙风爜
+ 涔︾睄鐨処SBN缂栧彿
+ - <code>category</code> 鍥句功鍒嗙被
+ 涔︾睄鐨勫垎绫荤被鍒�
+
+ 閽堝缃戦〉绫诲瀷 For <code>web_page</code>:
+ - <code>title</code> 椤甸潰鏍囬
+ 缃戦〉鐨勬爣棰�
+ - <code>url</code> 椤甸潰缃戝潃
+ 缃戦〉鐨刄RL鍦板潃
+ - <code>language</code> 椤甸潰璇█
+ 缃戦〉鐨勮瑷�
+ - <code>publish_date</code> 鍙戝竷鏃ユ湡
+ 缃戦〉鐨勫彂甯冩棩鏈�
+ - <code>author/publisher</code> 浣滆��/鍙戝竷鑰�
+ 缃戦〉鐨勪綔鑰呮垨鍙戝竷鑰�
+ - <code>topic/keywords</code> 涓婚/鍏抽敭璇�
+ 缃戦〉鐨勪富棰樻垨鍏抽敭璇�
+ - <code>description</code> 椤甸潰鎻忚堪
+ 缃戦〉鐨勬弿杩颁俊鎭�
+
+ 璇锋煡鐪� [api/services/dataset_service.py](https://github.com/langgenius/dify/blob/main/api/services/dataset_service.py#L475) 浜嗚В鍚勬枃妗ｇ被鍨嬫墍闇�瀛楁鐨勮缁嗕俊鎭��
+
+ 閽堝"鍏朵粬"绫诲瀷鏂囨。锛屾帴鍙椾换浣曟湁鏁堢殑JSON瀵硅薄
</Property>
</Properties>
</Col>
@@ -1047,8 +967,10 @@
```
</CodeGroup>
<CodeGroup title="Response">
- ```text {{ title: 'Response' }}
- 204 No Content
+ ```json {{ title: 'Response' }}
+ {
+ "result": "success"
+ }
```
</CodeGroup>
</Col>
@@ -1243,12 +1165,6 @@
<Property name='status' type='string' key='status'>
鎼滅储鐘舵�侊紝completed
</Property>
- <Property name='page' type='string' key='page'>
- 椤电爜锛屽彲閫�
- </Property>
- <Property name='limit' type='string' key='limit'>
- 杩斿洖鏉℃暟锛屽彲閫夛紝榛樿 20锛岃寖鍥� 1-100
- </Property>
</Properties>
</Col>
<Col sticky>
@@ -1292,11 +1208,7 @@
"error": null,
"stopped_at": null
}],
- "doc_form": "text_model",
- "has_more": false,
- "limit": 20,
- "total": 9,
- "page": 1
+ "doc_form": "text_model"
}
```
</CodeGroup>
@@ -1340,8 +1252,10 @@
```
</CodeGroup>
<CodeGroup title="Response">
- ```text {{ title: 'Response' }}
- 204 No Content
+ ```json {{ title: 'Response' }}
+ {
+ "result": "success"
+ }
```
</CodeGroup>
</Col>
@@ -1405,7 +1319,7 @@
<CodeGroup title="Response">
```json {{ title: 'Response' }}
{
- "data": {
+ "data": [{
"id": "",
"position": 1,
"document_id": "",
@@ -1429,310 +1343,8 @@
"completed_at": 1695312007,
"error": null,
"stopped_at": null
- },
- "doc_form": "text_model"
- }
- ```
- </CodeGroup>
- </Col>
-</Row>
-
-<hr className='ml-0 mr-0' />
-
-<Heading
- url='/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks'
- method='POST'
- title='鏂板鏂囨。瀛愬垎娈�'
- name='#create_child_chunk'
-/>
-<Row>
- <Col>
- ### Path
- <Properties>
- <Property name='dataset_id' type='string' key='dataset_id'>
- 鐭ヨ瘑搴� ID
- </Property>
- <Property name='document_id' type='string' key='document_id'>
- 鏂囨。 ID
- </Property>
- <Property name='segment_id' type='string' key='segment_id'>
- 鍒嗘 ID
- </Property>
- </Properties>
-
- ### Request Body
- <Properties>
- <Property name='content' type='string' key='content'>
- 瀛愬垎娈靛唴瀹�
- </Property>
- </Properties>
- </Col>
- <Col sticky>
- <CodeGroup
- title="Request"
- tag="POST"
- label="/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks"
- targetCode={`curl --location --request POST '${props.apiBaseUrl}/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks' \\\n--header 'Authorization: Bearer {api_key}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{"content": "瀛愬垎娈靛唴瀹�"}'`}
- >
- ```bash {{ title: 'cURL' }}
- curl --location --request POST '${props.apiBaseUrl}/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks' \
- --header 'Authorization: Bearer {api_key}' \
- --header 'Content-Type: application/json' \
- --data-raw '{
- "content": "瀛愬垎娈靛唴瀹�"
- }'
- ```
- </CodeGroup>
- <CodeGroup title="Response">
- ```json {{ title: 'Response' }}
- {
- "data": {
- "id": "",
- "segment_id": "",
- "content": "瀛愬垎娈靛唴瀹�",
- "word_count": 25,
- "tokens": 0,
- "index_node_id": "",
- "index_node_hash": "",
- "status": "completed",
- "created_by": "",
- "created_at": 1695312007,
- "indexing_at": 1695312007,
- "completed_at": 1695312007,
- "error": null,
- "stopped_at": null
- }
- }
- ```
- </CodeGroup>
- </Col>
-</Row>
-
-<hr className='ml-0 mr-0' />
-
-<Heading
- url='/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks'
- method='GET'
- title='鏌ヨ鏂囨。瀛愬垎娈�'
- name='#get_child_chunks'
-/>
-<Row>
- <Col>
- ### Path
- <Properties>
- <Property name='dataset_id' type='string' key='dataset_id'>
- 鐭ヨ瘑搴� ID
- </Property>
- <Property name='document_id' type='string' key='document_id'>
- 鏂囨。 ID
- </Property>
- <Property name='segment_id' type='string' key='segment_id'>
- 鍒嗘 ID
- </Property>
- </Properties>
-
- ### Query
- <Properties>
- <Property name='keyword' type='string' key='keyword'>
- 鎼滅储鍏抽敭璇嶏紙閫夊～锛�
- </Property>
- <Property name='page' type='integer' key='page'>
- 椤电爜锛堥�夊～锛岄粯璁�1锛�
- </Property>
- <Property name='limit' type='integer' key='limit'>
- 姣忛〉鏁伴噺锛堥�夊～锛岄粯璁�20锛屾渶澶�100锛�
- </Property>
- </Properties>
- </Col>
- <Col sticky>
- <CodeGroup
- title="Request"
- tag="GET"
- label="/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks"
- targetCode={`curl --location --request GET '${props.apiBaseUrl}/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks?page=1&limit=20' \\\n--header 'Authorization: Bearer {api_key}'`}
- >
- ```bash {{ title: 'cURL' }}
- curl --location --request GET '${props.apiBaseUrl}/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks?page=1&limit=20' \
- --header 'Authorization: Bearer {api_key}'
- ```
- </CodeGroup>
- <CodeGroup title="Response">
- ```json {{ title: 'Response' }}
- {
- "data": [{
- "id": "",
- "segment_id": "",
- "content": "瀛愬垎娈靛唴瀹�",
- "word_count": 25,
- "tokens": 0,
- "index_node_id": "",
- "index_node_hash": "",
- "status": "completed",
- "created_by": "",
- "created_at": 1695312007,
- "indexing_at": 1695312007,
- "completed_at": 1695312007,
- "error": null,
- "stopped_at": null
}],
- "total": 1,
- "total_pages": 1,
- "page": 1,
- "limit": 20
- }
- ```
- </CodeGroup>
- </Col>
-</Row>
-
-<hr className='ml-0 mr-0' />
-
-<Heading
- url='/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}'
- method='DELETE'
- title='鍒犻櫎鏂囨。瀛愬垎娈�'
- name='#delete_child_chunk'
-/>
-<Row>
- <Col>
- ### Path
- <Properties>
- <Property name='dataset_id' type='string' key='dataset_id'>
- 鐭ヨ瘑搴� ID
- </Property>
- <Property name='document_id' type='string' key='document_id'>
- 鏂囨。 ID
- </Property>
- <Property name='segment_id' type='string' key='segment_id'>
- 鍒嗘 ID
- </Property>
- <Property name='child_chunk_id' type='string' key='child_chunk_id'>
- 瀛愬垎娈� ID
- </Property>
- </Properties>
- </Col>
- <Col sticky>
- <CodeGroup
- title="Request"
- tag="DELETE"
- label="/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}"
- targetCode={`curl --location --request DELETE '${props.apiBaseUrl}/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}' \\\n--header 'Authorization: Bearer {api_key}'`}
- >
- ```bash {{ title: 'cURL' }}
- curl --location --request DELETE '${props.apiBaseUrl}/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}' \
- --header 'Authorization: Bearer {api_key}'
- ```
- </CodeGroup>
- <CodeGroup title="Response">
- ```text {{ title: 'Response' }}
- 204 No Content
- ```
- </CodeGroup>
- </Col>
-</Row>
-
-<hr className='ml-0 mr-0' />
-
-<Row>
- <Col>
- ### 閿欒淇℃伅
- <Properties>
- <Property name='code' type='string' key='code'>
- 杩斿洖鐨勯敊璇唬鐮�
- </Property>
- </Properties>
- <Properties>
- <Property name='status' type='number' key='status'>
- 杩斿洖鐨勯敊璇姸鎬�
- </Property>
- </Properties>
- <Properties>
- <Property name='message' type='string' key='message'>
- 杩斿洖鐨勯敊璇俊鎭�
- </Property>
- </Properties>
- </Col>
- <Col>
- <CodeGroup title="Example">
- ```json {{ title: 'Response' }}
- {
- "code": "no_file_uploaded",
- "message": "Please upload your file.",
- "status": 400
- }
- ```
- </CodeGroup>
- </Col>
-</Row>
-
-<hr className='ml-0 mr-0' />
-
-<Heading
- url='/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}'
- method='PATCH'
- title='鏇存柊鏂囨。瀛愬垎娈�'
- name='#update_child_chunk'
-/>
-<Row>
- <Col>
- ### Path
- <Properties>
- <Property name='dataset_id' type='string' key='dataset_id'>
- 鐭ヨ瘑搴� ID
- </Property>
- <Property name='document_id' type='string' key='document_id'>
- 鏂囨。 ID
- </Property>
- <Property name='segment_id' type='string' key='segment_id'>
- 鍒嗘 ID
- </Property>
- <Property name='child_chunk_id' type='string' key='child_chunk_id'>
- 瀛愬垎娈� ID
- </Property>
- </Properties>
-
- ### Request Body
- <Properties>
- <Property name='content' type='string' key='content'>
- 瀛愬垎娈靛唴瀹�
- </Property>
- </Properties>
- </Col>
- <Col sticky>
- <CodeGroup
- title="Request"
- tag="PATCH"
- label="/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}"
- targetCode={`curl --location --request PATCH '${props.apiBaseUrl}/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}' \\\n--header 'Authorization: Bearer {api_key}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{"content": "鏇存柊鐨勫瓙鍒嗘鍐呭"}'`}
- >
- ```bash {{ title: 'cURL' }}
- curl --location --request PATCH '${props.apiBaseUrl}/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}' \
- --header 'Authorization: Bearer {api_key}' \
- --header 'Content-Type: application/json' \
- --data-raw '{
- "content": "鏇存柊鐨勫瓙鍒嗘鍐呭"
- }'
- ```
- </CodeGroup>
- <CodeGroup title="Response">
- ```json {{ title: 'Response' }}
- {
- "data": {
- "id": "",
- "segment_id": "",
- "content": "鏇存柊鐨勫瓙鍒嗘鍐呭",
- "word_count": 25,
- "tokens": 0,
- "index_node_id": "",
- "index_node_hash": "",
- "status": "completed",
- "created_by": "",
- "created_at": 1695312007,
- "indexing_at": 1695312007,
- "completed_at": 1695312007,
- "error": null,
- "stopped_at": null
- }
+ "doc_form": "text_model"
}
```
</CodeGroup>
@@ -1814,7 +1426,7 @@
</Property>
<Property name='retrieval_model' type='object' key='retrieval_model'>
妫�绱㈠弬鏁帮紙閫夊～锛屽涓嶅～锛屾寜鐓ч粯璁ゆ柟寮忓彫鍥烇級
- - <code>search_method</code> (text) 妫�绱㈡柟娉曪細浠ヤ笅鍥涗釜鍏抽敭瀛椾箣涓�锛屽繀濉�
+ - <code>search_method</code> (text) 妫�绱㈡柟娉曪細浠ヤ笅涓変釜鍏抽敭瀛椾箣涓�锛屽繀濉�
- <code>keyword_search</code> 鍏抽敭瀛楁绱�
- <code>semantic_search</code> 璇箟妫�绱�
- <code>full_text_search</code> 鍏ㄦ枃妫�绱�
@@ -1922,6 +1534,7 @@
"id": "a8c6c36f-9f5d-4d7a-8472-f5d7b75d71d2",
"data_source_type": "upload_file",
"name": "readme.txt",
+ "doc_type": null
}
},
"score": 3.730463140527718e-05,
@@ -1934,358 +1547,6 @@
</Col>
</Row>
-<hr className='ml-0 mr-0' />
-
-<Heading
- url='/datasets/{dataset_id}/metadata'
- method='POST'
- title='鏂板鍏冩暟鎹�'
- name='#create_metadata'
-/>
-<Row>
- <Col>
- ### Params
- <Properties>
- <Property name='dataset_id' type='string' key='dataset_id'>
- 鐭ヨ瘑搴� ID
- </Property>
- </Properties>
-
- ### Request Body
- <Properties>
- <Property name='segment' type='object' key='segment'>
- - <code>type</code> (string) 鍏冩暟鎹被鍨嬶紝蹇呭～
- - <code>name</code> (string) 鍏冩暟鎹悕绉帮紝蹇呭～
- </Property>
- </Properties>
- </Col>
- <Col sticky>
- <CodeGroup
- title="Request"
- tag="POST"
- label="/datasets/{dataset_id}/metadata"
- targetCode={`curl --location --request POST '${props.apiBaseUrl}/datasets/{dataset_id}/metadata' \\\n--header 'Authorization: Bearer {api_key}' \\\n--header 'Content-Type: application/json'\\\n--data-raw '{"type": "string", "name": "test"}'`}
- >
- ```bash {{ title: 'cURL' }}
- ```
- </CodeGroup>
- <CodeGroup title="Response">
- ```json {{ title: 'Response' }}
- {
- "id": "abc",
- "type": "string",
- "name": "test",
- }
- ```
- </CodeGroup>
- </Col>
-</Row>
-
-<hr className='ml-0 mr-0' />
-
-<Heading
- url='/datasets/{dataset_id}/metadata/{metadata_id}'
- method='PATCH'
- title='鏇存柊鍏冩暟鎹�'
- name='#update_metadata'
-/>
-<Row>
- <Col>
- ### Path
- <Properties>
- <Property name='dataset_id' type='string' key='dataset_id'>
- 鐭ヨ瘑搴� ID
- </Property>
- <Property name='metadata_id' type='string' key='metadata_id'>
- 鍏冩暟鎹� ID
- </Property>
- </Properties>
-
- ### Request Body
- <Properties>
- <Property name='segment' type='object' key='segment'>
- - <code>name</code> (string) 鍏冩暟鎹悕绉帮紝蹇呭～
- </Property>
- </Properties>
- </Col>
- <Col sticky>
- <CodeGroup
- title="Request"
- tag="PATCH"
- label="/datasets/{dataset_id}/metadata/{metadata_id}"
- targetCode={`curl --location --request PATCH '${props.apiBaseUrl}/datasets/{dataset_id}/metadata/{metadata_id}' \\\n--header 'Authorization: Bearer {api_key}' \\\n--header 'Content-Type: application/json'\\\n--data-raw '{"name": "test"}'`}
- >
- ```bash {{ title: 'cURL' }}
- ```
- </CodeGroup>
- <CodeGroup title="Response">
- ```json {{ title: 'Response' }}
- {
- "id": "abc",
- "type": "string",
- "name": "test",
- }
- ```
- </CodeGroup>
- </Col>
-</Row>
-
-<hr className='ml-0 mr-0' />
-
-<Heading
- url='/datasets/{dataset_id}/metadata/{metadata_id}'
- method='DELETE'
- title='鍒犻櫎鍏冩暟鎹�'
- name='#delete_metadata'
-/>
-<Row>
- <Col>
- ### Path
- <Properties>
- <Property name='dataset_id' type='string' key='dataset_id'>
- 鐭ヨ瘑搴� ID
- </Property>
- <Property name='metadata_id' type='string' key='metadata_id'>
- 鍏冩暟鎹� ID
- </Property>
- </Properties>
- </Col>
- <Col sticky>
- <CodeGroup
- title="Request"
- tag="DELETE"
- label="/datasets/{dataset_id}/metadata/{metadata_id}"
- targetCode={`curl --location --request DELETE '${props.apiBaseUrl}/datasets/{dataset_id}/metadata/{metadata_id}' \\\n--header 'Authorization: Bearer {api_key}'`}
- >
- ```bash {{ title: 'cURL' }}
- ```
- </CodeGroup>
- </Col>
-</Row>
-
-<hr className='ml-0 mr-0' />
-
-<Heading
- url='/datasets/{dataset_id}/metadata/built-in/{action}'
- method='POST'
- title='鍚敤/绂佺敤鍐呯疆鍏冩暟鎹�'
- name='#toggle_metadata'
-/>
-<Row>
- <Col>
- ### Path
- <Properties>
- <Property name='dataset_id' type='string' key='dataset_id'>
- 鐭ヨ瘑搴� ID
- </Property>
- <Property name='action' type='string' key='action'>
- disable/enable
- </Property>
- </Properties>
- </Col>
- <Col sticky>
- <CodeGroup
- title="Request"
- tag="POST"
- label="/datasets/{dataset_id}/metadata/built-in/{action}"
- targetCode={`curl --location --request POST '${props.apiBaseUrl}/datasets/{dataset_id}/metadata/built-in/{action}' \\\n--header 'Authorization: Bearer {api_key}'`}
- >
- ```bash {{ title: 'cURL' }}
- ```
- </CodeGroup>
- </Col>
-</Row>
-
-<hr className='ml-0 mr-0' />
-
-<Heading
- url='/datasets/{dataset_id}/documents/metadata'
- method='POST'
- title='鏇存柊鏂囨。鍏冩暟鎹�'
- name='#update_documents_metadata'
-/>
-<Row>
- <Col>
- ### Path
- <Properties>
- <Property name='dataset_id' type='string' key='dataset_id'>
- 鐭ヨ瘑搴� ID
- </Property>
- </Properties>
-
- ### Request Body
- <Properties>
- <Property name='operation_data' type='object list' key='segments'>
- - <code>document_id</code> (string) 鏂囨。 ID
- - <code>metadata_list</code> (list) 鍏冩暟鎹垪琛�
- - <code>id</code> (string) 鍏冩暟鎹� ID
- - <code>type</code> (string) 鍏冩暟鎹被鍨�
- - <code>name</code> (string) 鍏冩暟鎹悕绉�
- </Property>
- </Properties>
- </Col>
- <Col sticky>
- <CodeGroup
- title="Request"
- tag="POST"
- label="/datasets/{dataset_id}/documents/metadata"
- targetCode={`curl --location --request POST '${props.apiBaseUrl}/datasets/{dataset_id}/documents/metadata' \\\n--header 'Authorization: Bearer {api_key}' \\\n--header 'Content-Type: application/json'\\\n--data-raw '{"operation_data": [{"document_id": "document_id", "metadata_list": [{"id": "id", "value": "value", "name": "name"}]}]}'`}
- >
- ```bash {{ title: 'cURL' }}
- ```
- </CodeGroup>
- </Col>
-</Row>
-
-<hr className='ml-0 mr-0' />
-
-<Heading
- url='/datasets/{dataset_id}/metadata'
- method='GET'
- title='鏌ヨ鐭ヨ瘑搴撳厓鏁版嵁鍒楄〃'
- name='#dataset_metadata_list'
-/>
-<Row>
- <Col>
- ### Path
- <Properties>
- <Property name='dataset_id' type='string' key='dataset_id'>
- 鐭ヨ瘑搴� ID
- </Property>
- </Properties>
- </Col>
- <Col sticky>
- <CodeGroup
- title="Request"
- tag="GET"
- label="/datasets/{dataset_id}/metadata"
- targetCode={`curl --location --request GET '${props.apiBaseUrl}/datasets/{dataset_id}/metadata' \\\n--header 'Authorization: Bearer {api_key}'`}
- >
- ```bash {{ title: 'cURL' }}
- ```
- </CodeGroup>
- <CodeGroup title="Response">
- ```json {{ title: 'Response' }}
- {
- "doc_metadata": [
- {
- "id": "",
- "name": "name",
- "type": "string",
- "use_count": 0,
- },
- ...
- ],
- "built_in_field_enabled": true
- }
- ```
- </CodeGroup>
- </Col>
-</Row>
-
-<hr className='ml-0 mr-0' />
-
-<Heading
- url='/workspaces/current/models/model-types/text-embedding'
- method='GET'
- title='鑾峰彇宓屽叆妯″瀷鍒楄〃'
- name='#model_type_list'
-/>
-<Row>
- <Col>
- ### Query
- <Properties>
- </Properties>
- </Col>
- <Col sticky>
- <CodeGroup
- title="Request"
- tag="GET"
- label="/datasets/{dataset_id}"
- targetCode={`curl --location --location --request GET '${props.apiBaseUrl}/workspaces/current/models/model-types/text-embedding' \\\n--header 'Authorization: Bearer {api_key}' \\\n--header 'Content-Type: application/json' `}
- >
- ```bash {{ title: 'cURL' }}
- curl --location --request GET '${props.apiBaseUrl}/workspaces/current/models/model-types/text-embedding' \
- --header 'Authorization: Bearer {api_key}' \
- --header 'Content-Type: application/json' \
- ```
- </CodeGroup>
- <CodeGroup title="Response">
- ```json {{ title: 'Response' }}
- {
- "data": [
- {
- "provider": "zhipuai",
- "label": {
- "zh_Hans": "鏅鸿氨 AI",
- "en_US": "ZHIPU AI"
- },
- "icon_small": {
- "zh_Hans": "http://127.0.0.1:5001/console/api/workspaces/current/model-providers/zhipuai/icon_small/zh_Hans",
- "en_US": "http://127.0.0.1:5001/console/api/workspaces/current/model-providers/zhipuai/icon_small/en_US"
- },
- "icon_large": {
- "zh_Hans": "http://127.0.0.1:5001/console/api/workspaces/current/model-providers/zhipuai/icon_large/zh_Hans",
- "en_US": "http://127.0.0.1:5001/console/api/workspaces/current/model-providers/zhipuai/icon_large/en_US"
- },
- "status": "active",
- "models": [
- {
- "model": "embedding-3",
- "label": {
- "zh_Hans": "embedding-3",
- "en_US": "embedding-3"
- },
- "model_type": "text-embedding",
- "features": null,
- "fetch_from": "predefined-model",
- "model_properties": {
- "context_size": 8192
- },
- "deprecated": false,
- "status": "active",
- "load_balancing_enabled": false
- },
- {
- "model": "embedding-2",
- "label": {
- "zh_Hans": "embedding-2",
- "en_US": "embedding-2"
- },
- "model_type": "text-embedding",
- "features": null,
- "fetch_from": "predefined-model",
- "model_properties": {
- "context_size": 8192
- },
- "deprecated": false,
- "status": "active",
- "load_balancing_enabled": false
- },
- {
- "model": "text_embedding",
- "label": {
- "zh_Hans": "text_embedding",
- "en_US": "text_embedding"
- },
- "model_type": "text-embedding",
- "features": null,
- "fetch_from": "predefined-model",
- "model_properties": {
- "context_size": 512
- },
- "deprecated": false,
- "status": "active",
- "load_balancing_enabled": false
- }
- ]
- }
- ]
- }
- ```
- </CodeGroup>
- </Col>
-</Row>
<hr className='ml-0 mr-0' />
--
Gitblit v1.8.0