word_match
Search the ASD-STE100 vocabulary with a regular expression to find terms sharing a prefix, suffix, or other pattern. Paginated results include the total match count and truncation flag.
Instructions
Search the vocabulary using a regular expression pattern.
Return all entries whose term matches. Use it to find all words with a common prefix or pattern (e.g. ^de or .*tion$). A broad pattern can match a large part of the vocabulary, so results are paginated.
Parameters
term:
A regular-expression pattern (e.g. "util.*").
max_results:
The maximum number of matching vocabulary entries to return
(default 25).
offset:
The number of matching vocabulary entries to skip before
returning results, for pagination (default 0).
Returns
WordResult
results holds the (possibly empty) page of matching
vocabulary entries after applying offset and max_results.
total is the full match count before pagination, and
truncated tells the caller whether more matches exist beyond
this page.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| term | Yes | The term to look up. | |
| offset | No | The number of matching entries to skip before returning results, for pagination. | |
| max_results | No | The maximum number of matching entries to return. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| total | Yes | ||
| offset | Yes | ||
| results | No | ||
| truncated | Yes | ||
| max_results | Yes |