92 lines
1.9 KiB
Markdown
92 lines
1.9 KiB
Markdown
# backend-transcription
|
|
|
|
Beep backend handling transcription of bites to text via Google Cloud.
|
|
|
|
## Quickstart
|
|
|
|
```
|
|
go build && ./backend-transcription
|
|
```
|
|
|
|
## Environment Variables
|
|
|
|
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. |
|