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.2a1.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.2a1-py3-none-any.whl (7.2 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for keyword_template_matcher-0.1.2a1.tar.gz
Algorithm Hash digest
SHA256 dfb4bfce3ca321370add4b458d59c439d2dc39c46f9428f4bacd0652ef60b97b
MD5 43ac0f4eb3808a676b575c7fd531370e
BLAKE2b-256 b6cd47729a35d5d28668ccb67368fab51870c50caf0ce1455fb3354534e19f21

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for keyword_template_matcher-0.1.2a1-py3-none-any.whl
Algorithm Hash digest
SHA256 aecc6703458750db5b2029ee6dd1b3c4217b516cc44d5b1e46ea9a03cdcfd80b
MD5 d2b5495f396cd6e864438425e53a39ad
BLAKE2b-256 c1f0b613a558bff4592f7f38ab02a883a2ef6dc129ad3c07a98cab026ad55fac

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