Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adrien2p/nestjs-api-ai
Nest + Api.ai
https://github.com/adrien2p/nestjs-api-ai
actionsongoogle ai api-ai assistant dotenv jsonwebtoken jwt nest nest-js node nodejs orm sequelize typescript
Last synced: about 1 month ago
JSON representation
Nest + Api.ai
- Host: GitHub
- URL: https://github.com/adrien2p/nestjs-api-ai
- Owner: adrien2p
- License: mit
- Archived: true
- Created: 2017-08-17T15:49:32.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-05-08T17:11:03.000Z (over 6 years ago)
- Last Synced: 2024-08-04T07:01:11.165Z (3 months ago)
- Topics: actionsongoogle, ai, api-ai, assistant, dotenv, jsonwebtoken, jwt, nest, nest-js, node, nodejs, orm, sequelize, typescript
- Language: TypeScript
- Homepage:
- Size: 523 KB
- Stars: 24
- Watchers: 4
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
### [UNMAINTAINED] use [nestjs-dialogflow](https://github.com/adrien2p/nestjs-dialogflow) instead
This project allow you to catch web hook from [api.ai](https://api.ai/) when a request is triggered
on you agent, the server process the result to send back the response and let your assistant speech it.
For the authentication part, when the user is authenticated with google OAuth2, The middleware catch the request
to create the user locally if is not already created.
### How it works
- To run lint and fix `npm run lint`
- To run tests suite `npm run test`
- Start the server `npm start`
- To run up/down migration `npm run migrate {up/down}`
### Configuration
To configure put all config file in the `./src/config/*`.
To use the env variable, remove `.demo` from `.env.demo`.
### WebHook from [api.ai](https://api.ai/)
To receive a callback from [api.ai](https://api.ai/), you must enabled webhook in `Fullfillment` tab and fill all information needed.
To see how it works locally, you need to activate a local tunnel using the following url
- `GET http://localhost:3000/localTunnelStart` to start it
- `GET http://localhost:3000/localTunnelStop` to close it
The local tunnel url returned need to be write in the `url` section with the path to the webHook which is actually `/apiAi`
After to be logged in your app you should give you `token` access in the `headers` section : `authorization ...`
Then, active `Fullfillment` in the targeted intent.
After that, to connect your agent to actions on google, go to `Integration` part and active actions on google.
Then configure it to access `OAuth2` authentication with google. (Look `google cloud platform` to manage you OAuth settings).
After [api.ai](https://api.ai/) received request, you should received a callback as the following result :
```json
{
"source": "agent",
"resolvedQuery": "quelle est la météo",
"action": "weather",
"actionIncomplete": true,
"parameters": {
"address": "",
"date-time": ""
},
"contexts": [
{
"name": "weather_dialog_context",
"parameters": {
"date-time.original": "",
"address": "",
"date-time": "",
"address.original": ""
},
"lifespan": 2
},
{
"name": "db44589c-29e2-447c-8368-94503e3ccae9_id_dialog_context",
"parameters": {
"date-time.original": "",
"address": "",
"date-time": "",
"address.original": ""__
},
"lifespan": 2
},
{
"name": "weather_dialog_params_address",
"parameters": {
"date-time.original": "",
"address": "",
"date-time": "",
"address.original": ""
},
"lifespan": 1
}
]
}
```
And then, the result is sent to the run method of the service `jeeves` endPoint which manage the rest of the process.
And when the process is done, a response is generated to be send to the `api.api`.