greggaba / evolution_NLQA

Welcome to AskTanmay!

This repository contains the complete source code for AskTanmay.

Current Versions

(Stable) 2.1 (master)

(Beta) 3.0 (TQA-3.0-beta)

---

What is AskTanmay?

AskTanmay is a Natural Language Question-Answering system (NLQA system), built in Swift, Java, and Python (though the eventual aim is to have it solely in Swift). The goal of AskTanmay is to allow developers to have a foundation to start off of, if they'd like to implement their own NLQA systems, but don't know where to start.

---

Currently Supported Answer Types

• Person (e.g. "Who is the CEO of IBM?")
• Organization/Company (e.g. "Which worldwide retail chain makes the most profit?")
• Location (e.g. "Where is the Taj Mahal?" or "In which city is the Taj Mahal?")

---

Build instructions

In order to build AskTanmay, you must have the following dependencies:

• Python 2.7.10
• Java 8
• Xcode 8.2.1 (latest stable Xcode)
• macOS

NOTE! Do not build AskTanmay from Xcode! It is not designed for this, though with a bit of modification, can run. While it will build successfully, it won't work in the later stages, as the Python and Java components have not been added. However, you can use Xcode as an IDE, and Build ("CMD+B"), not Run ("CMD+R"), to check your code, and save it.

Before building & running AskTanmay, you will need to fill out some credentials & API Keys. You need to fill out credentials in the following files:

• TanmayQA/GlobalConstants.swift
• TanmayQA_NER_FNS/NER_FNS.java (at service.setApiKey("<ALCHEMYAPI KEY>");)

Now, the build instructions:

1. Go into Terminal
2. Navigate into the directory for the project (the directory containing "TanmayQA.xcodeproj")
3. Run this bash command: sh buildTQA.sh

Done! This should compile AskTanmay and the Python & Java dependencies.

In order to run the binary, do this:

1. From that project directory, navigate to "build/Release"
2. Run AskTanmay with a question: ./TanmayQA "<QUESTION>"

---

Credits

AskTanmay's dependencies consist of the following software:

• IBM Watson java-sdk (v2.9.5)
• gson (v2.3.1)
• okhttp (v2.7.4)
• okio (v1.4.0)
• topia.termextract
• zope.interface

Thanks to the above sources for making AskTanmay possible.

License

AskTanmay (codename: TanmayQA) by Tanmay Bakshi is licensed under a Creative Commons Attribution 4.0 International License.