# botfuel-module-collect-tool

> Collect all the transformation steps for each input in a given CSV input file and generate an JSON output file containing the results

Latest version **0.1.2** (published 2018-12-19) · ISC license · 0 weekly downloads

## Install

```sh
npm install botfuel-module-collect-tool
pnpm add botfuel-module-collect-tool
yarn add botfuel-module-collect-tool
bun add botfuel-module-collect-tool
```

Provides the command `botfuel-collect-run`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2018-12-19 |
| First published | 2018-12-19 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 43 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Kevin Depuydt |
| Maintainers | botfueladmin |
| Keywords | botfuel-dialog, module, nlu, statistics |

## Links

- npm: https://www.npmjs.com/package/botfuel-module-collect-tool
- npm.io page: https://npm.io/package/botfuel-module-collect-tool

## Dependencies (4)

- [csv-parse](https://npm.io/package/csv-parse.md) ^4.2.0
- [babel-polyfill](https://npm.io/package/babel-polyfill.md) ^6.26.0
- [botfuel-dialog](https://npm.io/package/botfuel-dialog.md) ^12.0.1
- [request-promise-native](https://npm.io/package/request-promise-native.md) ^1.0.5

## Alternatives

- [react-native-root-siblings](https://npm.io/package/react-native-root-siblings.md) — 102.9K weekly downloads
- [@praxisui/dialog](https://npm.io/package/@praxisui/dialog.md) — 2.0K weekly downloads
- [easy-toggle-state](https://npm.io/package/easy-toggle-state.md) — 350 weekly downloads
- [ngx-lightbox-evp](https://npm.io/package/ngx-lightbox-evp.md) — 19 weekly downloads
- [react-native-modal-translucent-axton](https://npm.io/package/react-native-modal-translucent-axton.md) — 4 weekly downloads

## Recent versions

- 0.1.2 (latest) — 2018-12-19
- 0.1.1 — 2018-12-19
- 0.1.0 — 2018-12-19
- 0.0.1 — 2018-12-19

## README

# Botfuel module collect tool

This module allow to simulate user inputs using a CSV input file
that will be processed and generate an output file with the different
input transformation steps.

# Install

```shell
npm i -D botfuel-module-collect-tool
```

# How to use

## Configuration

To make it work your configuration file must:
- include the module
- use the adapter provided in the module
- use the nlu module provided in the module
- provide the path of the CSV input file

```javascript
// file collect-config.js
module.exports = {
  adapter: {
    name: 'collect',
    files: {
      input: './input.csv',
      output: './output.json', // optional
    },
  },
  nlu: {
    name: 'botfuel-collect',
  },
  modules: ['botfuel-module-collect-tool'],
  logger: 'info',
};
```

## Run

The module come with it's own start command `botfuel-collect-run`,
to use it you can create a new script in your package.json like the following:


```javascript
// file package.json
{
  ...
  "scripts": {
    ...
    "start:collect": "BOTFUEL_APP_TOKEN=<the BOTFUEL_APP_TOKEN> BOTFUEL_APP_ID=<the BOTFUEL_APP_ID> BOTFUEL_APP_KEY=<the BOTFUEL_APP_KEY> botfuel-collect-run collect-config",
    ...
  },
  ...
}
```

and then run the bot using the new command, in this case:

```shell
npm run start:collect
```

Or without creating the new script you can run directly:

```shell
BOTFUEL_APP_TOKEN=<the BOTFUEL_APP_TOKEN> BOTFUEL_APP_ID=<the BOTFUEL_APP_ID> BOTFUEL_APP_KEY=<the BOTFUEL_APP_KEY> node_modules/.bin/botfuel-collect-run collect-config
```

## Format

### Input file format

The input `.csv` file must have the following format:

| raw_sentence | correct_intent |
|--------------|----------------|
| Bonjour      | greetings      |
| Hello        | greetings      |

The out `.json` file will have the following format:

```javascript
[
  ...
  {
    "raw_sentence": "Utterance",
    "correct_intent": "Correct intent label",
    "sentence_after_in_middleware": "Utterance after in middlewares",
    "sentence_after_spellchecking": "Utterance after spellchecking",
    "classification_results": <CLASSIFICATION_RESULTS_LIST>,
    "sentence_after_out_middleware": "Utterance after out middlewares",
    "bot_messages": <BOT_MESSAGES_LIST>
  },
  ...
]
```

---
_Source: https://npm.io/package/botfuel-module-collect-tool · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._