pengjunjie/ragflow
1
0
Fork 1
mirror of https://github.com/infiniflow/ragflow.git synced 2025-12-08 12:32:30 +08:00
Code Issues Packages Projects Releases Wiki Activity

Updated descriptions for the Agent components (#3728)

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



### Type of change


- [x] Documentation Update
This commit is contained in:
writinwaters
2024-11-28 19:32:50 +08:00
committed by GitHub
parent 112ef42a19
commit 966bcda6b9
5 changed files with 15 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
agent/templates/interpreter.json
View File

@ -1,7 +1,7 @@
{
"id": 4,
"title": "Interpreter",
"description": "Translation Agent: Agentic translation using reflection workflow.\n\nThis is inspired by Andrew NG's project: https://github.com/andrewyng/translation-agent\n\n",
"description": "A translation agent based on a reflection agentic workflow, inspired by Andrew Ng's project: https://github.com/andrewyng/translation-agent\n\n1. Prompt an LLM to translate a text into the target language.\n2. Have the LLM reflect on the translation and provide constructive suggestions for improvement.\n3. Use these suggestions to improve the translation.",
"canvas_type": "chatbot",
"dsl": {
"answer": [],
@ -473,7 +473,7 @@
{
"data": {
"form": {
"text": "Translation Agent: Agentic translation using reflection workflow\n\nThis is inspired by Andrew NG's project: https://github.com/andrewyng/translation-agent\n\n1. Prompt an LLM to translate a text to target_language;\n2. Have the LLM reflect on the translation to come up with constructive suggestions for improving it;\n3. Use the suggestions to improve the translation."
"text": "Translation Agent: Agentic translation using reflection workflow\n\nThis is inspired by Andrew NG's project: https://github.com/andrewyng/translation-agent\n\n1. Prompt an LLM to translate a text into the target language;\n2. Have the LLM reflect on the translation and provide constructive suggestions for improvement;\n3. Use these suggestions to improve the translation."
},
"label": "Note",
"name": "Breif"

2
agent/templates/seo_blog.json
View File

@ -1,7 +1,7 @@
{
"id": 9,
"title": "SEO Blog Generator",
"description": "A generator for Blogs with SEO just by giving title or keywords.",
"description": "A blog generator that creates SEO-optimized content based on your chosen title or keywords.",
"canvas_type": "chatbot",
"dsl": {
"answer": [],

2
docs/release_notes.md
View File

@ -94,7 +94,7 @@ Released on September 30, 2024.
- Improves the results of multi-round dialogues.
- Enables users to remove added LLM vendors.
- Adds support for OpenTTS and SparkTTS models.
- Implements an **Excel to HTML** toggle in the **General** chunk method, allowing users to parse an spreadsheet into either an HTML table or key-value pairs by row.
- Implements an **Excel to HTML** toggle in the **General** chunk method, allowing users to parse a spreadsheet into either HTML tables or key-value pairs by row.
- Adds agent tools **YahooFance** and **Jin10**.
- Adds a template for an investment advisor agent.

18
web/src/locales/en.ts
View File

@ -158,7 +158,7 @@ export default {
topKTip: `K chunks will be fed into rerank models.`,
delimiter: `Delimiter`,
html4excel: 'Excel to HTML',
html4excelTip: `Excel will be parsed into HTML table or not. If it's FALSE, every row in Excel will be formed as a chunk.`,
html4excelTip: `When enabled, the spreadsheet will be parsed into HTML tables; otherwise, it will be parsed into key-value pairs by row.`,
autoKeywords: 'Auto-keyword',
autoKeywordsTip: `Extract N keywords for each chunk to increase their ranking for queries containing those keywords. You can check or update the added keywords for a chunk from the chunk list. Be aware that extra tokens will be consumed by the LLM specified in 'System model settings'.`,
autoQuestions: 'Auto-question',
@ -694,7 +694,7 @@ The above is the content you need to summarize.`,
"A component that sends out a static message. If multiple messages are supplied, it randomly selects one to send. Ensure its downstream is 'Answer', the interface component.",
keywordDescription: `A component that retrieves top N search results from user's input. Ensure the TopN value is set properly before use.`,
switchDescription: `A component that evaluates conditions based on the output of previous components and directs the flow of execution accordingly. It allows for complex branching logic by defining cases and specifying actions for each case or default action if no conditions are met.`,
wikipediaDescription: `This component is used to get search result from wikipedia.org. Typically, it performs as a supplement to knowledgebases. Top N specifies the number of search results you need to adapt.`,
wikipediaDescription: `A component that searches from wikipedia.org, using TopN to specify the number of search results. It supplements the existing knowledge bases.`,
promptText: `Please summarize the following paragraphs. Be careful with the numbers, do not make things up. Paragraphs as following:
{input}
The above is the content you need to summarize.`,
@ -718,10 +718,10 @@ The above is the content you need to summarize.`,
keywordExtract: 'Keyword',
keywordExtractDescription: `A component that extracts keywords from a user query, with Top N specifing the number of keywords to extract.`,
baidu: 'Baidu',
baiduDescription: `This component is used to get search result from www.baidu.com. Typically, it performs as a supplement to knowledgebases. Top N specifies the number of search results you need to adapt.`,
baiduDescription: `A component that searches from baidu.com, using TopN to specify the number of search results. It supplements the existing knowledge bases.`,
duckDuckGo: 'DuckDuckGo',
duckDuckGoDescription:
'A component that retrieves search results from duckduckgo.com, with TopN specifying the number of search results. It supplements existing knowledge bases.',
'A component that searches from duckduckgo.com, allowing you to specify the number of search results using TopN. It supplements the existing knowledge bases.',
channel: 'Channel',
channelTip: `Perform text search or news search on the component's input`,
text: 'Text',
@ -732,23 +732,23 @@ The above is the content you need to summarize.`,
wikipedia: 'Wikipedia',
pubMed: 'PubMed',
pubMedDescription:
'This component is used to get search result from https://pubmed.ncbi.nlm.nih.gov/. Typically, it performs as a supplement to knowledgebases. Top N specifies the number of search results you need to adapt. E-mail is a required field.',
'A component that searches from https://pubmed.ncbi.nlm.nih.gov/, allowing you to specify the number of search results using TopN. It supplements the existing knowledge bases.',
email: 'Email',
emailTip:
'This component is used to get search result from https://pubmed.ncbi.nlm.nih.gov/. Typically, it performs as a supplement to knowledgebases. Top N specifies the number of search results you need to adapt. E-mail is a required field.',
'E-mail is a required field. You must input an E-mail address here.',
arXiv: 'ArXiv',
arXivDescription:
'This component is used to get search result from https://arxiv.org/. Typically, it performs as a supplement to knowledgebases. Top N specifies the number of search results you need to adapt.',
'A component that searches from https://arxiv.org/, allowing you to specify the number of search results using TopN. It supplements the existing knowledge bases.',
sortBy: 'Sort by',
submittedDate: 'Submitted date',
lastUpdatedDate: 'Last updated date',
relevance: 'Relevance',
google: 'Google',
googleDescription:
'This component is used to get search result fromhttps://www.google.com/ . Typically, it performs as a supplement to knowledgebases. Top N and SerpApi API key specifies the number of search results you need to adapt.',
'A component that searches from https://www.google.com/, allowing you to specify the number of search results using TopN. It supplements the existing knowledge bases. Please note that this requires an API key from serpapi.com.',
bing: 'Bing',
bingDescription:
'This component is used to get search result from https://www.bing.com/. Typically, it performs as a supplement to knowledgebases. Top N and Bing Subscription-Key specifies the number of search results you need to adapt.',
'A component that searches from https://www.bing.com/, allowing you to specify the number of search results using TopN. It supplements the existing knowledge bases. Please note that this requires an API key from microsoft.com.',
apiKey: 'API KEY',
country: 'Country&Region',
language: 'Language',

4
web/src/pages/flow/constant.tsx
View File

@ -455,7 +455,7 @@ export const initialArXivValues = {
export const initialGoogleValues = {
top_n: 10,
api_key: 'Xxx(get from https://serpapi.com/manage-api-key)',
api_key: 'YOUR_API_KEY (obtained from https://serpapi.com/manage-api-key)',
country: 'cn',
language: 'en',
...initialQueryBaseValues,
@ -465,7 +465,7 @@ export const initialBingValues = {
top_n: 10,
channel: 'Webpages',
api_key:
'"YOUR_ACCESS_KEY"(get from https://www.microsoft.com/en-us/bing/apis/bing-web-search-api)',
'YOUR_API_KEY (obtained from https://www.microsoft.com/en-us/bing/apis/bing-web-search-api)',
country: 'CH',
language: 'en',
...initialQueryBaseValues,