Welcome to Gozokia’s documentation!

Gozokia is a microframework to build chatbots. The developer create the rules and Gozokia do the logic.

Installation

  1. Clone the project

    git clone https://github.com/avara1986/gozokia.git

  2. Install Python dependencies

    pip install -r requirements.txt

  3. Install Linux dependencies

    sudo apt-get install python3-dev sudo apt-get install portaudio19-dev

Configuration

TODO

Usage

  1. Rename settings.example.py as settings.py

Example of console script:

os.environ.setdefault(“GOZOKIA_SETTINGS_MODULE”, “settings”)

goz = Gozokia() goz.initialize() goz.console()Rename settings.example.py as settings.py

Core

class gozokia.core.rules.RuleBase

All rules inherit from RuleBase. All rules needs a condition, a response.

RuleBase is the base model to all rules. with this class, the rules will can to access to the main class (Gozokia), the sentence (the input), and/or the analyzer (if it is active)

class gozokia.core.rules.Rules(*args, **kwargs)
get_rule(gozokia)

Get the active rule or find one.

get_rules(type_rule=None)

return a diccionary of rules order by rank and filter by type or fule

class gozokia.core.text_processor.Analyzer

I/O

I/O configurations

class gozokia.i_o.io.Io(*args, **kwargs)
get_input_method()
get_output_method()
listen(*args, **kwargs)
response(text, *args, **kwargs)
set_input_method(input_type)

Input configuration

set_output_method(output_type)

Output configuration

Indices and tables