Skip to content

Commit 94ea467

Browse files
author
Swaroop Manchala
committed
docs : add nl parser documentation and allign module location
1 parent 3630728 commit 94ea467

File tree

2 files changed

+32
-0
lines changed

2 files changed

+32
-0
lines changed
File renamed without changes.

docs/NL_PARSER.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Natural Language Parser (NL Parser)
2+
3+
## Overview
4+
The NL Parser enables users to describe installation requests in natural language
5+
(e.g., “install docker and kubernetes” or “set up python dev environment”).
6+
It converts free-form text into structured intents that Cortex can act upon.
7+
8+
This improves demo reliability and usability by removing the need for strict
9+
command syntax.
10+
11+
---
12+
13+
## Key Features
14+
- Typo tolerance (e.g., kubernets → kubernetes, pyhton → python)
15+
- Rule-based + fuzzy semantic intent detection
16+
- Confidence scoring for detected intent
17+
- Clarification prompts for ambiguous requests
18+
- Slot extraction (python version, platform, packages)
19+
- Lightweight, dependency-free core logic
20+
21+
---
22+
23+
## Usage Example
24+
25+
```python
26+
from cortex.nl_parser import parse_request
27+
28+
result = parse_request("pls install pyhton 3.10 on mac")
29+
30+
print(result)
31+
32+

0 commit comments

Comments
 (0)