krogoldAI commited on
Commit
60b76d7
·
verified ·
1 Parent(s): fff158e

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +31 -0
README.md CHANGED
@@ -20,6 +20,37 @@ This model addresses a critical challenge in RAG systems: converting ambiguous,
20
 
21
  **Note:** This model is currently in an experimental, beta stage. It represents an initial release focused on establishing baseline capabilities. Future iterations may address current limitations, expand domain coverage, or incorporate additional output features based on real-world deployment feedback.
22
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
23
  ## Intended Use
24
 
25
  The model is designed to serve as a query analysis layer in RAG systems, where it processes user inputs before they are sent to retrieval components. It can handle queries with varying degrees of ambiguity and identify when queries lack sufficient context for effective retrieval. The structured XML output enables downstream systems to make informed decisions about how to handle each query based on confidence scores, ambiguity flags, and the rephrased version.
 
20
 
21
  **Note:** This model is currently in an experimental, beta stage. It represents an initial release focused on establishing baseline capabilities. Future iterations may address current limitations, expand domain coverage, or incorporate additional output features based on real-world deployment feedback.
22
 
23
+ ## Examples
24
+
25
+ <details>
26
+ <summary><i>Unroll to see Example #1</i></summary>
27
+
28
+ User query:
29
+
30
+ >How do I reset my password?
31
+
32
+ Model output:
33
+
34
+ ```xml
35
+ <query_analysis>
36
+ <domain ambiguous="false">
37
+ <candidate confidence="1.0">Information Technology</candidate>
38
+ </domain>
39
+ <intent ambiguous="false">
40
+ <candidate confidence="1.0">Troubleshooting, How-to Guidance</candidate>
41
+ </intent>
42
+ <concepts>
43
+ <explicit>password reset</explicit>
44
+ <implicit>password recovery, account security, IT services</implicit>
45
+ </concepts>
46
+ <insufficient_context>false</insufficient_context>
47
+ <rephrased>true</rephrased>
48
+ <rephrased_query>how to recover lost / forgotten [USER_PASSWORD] password</rephrased_query>
49
+ </query_analysis>
50
+ ```
51
+
52
+ </details>
53
+
54
  ## Intended Use
55
 
56
  The model is designed to serve as a query analysis layer in RAG systems, where it processes user inputs before they are sent to retrieval components. It can handle queries with varying degrees of ambiguity and identify when queries lack sufficient context for effective retrieval. The structured XML output enables downstream systems to make informed decisions about how to handle each query based on confidence scores, ambiguity flags, and the rephrased version.