AI/dify
1
0
Fork 0
mirror of https://git.mirrors.martin98.com/https://github.com/langgenius/dify.git synced 2025-08-12 08:38:58 +08:00
Code Issues Packages Projects Releases Wiki Activity

chore: improve app doc (#12490)

Browse Source
This commit is contained in:
非法操作 2025-01-08 18:37:12 +08:00 committed by GitHub
parent bee32d960a
commit f4ee50a7ad
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
13 changed files with 75 additions and 259 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
web/app/components/develop/doc.tsx
View File

@ -61,6 +61,23 @@ const Doc = ({ appDetail }: IDocProps) => {
// Run after component has rendered // Run after component has rendered
setTimeout(extractTOC, 0) setTimeout(extractTOC, 0)
}, [appDetail, locale]) }, [appDetail, locale])
const handleTocClick = (e: React.MouseEvent<HTMLAnchorElement>, item: { href: string; text: string }) => {
e.preventDefault()
const targetId = item.href.replace('#', '')
const element = document.getElementById(targetId)
if (element) {
const scrollContainer = document.querySelector('.overflow-auto')
if (scrollContainer) {
const headerOffset = 80
const elementTop = element.offsetTop - headerOffset
scrollContainer.scrollTo({
top: elementTop,
behavior: 'smooth',
})
}
}
}
return ( return (
<div className="flex"> <div className="flex">
<div className={`fixed right-8 top-32 z-10 transition-all ${isTocExpanded ? 'w-64' : 'w-10'}`}> <div className={`fixed right-8 top-32 z-10 transition-all ${isTocExpanded ? 'w-64' : 'w-10'}`}>
@ -82,6 +99,7 @@ const Doc = ({ appDetail }: IDocProps) => {
<a <a
href={item.href} href={item.href}
className="text-gray-600 hover:text-gray-900 hover:underline transition-colors duration-200" className="text-gray-600 hover:text-gray-900 hover:underline transition-colors duration-200"
onClick={e => handleTocClick(e, item)}
> >
{item.text} {item.text}
</a> </a>

22
web/app/components/develop/template/template.en.mdx
View File

@ -444,22 +444,16 @@ The text generation application offers non-session support and is ideal for tran
<Row> <Row>
<Col> <Col>
Used to get basic information about this application Used to get basic information about this application
### Query
<Properties>
<Property name='user' type='string' key='user'>
User identifier, defined by the developer's rules, must be unique within the application.
</Property>
</Properties>
### Response ### Response
- `name` (string) application name - `name` (string) application name
- `description` (string) application description - `description` (string) application description
- `tags` (array[string]) application tags - `tags` (array[string]) application tags
</Col> </Col>
<Col> <Col>
<CodeGroup title="Request" tag="GET" label="/info" targetCode={`curl -X GET '${props.appDetail.api_base_url}/info?user=abc-123' \\\n-H 'Authorization: Bearer {api_key}'`}> <CodeGroup title="Request" tag="GET" label="/info" targetCode={`curl -X GET '${props.appDetail.api_base_url}/info' \\\n-H 'Authorization: Bearer {api_key}'`}>
```bash {{ title: 'cURL' }} ```bash {{ title: 'cURL' }}
curl -X GET '${props.appDetail.api_base_url}/info?user=abc-123' \ curl -X GET '${props.appDetail.api_base_url}/info' \
-H 'Authorization: Bearer {api_key}' -H 'Authorization: Bearer {api_key}'
``` ```
</CodeGroup> </CodeGroup>
@ -490,14 +484,6 @@ The text generation application offers non-session support and is ideal for tran
<Col> <Col>
Used at the start of entering the page to obtain information such as features, input parameter names, types, and default values. Used at the start of entering the page to obtain information such as features, input parameter names, types, and default values.
### Query
<Properties>
<Property name='user' type='string' key='user'>
User identifier, defined by the developer's rules, must be unique within the application.
</Property>
</Properties>
### Response ### Response
- `opening_statement` (string) Opening statement - `opening_statement` (string) Opening statement
- `suggested_questions` (array[string]) List of suggested questions for the opening - `suggested_questions` (array[string]) List of suggested questions for the opening
@ -541,10 +527,10 @@ The text generation application offers non-session support and is ideal for tran
</Col> </Col>
<Col sticky> <Col sticky>
<CodeGroup title="Request" tag="GET" label="/parameters" targetCode={` curl -X GET '${props.appDetail.api_base_url}/parameters?user=abc-123'`}> <CodeGroup title="Request" tag="GET" label="/parameters" targetCode={` curl -X GET '${props.appDetail.api_base_url}/parameters'`}>
```bash {{ title: 'cURL' }} ```bash {{ title: 'cURL' }}
curl -X GET '${props.appDetail.api_base_url}/parameters?user=abc-123' \ curl -X GET '${props.appDetail.api_base_url}/parameters' \
--header 'Authorization: Bearer {api_key}' --header 'Authorization: Bearer {api_key}'
``` ```

22
web/app/components/develop/template/template.ja.mdx
View File

@ -442,22 +442,16 @@ import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from
<Row> <Row>
<Col> <Col>
このアプリケーションの基本情報を取得するために使用されます このアプリケーションの基本情報を取得するために使用されます
### Query
<Properties>
<Property name='user' type='string' key='user'>
ユーザー識別子、開発者のルールによって定義され、アプリケーション内で一意でなければなりません。
</Property>
</Properties>
### Response ### Response
- `name` (string) アプリケーションの名前 - `name` (string) アプリケーションの名前
- `description` (string) アプリケーションの説明 - `description` (string) アプリケーションの説明
- `tags` (array[string]) アプリケーションのタグ - `tags` (array[string]) アプリケーションのタグ
</Col> </Col>
<Col> <Col>
<CodeGroup title="Request" tag="GET" label="/info" targetCode={`curl -X GET '${props.appDetail.api_base_url}/info?user=abc-123' \\\n-H 'Authorization: Bearer {api_key}'`}> <CodeGroup title="Request" tag="GET" label="/info" targetCode={`curl -X GET '${props.appDetail.api_base_url}/info' \\\n-H 'Authorization: Bearer {api_key}'`}>
```bash {{ title: 'cURL' }} ```bash {{ title: 'cURL' }}
curl -X GET '${props.appDetail.api_base_url}/info?user=abc-123' \ curl -X GET '${props.appDetail.api_base_url}/info' \
-H 'Authorization: Bearer {api_key}' -H 'Authorization: Bearer {api_key}'
``` ```
</CodeGroup> </CodeGroup>
@ -488,14 +482,6 @@ import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from
<Col> <Col>
ページ開始時に、機能、入力パラメータ名、タイプ、デフォルト値などの情報を取得するために使用されます。 ページ開始時に、機能、入力パラメータ名、タイプ、デフォルト値などの情報を取得するために使用されます。
### クエリ
<Properties>
<Property name='user' type='string' key='user'>
開発者のルールで定義されたユーザー識別子。アプリケーション内で一意である必要があります。
</Property>
</Properties>
### レスポンス ### レスポンス
- `opening_statement` (string) 開始文 - `opening_statement` (string) 開始文
- `suggested_questions` (array[string]) 開始時の提案質問リスト - `suggested_questions` (array[string]) 開始時の提案質問リスト
@ -539,10 +525,10 @@ import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from
</Col> </Col>
<Col sticky> <Col sticky>
<CodeGroup title="Request" tag="GET" label="/parameters" targetCode={` curl -X GET '${props.appDetail.api_base_url}/parameters?user=abc-123'`}> <CodeGroup title="Request" tag="GET" label="/parameters" targetCode={` curl -X GET '${props.appDetail.api_base_url}/parameters'`}>
```bash {{ title: 'cURL' }} ```bash {{ title: 'cURL' }}
curl -X GET '${props.appDetail.api_base_url}/parameters?user=abc-123' \ curl -X GET '${props.appDetail.api_base_url}/parameters' \
--header 'Authorization: Bearer {api_key}' --header 'Authorization: Bearer {api_key}'
``` ```

21
web/app/components/develop/template/template.zh.mdx
View File

@ -419,22 +419,15 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx'
<Row> <Row>
<Col> <Col>
用于获取应用的基本信息 用于获取应用的基本信息
### Query
<Properties>
<Property name='user' type='string' key='user'>
用户标识，由开发者定义规则，需保证用户标识在应用内唯一。
</Property>
</Properties>
### Response ### Response
- `name` (string) 应用名称 - `name` (string) 应用名称
- `description` (string) 应用描述 - `description` (string) 应用描述
- `tags` (array[string]) 应用标签 - `tags` (array[string]) 应用标签
</Col> </Col>
<Col> <Col>
<CodeGroup title="Request" tag="GET" label="/info" targetCode={`curl -X GET '${props.appDetail.api_base_url}/info?user=abc-123' \\\n-H 'Authorization: Bearer {api_key}'`}> <CodeGroup title="Request" tag="GET" label="/info" targetCode={`curl -X GET '${props.appDetail.api_base_url}/info' \\\n-H 'Authorization: Bearer {api_key}'`}>
```bash {{ title: 'cURL' }} ```bash {{ title: 'cURL' }}
curl -X GET '${props.appDetail.api_base_url}/info?user=abc-123' \ curl -X GET '${props.appDetail.api_base_url}/info' \
-H 'Authorization: Bearer {api_key}' -H 'Authorization: Bearer {api_key}'
``` ```
</CodeGroup> </CodeGroup>
@ -465,14 +458,6 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx'
<Col> <Col>
用于进入页面一开始，获取功能开关、输入参数名称、类型及默认值等使用。 用于进入页面一开始，获取功能开关、输入参数名称、类型及默认值等使用。
### Query
<Properties>
<Property name='user' type='string' key='user'>
用户标识，由开发者定义规则，需保证用户标识在应用内唯一。
</Property>
</Properties>
### Response ### Response
- `opening_statement` (string) 开场白 - `opening_statement` (string) 开场白
- `suggested_questions` (array[string]) 开场推荐问题列表 - `suggested_questions` (array[string]) 开场推荐问题列表
@ -518,7 +503,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx'
<CodeGroup title="Request" tag="GET" label="/parameters" targetCode={` curl -X GET '${props.appDetail.api_base_url}/parameters'\\\n--header 'Authorization: Bearer {api_key}'`}> <CodeGroup title="Request" tag="GET" label="/parameters" targetCode={` curl -X GET '${props.appDetail.api_base_url}/parameters'\\\n--header 'Authorization: Bearer {api_key}'`}>
```bash {{ title: 'cURL' }} ```bash {{ title: 'cURL' }}
curl -X GET '${props.appDetail.api_base_url}/parameters?user=abc-123' \ curl -X GET '${props.appDetail.api_base_url}/parameters' \
--header 'Authorization: Bearer {api_key}' --header 'Authorization: Bearer {api_key}'
``` ```

32
web/app/components/develop/template/template_advanced_chat.en.mdx
View File

@ -952,22 +952,16 @@ Chat applications support session persistence, allowing previous chat history to
<Row> <Row>
<Col> <Col>
Used to get basic information about this application Used to get basic information about this application
### Query
<Properties>
<Property name='user' type='string' key='user'>
User identifier, defined by the developer's rules, must be unique within the application.
</Property>
</Properties>
### Response ### Response
- `name` (string) application name - `name` (string) application name
- `description` (string) application description - `description` (string) application description
- `tags` (array[string]) application tags - `tags` (array[string]) application tags
</Col> </Col>
<Col> <Col>
<CodeGroup title="Request" tag="GET" label="/info" targetCode={`curl -X GET '${props.appDetail.api_base_url}/info?user=abc-123' \\\n-H 'Authorization: Bearer {api_key}'`}> <CodeGroup title="Request" tag="GET" label="/info" targetCode={`curl -X GET '${props.appDetail.api_base_url}/info' \\\n-H 'Authorization: Bearer {api_key}'`}>
```bash {{ title: 'cURL' }} ```bash {{ title: 'cURL' }}
curl -X GET '${props.appDetail.api_base_url}/info?user=abc-123' \ curl -X GET '${props.appDetail.api_base_url}/info' \
-H 'Authorization: Bearer {api_key}' -H 'Authorization: Bearer {api_key}'
``` ```
</CodeGroup> </CodeGroup>
@ -998,14 +992,6 @@ Chat applications support session persistence, allowing previous chat history to
<Col> <Col>
Used at the start of entering the page to obtain information such as features, input parameter names, types, and default values. Used at the start of entering the page to obtain information such as features, input parameter names, types, and default values.
### Query
<Properties>
<Property name='user' type='string' key='user'>
User identifier, defined by the developer's rules, must be unique within the application.
</Property>
</Properties>
### Response ### Response
- `opening_statement` (string) Opening statement - `opening_statement` (string) Opening statement
- `suggested_questions` (array[string]) List of suggested questions for the opening - `suggested_questions` (array[string]) List of suggested questions for the opening
@ -1049,10 +1035,10 @@ Chat applications support session persistence, allowing previous chat history to
</Col> </Col>
<Col sticky> <Col sticky>
<CodeGroup title="Request" tag="GET" label="/parameters" targetCode={` curl -X GET '${props.appDetail.api_base_url}/parameters?user=abc-123'`}> <CodeGroup title="Request" tag="GET" label="/parameters" targetCode={` curl -X GET '${props.appDetail.api_base_url}/parameters'`}>
```bash {{ title: 'cURL' }} ```bash {{ title: 'cURL' }}
curl -X GET '${props.appDetail.api_base_url}/parameters?user=abc-123' \ curl -X GET '${props.appDetail.api_base_url}/parameters' \
--header 'Authorization: Bearer {api_key}' --header 'Authorization: Bearer {api_key}'
``` ```
@ -1117,13 +1103,7 @@ Chat applications support session persistence, allowing previous chat history to
<Row> <Row>
<Col> <Col>
Used to get icons of tools in this application Used to get icons of tools in this application
### Query
<Properties>
<Property name='user' type='string' key='user'>
User identifier, defined by the developer's rules, must be unique within the application.
</Property>
</Properties>
### Response ### Response
- `tool_icons`(object[string]) tool icons - `tool_icons`(object[string]) tool icons
- `tool_name` (string) - `tool_name` (string)
@ -1134,9 +1114,9 @@ Chat applications support session persistence, allowing previous chat history to
- (string) url of icon - (string) url of icon
</Col> </Col>
<Col> <Col>
<CodeGroup title="Request" tag="GET" label="/meta" targetCode={`curl -X GET '${props.appDetail.api_base_url}/meta?user=abc-123' \\\n-H 'Authorization: Bearer {api_key}'`}> <CodeGroup title="Request" tag="GET" label="/meta" targetCode={`curl -X GET '${props.appDetail.api_base_url}/meta' \\\n-H 'Authorization: Bearer {api_key}'`}>
```bash {{ title: 'cURL' }} ```bash {{ title: 'cURL' }}
curl -X GET '${props.appDetail.api_base_url}/meta?user=abc-123' \ curl -X GET '${props.appDetail.api_base_url}/meta' \
-H 'Authorization: Bearer {api_key}' -H 'Authorization: Bearer {api_key}'
``` ```

32
web/app/components/develop/template/template_advanced_chat.ja.mdx
View File

@ -951,22 +951,16 @@ import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from
<Row> <Row>
<Col> <Col>
このアプリケーションの基本情報を取得するために使用されます このアプリケーションの基本情報を取得するために使用されます
### Query
<Properties>
<Property name='user' type='string' key='user'>
ユーザー識別子、開発者のルールによって定義され、アプリケーション内で一意でなければなりません。
</Property>
</Properties>
### Response ### Response
- `name` (string) アプリケーションの名前 - `name` (string) アプリケーションの名前
- `description` (string) アプリケーションの説明 - `description` (string) アプリケーションの説明
- `tags` (array[string]) アプリケーションのタグ - `tags` (array[string]) アプリケーションのタグ
</Col> </Col>
<Col> <Col>
<CodeGroup title="Request" tag="GET" label="/info" targetCode={`curl -X GET '${props.appDetail.api_base_url}/info?user=abc-123' \\\n-H 'Authorization: Bearer {api_key}'`}> <CodeGroup title="Request" tag="GET" label="/info" targetCode={`curl -X GET '${props.appDetail.api_base_url}/info' \\\n-H 'Authorization: Bearer {api_key}'`}>
```bash {{ title: 'cURL' }} ```bash {{ title: 'cURL' }}
curl -X GET '${props.appDetail.api_base_url}/info?user=abc-123' \ curl -X GET '${props.appDetail.api_base_url}/info' \
-H 'Authorization: Bearer {api_key}' -H 'Authorization: Bearer {api_key}'
``` ```
</CodeGroup> </CodeGroup>
@ -997,14 +991,6 @@ import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from
<Col> <Col>
ページに入る際に、機能、入力パラメータ名、タイプ、デフォルト値などの情報を取得するために使用されます。 ページに入る際に、機能、入力パラメータ名、タイプ、デフォルト値などの情報を取得するために使用されます。
### クエリ
<Properties>
<Property name='user' type='string' key='user'>
ユーザー識別子、開発者のルールによって定義され、アプリケーション内で一意でなければなりません。
</Property>
</Properties>
### 応答 ### 応答
- `opening_statement` (string) 開始の挨拶 - `opening_statement` (string) 開始の挨拶
- `suggested_questions` (array[string]) 開始時の推奨質問のリスト - `suggested_questions` (array[string]) 開始時の推奨質問のリスト
@ -1048,10 +1034,10 @@ import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from
</Col> </Col>
<Col sticky> <Col sticky>
<CodeGroup title="リクエスト" tag="GET" label="/parameters" targetCode={` curl -X GET '${props.appDetail.api_base_url}/parameters?user=abc-123'`}> <CodeGroup title="リクエスト" tag="GET" label="/parameters" targetCode={` curl -X GET '${props.appDetail.api_base_url}/parameters'`}>
```bash {{ title: 'cURL' }} ```bash {{ title: 'cURL' }}
curl -X GET '${props.appDetail.api_base_url}/parameters?user=abc-123' \ curl -X GET '${props.appDetail.api_base_url}/parameters' \
--header 'Authorization: Bearer {api_key}' --header 'Authorization: Bearer {api_key}'
``` ```
@ -1116,13 +1102,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from
<Row> <Row>
<Col> <Col>
このアプリケーションのツールのアイコンを取得するために使用されます このアプリケーションのツールのアイコンを取得するために使用されます
### クエリ
<Properties>
<Property name='user' type='string' key='user'>
ユーザー識別子、開発者のルールによって定義され、アプリケーション内で一意でなければなりません。
</Property>
</Properties>
### 応答 ### 応答
- `tool_icons`(object[string]) ツールアイコン - `tool_icons`(object[string]) ツールアイコン
- `tool_name` (string) - `tool_name` (string)
@ -1133,9 +1113,9 @@ import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from
- (string) アイコンのURL - (string) アイコンのURL
</Col> </Col>
<Col> <Col>
<CodeGroup title="リクエスト" tag="GET" label="/meta" targetCode={`curl -X GET '${props.appDetail.api_base_url}/meta?user=abc-123' \\\n-H 'Authorization: Bearer {api_key}'`}> <CodeGroup title="リクエスト" tag="GET" label="/meta" targetCode={`curl -X GET '${props.appDetail.api_base_url}/meta' \\\n-H 'Authorization: Bearer {api_key}'`}>
```bash {{ title: 'cURL' }} ```bash {{ title: 'cURL' }}
curl -X GET '${props.appDetail.api_base_url}/meta?user=abc-123' \ curl -X GET '${props.appDetail.api_base_url}/meta' \
-H 'Authorization: Bearer {api_key}' -H 'Authorization: Bearer {api_key}'
``` ```

32
web/app/components/develop/template/template_advanced_chat.zh.mdx
View File

@ -985,22 +985,15 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx'
<Row> <Row>
<Col> <Col>
用于获取应用的基本信息 用于获取应用的基本信息
### Query
<Properties>
<Property name='user' type='string' key='user'>
用户标识，由开发者定义规则，需保证用户标识在应用内唯一。
</Property>
</Properties>
### Response ### Response
- `name` (string) 应用名称 - `name` (string) 应用名称
- `description` (string) 应用描述 - `description` (string) 应用描述
- `tags` (array[string]) 应用标签 - `tags` (array[string]) 应用标签
</Col> </Col>
<Col> <Col>
<CodeGroup title="Request" tag="GET" label="/info" targetCode={`curl -X GET '${props.appDetail.api_base_url}/info?user=abc-123' \\\n-H 'Authorization: Bearer {api_key}'`}> <CodeGroup title="Request" tag="GET" label="/info" targetCode={`curl -X GET '${props.appDetail.api_base_url}/info' \\\n-H 'Authorization: Bearer {api_key}'`}>
```bash {{ title: 'cURL' }} ```bash {{ title: 'cURL' }}
curl -X GET '${props.appDetail.api_base_url}/info?user=abc-123' \ curl -X GET '${props.appDetail.api_base_url}/info' \
-H 'Authorization: Bearer {api_key}' -H 'Authorization: Bearer {api_key}'
``` ```
</CodeGroup> </CodeGroup>
@ -1031,14 +1024,6 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx'
<Col> <Col>
用于进入页面一开始，获取功能开关、输入参数名称、类型及默认值等使用。 用于进入页面一开始，获取功能开关、输入参数名称、类型及默认值等使用。
### Query
<Properties>
<Property name='user' type='string' key='user'>
用户标识，由开发者定义规则，需保证用户标识在应用内唯一。
</Property>
</Properties>
### Response ### Response
- `opening_statement` (string) 开场白 - `opening_statement` (string) 开场白
- `suggested_questions` (array[string]) 开场推荐问题列表 - `suggested_questions` (array[string]) 开场推荐问题列表
@ -1084,7 +1069,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx'
<CodeGroup title="Request" tag="GET" label="/parameters" targetCode={` curl -X GET '${props.appDetail.api_base_url}/parameters'\\\n--header 'Authorization: Bearer {api_key}'`}> <CodeGroup title="Request" tag="GET" label="/parameters" targetCode={` curl -X GET '${props.appDetail.api_base_url}/parameters'\\\n--header 'Authorization: Bearer {api_key}'`}>
```bash {{ title: 'cURL' }} ```bash {{ title: 'cURL' }}
curl -X GET '${props.appDetail.api_base_url}/parameters?user=abc-123' \ curl -X GET '${props.appDetail.api_base_url}/parameters' \
--header 'Authorization: Bearer {api_key}' --header 'Authorization: Bearer {api_key}'
``` ```
@ -1141,13 +1126,6 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx'
<Row> <Row>
<Col> <Col>
用于获取工具icon 用于获取工具icon
### Query
<Properties>
<Property name='user' type='string' key='user'>
用户标识，由开发者定义规则，需保证用户标识在应用内唯一。
</Property>
</Properties>
### Response ### Response
- `tool_icons`(object[string]) 工具图标 - `tool_icons`(object[string]) 工具图标
- `工具名称` (string) - `工具名称` (string)
@ -1158,9 +1136,9 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx'
- (string) 图标URL - (string) 图标URL
</Col> </Col>
<Col> <Col>
<CodeGroup title="Request" tag="POST" label="/meta" targetCode={`curl -X GET '${props.appDetail.api_base_url}/meta?user=abc-123' \\\n-H 'Authorization: Bearer {api_key}'`}> <CodeGroup title="Request" tag="POST" label="/meta" targetCode={`curl -X GET '${props.appDetail.api_base_url}/meta' \\\n-H 'Authorization: Bearer {api_key}'`}>
```bash {{ title: 'cURL' }} ```bash {{ title: 'cURL' }}
curl -X GET '${props.appDetail.api_base_url}/meta?user=abc-123' \ curl -X GET '${props.appDetail.api_base_url}/meta' \
-H 'Authorization: Bearer {api_key}' -H 'Authorization: Bearer {api_key}'
``` ```

24
web/app/components/develop/template/template_chat.en.mdx
View File

@ -980,22 +980,16 @@ Chat applications support session persistence, allowing previous chat history to
<Row> <Row>
<Col> <Col>
Used to get basic information about this application Used to get basic information about this application
### Query
<Properties>
<Property name='user' type='string' key='user'>
User identifier, defined by the developer's rules, must be unique within the application.
</Property>
</Properties>
### Response ### Response
- `name` (string) application name - `name` (string) application name
- `description` (string) application description - `description` (string) application description
- `tags` (array[string]) application tags - `tags` (array[string]) application tags
</Col> </Col>
<Col> <Col>
<CodeGroup title="Request" tag="GET" label="/info" targetCode={`curl -X GET '${props.appDetail.api_base_url}/info?user=abc-123' \\\n-H 'Authorization: Bearer {api_key}'`}> <CodeGroup title="Request" tag="GET" label="/info" targetCode={`curl -X GET '${props.appDetail.api_base_url}/info' \\\n-H 'Authorization: Bearer {api_key}'`}>
```bash {{ title: 'cURL' }} ```bash {{ title: 'cURL' }}
curl -X GET '${props.appDetail.api_base_url}/info?user=abc-123' \ curl -X GET '${props.appDetail.api_base_url}/info' \
-H 'Authorization: Bearer {api_key}' -H 'Authorization: Bearer {api_key}'
``` ```
</CodeGroup> </CodeGroup>
@ -1077,10 +1071,10 @@ Chat applications support session persistence, allowing previous chat history to
</Col> </Col>
<Col sticky> <Col sticky>
<CodeGroup title="Request" tag="GET" label="/parameters" targetCode={` curl -X GET '${props.appDetail.api_base_url}/parameters?user=abc-123'`}> <CodeGroup title="Request" tag="GET" label="/parameters" targetCode={` curl -X GET '${props.appDetail.api_base_url}/parameters'`}>
```bash {{ title: 'cURL' }} ```bash {{ title: 'cURL' }}
curl -X GET '${props.appDetail.api_base_url}/parameters?user=abc-123' \ curl -X GET '${props.appDetail.api_base_url}/parameters' \
--header 'Authorization: Bearer {api_key}' --header 'Authorization: Bearer {api_key}'
``` ```
@ -1145,13 +1139,7 @@ Chat applications support session persistence, allowing previous chat history to
<Row> <Row>
<Col> <Col>
Used to get icons of tools in this application Used to get icons of tools in this application
### Query
<Properties>
<Property name='user' type='string' key='user'>
User identifier, defined by the developer's rules, must be unique within the application.
</Property>
</Properties>
### Response ### Response
- `tool_icons`(object[string]) tool icons - `tool_icons`(object[string]) tool icons
- `tool_name` (string) - `tool_name` (string)
@ -1162,9 +1150,9 @@ Chat applications support session persistence, allowing previous chat history to
- (string) url of icon - (string) url of icon
</Col> </Col>
<Col> <Col>
<CodeGroup title="Request" tag="GET" label="/meta" targetCode={`curl -X GET '${props.appDetail.api_base_url}/meta?user=abc-123' \\\n-H 'Authorization: Bearer {api_key}'`}> <CodeGroup title="Request" tag="GET" label="/meta" targetCode={`curl -X GET '${props.appDetail.api_base_url}/meta' \\\n-H 'Authorization: Bearer {api_key}'`}>
```bash {{ title: 'cURL' }} ```bash {{ title: 'cURL' }}
curl -X GET '${props.appDetail.api_base_url}/meta?user=abc-123' \ curl -X GET '${props.appDetail.api_base_url}/meta' \
-H 'Authorization: Bearer {api_key}' -H 'Authorization: Bearer {api_key}'
``` ```

32
web/app/components/develop/template/template_chat.ja.mdx
View File

@ -978,22 +978,16 @@ import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from
<Row> <Row>
<Col> <Col>
このアプリケーションの基本情報を取得するために使用されます このアプリケーションの基本情報を取得するために使用されます
### Query
<Properties>
<Property name='user' type='string' key='user'>
ユーザー識別子、開発者のルールによって定義され、アプリケーション内で一意でなければなりません。
</Property>
</Properties>
### Response ### Response
- `name` (string) アプリケーションの名前 - `name` (string) アプリケーションの名前
- `description` (string) アプリケーションの説明 - `description` (string) アプリケーションの説明
- `tags` (array[string]) アプリケーションのタグ - `tags` (array[string]) アプリケーションのタグ
</Col> </Col>
<Col> <Col>
<CodeGroup title="Request" tag="GET" label="/info" targetCode={`curl -X GET '${props.appDetail.api_base_url}/info?user=abc-123' \\\n-H 'Authorization: Bearer {api_key}'`}> <CodeGroup title="Request" tag="GET" label="/info" targetCode={`curl -X GET '${props.appDetail.api_base_url}/info' \\\n-H 'Authorization: Bearer {api_key}'`}>
```bash {{ title: 'cURL' }} ```bash {{ title: 'cURL' }}
curl -X GET '${props.appDetail.api_base_url}/info?user=abc-123' \ curl -X GET '${props.appDetail.api_base_url}/info' \
-H 'Authorization: Bearer {api_key}' -H 'Authorization: Bearer {api_key}'
``` ```
</CodeGroup> </CodeGroup>
@ -1024,14 +1018,6 @@ import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from
<Col> <Col>
ページに入る際に、機能、入力パラメータ名、タイプ、デフォルト値などの情報を取得するために使用されます。 ページに入る際に、機能、入力パラメータ名、タイプ、デフォルト値などの情報を取得するために使用されます。
### クエリ
<Properties>
<Property name='user' type='string' key='user'>
ユーザー識別子、開発者のルールで定義され、アプリケーション内で一意でなければなりません。
</Property>
</Properties>
### 応答 ### 応答
- `opening_statement` (string) 開始文 - `opening_statement` (string) 開始文
- `suggested_questions` (array[string]) 開始時の推奨質問のリスト - `suggested_questions` (array[string]) 開始時の推奨質問のリスト
@ -1075,10 +1061,10 @@ import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from
</Col> </Col>
<Col sticky> <Col sticky>
<CodeGroup title="リクエスト" tag="GET" label="/parameters" targetCode={` curl -X GET '${props.appDetail.api_base_url}/parameters?user=abc-123'`}> <CodeGroup title="リクエスト" tag="GET" label="/parameters" targetCode={` curl -X GET '${props.appDetail.api_base_url}/parameters'`}>
```bash {{ title: 'cURL' }} ```bash {{ title: 'cURL' }}
curl -X GET '${props.appDetail.api_base_url}/parameters?user=abc-123' \ curl -X GET '${props.appDetail.api_base_url}/parameters' \
--header 'Authorization: Bearer {api_key}' --header 'Authorization: Bearer {api_key}'
``` ```
@ -1143,13 +1129,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from
<Row> <Row>
<Col> <Col>
このアプリケーションのツールのアイコンを取得するために使用されます このアプリケーションのツールのアイコンを取得するために使用されます
### クエリ
<Properties>
<Property name='user' type='string' key='user'>
ユーザー識別子、開発者のルールで定義され、アプリケーション内で一意でなければなりません。
</Property>
</Properties>
### 応答 ### 応答
- `tool_icons`(object[string]) ツールアイコン - `tool_icons`(object[string]) ツールアイコン
- `tool_name` (string) - `tool_name` (string)
@ -1160,9 +1140,9 @@ import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from
- (string) アイコンのURL - (string) アイコンのURL
</Col> </Col>
<Col> <Col>
<CodeGroup title="リクエスト" tag="GET" label="/meta" targetCode={`curl -X GET '${props.appDetail.api_base_url}/meta?user=abc-123' \\\n-H 'Authorization: Bearer {api_key}'`}> <CodeGroup title="リクエスト" tag="GET" label="/meta" targetCode={`curl -X GET '${props.appDetail.api_base_url}/meta' \\\n-H 'Authorization: Bearer {api_key}'`}>
```bash {{ title: 'cURL' }} ```bash {{ title: 'cURL' }}
curl -X GET '${props.appDetail.api_base_url}/meta?user=abc-123' \ curl -X GET '${props.appDetail.api_base_url}/meta' \
-H 'Authorization: Bearer {api_key}' -H 'Authorization: Bearer {api_key}'
``` ```

32
web/app/components/develop/template/template_chat.zh.mdx
View File

@ -993,22 +993,15 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx'
<Row> <Row>
<Col> <Col>
用于获取应用的基本信息 用于获取应用的基本信息
### Query
<Properties>
<Property name='user' type='string' key='user'>
用户标识，由开发者定义规则，需保证用户标识在应用内唯一。
</Property>
</Properties>
### Response ### Response
- `name` (string) 应用名称 - `name` (string) 应用名称
- `description` (string) 应用描述 - `description` (string) 应用描述
- `tags` (array[string]) 应用标签 - `tags` (array[string]) 应用标签
</Col> </Col>
<Col> <Col>
<CodeGroup title="Request" tag="GET" label="/info" targetCode={`curl -X GET '${props.appDetail.api_base_url}/info?user=abc-123' \\\n-H 'Authorization: Bearer {api_key}'`}> <CodeGroup title="Request" tag="GET" label="/info" targetCode={`curl -X GET '${props.appDetail.api_base_url}/info' \\\n-H 'Authorization: Bearer {api_key}'`}>
```bash {{ title: 'cURL' }} ```bash {{ title: 'cURL' }}
curl -X GET '${props.appDetail.api_base_url}/info?user=abc-123' \ curl -X GET '${props.appDetail.api_base_url}/info' \
-H 'Authorization: Bearer {api_key}' -H 'Authorization: Bearer {api_key}'
``` ```
</CodeGroup> </CodeGroup>
@ -1039,14 +1032,6 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx'
<Col> <Col>
用于进入页面一开始，获取功能开关、输入参数名称、类型及默认值等使用。 用于进入页面一开始，获取功能开关、输入参数名称、类型及默认值等使用。
### Query
<Properties>
<Property name='user' type='string' key='user'>
用户标识，由开发者定义规则，需保证用户标识在应用内唯一。
</Property>
</Properties>
### Response ### Response
- `opening_statement` (string) 开场白 - `opening_statement` (string) 开场白
- `suggested_questions` (array[string]) 开场推荐问题列表 - `suggested_questions` (array[string]) 开场推荐问题列表
@ -1092,7 +1077,7 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx'
<CodeGroup title="Request" tag="GET" label="/parameters" targetCode={` curl -X GET '${props.appDetail.api_base_url}/parameters'\\\n--header 'Authorization: Bearer {api_key}'`}> <CodeGroup title="Request" tag="GET" label="/parameters" targetCode={` curl -X GET '${props.appDetail.api_base_url}/parameters'\\\n--header 'Authorization: Bearer {api_key}'`}>
```bash {{ title: 'cURL' }} ```bash {{ title: 'cURL' }}
curl -X GET '${props.appDetail.api_base_url}/parameters?user=abc-123' \ curl -X GET '${props.appDetail.api_base_url}/parameters' \
--header 'Authorization: Bearer {api_key}' --header 'Authorization: Bearer {api_key}'
``` ```
@ -1149,13 +1134,6 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx'
<Row> <Row>
<Col> <Col>
用于获取工具icon 用于获取工具icon
### Query
<Properties>
<Property name='user' type='string' key='user'>
用户标识，由开发者定义规则，需保证用户标识在应用内唯一。
</Property>
</Properties>
### Response ### Response
- `tool_icons`(object[string]) 工具图标 - `tool_icons`(object[string]) 工具图标
- `工具名称` (string) - `工具名称` (string)
@ -1166,9 +1144,9 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx'
- (string) 图标URL - (string) 图标URL
</Col> </Col>
<Col> <Col>
<CodeGroup title="Request" tag="POST" label="/meta" targetCode={`curl -X GET '${props.appDetail.api_base_url}/meta?user=abc-123' \\\n-H 'Authorization: Bearer {api_key}'`}> <CodeGroup title="Request" tag="POST" label="/meta" targetCode={`curl -X GET '${props.appDetail.api_base_url}/meta' \\\n-H 'Authorization: Bearer {api_key}'`}>
```bash {{ title: 'cURL' }} ```bash {{ title: 'cURL' }}
curl -X GET '${props.appDetail.api_base_url}/meta?user=abc-123' \ curl -X GET '${props.appDetail.api_base_url}/meta' \
-H 'Authorization: Bearer {api_key}' -H 'Authorization: Bearer {api_key}'
``` ```

22
web/app/components/develop/template/template_workflow.en.mdx
View File

@ -610,22 +610,16 @@ Workflow applications offers non-session support and is ideal for translation, a
<Row> <Row>
<Col> <Col>
Used to get basic information about this application Used to get basic information about this application
### Query
<Properties>
<Property name='user' type='string' key='user'>
User identifier, defined by the developer's rules, must be unique within the application.
</Property>
</Properties>
### Response ### Response
- `name` (string) application name - `name` (string) application name
- `description` (string) application description - `description` (string) application description
- `tags` (array[string]) application tags - `tags` (array[string]) application tags
</Col> </Col>
<Col> <Col>
<CodeGroup title="Request" tag="GET" label="/info" targetCode={`curl -X GET '${props.appDetail.api_base_url}/info?user=abc-123' \\\n-H 'Authorization: Bearer {api_key}'`}> <CodeGroup title="Request" tag="GET" label="/info" targetCode={`curl -X GET '${props.appDetail.api_base_url}/info' \\\n-H 'Authorization: Bearer {api_key}'`}>
```bash {{ title: 'cURL' }} ```bash {{ title: 'cURL' }}
curl -X GET '${props.appDetail.api_base_url}/info?user=abc-123' \ curl -X GET '${props.appDetail.api_base_url}/info' \
-H 'Authorization: Bearer {api_key}' -H 'Authorization: Bearer {api_key}'
``` ```
</CodeGroup> </CodeGroup>
@ -656,14 +650,6 @@ Workflow applications offers non-session support and is ideal for translation, a
<Col> <Col>
Used at the start of entering the page to obtain information such as features, input parameter names, types, and default values. Used at the start of entering the page to obtain information such as features, input parameter names, types, and default values.
### Query
<Properties>
<Property name='user' type='string' key='user'>
User identifier, defined by the developer's rules, must be unique within the application.
</Property>
</Properties>
### Response ### Response
- `user_input_form` (array[object]) User input form configuration - `user_input_form` (array[object]) User input form configuration
- `text-input` (object) Text input control - `text-input` (object) Text input control
@ -697,10 +683,10 @@ Workflow applications offers non-session support and is ideal for translation, a
</Col> </Col>
<Col sticky> <Col sticky>
<CodeGroup title="Request" tag="GET" label="/parameters" targetCode={` curl -X GET '${props.appDetail.api_base_url}/parameters?user=abc-123'`}> <CodeGroup title="Request" tag="GET" label="/parameters" targetCode={` curl -X GET '${props.appDetail.api_base_url}/parameters'`}>
```bash {{ title: 'cURL' }} ```bash {{ title: 'cURL' }}
curl -X GET '${props.appDetail.api_base_url}/parameters?user=abc-123' \ curl -X GET '${props.appDetail.api_base_url}/parameters' \
--header 'Authorization: Bearer {api_key}' --header 'Authorization: Bearer {api_key}'
``` ```

22
web/app/components/develop/template/template_workflow.ja.mdx
View File

@ -610,22 +610,16 @@ import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from
<Row> <Row>
<Col> <Col>
このアプリケーションの基本情報を取得するために使用されます このアプリケーションの基本情報を取得するために使用されます
### Query
<Properties>
<Property name='user' type='string' key='user'>
ユーザー識別子、開発者のルールによって定義され、アプリケーション内で一意でなければなりません。
</Property>
</Properties>
### Response ### Response
- `name` (string) アプリケーションの名前 - `name` (string) アプリケーションの名前
- `description` (string) アプリケーションの説明 - `description` (string) アプリケーションの説明
- `tags` (array[string]) アプリケーションのタグ - `tags` (array[string]) アプリケーションのタグ
</Col> </Col>
<Col> <Col>
<CodeGroup title="Request" tag="GET" label="/info" targetCode={`curl -X GET '${props.appDetail.api_base_url}/info?user=abc-123' \\\n-H 'Authorization: Bearer {api_key}'`}> <CodeGroup title="Request" tag="GET" label="/info" targetCode={`curl -X GET '${props.appDetail.api_base_url}/info' \\\n-H 'Authorization: Bearer {api_key}'`}>
```bash {{ title: 'cURL' }} ```bash {{ title: 'cURL' }}
curl -X GET '${props.appDetail.api_base_url}/info?user=abc-123' \ curl -X GET '${props.appDetail.api_base_url}/info' \
-H 'Authorization: Bearer {api_key}' -H 'Authorization: Bearer {api_key}'
``` ```
</CodeGroup> </CodeGroup>
@ -656,14 +650,6 @@ import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from
<Col> <Col>
ページに入る際に、機能、入力パラメータ名、タイプ、デフォルト値などの情報を取得するために使用されます。 ページに入る際に、機能、入力パラメータ名、タイプ、デフォルト値などの情報を取得するために使用されます。
### クエリ
<Properties>
<Property name='user' type='string' key='user'>
ユーザー識別子、開発者のルールで定義され、アプリケーション内で一意でなければなりません。
</Property>
</Properties>
### 応答 ### 応答
- `user_input_form` (array[object]) ユーザー入力フォームの設定 - `user_input_form` (array[object]) ユーザー入力フォームの設定
- `text-input` (object) テキスト入力コントロール - `text-input` (object) テキスト入力コントロール
@ -697,10 +683,10 @@ import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from
</Col> </Col>
<Col sticky> <Col sticky>
<CodeGroup title="リクエスト" tag="GET" label="/parameters" targetCode={` curl -X GET '${props.appDetail.api_base_url}/parameters?user=abc-123'`}> <CodeGroup title="リクエスト" tag="GET" label="/parameters" targetCode={` curl -X GET '${props.appDetail.api_base_url}/parameters'`}>
```bash {{ title: 'cURL' }} ```bash {{ title: 'cURL' }}
curl -X GET '${props.appDetail.api_base_url}/parameters?user=abc-123' \ curl -X GET '${props.appDetail.api_base_url}/parameters' \
--header 'Authorization: Bearer {api_key}' --header 'Authorization: Bearer {api_key}'
``` ```

23
web/app/components/develop/template/template_workflow.zh.mdx
View File

@ -602,22 +602,15 @@ Workflow 应用无会话支持，适合用于翻译/文章写作/总结 AI 等
<Row> <Row>
<Col> <Col>
用于获取应用的基本信息 用于获取应用的基本信息
### Query
<Properties>
<Property name='user' type='string' key='user'>
用户标识，由开发者定义规则，需保证用户标识在应用内唯一。
</Property>
</Properties>
### Response ### Response
- `name` (string) 应用名称 - `name` (string) 应用名称
- `description` (string) 应用描述 - `description` (string) 应用描述
- `tags` (array[string]) 应用标签 - `tags` (array[string]) 应用标签
</Col> </Col>
<Col> <Col>
<CodeGroup title="Request" tag="GET" label="/info" targetCode={`curl -X GET '${props.appDetail.api_base_url}/info?user=abc-123' \\\n-H 'Authorization: Bearer {api_key}'`}> <CodeGroup title="Request" tag="GET" label="/info" targetCode={`curl -X GET '${props.appDetail.api_base_url}/info' \\\n-H 'Authorization: Bearer {api_key}'`}>
```bash {{ title: 'cURL' }} ```bash {{ title: 'cURL' }}
curl -X GET '${props.appDetail.api_base_url}/info?user=abc-123' \ curl -X GET '${props.appDetail.api_base_url}/info' \
-H 'Authorization: Bearer {api_key}' -H 'Authorization: Bearer {api_key}'
``` ```
</CodeGroup> </CodeGroup>
@ -648,14 +641,6 @@ Workflow 应用无会话支持，适合用于翻译/文章写作/总结 AI 等
<Col> <Col>
用于进入页面一开始，获取功能开关、输入参数名称、类型及默认值等使用。 用于进入页面一开始，获取功能开关、输入参数名称、类型及默认值等使用。
### Query
<Properties>
<Property name='user' type='string' key='user'>
用户标识，由开发者定义规则，需保证用户标识在应用内唯一。
</Property>
</Properties>
### Response ### Response
- `user_input_form` (array[object]) 用户输入表单配置 - `user_input_form` (array[object]) 用户输入表单配置
- `text-input` (object) 文本输入控件 - `text-input` (object) 文本输入控件
@ -689,10 +674,10 @@ Workflow 应用无会话支持，适合用于翻译/文章写作/总结 AI 等
</Col> </Col>
<Col sticky> <Col sticky>
<CodeGroup title="Request" tag="GET" label="/parameters" targetCode={` curl -X GET '${props.appDetail.api_base_url}/parameters?user=abc-123'`}> <CodeGroup title="Request" tag="GET" label="/parameters" targetCode={` curl -X GET '${props.appDetail.api_base_url}/parameters'`}>
```bash {{ title: 'cURL' }} ```bash {{ title: 'cURL' }}
curl -X GET '${props.appDetail.api_base_url}/parameters?user=abc-123' \ curl -X GET '${props.appDetail.api_base_url}/parameters' \
--header 'Authorization: Bearer {api_key}' --header 'Authorization: Bearer {api_key}'
``` ```