Talk to Sim with Teach Feature
npm install sim-phA Node.js client for interacting with the SimSimi chatbot API (for PH region only), featuring built-in fallback mechanisms to ensure reliability when accessing Sim and Teach functionalities.
- Introduction
- Installation
- API Key
- Usage
- Features
- API Methods
- Dependencies
- Configuration
- Examples
- Troubleshooting
- Contributors
- License
sim-ph is a lightweight wrapper around the SimSimi chatbot API tailored for users in the Philippines. It provides methods to send queries to SimSimi and teach the bot new responses. If the primary API endpoint fails, the module automatically falls back to a backup endpoint to improve reliability.
``bash`
npm install sim-ph
You must create an account and obtain your API key from:
https://simsimi.ooguy.com
`js
const Sim = require('sim-ph');
const sim = new Sim('your-api-key-here');
// Ask something
sim.sim('Hello!').then(response => {
console.log(response);
}).catch(console.error);
// Teach SimSimi a new response
sim.teach('How are you?', 'I am fine, thank you!').then(response => {
console.log(response);
}).catch(console.error);
`
- Communicate with the SimSimi API using sim() method.teach()
- Teach new responses using method.
- Built-in fallback to secondary API endpoint if the primary fails.
- Simple and easy-to-use class interface.
- query (string): The user's input message.
- ask (string): The question.ans
- (string): The answer SimSimi should learn.
- axios: Promise-based HTTP client for Node.js.
To use this module, you need a valid API key for the SimSimi PH service. Replace 'your-api-key-here' with your actual key.
`js
const sim = new Sim('apikey');
async function interact() {
try {
const reply = await sim.sim('Kumusta ka?');
console.log('SimSimi:', reply);
} catch (err) {
console.error('Error:', err.message);
}
}
interact();
``
- API Key Errors: Ensure your API key is correct and active.
- Both APIs Fail: If both primary and backup endpoints fail, check your internet connection or wait for service restoration.
- [ jerdev ]
MIT License