This is the datamuse Reference Manual, version 1.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 05:56:49 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
datamuseCommon Lisp library for accessing the Datamuse word-finding API
modula t.
(GIT git@github.com:defaultxr/datamuse.git)
MIT
1.2
alexandria (system).
drakma (system).
yason (system).
package.lisp (file).
datamuse.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
datamuse/datamuse.lisppackage.lisp (file).
datamuse (system).
+words-query-parameters+ (constant).
parameter-documentation (function).
suggestions (function).
suggestions* (function).
words (function).
words* (function).
Packages are listed by definition order.
datamusealexandria.
common-lisp.
+words-query-parameters+ (constant).
parameter-documentation (function).
suggestions (function).
suggestions* (function).
words (function).
words* (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Alist mapping ‘words’ and ‘words*’ parameter names to the API’s query parameter names and the official documentation for each. You can also use the ‘parameter-documentation’ function to easily get the documentation for a specific parameter.
See https://www.datamuse.com/api/ for more information about the API.
See also: ‘parameter-documentation’, ‘words’, ‘words*’
Get the documentation string for the specified parameter of the ‘words’ function.
See also: ‘+words-query-parameters+’, ‘words’, ‘words*’
Get a list of suggestions to a partially-type phrase, similar to the auto-suggest feature of some search engines. This function works by querying the Datamuse API’s /sug endpoint as described at https://www.datamuse.com/api/ .
STRING is the input string to generate suggestions for, MAX is the maximum number of results, VOCABULARY is the vocabulary (which defaults to English).
Examples:
;; (dm:suggestions "rei")
=> ("rein" "reiterate" "reign" "reinforce" "reimbursement" "reimburse" "reinstate" "reify" "reins" "reiki")
See also: ‘words’, ‘suggestions*’.
Performs a query to the Datamuse API’s /sug endpoint as described at https://www.datamuse.com/api/ , to get a list of suggestions to partially-typed queries, similar to the auto-suggest feature of some search engines.
STRING is the input string to generate suggestions for, MAX is the maximum number of results, VOCABULARY is the vocabulary (which defaults to English).
See also: ‘suggestions’, ‘words’.
Get a list of words matching the query specified. See the ‘+words-query-parameters+’ alist or the ‘parameter-documentation’ function for documentation on each parameter. This function works by performing a query to the Datamuse API’s /words endpoint as described at https://www.datamuse.com/api/ .
Note that this function returns just a list of words. To get the full results which include the metadata, use ‘words*’.
Examples:
;; ;; Get a list of words that rhyme with "foobar":
;; (words :rhymes "foobar")
;; ;; Get a list of words that start with "s" and end with "ing":
;; (words :spelling "s*ing")
See also: ‘words*’, ‘parameter-documentation’, ‘+words-query-parameters+’, ‘suggestions’.
Get a list of results matching the query specified, including the metadata for each. See the ‘+words-query-parameters+’ alist or the ‘parameter-documentation’ function for documentation on each parameter. This function works by performing a query to the Datamuse API’s /words endpoint as described at https://www.datamuse.com/api/ .
Note that the with-* parameters are simply boolean toggles that set whether specific metadata is included in the results; they don’t actually change which results are returned.
This function includes all of the data returned by the API as alists (i.e. including various metadata for each result). If you just want a list of the words themselves, use ‘words’.
See also: ‘words’, ‘parameter-documentation’, ‘+words-query-parameters+’, ‘suggestions’.
| Jump to: | F P S W |
|---|
| Jump to: | F P S W |
|---|
| Jump to: | +
C |
|---|
| Index Entry | Section | ||
|---|---|---|---|
| | |||
| + | |||
+words-query-parameters+: | Public constants | ||
| | |||
| C | |||
Constant, +words-query-parameters+: | Public constants | ||
| | |||
| Jump to: | +
C |
|---|
| Jump to: | D F P S |
|---|
| Jump to: | D F P S |
|---|