From a430284aa21e3ae1f0d5654e55b2ad2852519cc2 Mon Sep 17 00:00:00 2001
From: wwf <yearningwang@iqtogether.com>
Date: 星期三, 04 六月 2025 15:17:49 +0800
Subject: [PATCH] 初始化
---
app/components/develop/template/template.zh.mdx | 421 ----------------------------------------------------
1 files changed, 2 insertions(+), 419 deletions(-)
diff --git a/app/components/develop/template/template.zh.mdx b/app/components/develop/template/template.zh.mdx
index df83684..d8cabb5 100644
--- a/app/components/develop/template/template.zh.mdx
+++ b/app/components/develop/template/template.zh.mdx
@@ -356,68 +356,6 @@
</Row>
---
-<Heading
- url='/app/feedbacks'
- method='GET'
- title='Get feedbacks of application'
- name='#app-feedbacks'
-/>
-<Row>
- <Col>
- Get application's feedbacks.
-
- ### Query
- <Properties>
- <Property name='page' type='string' key='page'>
- 锛坥ptional锛塸agination锛宒efault锛�1
- </Property>
- </Properties>
-
- <Properties>
- <Property name='limit' type='string' key='limit'>
- 锛坥ptional锛� records per page default锛�20
- </Property>
- </Properties>
-
- ### Response
- - `data` (List) return apps feedback list.
- </Col>
- <Col sticky>
-
- <CodeGroup title="Request" tag="GET" label="/app/feedbacks" targetCode={`curl -X GET '${props.appDetail.api_base_url}/app/feedbacks?page=1&limit=20'`}>
-
- ```bash {{ title: 'cURL' }}
- curl -X GET '${props.appDetail.api_base_url}/app/feedbacks?page=1&limit=20' \
- --header 'Authorization: Bearer {api_key}' \
- --header 'Content-Type: application/json'
- ```
-
- </CodeGroup>
-
- <CodeGroup title="Response">
- ```json {{ title: 'Response' }}
- {
- "data": [
- {
- "id": "8c0fbed8-e2f9-49ff-9f0e-15a35bdd0e25",
- "app_id": "f252d396-fe48-450e-94ec-e184218e7346",
- "conversation_id": "2397604b-9deb-430e-b285-4726e51fd62d",
- "message_id": "709c0b0f-0a96-4a4e-91a4-ec0889937b11",
- "rating": "like",
- "content": "message feedback information-3",
- "from_source": "user",
- "from_end_user_id": "74286412-9a1a-42c1-929c-01edb1d381d5",
- "from_account_id": null,
- "created_at": "2025-04-24T09:24:38",
- "updated_at": "2025-04-24T09:24:38"
- }
- ]
- }
- ```
- </CodeGroup>
- </Col>
-</Row>
----
<Heading
url='/text-to-audio'
@@ -432,7 +370,7 @@
### Request Body
<Properties>
- <Property name='message_id' type='str' key='message_id'>
+ <Property name='message_id' type='str' key='text'>
Dify 鐢熸垚鐨勬枃鏈秷鎭紝閭ｄ箞鐩存帴浼犻�掔敓鎴愮殑message-id 鍗冲彲锛屽悗鍙颁細閫氳繃 message_id 鏌ユ壘鐩稿簲鐨勫唴瀹圭洿鎺ュ悎鎴愯闊充俊鎭�傚鏋滃悓鏃朵紶 message_id 鍜� text锛屼紭鍏堜娇鐢� message_id銆�
</Property>
<Property name='text' type='str' key='text'>
@@ -507,6 +445,7 @@
</CodeGroup>
</Col>
</Row>
+
---
<Heading
@@ -604,362 +543,6 @@
"audio_file_size_limit": 50,
"video_file_size_limit": 100
}
- }
- ```
- </CodeGroup>
- </Col>
-</Row>
----
-
-<Heading
- url='/site'
- method='GET'
- title='鑾峰彇搴旂敤 WebApp 璁剧疆'
- name='#site'
-/>
-<Row>
- <Col>
- 鐢ㄤ簬鑾峰彇搴旂敤鐨� WebApp 璁剧疆
- ### Response
- - `title` (string) WebApp 鍚嶇О
- - `chat_color_theme` (string) 鑱婂ぉ棰滆壊涓婚, hex 鏍煎紡
- - `chat_color_theme_inverted` (bool) 鑱婂ぉ棰滆壊涓婚鏄惁鍙嶈浆
- - `icon_type` (string) 鍥炬爣绫诲瀷, `emoji`-琛ㄦ儏, `image`-鍥剧墖
- - `icon` (string) 鍥炬爣, 濡傛灉鏄� `emoji` 绫诲瀷, 鍒欐槸 emoji 琛ㄦ儏绗﹀彿, 濡傛灉鏄� `image` 绫诲瀷, 鍒欐槸鍥剧墖 URL
- - `icon_background` (string) hex 鏍煎紡鐨勮儗鏅壊
- - `icon_url` (string) 鍥炬爣 URL
- - `description` (string) 鎻忚堪
- - `copyright` (string) 鐗堟潈淇℃伅
- - `privacy_policy` (string) 闅愮鏀跨瓥閾炬帴
- - `custom_disclaimer` (string) 鑷畾涔夊厤璐ｅ０鏄�
- - `default_language` (string) 榛樿璇█
- - `show_workflow_steps` (bool) 鏄惁鏄剧ず宸ヤ綔娴佽鎯�
- - `use_icon_as_answer_icon` (bool) 鏄惁浣跨敤 WebApp 鍥炬爣鏇挎崲鑱婂ぉ涓殑 馃
- </Col>
- <Col>
- <CodeGroup title="Request" tag="POST" label="/meta" targetCode={`curl -X GET '${props.appDetail.api_base_url}/site' \\\n-H 'Authorization: Bearer {api_key}'`}>
- ```bash {{ title: 'cURL' }}
- curl -X GET '${props.appDetail.api_base_url}/site' \
- -H 'Authorization: Bearer {api_key}'
- ```
-
- </CodeGroup>
-
- <CodeGroup title="Response">
- ```json {{ title: 'Response' }}
- {
- "title": "My App",
- "chat_color_theme": "#ff4a4a",
- "chat_color_theme_inverted": false,
- "icon_type": "emoji",
- "icon": "馃槃",
- "icon_background": "#FFEAD5",
- "icon_url": null,
- "description": "This is my app.",
- "copyright": "all rights reserved",
- "privacy_policy": "",
- "custom_disclaimer": "All generated by AI",
- "default_language": "en-US",
- "show_workflow_steps": false,
- "use_icon_as_answer_icon": false,
- }
- ```
- </CodeGroup>
- </Col>
-</Row>
-___
-
-<Heading
- url='/apps/annotations'
- method='GET'
- title='鑾峰彇鏍囨敞鍒楄〃'
- name='#annotation_list'
-/>
-<Row>
- <Col>
- ### Query
- <Properties>
- <Property name='page' type='string' key='page'>
- 椤电爜
- </Property>
- <Property name='limit' type='string' key='limit'>
- 姣忛〉鏁伴噺
- </Property>
- </Properties>
- </Col>
- <Col sticky>
- <CodeGroup
- title="Request"
- tag="GET"
- label="/apps/annotations"
- targetCode={`curl --location --request GET '${props.apiBaseUrl}/apps/annotations?page=1&limit=20' \\\n--header 'Authorization: Bearer {api_key}'`}
- >
- ```bash {{ title: 'cURL' }}
- curl --location --request GET '${props.apiBaseUrl}/apps/annotations?page=1&limit=20' \
- --header 'Authorization: Bearer {api_key}'
- ```
- </CodeGroup>
-
- <CodeGroup title="Response">
- ```json {{ title: 'Response' }}
- {
- "data": [
- {
- "id": "69d48372-ad81-4c75-9c46-2ce197b4d402",
- "question": "What is your name?",
- "answer": "I am Dify.",
- "hit_count": 0,
- "created_at": 1735625869
- }
- ],
- "has_more": false,
- "limit": 20,
- "total": 1,
- "page": 1
- }
- ```
- </CodeGroup>
- </Col>
-</Row>
----
-
-<Heading
- url='/apps/annotations'
- method='POST'
- title='鍒涘缓鏍囨敞'
- name='#create_annotation'
-/>
-<Row>
- <Col>
- ### Query
- <Properties>
- <Property name='question' type='string' key='question'>
- 闂
- </Property>
- <Property name='answer' type='string' key='answer'>
- 绛旀鍐呭
- </Property>
- </Properties>
- </Col>
- <Col sticky>
- <CodeGroup
- title="Request"
- tag="POST"
- label="/apps/annotations"
- targetCode={`curl --location --request POST '${props.apiBaseUrl}/apps/annotations' \\\n--header 'Authorization: Bearer {api_key}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{"question": "What is your name?","answer": "I am Dify."}'`}
- >
- ```bash {{ title: 'cURL' }}
- curl --location --request POST '${props.apiBaseUrl}/apps/annotations' \
- --header 'Authorization: Bearer {api_key}' \
- --header 'Content-Type: application/json' \
- --data-raw '{
- "question": "What is your name?",
- "answer": "I am Dify."
- }'
- ```
- </CodeGroup>
-
- <CodeGroup title="Response">
- ```json {{ title: 'Response' }}
- {
- "id": "69d48372-ad81-4c75-9c46-2ce197b4d402",
- "question": "What is your name?",
- "answer": "I am Dify.",
- "hit_count": 0,
- "created_at": 1735625869
- }
- ```
- </CodeGroup>
- </Col>
-</Row>
----
-
-<Heading
- url='/apps/annotations/{annotation_id}'
- method='PUT'
- title='鏇存柊鏍囨敞'
- name='#update_annotation'
-/>
-<Row>
- <Col>
- ### Query
- <Properties>
- <Property name='annotation_id' type='string' key='annotation_id'>
- 鏍囨敞 ID
- </Property>
- <Property name='question' type='string' key='question'>
- 闂
- </Property>
- <Property name='answer' type='string' key='answer'>
- 绛旀鍐呭
- </Property>
- </Properties>
- </Col>
- <Col sticky>
- <CodeGroup
- title="Request"
- tag="PUT"
- label="/apps/annotations/{annotation_id}"
- targetCode={`curl --location --request PUT '${props.apiBaseUrl}/apps/annotations/{annotation_id}' \\\n--header 'Authorization: Bearer {api_key}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{"question": "What is your name?","answer": "I am Dify."}'`}
- >
- ```bash {{ title: 'cURL' }}
- curl --location --request PUT '${props.apiBaseUrl}/apps/annotations/{annotation_id}' \
- --header 'Authorization: Bearer {api_key}' \
- --header 'Content-Type: application/json' \
- --data-raw '{
- "question": "What is your name?",
- "answer": "I am Dify."
- }'
- ```
- </CodeGroup>
-
- <CodeGroup title="Response">
- ```json {{ title: 'Response' }}
- {
- "id": "69d48372-ad81-4c75-9c46-2ce197b4d402",
- "question": "What is your name?",
- "answer": "I am Dify.",
- "hit_count": 0,
- "created_at": 1735625869
- }
- ```
- </CodeGroup>
- </Col>
-</Row>
----
-
-<Heading
- url='/apps/annotations/{annotation_id}'
- method='DELETE'
- title='鍒犻櫎鏍囨敞'
- name='#delete_annotation'
-/>
-<Row>
- <Col>
- ### Query
- <Properties>
- <Property name='annotation_id' type='string' key='annotation_id'>
- 鏍囨敞 ID
- </Property>
- </Properties>
- </Col>
- <Col sticky>
- <CodeGroup
- title="Request"
- tag="PUT"
- label="/apps/annotations/{annotation_id}"
- targetCode={`curl --location --request DELETE '${props.apiBaseUrl}/apps/annotations/{annotation_id}' \\\n--header 'Authorization: Bearer {api_key}' \\\n--header 'Content-Type: application/json'`}
- >
- ```bash {{ title: 'cURL' }}
- curl --location --request DELETE '${props.apiBaseUrl}/apps/annotations/{annotation_id}' \
- --header 'Authorization: Bearer {api_key}'
- ```
- </CodeGroup>
-
- <CodeGroup title="Response">
- ```text {{ title: 'Response' }}
- 204 No Content
- ```
- </CodeGroup>
- </Col>
-</Row>
----
-
-<Heading
- url='/apps/annotation-reply/{action}'
- method='POST'
- title='鏍囨敞鍥炲鍒濆璁剧疆'
- name='#initial_annotation_reply_settings'
-/>
-<Row>
- <Col>
- ### Query
- <Properties>
- <Property name='action' type='string' key='action'>
- 鍔ㄤ綔锛屽彧鑳芥槸 'enable' 鎴� 'disable'
- </Property>
- <Property name='embedding_provider_name' type='string' key='embedding_provider_name'>
- 鎸囧畾鐨勫祵鍏ユā鍨嬫彁渚涘晢, 蹇呴』鍏堝湪绯荤粺鍐呰瀹氬ソ鎺ュ叆鐨勬ā鍨嬶紝瀵瑰簲鐨勬槸provider瀛楁
- </Property>
- <Property name='embedding_model_name' type='string' key='embedding_model_name'>
- 鎸囧畾鐨勫祵鍏ユā鍨嬶紝瀵瑰簲鐨勬槸model瀛楁
- </Property>
- <Property name='score_threshold' type='number' key='score_threshold'>
- 鐩镐技搴﹂槇鍊硷紝褰撶浉浼煎害澶т簬璇ラ槇鍊兼椂锛岀郴缁熶細鑷姩鍥炲锛屽惁鍒欎笉鍥炲
- </Property>
- </Properties>
- </Col>
- <Col sticky>
- 宓屽叆妯″瀷鐨勬彁渚涘晢鍜屾ā鍨嬪悕绉板彲浠ラ�氳繃浠ヤ笅鎺ュ彛鑾峰彇锛歷1/workspaces/current/models/model-types/text-embedding锛� 鍏蜂綋瑙侊細閫氳繃 API 缁存姢鐭ヨ瘑搴撱�� 浣跨敤鐨凙uthorization鏄疍ataset鐨凙PI Token銆�
- 璇ユ帴鍙ｆ槸寮傛鎵ц锛屾墍浠ヤ細杩斿洖涓�涓猨ob_id锛岄�氳繃鏌ヨjob鐘舵�佹帴鍙ｅ彲浠ヨ幏鍙栧埌鏈�缁堢殑鎵ц缁撴灉銆�
- <CodeGroup
- title="Request"
- tag="POST"
- label="/apps/annotation-reply/{action}"
- targetCode={`curl --location --request POST '${props.apiBaseUrl}/apps/annotation-reply/{action}' \\\n--header 'Authorization: Bearer {api_key}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{"score_threshold": 0.9, "embedding_provider_name": "zhipu", "embedding_model_name": "embedding_3"}'`}
- >
- ```bash {{ title: 'cURL' }}
- curl --location --request POST 'https://api.dify.ai/v1/apps/annotation-reply/{action}' \
- --header 'Authorization: Bearer {api_key}' \
- --header 'Content-Type: application/json' \
- --data-raw '{
- "score_threshold": 0.9,
- "embedding_provider_name": "zhipu",
- "embedding_model_name": "embedding_3"
- }'
- ```
- </CodeGroup>
-
- <CodeGroup title="Response">
- ```json {{ title: 'Response' }}
- {
- "job_id": "b15c8f68-1cf4-4877-bf21-ed7cf2011802",
- "job_status": "waiting"
- }
- ```
-
- </CodeGroup>
- </Col>
-</Row>
----
-
-<Heading
- url='/apps/annotation-reply/{action}/status/{job_id}'
- method='GET'
- title='鏌ヨ鏍囨敞鍥炲鍒濆璁剧疆浠诲姟鐘舵��'
- name='#initial_annotation_reply_settings_task_status'
-/>
-<Row>
- <Col>
- ### Query
- <Properties>
- <Property name='action' type='string' key='action'>
- 鍔ㄤ綔锛屽彧鑳芥槸 'enable' 鎴� 'disable'锛屽苟涓斿繀椤诲拰鏍囨敞鍥炲鍒濆璁剧疆鎺ュ彛鐨勫姩浣滀竴鑷�
- </Property>
- <Property name='job_id' type='string' key='job_id'>
- 浠诲姟 ID锛屼粠鏍囨敞鍥炲鍒濆璁剧疆鎺ュ彛杩斿洖鐨� job_id
- </Property>
- </Properties>
- </Col>
- <Col sticky>
- <CodeGroup
- title="Request"
- tag="GET"
- label="/apps/annotations"
- targetCode={`curl --location --request GET '${props.apiBaseUrl}/apps/annotation-reply/{action}/status/{job_id}' \\\n--header 'Authorization: Bearer {api_key}'`}
- >
- ```bash {{ title: 'cURL' }}
- curl --location --request GET '${props.apiBaseUrl}/apps/annotation-reply/{action}/status/{job_id}' \
- --header 'Authorization: Bearer {api_key}'
- ```
- </CodeGroup>
-
- <CodeGroup title="Response">
- ```json {{ title: 'Response' }}
- {
- "job_id": "b15c8f68-1cf4-4877-bf21-ed7cf2011802",
- "job_status": "waiting",
- "error_msg": ""
}
```
</CodeGroup>
--
Gitblit v1.8.0