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.1a1.tar.gz (6.7 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.1a1-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

File details

Details for the file keyword-template-matcher-0.1.1a1.tar.gz.

File metadata

File hashes

Hashes for keyword-template-matcher-0.1.1a1.tar.gz
Algorithm Hash digest
SHA256 2fd42571a8354fc97262c28b4b112e7c9a77ba62df78350388aa0ee58a66440b
MD5 06aafddb6dc6bc32ca5bd0e46923c16c
BLAKE2b-256 e03344e4124df4b20d859f9be2a6eed15fc8a8e77539ea71a12bb275c3cb5f95

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for keyword_template_matcher-0.1.1a1-py3-none-any.whl
Algorithm Hash digest
SHA256 46d6458b2cc64a0e1e9f9a5e384b644bc839347c1681133d74731e7c2e5e01cb
MD5 71a58dec144ec1105ec08925f48d1fc1
BLAKE2b-256 1e3528d6f8c8fb8073468d4953837e351e7ba45703b39e5eff728998a424bd6b

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