Clean up JSON wire protocol and formalize it.

nlplab / brat

brat rapid annotation tool (brat) - for all your textual annotation needs

http://brat.nlplab.org

Other

1.82k stars 509 forks source link

Clean up JSON wire protocol and formalize it. #89

Open spyysalo opened 13 years ago

spyysalo commented 13 years ago

The current object sent over JSON from the server to the client has some historical idiosyncrasies and bits that are needlessly specific to the particular application / server-side storage. For example

"equivs" : a more general way to specify relations would be preferable
"triggers" : the separation of triggers and events is somewhat application/storage - specific. The event text binding span could be included in the event.
'infos' : funny name

The protocol should be generalized and cleaned up (possibly also in other aspects) and defined at least semi-formally.

ghost commented 13 years ago

Documentation work is carried out here.

spyysalo commented 12 years ago

Pushing for later milestone.

ghost commented 11 years ago

What I have found for the response to getDocument:

Mandatory:

text

Optional:

attributes
entities
equivs
events
modifications
normalizations
relations
triggers
comments
action
ctime
mtime
messages
source_files

Optional (with client-side fall-backs):

sentence_offsets
token_offsets