Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Counting indexes changed #120

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Counting indexes changed #120

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c4c79cc
refactor: adapt to new sentence index counting
kvdb Jun 29, 2020
4de5324
refactor: adapt to new text index counting
kvdb Jun 29, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 20 additions & 20 deletions docs/api/feedback.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Content-Disposition: form-data; name="sentences"
Content-Type: application/json

{
"sentence": 0,
"sentence": 1,
"errors": 1,
"confidence": -159.0,
"currentFrame": 64,
Expand All @@ -57,8 +57,8 @@ Content-Type: application/json
"tokenType": "EOS"
"words": [
{
"sentenceIndex": 0,
"textIndex": 0,
"sentenceIndex": 1,
"textIndex": 1,
"expected": "hello",
"recognized": "hello",
"label": "CW",
Expand All @@ -68,8 +68,8 @@ Content-Type: application/json
"endTiming": 400
},
{
"sentenceIndex": 0,
"textIndex": 1,
"sentenceIndex": 1,
"textIndex": 2,
"expected": "there",
"recognized": "there-ERR",
"label": "PC",
Expand All @@ -85,7 +85,7 @@ Content-Disposition: form-data; name="sentences"
Content-Type: application/json

{
"sentence": 1,
"sentence": 2,
"errors": 0,
"confidence": -124.1,
"currentFrame": 87,
Expand All @@ -94,8 +94,8 @@ Content-Type: application/json
"tokenType": "EOS"
"words": [
{
"sentenceIndex": 1,
"textIndex": 2,
"sentenceIndex": 2,
"textIndex": 3,
"expected": "general",
"recognized": "general",
"label": "CW",
Expand All @@ -105,8 +105,8 @@ Content-Type: application/json
"endTiming": 320
},
{
"sentenceIndex": 1,
"textIndex": 3,
"sentenceIndex": 2,
"textIndex": 4,
"expected": "kenobi",
"recognized": "kenobi",
"label": "CW",
Expand Down Expand Up @@ -146,7 +146,7 @@ Content-Type: application/json
"challengeId": "chal",
"sentences": [
{
"sentence": 0,
"sentence": 1,
"errors": 1,
"confidence": -159.0,
"currentFrame": 64,
Expand All @@ -155,8 +155,8 @@ Content-Type: application/json
"tokenType": "EOS"
"words": [
{
"sentenceIndex": 0,
"textIndex": 0,
"sentenceIndex": 1,
"textIndex": 1,
"expected": "hello",
"recognized": "hello",
"label": "CW",
Expand All @@ -166,8 +166,8 @@ Content-Type: application/json
"endTiming": 400
},
{
"sentenceIndex": 0,
"textIndex": 1,
"sentenceIndex": 1,
"textIndex": 2,
"expected": "there",
"recognized": "there-ERR",
"label": "PC",
Expand All @@ -179,7 +179,7 @@ Content-Type: application/json
]
},
{
"sentence": 1,
"sentence": 2,
"errors": 0,
"confidence": -124.1,
"currentFrame": 87,
Expand All @@ -188,8 +188,8 @@ Content-Type: application/json
"tokenType": "EOS"
"words": [
{
"sentenceIndex": 1,
"textIndex": 2,
"sentenceIndex": 2,
"textIndex": 3,
"expected": "general",
"recognized": "general",
"label": "CW",
Expand All @@ -199,8 +199,8 @@ Content-Type: application/json
"endTiming": 320
},
{
"sentenceIndex": 1,
"textIndex": 3,
"sentenceIndex": 2,
"textIndex": 4,
"expected": "kenobi",
"recognized": "kenobi",
"label": "CW",
Expand Down
36 changes: 18 additions & 18 deletions docs/websocket/feedback.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ the following json is sent as a progressive result:
```json
{
"feedback_id": "recording_1",
"sentence": 0,
"sentence": 1,
"errors": 1,
"confidence": -78.0,
"currentFrame": 68,
Expand All @@ -81,7 +81,7 @@ the following json is sent as a progressive result:
"tokenType": "EOS"
"words": [
{
"sentenceIndex": 0,
"sentenceIndex": 1,
"textIndex": 1,
"expected": "funny",
"recognized": "funny",
Expand All @@ -90,8 +90,8 @@ the following json is sent as a progressive result:
"explanation": "The pronunciation matches the expected text."
},
{
"sentenceIndex": 0,
"textIndex": 1,
"sentenceIndex": 1,
"textIndex": 2,
"expected": "gif",
"recognized": "gif-ERR",
"label": "PC",
Expand All @@ -105,7 +105,7 @@ the following json is sent as a progressive result:
Name | Type | Description
-------------|----------|------------
feedback_id | `string` | The unique id of the feedback this results belongs to.
sentence | `int` | The index of the sentence, starting at `0`.
sentence | `int` | The index of the sentence, starting at `1`.
errors | `int` | Amount of errors made.
confidence | `float` | Confidence of the end of sentence detection.
currentFrame | `int` | Audio frame of end of sentence detection.
Expand All @@ -118,8 +118,8 @@ The list of words each contain the following fields:

Name | Type | Description
--------------|----------|------------
sentenceIndex | `int` | Index of the sentence.
textIndex | `int` | Index of the whole text.
sentenceIndex | `int` | Index of the sentence, starting at `1`.
textIndex | `int` | Index of word as position in the whole text, starting at `1`.
expected | `string` | The word as it was expected to be pronounced.
recognized | `string` | The recognized result. If nothing is recognized this field is `null`.
label | `string` | Label describing what was recognized.
Expand Down Expand Up @@ -150,7 +150,7 @@ When the recording is finished a recording with feedback is returned:
"audioUrl": "https://api.itslanguage.nl/download/audio.wav",
"sentences": [
{
"sentence": 0,
"sentence": 1,
"errors": 1,
"confidence": -159.0,
"currentFrame": 64,
Expand All @@ -159,8 +159,8 @@ When the recording is finished a recording with feedback is returned:
"tokenType": "EOS"
"words": [
{
"sentenceIndex": 0,
"textIndex": 0,
"sentenceIndex": 1,
"textIndex": 1,
"expected": "hello",
"recognized": "hello",
"label": "CW",
Expand All @@ -170,8 +170,8 @@ When the recording is finished a recording with feedback is returned:
"endTiming": 400
},
{
"sentenceIndex": 0,
"textIndex": 1,
"sentenceIndex": 1,
"textIndex": 2,
"expected": "there",
"recognized": "there-ERR",
"label": "PC",
Expand All @@ -183,7 +183,7 @@ When the recording is finished a recording with feedback is returned:
]
},
{
"sentence": 1,
"sentence": 2,
"errors": 0,
"confidence": -124.1,
"currentFrame": 87,
Expand All @@ -192,8 +192,8 @@ When the recording is finished a recording with feedback is returned:
"tokenType": "EOS"
"words": [
{
"sentenceIndex": 1,
"textIndex": 2,
"sentenceIndex": 2,
"textIndex": 3,
"expected": "general",
"recognized": "general",
"label": "CW",
Expand All @@ -203,8 +203,8 @@ When the recording is finished a recording with feedback is returned:
"endTiming": 320
},
{
"sentenceIndex": 1,
"textIndex": 3,
"sentenceIndex": 2,
"textIndex": 4,
"expected": "kenobi",
"recognized": "kenobi",
"label": "CW",
Expand Down Expand Up @@ -276,4 +276,4 @@ nl.itslanguage.feedback.resume
Name | Type | Description
------------|----------|------------
id | `string` | **Required** The id of the feedback to resume.
sentence_id | `int` | **Required** The id of the sentence (starting with `0`) to resume on.
sentence_id | `int` | **Required** The id of the sentence (starting with `1`) to resume on.