calpoly-csai / calpoly-csai/api

Create a REST endpoint for text input of QA pipeline

Open
#16 1 comment 0 reactions 1 assignee Claimed by @mfekadu View on GitHub
enhancement
Dominant language
Python
Stars
9
Forks
4
PR merge metrics
No merged PRs in 30d

Description

## Objective
Support progress toward the [Implement QA pipeline][1] by _creating an endpoint for raw string questions either in `request params` or `request body`_

## Key Result
Commit _code that does either option 1 or option 2 from below_ by _Jan 19 2020_

## Details

### option 1: the google search way
A URL somewhat similar to this one: `http://calpoly-nimbus.com/ask/what%20is%20meaning%20life?` should result in a webpage (HTTP response) containing some kind of answer (e.g “42”)

#### example google search
```
http://google.com/search?q=what+is+meaning+life?
```

#### pros
* you can query directly from any browser... no fancy `cURL` command needed

#### cons
* need to escape special characters like `&`
* long URLs

### option 2: the JSON way
endpoint: `/ask`
body:
```json
{
"question": "what is meaning life?"
}
```

#### pros
* no worries about special characters

#### cons
* need special tools to perform query (e.g `cURL` or `Postman` or fancy web app code)

[1]: https://github.com/calpoly-csai/api/milestones

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.