5
0
Fork 0

Updated README

master
Daniel Lim 2019-06-28 20:43:08 +08:00
parent 16915d240f
commit 9e8ae9b73e
1 changed files with 1 additions and 73 deletions

View File

@ -1,6 +1,6 @@
# backend-transcription
Beep backend handling transcription of bites to text via Google Cloud.
Beep backend handling transcription of bites to text via Google Cloud. Is completely within the backend and has no exposed endpoints.
## Quickstart
@ -14,78 +14,6 @@ Supply environment variables by either exporting them or editing ```.env```.
| ENV | Description | Default |
| ---- | ----------- | ------- |
| LISTEN | Host and port number to listen on | :8080 |
| NATS | Host and port of nats | nats://localhost:4222 |
| API_KEY | Google Cloud API key | Something that works. Probably |
## API
## Scan Bites
```
GET /conversation/:key/scan
```
Get a list of transcription start times within a conversation key and specified timespan.
#### URL Params
| Name | Type | Description |
| ---- | ---- | ----------- |
| key | String | Audio transcription's bite's conversation's ID. |
#### Querystring
| Name | Type | Description |
| ---- | ---- | ----------- |
| from | Epoch timestamp | Time to start scanning from |
| to | Epoch timestamp | Time to scan to |
#### Success (200 OK)
```
Content-Type: application/json
```
```
{
"previous": <Timestamp of transcription before <starts>>,
"starts": [Timestamp, Timestamp...],
"next": <Timestamp of transcription after <starts>>,
}
```
#### Errors
| Code | Description |
| ---- | ----------- |
| 400 | Malformed input (from/to not timestamp, key not alphanumeric). |
| 500 | NATs or protobuf serialisation encountered errors. |
---
### Get Bite
```
GET /conversation/:key/start/:start
```
Get a specific ```transcription```.
#### URL Params
| Name | Type | Description |
| ---- | ---- | ----------- |
| key | String | Audio transcription's conversation's ID. |
| start | Epoch timestamp | Time the audio transcription starts. |
#### Success (200 OK)
Plaintext transcription
#### Errors
| Code | Description |
| ---- | ----------- |
| 400 | start is not an uint/key is not an alphanumeric string/specified bite could not be found |
| 500 | NATs or protobuf serialisation encountered errors. |