writinwaters commited on
Commit
ac4d1d4
·
1 Parent(s): a2e7afc

Updated RAGFlow Agent UI (#4029)

Browse files

### What problem does this PR solve?


### Type of change


- [x] Documentation Update

README_zh.md CHANGED
@@ -158,6 +158,11 @@
158
  | nightly | ≈9 | :heavy_check_mark: | *Unstable* nightly build |
159
  | nightly-slim | ≈2 | ❌ | *Unstable* nightly build |
160
 
 
 
 
 
 
161
  4. 服务器启动成功后再次确认服务器状态:
162
 
163
  ```bash
 
158
  | nightly | ≈9 | :heavy_check_mark: | *Unstable* nightly build |
159
  | nightly-slim | ≈2 | ❌ | *Unstable* nightly build |
160
 
161
+ > [!TIP]
162
+ > 如果你遇到 Docker 镜像拉不下来的问题,可以在 **docker/.env** 文件内根据变量 `RAGFLOW_IMAGE` 的注释提示选择华为云或者阿里云的相应镜像。
163
+ > - 华为云镜像名:`swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow`
164
+ > - 阿里云镜像名:`registry.cn-hangzhou.aliyuncs.com/infiniflow/ragflow`
165
+
166
  4. 服务器启动成功后再次确认服务器状态:
167
 
168
  ```bash
docker/README.md CHANGED
@@ -16,6 +16,9 @@
16
  - **docker-compose-base.yml**
17
  Sets up environment for RAGFlow's dependencies: Elasticsearch/[Infinity](https://github.com/infiniflow/infinity), MySQL, MinIO, and Redis.
18
 
 
 
 
19
  ## 🐬 Docker environment variables
20
 
21
  The [.env](./.env) file contains important environment variables for Docker.
@@ -27,7 +30,7 @@ The [.env](./.env) file contains important environment variables for Docker.
27
  - `ES_PORT`
28
  The port used to expose the Elasticsearch service to the host machine, allowing **external** access to the service running inside the Docker container. Defaults to `1200`.
29
  - `ELASTIC_PASSWORD`
30
- The password for Elasticsearch.
31
 
32
  ### Kibana
33
 
@@ -46,7 +49,7 @@ The [.env](./.env) file contains important environment variables for Docker.
46
  ### MySQL
47
 
48
  - `MYSQL_PASSWORD`
49
- The password for MySQL.
50
  - `MYSQL_PORT`
51
  The port used to expose the MySQL service to the host machine, allowing **external** access to the MySQL database running inside the Docker container. Defaults to `5455`.
52
 
@@ -59,7 +62,7 @@ The [.env](./.env) file contains important environment variables for Docker.
59
  - `MINIO_USER`
60
  The username for MinIO.
61
  - `MINIO_PASSWORD`
62
- The password for MinIO.
63
 
64
  ### Redis
65
 
 
16
  - **docker-compose-base.yml**
17
  Sets up environment for RAGFlow's dependencies: Elasticsearch/[Infinity](https://github.com/infiniflow/infinity), MySQL, MinIO, and Redis.
18
 
19
+ > [!CAUTION]
20
+ > We do not actively maintain **docker-compose-CN-oc9.yml**, **docker-compose-gpu-CN-oc9.yml**, or **docker-compose-gpu.yml**, so use them at your own risk. However, you are welcome to file a pull request to improve any of them.
21
+
22
  ## 🐬 Docker environment variables
23
 
24
  The [.env](./.env) file contains important environment variables for Docker.
 
30
  - `ES_PORT`
31
  The port used to expose the Elasticsearch service to the host machine, allowing **external** access to the service running inside the Docker container. Defaults to `1200`.
32
  - `ELASTIC_PASSWORD`
33
+ The password for Elasticsearch.
34
 
35
  ### Kibana
36
 
 
49
  ### MySQL
50
 
51
  - `MYSQL_PASSWORD`
52
+ The password for MySQL.
53
  - `MYSQL_PORT`
54
  The port used to expose the MySQL service to the host machine, allowing **external** access to the MySQL database running inside the Docker container. Defaults to `5455`.
55
 
 
62
  - `MINIO_USER`
63
  The username for MinIO.
64
  - `MINIO_PASSWORD`
65
+ The password for MinIO.
66
 
67
  ### Redis
68
 
docker/docker-compose-CN-oc9.yml CHANGED
@@ -1,3 +1,5 @@
 
 
1
  include:
2
  - ./docker-compose-base.yml
3
 
 
1
+ # The RAGFlow team do not actively maintain docker-compose-CN-oc9.yml, so use them at your own risk.
2
+ # However, you are welcome to file a pull request to improve it.
3
  include:
4
  - ./docker-compose-base.yml
5
 
docker/docker-compose-admin-tool.yml DELETED
@@ -1,37 +0,0 @@
1
- include:
2
- - path: ./docker-compose.yml
3
- env_file: ./.env
4
-
5
- services:
6
- kibana:
7
- image: kibana:${STACK_VERSION}
8
- container_name: ragflow-kibana
9
- environment:
10
- ELASTICSEARCH_USERNAME: ${KIBANA_USER}
11
- ELASTICSEARCH_PASSWORD: ${KIBANA_PASSWORD}
12
- ELASTICSEARCH_HOSTS: "http://es01:9200"
13
- ports:
14
- - ${KIBANA_PORT}:5601
15
- depends_on:
16
- es01:
17
- condition: service_healthy
18
- kibana-user-init:
19
- condition: service_completed_successfully
20
-
21
- networks:
22
- - ragflow
23
- kibana-user-init:
24
- image: appropriate/curl
25
- depends_on:
26
- es01:
27
- condition: service_healthy
28
- volumes:
29
- - ./init-kibana.sh:/app/init-kibana.sh
30
- environment:
31
- - ELASTIC_PASSWORD=${ELASTIC_PASSWORD}
32
- - KIBANA_USER=${KIBANA_USER}
33
- - KIBANA_PASSWORD=${KIBANA_PASSWORD}
34
- command: /bin/sh -c "sh /app/init-kibana.sh"
35
- networks:
36
- - ragflow
37
- restart: 'no'
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
docker/docker-compose-gpu-CN-oc9.yml CHANGED
@@ -1,3 +1,5 @@
 
 
1
  include:
2
  - ./docker-compose-base.yml
3
 
 
1
+ # The RAGFlow team do not actively maintain docker-compose-gpu-CN-oc9.yml, so use them at your own risk.
2
+ # However, you are welcome to file a pull request to improve it.
3
  include:
4
  - ./docker-compose-base.yml
5
 
docker/docker-compose-gpu.yml CHANGED
@@ -1,3 +1,5 @@
 
 
1
  include:
2
  - ./docker-compose-base.yml
3
 
 
1
+ # The RAGFlow team do not actively maintain docker-compose-gpu.yml, so use them at your own risk.
2
+ # However, you are welcome to file a pull request to improve it.
3
  include:
4
  - ./docker-compose-base.yml
5
 
docs/configurations.md CHANGED
@@ -34,6 +34,10 @@ docker compose -f docker/docker-compose.yml up -d
34
  - **docker-compose-base.yml**
35
  Sets up environment for RAGFlow's dependencies: Elasticsearch/[Infinity](https://github.com/infiniflow/infinity), MySQL, MinIO, and Redis.
36
 
 
 
 
 
37
  ## Docker environment variables
38
 
39
  The [.env](https://github.com/infiniflow/ragflow/blob/main/docker/.env) file contains important environment variables for Docker.
@@ -45,7 +49,7 @@ The [.env](https://github.com/infiniflow/ragflow/blob/main/docker/.env) file con
45
  - `ES_PORT`
46
  The port used to expose the Elasticsearch service to the host machine, allowing **external** access to the service running inside the Docker container. Defaults to `1200`.
47
  - `ELASTIC_PASSWORD`
48
- The password for Elasticsearch.
49
 
50
  ### Kibana
51
 
 
34
  - **docker-compose-base.yml**
35
  Sets up environment for RAGFlow's dependencies: Elasticsearch/[Infinity](https://github.com/infiniflow/infinity), MySQL, MinIO, and Redis.
36
 
37
+ :::danger IMPORTANT
38
+ **docker-compose-CN-oc9.yml**, **docker-compose-gpu-CN-oc9.yml**, **docker-compose-gpu.yml** have been contributed by our community. We do not actively maintain these files, so use them at your own risk. However, you are welcome to file a pull request to improve any of them.
39
+ :::
40
+
41
  ## Docker environment variables
42
 
43
  The [.env](https://github.com/infiniflow/ragflow/blob/main/docker/.env) file contains important environment variables for Docker.
 
49
  - `ES_PORT`
50
  The port used to expose the Elasticsearch service to the host machine, allowing **external** access to the service running inside the Docker container. Defaults to `1200`.
51
  - `ELASTIC_PASSWORD`
52
+ The password for Elasticsearch.
53
 
54
  ### Kibana
55
 
docs/quickstart.mdx CHANGED
@@ -192,9 +192,9 @@ This section provides instructions on setting up the RAGFlow server on Linux. If
192
  $ docker compose -f docker/docker-compose.yml up -d
193
  ```
194
 
195
- ```mdx-code-block
196
- <APITable>
197
- ```
198
 
199
  | RAGFlow image tag | Image size (GB) | Has embedding models and Python packages? | Stable? |
200
  | ------------------- | --------------- | ----------------------------------------- | ------------------------ |
@@ -205,9 +205,9 @@ This section provides instructions on setting up the RAGFlow server on Linux. If
205
  | `nightly` | &approx;9 | :heavy_check_mark: | *Unstable* nightly build |
206
  | `nightly-slim` | &approx;2 | ❌ | *Unstable* nightly build |
207
 
208
- ```mdx-code-block
209
- </APITable>
210
- ```
211
 
212
  4. Check the server status after having the server up and running:
213
 
 
192
  $ docker compose -f docker/docker-compose.yml up -d
193
  ```
194
 
195
+ ```mdx-code-block
196
+ <APITable>
197
+ ```
198
 
199
  | RAGFlow image tag | Image size (GB) | Has embedding models and Python packages? | Stable? |
200
  | ------------------- | --------------- | ----------------------------------------- | ------------------------ |
 
205
  | `nightly` | &approx;9 | :heavy_check_mark: | *Unstable* nightly build |
206
  | `nightly-slim` | &approx;2 | ❌ | *Unstable* nightly build |
207
 
208
+ ```mdx-code-block
209
+ </APITable>
210
+ ```
211
 
212
  4. Check the server status after having the server up and running:
213
 
web/src/locales/en.ts CHANGED
@@ -760,23 +760,23 @@ The above is the content you need to summarize.`,
760
  language: 'Language',
761
  googleScholar: 'Google Scholar',
762
  googleScholarDescription:
763
- 'This component is used to get search result from https://scholar.google.com/. Typically, it performs as a supplement to knowledgebases. Top N specifies the number of search results you need to adapt.',
764
  yearLow: 'Year low',
765
  yearHigh: 'Year high',
766
  patents: 'Patents',
767
  data: 'Data',
768
  deepL: 'DeepL',
769
  deepLDescription:
770
- 'This component is used to get translations from https://www.deepl.com/. Typically, it provides a more specialized translation result.',
771
  authKey: 'Auth key',
772
  sourceLang: 'Source language',
773
  targetLang: 'Target language',
774
  gitHub: 'GitHub',
775
  gitHubDescription:
776
- 'This component is used to search the repository from https://github.com/. Top N specifies the number of search results to be adjusted.',
777
  baiduFanyi: 'BaiduFanyi',
778
  baiduFanyiDescription:
779
- 'This component is used to get translations from https://fanyi.baidu.com/. Typically, it provides a more specialized translation result',
780
  appid: 'App id',
781
  secretKey: 'Secret key',
782
  domain: 'Domain',
@@ -831,7 +831,7 @@ The above is the content you need to summarize.`,
831
  },
832
  qWeather: 'QWeather',
833
  qWeatherDescription:
834
- 'This component is used to get weather related information from https://www.qweather.com/. You can get weather, indices, air quality.',
835
  lang: 'Language',
836
  type: 'Type',
837
  webApiKey: 'Web API key',
@@ -890,7 +890,7 @@ The above is the content you need to summarize.`,
890
  publish: 'API',
891
  exeSQL: 'ExeSQL',
892
  exeSQLDescription:
893
- 'The component queries the results from the corresponding relational database via SQL statements. Supports MySQL, PostgreSQL, MariaDB. ',
894
  dbType: 'Database Type',
895
  database: 'Database',
896
  username: 'Username',
@@ -923,7 +923,7 @@ The above is the content you need to summarize.`,
923
  wenCai: 'WenCai',
924
  queryType: 'Query type',
925
  wenCaiDescription:
926
- 'The component can be used to obtain information on a wide range of financial areas, including but not limited to stocks, funds, etc...',
927
  wenCaiQueryTypeOptions: {
928
  stock: 'stock',
929
  zhishu: 'index',
@@ -939,13 +939,13 @@ The above is the content you need to summarize.`,
939
  },
940
  akShare: 'AkShare',
941
  akShareDescription:
942
- 'This component can be used to obtain news information for the corresponding stock from the Eastmoney website.',
943
  yahooFinance: 'YahooFinance',
944
  yahooFinanceDescription:
945
- 'The component queries information about the company based on the provided ticker symbol.',
946
  crawler: 'Web Crawler',
947
  crawlerDescription:
948
- 'This component can be used to crawl HTML source code from a specified URL.',
949
  proxy: 'Proxy',
950
  crawlerResultOptions: {
951
  html: 'Html',
@@ -960,7 +960,7 @@ The above is the content you need to summarize.`,
960
  cashFlowStatement: 'Cash flow statement',
961
  jin10: 'Jin10',
962
  jin10Description:
963
- 'This component can be used to access information in the financial sector from the Jin10 Open Platform, including quick news, calendar, quotes, reference.',
964
  flashType: 'Flash type',
965
  filter: 'Filter',
966
  contain: 'Contain',
@@ -1007,7 +1007,7 @@ The above is the content you need to summarize.`,
1007
  'A component that receives the output from the upstream component and passes it on as input to the downstream components.',
1008
  tuShare: 'TuShare',
1009
  tuShareDescription:
1010
- 'This component can be used to obtain financial news briefs from mainstream financial websites, aiding industry and quantitative research.',
1011
  tuShareSrcOptions: {
1012
  sina: 'Sina',
1013
  wallstreetcn: 'wallstreetcn',
@@ -1027,7 +1027,7 @@ The above is the content you need to summarize.`,
1027
  notePlaceholder: 'Please enter a note',
1028
  invoke: 'Invoke',
1029
  invokeDescription:
1030
- 'This component can invoke remote end point call. Put the output of other components as parameters or set constant parameters to call remote functions.',
1031
  url: 'Url',
1032
  method: 'Method',
1033
  timeout: 'Timeout',
@@ -1048,9 +1048,9 @@ The above is the content you need to summarize.`,
1048
  testRun: 'Test Run',
1049
  template: 'Template',
1050
  templateDescription:
1051
- 'This component is used for typesetting the outputs of various components.',
1052
  emailComponent: 'Email',
1053
- emailDescription: 'Send email to specified address',
1054
  smtpServer: 'SMTP Server',
1055
  smtpPort: 'SMTP Port',
1056
  senderEmail: 'Sender Email',
 
760
  language: 'Language',
761
  googleScholar: 'Google Scholar',
762
  googleScholarDescription:
763
+ 'A component that searches https://scholar.google.com/. You can use Top N to specify the number of search results.',
764
  yearLow: 'Year low',
765
  yearHigh: 'Year high',
766
  patents: 'Patents',
767
  data: 'Data',
768
  deepL: 'DeepL',
769
  deepLDescription:
770
+ 'A component that gets more specialized translations from https://www.deepl.com/.',
771
  authKey: 'Auth key',
772
  sourceLang: 'Source language',
773
  targetLang: 'Target language',
774
  gitHub: 'GitHub',
775
  gitHubDescription:
776
+ 'A component that searches for repositories from https://github.com/. You can use Top N to specify the number of search results.',
777
  baiduFanyi: 'BaiduFanyi',
778
  baiduFanyiDescription:
779
+ 'A component that gets specialized translations from https://fanyi.baidu.com/.',
780
  appid: 'App id',
781
  secretKey: 'Secret key',
782
  domain: 'Domain',
 
831
  },
832
  qWeather: 'QWeather',
833
  qWeatherDescription:
834
+ 'A component that retrieves weather information, such as temperature and air quality, from https://www.qweather.com/.',
835
  lang: 'Language',
836
  type: 'Type',
837
  webApiKey: 'Web API key',
 
890
  publish: 'API',
891
  exeSQL: 'ExeSQL',
892
  exeSQLDescription:
893
+ 'A component that performs SQL queries on a relational database, supporting querying from MySQL, PostgreSQL, or MariaDB.',
894
  dbType: 'Database Type',
895
  database: 'Database',
896
  username: 'Username',
 
923
  wenCai: 'WenCai',
924
  queryType: 'Query type',
925
  wenCaiDescription:
926
+ 'A component that obtains financial information, including stock prices and funding news, from a wide range of financial websites.',
927
  wenCaiQueryTypeOptions: {
928
  stock: 'stock',
929
  zhishu: 'index',
 
939
  },
940
  akShare: 'AkShare',
941
  akShareDescription:
942
+ 'A component that obtains news about stocks from https://www.eastmoney.com/.',
943
  yahooFinance: 'YahooFinance',
944
  yahooFinanceDescription:
945
+ 'A component that queries information about a publicly traded company using its ticker symbol.',
946
  crawler: 'Web Crawler',
947
  crawlerDescription:
948
+ 'A component that crawls HTML source code from a specified URL.',
949
  proxy: 'Proxy',
950
  crawlerResultOptions: {
951
  html: 'Html',
 
960
  cashFlowStatement: 'Cash flow statement',
961
  jin10: 'Jin10',
962
  jin10Description:
963
+ 'A component that retrieves financial information from the Jin10 Open Platform, including news updates, calendars, quotes, and references.',
964
  flashType: 'Flash type',
965
  filter: 'Filter',
966
  contain: 'Contain',
 
1007
  'A component that receives the output from the upstream component and passes it on as input to the downstream components.',
1008
  tuShare: 'TuShare',
1009
  tuShareDescription:
1010
+ 'A component that obtains financial news briefs from mainstream financial websites, aiding industry and quantitative research.',
1011
  tuShareSrcOptions: {
1012
  sina: 'Sina',
1013
  wallstreetcn: 'wallstreetcn',
 
1027
  notePlaceholder: 'Please enter a note',
1028
  invoke: 'Invoke',
1029
  invokeDescription:
1030
+ `A component capable of calling remote services, using other components' outputs or constants as inputs.`,
1031
  url: 'Url',
1032
  method: 'Method',
1033
  timeout: 'Timeout',
 
1048
  testRun: 'Test Run',
1049
  template: 'Template',
1050
  templateDescription:
1051
+ 'A component that formats the output of another component.',
1052
  emailComponent: 'Email',
1053
+ emailDescription: 'Send an email to a specified address.',
1054
  smtpServer: 'SMTP Server',
1055
  smtpPort: 'SMTP Port',
1056
  senderEmail: 'Sender Email',