Data

You must provide some static data for WordWeaver including the fomabin of your language model, a swagger template and flat files (json) containing data about your language’s pronouns, verbs and affixes.

JSON data

Affixes

Pronouns

Verbs

Foma Binary

You must have a valid Foma binary.

Swagger

WordWeaver uses Swagger to document its API. We recommend using the default swagger spec instead of writing your own. In order to update your swagger spec, run the following code:

gen = SwaggerSpecGenerator()
gen.writeNewData()

You can also run the above code in the command line as follows:

wordweaver spec

We recommend integrating this into a CI/CD pipeline for your WordWeaver instance.

Note

This will only edit your swagger spec at $WW_DATA_DIR/swagger/swagger-pre.json