Skip to main content

A lightweight Python utility for template expansion and matching with slots and fuzzy matching.

Project description

Ask DeepWiki

🧩 KeywordTemplateMatcher

A lightweight Python utility for expanding and matching natural language templates with slots, optional phrases, and alternatives. It supports fuzzy matching and slot extraction, making it ideal for prototyping NLU systems, voice assistants, or rule-based query matching.


🔧 Features

  • ✅ Template expansion with:
    • Optional phrases ([optional])
    • Alternatives ((choice1|choice2))
    • Slots ({slot_name})
  • ✅ Slot substitution with provided dictionaries
  • ✅ Fuzzy matching with confidence scoring using rapidfuzz
  • ✅ Simple template structure, extensible for any language/grammar rules
  • ✅ Built-in integration with simplematch for fuzzy slot matching

📦 Installation

pip install keyword-template-matcher

🚀 Usage

1. Expanding a Template with Slots

from kw_template_matcher import expand_slots

template = "change [the ]brightness to {brightness_level} and color to {color_name}"
slots = {
    "brightness_level": ["low", "medium", "high"],
    "color_name": ["red", "green", "blue"]
}

for sentence in expand_slots(template, slots):
    print(sentence)

Output:

change the brightness to low and color to red
change brightness to high and color to blue
... (all combinations)

2. Template Matching

from kw_template_matcher import TemplateMatcher

matcher = TemplateMatcher()
matcher.add_templates([
    "[hello,] (call me|my name is) {name}",
    "tell me a [{joke_type}] joke"
])

query = "hello, my name is Alice"
results = matcher.match(query)

for match in results:
    print(match)

🧠 How It Works

Template Syntax

Syntax Description
{slot} Placeholder to be replaced with values
[optional] Optional word or phrase
(a|b|c) Alternatives - only one is chosen

🧪 Test Example Templates

templates = [
    "[hello,] (call me|my name is) {name}",
    "tell me a [{joke_type}] joke",
    "play {query} [in ({device_name}|{skill_name}|{zone_name})]"
]

Produces expansions like:

- call me {name}
- hello, my name is {name}
- tell me a {joke_type} joke
- play {query}
- play {query} in {device_name}

🤝 Contributions

PRs, issues, and suggestions welcome! Feel free to open an issue or submit a pull request if you'd like to improve the matcher.


💬 Acknowledgements

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

keyword_template_matcher-0.1.2a2.tar.gz (6.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

keyword_template_matcher-0.1.2a2-py3-none-any.whl (7.2 kB view details)

Uploaded Python 3

File details

Details for the file keyword_template_matcher-0.1.2a2.tar.gz.

File metadata

File hashes

Hashes for keyword_template_matcher-0.1.2a2.tar.gz
Algorithm Hash digest
SHA256 c4dcce79aad23f47bdc68633f62ed946618c6da227d8a01b5fe2e3da23b8c218
MD5 7df4e9f92d99e59ed52f475eb9e607f6
BLAKE2b-256 1a5b737f1b3417c2bbdce45f2ee44be7a7942047868c918fd4a775cf747548aa

See more details on using hashes here.

File details

Details for the file keyword_template_matcher-0.1.2a2-py3-none-any.whl.

File metadata

File hashes

Hashes for keyword_template_matcher-0.1.2a2-py3-none-any.whl
Algorithm Hash digest
SHA256 093510cda89b7733825c20104b1313093a70c1cc399a7c0b5d7a4ba88791e926
MD5 260a3a9636b8d1cdc05824a3e9c3ce9d
BLAKE2b-256 7e34a75fa4fadd328e9b788e8e12bb73394c1f2b02a3c6c5b202462d7e01c29e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page