pengjunjie/ragflow
1
0
Fork 1
mirror of https://github.com/infiniflow/ragflow.git synced 2026-01-03 02:55:29 +08:00
Code Issues Packages Projects Releases Wiki Activity

Added instructions on embedding agent or assistant into a third-party webpage (#4369)

Browse Source 
### What problem does this PR solve?


### Type of change

- [x] Documentation Update
This commit is contained in:
writinwaters
2025-01-06 20:25:47 +08:00
committed by GitHub
parent 1d93eb81ae
commit bb24e5f739
7 changed files with 49 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
docs/guides/start_chat.md
View File

@ -57,7 +57,7 @@ You start an AI conversation by creating an assistant.
:::tip NOTE
Click the light bubble logo above the answer to view the expanded system prompt:
Click the light bubble icon above the answer to view the expanded system prompt:
![](https://github.com/user-attachments/assets/515ab187-94e8-412a-82f2-aba52cd79e09)
@ -74,10 +74,19 @@ Hover over an intended chat assistant **>** **Edit** to show the chat configurat
![chat_config](https://github.com/user-attachments/assets/1a4eaed2-5430-4585-8ab6-930549838c5b)
## Integrate chat capabilities into your application
## Integrate chat capabilities into your application or webpage
RAGFlow also offers HTTP and Python APIs for you to integrate RAGFlow's capabilities into your applications. Read the following documents for more information:
RAGFlow offers HTTP and Python APIs for you to integrate RAGFlow's capabilities into your applications. Read the following documents for more information:
- [Acquire a RAGFlow API key](./develop/acquire_ragflow_api_key.md)
- [HTTP API reference](../references/http_api_reference.md)
- [Python API reference](../references/python_api_reference.md)
- [Acquire a RAGFlow API key](https://ragflow.io/docs/dev/acquire_ragflow_api_key)
- [HTTP API reference](https://ragflow.io/docs/dev/http_api_reference)
- [Python API reference](https://ragflow.io/docs/dev/python_api_reference)
You can use iframe to embed the created chat assistant into a third-party webpage:
1. Before proceeding, you must [acquire an API key](https://ragflow.io/docs/dev/acquire_ragflow_api_key); otherwise, an error message would appear.
2. Hover over an intended chat assistant **>** **Edit** to show the **iframe** window:
![chat-embed](https://github.com/user-attachments/assets/13ea3021-31c4-4a14-9b32-328cd3318fb5)
3. Copy the iframe and embed it into a specific location on your webpage.