Skip to content

Commit

Permalink
Merge pull request #4 from Cielo24/feature/EN-2842
Browse files Browse the repository at this point in the history
EN-2842: fix example ElementList + minor fixes
  • Loading branch information
mikeweaver committed Jan 31, 2015
2 parents 1929764 + dcc667b commit d85ebc8
Show file tree
Hide file tree
Showing 2 changed files with 11,901 additions and 11,858 deletions.
16 changes: 9 additions & 7 deletions api/source/output_formats/elementlist.rst
Original file line number Diff line number Diff line change
Expand Up @@ -185,29 +185,29 @@ JSON Definitions

**Entity, Topic and Keyword:**

The entity/keyword/topic portions of the Elementlist contain metadata related
to the contents of the Elementlist.
The entity/keyword/topic portions of the ElementList contain metadata related
to the contents of the ElementList.

.. note::
The time ranges for the meta data may not exactly match token or segment
boundaries.

.. note::
The text of some entities/keywords/topics may have been inferred by the content
of the transcript and may not actually appear in the Elementlist.
of the transcript and may not actually appear in the ElementList.

.. note::
The actual entity/keyword/topic is the "key" in the dictionary. It is always lowercase
and will not be duplicated. The following data construct is the "value" associated with
the "key".

.. note::
The display_name may differ from the "key", typically in captilization, but sometimes
The display_name may differ from the "key", typically in capitalization, but sometimes
there are other differences.

.. code-block:: javascript
"keywords": {
"keyword (key)": {
/* The display value of the entity/keyword/topic.
* May be mixed case or otherwise different than the key value. */
"display_name": "<String>",
Expand All @@ -217,8 +217,10 @@ JSON Definitions
/* A list of time ranges to which the entity/keyword/topic is related. */
"time_ranges": [
["start_time": "<Integer (milliseconds)>",
"end_time:": "<Integer (milliseconds)>"],
{
"start_time": "<Integer (milliseconds)>",
"end_time:": "<Integer (milliseconds)>"
},
]
}
Expand Down

0 comments on commit d85ebc8

Please sign in to comment.