opencode/yao
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Enhance DESIGN.md to clarify citation formatting and output structure

Browse source 
- Added detailed guidelines for citation output format, including HTML link attributes for reference integration.
- Introduced examples demonstrating the correct usage of citation links in LLM outputs, improving clarity for developers.
- Updated documentation to ensure consistency in citation practices across the search module, aiding in the integration of references.
This commit is contained in:
Max 2025-12-12 10:41:46 +08:00
parent 155782bd7b
commit 8cd71f9946
1 changed files with 38 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
agent/search/DESIGN.md
View file

@ -1235,14 +1235,50 @@ URL: https://news.example.com/apple-iphone-15
```
You have access to reference data in <references> tags. Each <ref> has:
- id: Citation identifier (use #ref:{id} to cite)
- id: Citation identifier
- type: Data type (web/kb/db)
- weight: Relevance weight (1.0=highest priority, 0.6=lowest)
- source: Origin (user=user-provided, hook=assistant-searched, auto=auto-searched)
Prioritize higher-weight references when answering. Cite using: #ref:{id}
Prioritize higher-weight references when answering.
When citing a reference, use this exact HTML format:
<a class="ref" data-ref-id="{id}" data-ref-type="{type}" href="#ref:{id}">[{id}]</a>
Example: According to the product data<a class="ref" data-ref-id="ref_001" data-ref-type="db" href="#ref:ref_001">[ref_001]</a>, the price is $999.
```
**Citation Output Format:**
LLM outputs citations as HTML links that can be parsed and rendered by frontend:
```html
<!-- LLM output example -->
The iPhone 15 Pro<a
class="ref"
data-ref-id="ref_001"
data-ref-type="db"
href="#ref:ref_001"
>[ref_001]</a
>
features the A17 Pro chip<a
class="ref"
data-ref-id="ref_002"
data-ref-type="kb"
href="#ref:ref_002"
>[ref_002]</a
>.
```
**Citation Link Attributes:**
| Attribute | Description | Example |
| --------------- | ----------------------- | ----------------------- |
| `class` | Fixed class for styling | `"ref"` |
| `data-ref-id` | Reference ID | `"ref_001"` |
| `data-ref-type` | Data type | `"db"`, `"kb"`, `"web"` |
| `href` | Anchor link | `"#ref:ref_001"` |
**Conversion Examples:**
| Module | Input | Output Reference |