How to use the API : /api/aero/v1/projects/{projectId}/documents/{documentId}/annotations/{userId}

4 views
Skip to first unread message

Nam Hello

unread,
Oct 19, 2021, 4:51:53 AM10/19/21
to inception-users
Hi

I want to know what should the file to upload to this API.
What should be the file format , if you can mail the file that will be helpful.

/api/aero/v1/projects/{projectId}/documents/{documentId}/annotations/{userId}

Thanks & Regards,
Namrata

Richard Eckart de Castilho

unread,
Oct 19, 2021, 12:01:26 PM10/19/21
to inception-users
Hi,

> On 19. Oct 2021, at 10:51, Nam Hello <nam1...@gmail.com> wrote:
>
> I want to know what should the file to upload to this API.
> What should be the file format , if you can mail the file that will be helpful.
>
> /api/aero/v1/projects/{projectId}/documents/{documentId}/annotations/{userId}

The call has a parameter "format" where you need to specify which format the data
you upload has [1].

For the just released INCEpTION 21.1, I have updated the user documentation on the
different formats. At the beginning of each format section, there is a small table
stating the format, whether it can be read, written and which kinds of annotations
are supported. This section now also includes in parentheses the format ID that you
can specify in the "format" parameter in an AERO upload. For example, if you upload
in the UIMA CAS XMI (XML 1.0) format [2], then the id is `xmi`.

The format documentation also contains some examples. For XMI in particular, the
documentation of DKPro Cassis [3] or our Word-to-INCEpTION [4] Python example could be
helpful.

Cheers,

-- Richard

[1] https://openminted.github.io/releases/aero-spec/1.0.0/omtd-aero/#_create_annotations
[2] https://inception-project.github.io/releases/21.1/docs/user-guide.html#sect_formats_uimaxmi
[3] https://github.com/dkpro/dkpro-cassis
[4] https://inception-project.github.io/example-projects/python/

Reply all
Reply to author
Forward
0 new messages