writinwaters commited on
Commit
bc50356
·
1 Parent(s): f5ba209

Updated descriptions for the Agent components (#3728)

Browse files

### What problem does this PR solve?



### Type of change


- [x] Documentation Update

agent/templates/interpreter.json CHANGED
@@ -1,7 +1,7 @@
1
  {
2
  "id": 4,
3
  "title": "Interpreter",
4
- "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",
5
  "canvas_type": "chatbot",
6
  "dsl": {
7
  "answer": [],
@@ -473,7 +473,7 @@
473
  {
474
  "data": {
475
  "form": {
476
- "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."
477
  },
478
  "label": "Note",
479
  "name": "Breif"
 
1
  {
2
  "id": 4,
3
  "title": "Interpreter",
4
+ "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.",
5
  "canvas_type": "chatbot",
6
  "dsl": {
7
  "answer": [],
 
473
  {
474
  "data": {
475
  "form": {
476
+ "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."
477
  },
478
  "label": "Note",
479
  "name": "Breif"
agent/templates/seo_blog.json CHANGED
@@ -1,7 +1,7 @@
1
  {
2
  "id": 9,
3
  "title": "SEO Blog Generator",
4
- "description": "A generator for Blogs with SEO just by giving title or keywords.",
5
  "canvas_type": "chatbot",
6
  "dsl": {
7
  "answer": [],
 
1
  {
2
  "id": 9,
3
  "title": "SEO Blog Generator",
4
+ "description": "A blog generator that creates SEO-optimized content based on your chosen title or keywords.",
5
  "canvas_type": "chatbot",
6
  "dsl": {
7
  "answer": [],
docs/release_notes.md CHANGED
@@ -94,7 +94,7 @@ Released on September 30, 2024.
94
  - Improves the results of multi-round dialogues.
95
  - Enables users to remove added LLM vendors.
96
  - Adds support for OpenTTS and SparkTTS models.
97
- - 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.
98
  - Adds agent tools **YahooFance** and **Jin10**.
99
  - Adds a template for an investment advisor agent.
100
 
 
94
  - Improves the results of multi-round dialogues.
95
  - Enables users to remove added LLM vendors.
96
  - Adds support for OpenTTS and SparkTTS models.
97
+ - 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.
98
  - Adds agent tools **YahooFance** and **Jin10**.
99
  - Adds a template for an investment advisor agent.
100
 
web/src/locales/en.ts CHANGED
@@ -158,7 +158,7 @@ export default {
158
  topKTip: `K chunks will be fed into rerank models.`,
159
  delimiter: `Delimiter`,
160
  html4excel: 'Excel to HTML',
161
- html4excelTip: `Excel will be parsed into HTML table or not. If it's FALSE, every row in Excel will be formed as a chunk.`,
162
  autoKeywords: 'Auto-keyword',
163
  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'.`,
164
  autoQuestions: 'Auto-question',
@@ -694,7 +694,7 @@ The above is the content you need to summarize.`,
694
  "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.",
695
  keywordDescription: `A component that retrieves top N search results from user's input. Ensure the TopN value is set properly before use.`,
696
  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.`,
697
- 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.`,
698
  promptText: `Please summarize the following paragraphs. Be careful with the numbers, do not make things up. Paragraphs as following:
699
  {input}
700
  The above is the content you need to summarize.`,
@@ -718,10 +718,10 @@ The above is the content you need to summarize.`,
718
  keywordExtract: 'Keyword',
719
  keywordExtractDescription: `A component that extracts keywords from a user query, with Top N specifing the number of keywords to extract.`,
720
  baidu: 'Baidu',
721
- 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.`,
722
  duckDuckGo: 'DuckDuckGo',
723
  duckDuckGoDescription:
724
- 'A component that retrieves search results from duckduckgo.com, with TopN specifying the number of search results. It supplements existing knowledge bases.',
725
  channel: 'Channel',
726
  channelTip: `Perform text search or news search on the component's input`,
727
  text: 'Text',
@@ -732,23 +732,23 @@ The above is the content you need to summarize.`,
732
  wikipedia: 'Wikipedia',
733
  pubMed: 'PubMed',
734
  pubMedDescription:
735
- '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.',
736
  email: 'Email',
737
  emailTip:
738
- '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.',
739
  arXiv: 'ArXiv',
740
  arXivDescription:
741
- '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.',
742
  sortBy: 'Sort by',
743
  submittedDate: 'Submitted date',
744
  lastUpdatedDate: 'Last updated date',
745
  relevance: 'Relevance',
746
  google: 'Google',
747
  googleDescription:
748
- '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.',
749
  bing: 'Bing',
750
  bingDescription:
751
- '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.',
752
  apiKey: 'API KEY',
753
  country: 'Country&Region',
754
  language: 'Language',
 
158
  topKTip: `K chunks will be fed into rerank models.`,
159
  delimiter: `Delimiter`,
160
  html4excel: 'Excel to HTML',
161
+ html4excelTip: `When enabled, the spreadsheet will be parsed into HTML tables; otherwise, it will be parsed into key-value pairs by row.`,
162
  autoKeywords: 'Auto-keyword',
163
  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'.`,
164
  autoQuestions: 'Auto-question',
 
694
  "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.",
695
  keywordDescription: `A component that retrieves top N search results from user's input. Ensure the TopN value is set properly before use.`,
696
  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.`,
697
+ wikipediaDescription: `A component that searches from wikipedia.org, using TopN to specify the number of search results. It supplements the existing knowledge bases.`,
698
  promptText: `Please summarize the following paragraphs. Be careful with the numbers, do not make things up. Paragraphs as following:
699
  {input}
700
  The above is the content you need to summarize.`,
 
718
  keywordExtract: 'Keyword',
719
  keywordExtractDescription: `A component that extracts keywords from a user query, with Top N specifing the number of keywords to extract.`,
720
  baidu: 'Baidu',
721
+ baiduDescription: `A component that searches from baidu.com, using TopN to specify the number of search results. It supplements the existing knowledge bases.`,
722
  duckDuckGo: 'DuckDuckGo',
723
  duckDuckGoDescription:
724
+ 'A component that searches from duckduckgo.com, allowing you to specify the number of search results using TopN. It supplements the existing knowledge bases.',
725
  channel: 'Channel',
726
  channelTip: `Perform text search or news search on the component's input`,
727
  text: 'Text',
 
732
  wikipedia: 'Wikipedia',
733
  pubMed: 'PubMed',
734
  pubMedDescription:
735
+ '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.',
736
  email: 'Email',
737
  emailTip:
738
+ 'E-mail is a required field. You must input an E-mail address here.',
739
  arXiv: 'ArXiv',
740
  arXivDescription:
741
+ '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.',
742
  sortBy: 'Sort by',
743
  submittedDate: 'Submitted date',
744
  lastUpdatedDate: 'Last updated date',
745
  relevance: 'Relevance',
746
  google: 'Google',
747
  googleDescription:
748
+ '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.',
749
  bing: 'Bing',
750
  bingDescription:
751
+ '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.',
752
  apiKey: 'API KEY',
753
  country: 'Country&Region',
754
  language: 'Language',
web/src/pages/flow/constant.tsx CHANGED
@@ -455,7 +455,7 @@ export const initialArXivValues = {
455
 
456
  export const initialGoogleValues = {
457
  top_n: 10,
458
- api_key: 'Xxx(get from https://serpapi.com/manage-api-key)',
459
  country: 'cn',
460
  language: 'en',
461
  ...initialQueryBaseValues,
@@ -465,7 +465,7 @@ export const initialBingValues = {
465
  top_n: 10,
466
  channel: 'Webpages',
467
  api_key:
468
- '"YOUR_ACCESS_KEY"(get from https://www.microsoft.com/en-us/bing/apis/bing-web-search-api)',
469
  country: 'CH',
470
  language: 'en',
471
  ...initialQueryBaseValues,
 
455
 
456
  export const initialGoogleValues = {
457
  top_n: 10,
458
+ api_key: 'YOUR_API_KEY (obtained from https://serpapi.com/manage-api-key)',
459
  country: 'cn',
460
  language: 'en',
461
  ...initialQueryBaseValues,
 
465
  top_n: 10,
466
  channel: 'Webpages',
467
  api_key:
468
+ 'YOUR_API_KEY (obtained from https://www.microsoft.com/en-us/bing/apis/bing-web-search-api)',
469
  country: 'CH',
470
  language: 'en',
471
  ...initialQueryBaseValues,