Skip to main content

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

Project description

🧩 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.0.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.0-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

File details

Details for the file keyword-template-matcher-0.1.0.tar.gz.

File metadata

File hashes

Hashes for keyword-template-matcher-0.1.0.tar.gz
Algorithm Hash digest
SHA256 7bc235252a205a62aab8490e7d732a9f9b09855570cf8c3df47f04f7c48600d2
MD5 c22433f2c3a0152bfcd64645ffabc771
BLAKE2b-256 9a3ffcbc2d75d0d639c6800c8c95578b95c0788560165949b44ce0e62b64dadc

See more details on using hashes here.

File details

Details for the file keyword_template_matcher-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for keyword_template_matcher-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cde7508af30e5c8135fa4a98617c37c58c24c481bc05c6c902291287cb335d5a
MD5 1bbdfd860359e41f5e3b8ea2598344f0
BLAKE2b-256 8c24feea08afbd7222af31fa79b80b0cc03792d520a6b15fb6781e07f0790695

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