-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #197 from windsonsea/dak
[en] Add dak pages
- Loading branch information
Showing
14 changed files
with
413 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| --- | ||
| hide: | ||
| - toc | ||
| --- | ||
|
|
||
| # Number of Q&As | ||
|
|
||
| d.run supports recording the number of Q&As created in this workspace. | ||
|
|
||
| When users engage in Q&As, the records will be saved under the workspace where the app was created. Click the **Refresh** button in the upper right corner to view the latest Q&A count data. | ||
|
|
||
|  | ||
|
|
||
| You can summarize the Q&A counts of all users in this workspace into a table for export. | ||
|
|
||
| 1. On the **Number of Q&As** page, click the **Export** button in the upper right corner. | ||
|
|
||
| <!--  --> | ||
|
|
||
| 2. The Q&A counts of all users in this workspace will be compiled into a xlsx file for download. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| # Q&A Quality | ||
|
|
||
| d.run supports statistics on user feedback regarding the quality of Q&A, displaying it in reports and also allows data to be exported to xlsx format. | ||
|
|
||
| ## View Q&A Quality Details | ||
|
|
||
| 1. In the **Data Analysis** section, click **Q&A Quality** to find the Q&A you wish to view. Click the Q&A record to enter the details page. | ||
|
|
||
| <!--  --> | ||
|
|
||
| 2. You can view the following content: | ||
|
|
||
| - User's question, including the name of the user who asked. | ||
| - App's answer: the answer generated by the app in response to the user's question. | ||
| - The prompt used for the question. | ||
|
|
||
| <!--  --> | ||
|
|
||
| 3. When new Q&As are generated, you can click the **Refresh** button in the upper right corner to view the latest Q&A details. | ||
|
|
||
| <!--  --> | ||
|
|
||
| ## Export Q&A Quality | ||
|
|
||
| You can summarize all user feedback on Q&A quality within this workspace into a table for export. | ||
|
|
||
| 1. On the **Q&A Quality** page, click the **Export** button in the upper right corner. | ||
|
|
||
| <!--  --> | ||
|
|
||
| 2. Click **Export Records** to view the exported Q&A quality records. Select the records you need to download and export them as an Excel file. | ||
|
|
||
| <!--  --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| # Shard Hit Ratio | ||
|
|
||
| d.run tracks user interactions with shard data, ranking shards by hit count. It supports viewing shard content and exporting shard usage statistics to a xlsx file. | ||
|
|
||
| ## View Shard Hit Ratio Details | ||
|
|
||
| 1. In the **Data Analysis** section, click **Shard Hit Ratio**. Use the **Search** function to find the shard you are interested in. Click the shard to enter the details page, where you can view detailed information about how this shard has been referenced. | ||
|
|
||
| <!--  --> | ||
|
|
||
| 2. You can view the following content: | ||
|
|
||
| - Basic information about the shard: including the text shard ID and specific shard content. | ||
| - Detailed information: the questions that hit this shard, app name, questioner, and the time the question was asked. | ||
|
|
||
| <!--  --> | ||
|
|
||
| 3. When new Q&As are generated, you can click the **Refresh** button in the upper right corner to view the latest shard hit ratio results. | ||
|
|
||
| <!--  --> | ||
|
|
||
| You can also **Refresh** in the shard hit ratio details to see the latest results. | ||
|
|
||
| <!--  --> | ||
|
|
||
| ## Export Shard Hit Ratio | ||
|
|
||
| 1. On the **Shard Hit Ratio** page, click the **Export** button in the upper right corner. | ||
|
|
||
| <!--  --> | ||
|
|
||
| 2. This will export the shards created in this workspace and compile feedback on these shard usage statistics into a xlsx file for download. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| --- | ||
| hide: | ||
| - toc | ||
| --- | ||
|
|
||
| # Shard Quality | ||
|
|
||
| A shard refers to dividing larger data into multiple segments, which facilitates model training by making it easier to locate and hit the data. | ||
| d.run supports viewing the quality of shards. The specific steps are as follows: | ||
|
|
||
| 1. In the **Data Analysis** section, click **Shard Quality**, and use the **Search** function to find the shard you are interested in. Click the shard to enter the details page, where you can view detailed information about this shard. | ||
|
|
||
| <!--  --> | ||
|
|
||
| 2. You can view the following content: | ||
|
|
||
| - Corpus: Which corpus the shard belongs to. | ||
| - Update Time: The last update time of the shard file. | ||
| - Shard ID: The unique identification code of the shard. | ||
| - Shard Content: The specific content of the shard after slicing. | ||
| - Additional Information: Additional content related to this shard. | ||
|
|
||
| <!--  --> | ||
|
|
||
| 3. When new shard files are evaluated, you can click the **Refresh** button in the upper right corner to view the latest shard files. | ||
|
|
||
| <!--  --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| # Suggestions | ||
|
|
||
| d.run provides an entry for users to submit feedback, allowing administrators to see what issues need improvement in the apps within this workspace. | ||
|
|
||
| ## Handling Feedback | ||
|
|
||
| 1. In the **Data Analysis** section, click **Improvement Suggestions**, find the feedback that needs to be addressed, and click the **┇** button on the right. | ||
|
|
||
| 2. In the pop-up menu, select **Handle Feedback** (clicking the ticket information within the range will take you to the details page). | ||
|
|
||
| <!--  --> | ||
|
|
||
| 3. You can view the following content: | ||
|
|
||
| - User feedback on the Q&A. | ||
| - Relevant information about the Q&A: assistant name, model name, number of citations, processing time, and Q&A details. | ||
|
|
||
| <!--  --> | ||
|
|
||
| - Latest Citations: You can view the details of all citations referenced in the answer. | ||
|
|
||
| <!--  --> | ||
|
|
||
| - Details of ticket processing. | ||
|
|
||
| 4. Click the status of the ticket marked as **Pending** to change the status to **In Progress** or **Completed**, and fill in the **Processing Description** below. | ||
|
|
||
| 5. Click the **OK** button in the lower right corner to modify the feedback processing status. | ||
|
|
||
| <!--  --> | ||
|
|
||
| 6. When new improvement suggestions are submitted, you can click the **Refresh** button in the upper right corner to view the latest suggestions. | ||
|
|
||
| <!--  --> | ||
|
|
||
| ## Export Feedback | ||
|
|
||
| Aggregate all Q&A details and feedback into a table for export. | ||
|
|
||
| 1. Click the **left side of Q&A feedback**, select the feedback you want to export, and click the **Export** button in the upper right corner. | ||
|
|
||
| 2. The Q&A content will be compiled into a xlsx file for download. | ||
|
|
||
| <!--  --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| --- | ||
| hide: | ||
| - toc | ||
| --- | ||
|
|
||
| # App Dialogue Instructions | ||
|
|
||
| **Dialogue** is the most common way to obtain information since the emergence of ChatGPT. In d.run, once an app is published, the dialogue function can be used. You can freely ask questions in the dialogue after linking to a corpus, consult historical records at any time, and the navigation bar also lists the recently used dialogues. | ||
|
|
||
| ## Daily Dialogue | ||
|
|
||
| ### RAG App | ||
|
|
||
| 1. In the left navigation bar, click on **App Center**, select the published RAG type app, and click the dialogue icon in the lower right corner. | ||
|
|
||
| <!--  --> | ||
|
|
||
| 2. Enter your question in the dialogue box, click **Send**, or press the Enter key to start the conversation. | ||
|
|
||
| <!--  --> | ||
|
|
||
| ### Full Text Reading App | ||
|
|
||
| 1. In the left navigation bar, click on **App Center**, select the published **Full Text Reading** type app, and click the dialogue icon in the lower right corner. | ||
|
|
||
| <!--  --> | ||
|
|
||
| 2. Upload a file in the lower right corner of the dialogue box and ask questions based on the content of the file. Click **Send**, or press the Enter key to start the conversation. | ||
|
|
||
| <!--  --> | ||
|
|
||
| ### Combination App | ||
|
|
||
| 1. In the left navigation bar, click on **App Center**, select the published **Combination App** type app, and click the dialogue icon in the lower right corner. | ||
|
|
||
| <!--  --> | ||
|
|
||
| 2. Enter your question in the dialogue box, click **Send**, or press the Enter key to start the conversation. | ||
|
|
||
| <!--  --> | ||
|
|
||
| ## Dialogue Management | ||
|
|
||
| <!--  --> | ||
|
|
||
| - **Pin**, **Rename**, and **Delete**: In the history pane, click the **┇** on the right side of a dialogue to pin, rename, or delete the dialogue. | ||
| - **Clear**: In the upper left corner of the dialogue page, click the 🧹 icon to **clear** the dialogue. | ||
| - **Link Corpus**: In the lower left corner of the input box, click the 📖 icon to link the corpus. | ||
|
|
||
| Selection of corpus: The **chat app** will match the most similar corpus in the selected corpus as a reference to answer your questions. A successful operation will indicate that the corpus has been selected. You can also deselect one or more corpora. | ||
|
|
||
| !!! info | ||
|
|
||
| If you cannot select or change the linked corpus, you can only add a corpus. The vectorization model of the app must be consistent with the vectorization model of the corpus to be usable. | ||
|
|
||
| - **Stop Dialogue**: After asking a question, click the icon on the right side of the input box to stop the dialogue, allowing the assistant to cease outputting content. | ||
|
|
||
| ## Some Useful Icons | ||
|
|
||
| <!--  --> | ||
|
|
||
| - **Rating**: You can like 👍 or dislike 👎 a response, depending on your satisfaction with the content of the answer. | ||
| - **Copy**: You can copy a response. | ||
| - **Reset**: You can reset or regenerate a specific response. | ||
|
|
||
| !!! info "Randomness" | ||
|
|
||
| For the reset content, the administrator can adjust the model's **randomness** to control the consistency of the assistant's responses over multiple attempts. | ||
|
|
||
| If the randomness is high, the assistant's responses may vary each time. If high accuracy is required, the randomness can be lowered, resulting in more consistent outputs from the assistant each time. | ||
|
|
||
| - **Delete**: Click the trash can :material-delete: icon to delete a response, after which the deleted dialogue will not be remembered in the context of the assistant's conversation. | ||
| - **Feedback**: Click the last icon :bookmark_tabs: of a response to submit feedback, providing comments based on the quality of the assistant's responses. |
Oops, something went wrong.