writinwaters commited on
Commit
a24094f
·
1 Parent(s): 8302761

Expanded the supported LLM list (#960)

Browse files

### What problem does this PR solve?

_Briefly describe what this PR aims to solve. Include background context
that will help reviewers understand the purpose of the PR._

### Type of change

- [x] Documentation Update

docker/README.md CHANGED
@@ -67,7 +67,7 @@ The serving IP and port inside the docker container. This is not updating until
67
  Newly signed-up users use LLM configured by this part. Otherwise, user need to configure his own LLM in *setting*.
68
 
69
  ### factory
70
- The LLM suppliers. 'Tongyi-Qianwen', "OpenAI" "Moonshot" and "ZHIPU-AI" are supported.
71
 
72
  ### api_key
73
  The corresponding API key of your assigned LLM vendor.
 
67
  Newly signed-up users use LLM configured by this part. Otherwise, user need to configure his own LLM in *setting*.
68
 
69
  ### factory
70
+ The LLM suppliers. "OpenAI", "Tongyi-Qianwen", "ZHIPU-AI", "Moonshot", "DeepSeek", "Baichuan", and "VolcEngine" are supported.
71
 
72
  ### api_key
73
  The corresponding API key of your assigned LLM vendor.
docs/guides/llm_api_key_setup.md CHANGED
@@ -10,10 +10,15 @@ You have two ways to input your LLM API key.
10
  ## Before Starting The System
11
 
12
  In **user_default_llm** of [service_conf.yaml](https://github.com/infiniflow/ragflow/blob/main/docker/service_conf.yaml), you need to specify LLM factory and your own _API_KEY_.
13
- RagFlow supports the flowing LLM factory, and with more coming in the pipeline:
14
-
15
- > [OpenAI](https://platform.openai.com/login?launch), [Tongyi-Qianwen](https://dashscope.console.aliyun.com/model),
16
- > [ZHIPU-AI](https://open.bigmodel.cn/), [Moonshot](https://platform.moonshot.cn/docs)
 
 
 
 
 
17
 
18
  After sign in these LLM suppliers, create your own API-Key, they all have a certain amount of free quota.
19
 
 
10
  ## Before Starting The System
11
 
12
  In **user_default_llm** of [service_conf.yaml](https://github.com/infiniflow/ragflow/blob/main/docker/service_conf.yaml), you need to specify LLM factory and your own _API_KEY_.
13
+ RAGFlow supports the flowing LLMs, with more coming in the pipeline:
14
+
15
+ - [OpenAI](https://platform.openai.com/login?launch)
16
+ - [Tongyi-Qianwen](https://dashscope.console.aliyun.com/model),
17
+ - [ZHIPU-AI](https://open.bigmodel.cn/),
18
+ - [Moonshot](https://platform.moonshot.cn/docs)
19
+ - [DeepSeek](https://platform.deepseek.com/api-docs/)
20
+ - [Baichuan](https://www.baichuan-ai.com/home)
21
+ - [VolcEngine](https://www.volcengine.com/docs/82379)
22
 
23
  After sign in these LLM suppliers, create your own API-Key, they all have a certain amount of free quota.
24
 
docs/quickstart.md CHANGED
@@ -101,8 +101,11 @@ RAGFlow is a RAG engine, and it needs to work with an LLM to offer grounded, hal
101
 
102
  - OpenAI
103
  - Tongyi-Qianwen
 
104
  - Moonshot
105
  - DeepSeek-V2
 
 
106
 
107
  > RAGFlow also supports deploying LLMs locally using Ollama or Xinference, but this part is not covered in this quick start guide.
108
 
 
101
 
102
  - OpenAI
103
  - Tongyi-Qianwen
104
+ - ZHIPU-AI
105
  - Moonshot
106
  - DeepSeek-V2
107
+ - Baichuan
108
+ - VolcEngine
109
 
110
  > RAGFlow also supports deploying LLMs locally using Ollama or Xinference, but this part is not covered in this quick start guide.
111
 
docs/references/api.md CHANGED
@@ -108,13 +108,13 @@ This method retrieves the history of a specified conversation session.
108
  - `chunks`
109
  - `content_with_weight`: Content of the chunk.
110
  - `doc_name`: Name of the *hit* document.
111
- - `img_id`: The image ID of the chunk. It is an optional field only for PDF, PPTX, and images. Call ['GET' /document/get/\<id\>](#get-document-content-or-image) to retrieve the image.
112
  - positions: [page_number, [upleft corner(x, y)], [right bottom(x, y)]], the chunk position, only for PDF.
113
  - similarity: The hybrid similarity.
114
  - term_similarity: The keyword simimlarity.
115
  - vector_similarity: The embedding similarity.
116
  - `doc_aggs`:
117
- - `doc_id`: ID of the *hit* document. Call ['GET' /document/get/\<id\>](#get-document-content-or-image) to retrieve the document.
118
  - `doc_name`: Name of the *hit* document.
119
  - `count`: The number of *hit* chunks in this document.
120
 
@@ -235,13 +235,13 @@ This method retrieves from RAGFlow the answer to the user's latest question.
235
  - `chunks`: The retrieved chunks that contribute to the answer.
236
  - `content_with_weight`: Content of the chunk.
237
  - `doc_name`: Name of the *hit* document.
238
- - `img_id`: The image ID of the chunk. It is an optional field only for PDF, PPTX, and images. Call ['GET' /document/get/\<id\>](#get-document-content-or-image) to retrieve the image.
239
  - `positions`: [page_number, [upleft corner(x, y)], [right bottom(x, y)]], the chunk position, only for PDF.
240
  - `similarity`: The hybrid similarity.
241
  - `term_similarity`: The keyword simimlarity.
242
  - `vector_similarity`: The embedding similarity.
243
  - `doc_aggs`:
244
- - `doc_id`: ID of the *hit* document. Call ['GET' /document/get/\<id\>](#get-document-content-or-image) to retrieve the document.
245
  - `doc_name`: Name of the *hit* document.
246
  - `count`: The number of *hit* chunks in this document.
247
 
 
108
  - `chunks`
109
  - `content_with_weight`: Content of the chunk.
110
  - `doc_name`: Name of the *hit* document.
111
+ - `img_id`: The image ID of the chunk. It is an optional field only for PDF, PPTX, and images. Call ['GET' /document/get/\<id\>](#get-document-content) to retrieve the image.
112
  - positions: [page_number, [upleft corner(x, y)], [right bottom(x, y)]], the chunk position, only for PDF.
113
  - similarity: The hybrid similarity.
114
  - term_similarity: The keyword simimlarity.
115
  - vector_similarity: The embedding similarity.
116
  - `doc_aggs`:
117
+ - `doc_id`: ID of the *hit* document. Call ['GET' /document/get/\<id\>](#get-document-content) to retrieve the document.
118
  - `doc_name`: Name of the *hit* document.
119
  - `count`: The number of *hit* chunks in this document.
120
 
 
235
  - `chunks`: The retrieved chunks that contribute to the answer.
236
  - `content_with_weight`: Content of the chunk.
237
  - `doc_name`: Name of the *hit* document.
238
+ - `img_id`: The image ID of the chunk. It is an optional field only for PDF, PPTX, and images. Call ['GET' /document/get/\<id\>](#get-document-content) to retrieve the image.
239
  - `positions`: [page_number, [upleft corner(x, y)], [right bottom(x, y)]], the chunk position, only for PDF.
240
  - `similarity`: The hybrid similarity.
241
  - `term_similarity`: The keyword simimlarity.
242
  - `vector_similarity`: The embedding similarity.
243
  - `doc_aggs`:
244
+ - `doc_id`: ID of the *hit* document. Call ['GET' /document/get/\<id\>](#get-document-content) to retrieve the document.
245
  - `doc_name`: Name of the *hit* document.
246
  - `count`: The number of *hit* chunks in this document.
247