Miscelleneous editorial updates (#5390)

### What problem does this PR solve?


### Type of change

- [x] Documentation Update
This commit is contained in:
writinwaters
2025-02-26 19:03:50 +08:00
committed by GitHub
parent 0284248c93
commit f372bd8809
19 changed files with 59 additions and 82 deletions

View File

@ -258,10 +258,10 @@ export default {
<i>This chunk method is automatically applied to all uploaded PPT files, so you do not need to specify it manually.</i></p>`,
qa: `
<p>
This chunk method supports <b>EXCEL</b> and <b>CSV/TXT</b> file formats.
This chunk method supports <b>XLSX</b> and <b>CSV/TXT</b> file formats.
</p>
<li>
If a file is in <b>Excel</b> format, it should contain two columns
If a file is in <b>XLSX</b> format, it should contain two columns
without headers: one for questions and the other for answers, with the
question column preceding the answer column. Multiple sheets are
acceptable, provided the columns are properly structured.
@ -281,7 +281,7 @@ export default {
Résumés of various forms are parsed and organized into structured data to facilitate candidate search for recruiters.
</p>
`,
table: `<p>Supported file formats are <b>EXCEL</b> and <b>CSV/TXT</b>.</p><p>
table: `<p>Supported file formats are <b>XLSX</b> and <b>CSV/TXT</b>.</p><p>
Here're some prerequisites and tips:
<ul>
<li>For CSV or TXT file, the delimiter between columns must be <em><b>TAB</b></em>.</li>
@ -317,8 +317,8 @@ export default {
<p>Knowlege base using 'Tag' as a chunking method is <b>NOT</b> supposed to be involved in RAG procedure.</p>
<p>The chunks in this knowledge base are examples of tags, which demonstrate the entire tag set and the relevance between chunk and tags.</p>
<p>This chunk method supports <b>EXCEL</b> and <b>CSV/TXT</b> file formats.</p>
<p>If a file is in <b>Excel</b> format, it should contain two columns without headers: one for content and the other for tags, with the content column preceding the tags column. Multiple sheets are acceptable, provided the columns are properly structured.</p>
<p>This chunk method supports <b>XLSX</b> and <b>CSV/TXT</b> file formats.</p>
<p>If a file is in <b>XLSX</b> format, it should contain two columns without headers: one for content and the other for tags, with the content column preceding the tags column. Multiple sheets are acceptable, provided the columns are properly structured.</p>
<p>If a file is in <b>CSV/TXT</b> format, it must be UTF-8 encoded with TAB as the delimiter to separate content and tags.</p>
<p>In tags column, there're English <b>comma</b> between tags.</p>
<i>Lines of texts that fail to follow the above rules will be ignored, and each pair will be considered a distinct chunk.</i>
@ -352,16 +352,16 @@ The above is the content you need to summarize.`,
searchTags: 'Search tags',
tagCloud: 'Cloud',
tagTable: 'Table',
tagSet: 'Tag set',
tagSet: 'Tag sets',
tagSetTip: `
<p> Selecting the 'Tag' knowledge bases helps to tag every chunks. </p>
<p>Query to those chunks will also be with tags too.</p>
This procedure will improve precision of retrieval by adding more information to the dataset, especially when there's a large set of chunks.
<p>Difference between tags and keywords:</p>
<p> Select one or multiple tag knowledge bases to auto-tag chunks in your knowledge base. </p>
<p>The user query will also be auto-tagged.</p>
This auto-tag feature enhances retrieval by adding another layer of domain-specific knowledge to the existing dataset.
<p>Difference between auto-tag and auto-keyword:</p>
<ul>
<li>Tag is a close set which is defined and manipulated by user while keyword is an open set.</li>
<li>You need to upload tag sets with samples prior to use.</li>
<li>Keywords are generated by LLM which is expensive and time consuming.</li>
<li>A tag knowledge base is a user-defined close set, whereas keywords extraced by the LLM can be regarded as an open set.</li>
<li>You must upload tag sets in specified formats before running the auto-tag feature.</li>
<li>The auto-keyword feature is dependent on the LLM and consumes a significant number of tokens.</li>
</ul>
`,
topnTags: 'Top-N Tags',
@ -420,7 +420,7 @@ This procedure will improve precision of retrieval by adding more information to
language: 'Language',
emptyResponse: 'Empty response',
emptyResponseTip: `Set this as a response if no results are retrieved from the knowledge bases for your query, or leave this field blank to allow the LLM to improvise when nothing is found.`,
emptyResponseMessage: `Empty response will be triggered when nothing relevant is retrieved from knowledge bases. Erase 'Empty response' since none of knowledge base is selected.`,
emptyResponseMessage: `Empty response will be triggered when nothing relevant is retrieved from knowledge bases. You must clear the 'Empty response' field if no knowledge base is selected.`,
setAnOpener: 'Opening greeting',
setAnOpenerInitial: `Hi! I'm your assistant, what can I do for you?`,
setAnOpenerTip: 'Set an opening greeting for users.',