Skip to content

Latest commit

 

History

History
389 lines (294 loc) · 8.81 KB

API.md

File metadata and controls

389 lines (294 loc) · 8.81 KB
Raw

Sleipnir API documentation

Actions

List corpora

Python Function
>>> sleipnir.dbi.list_corpora()
[{'name': 'Yukaghir Corpus', 'igt_count': 7, 'id': 'TtWe4dSUSwe4KIMzUvBtLA'}]
REST URI
GET /corpora
$ curl -i localhost:5000/v1/corpora
HTTP/1.0 200 OK
Content-Type: application/json
Content-Length: 337

{
  "corpora": [
    {
      "id": "572ba99a-8940-4ae5-8937-8043f8595da1",
      "igt_count": 7,
      "name": "yux",
      "summary_url": "http://localhost:5000/v1/corpora/572ba99a-8940-4ae5-8937-8043f8595da1/summary",
      "url": "http://localhost:5000/v1/corpora/572ba99a-8940-4ae5-8937-8043f8595da1"
    }
  ],
  "corpus_count": 1
}

Get a corpus summary

Python Function
>>> sleipnir.dbi.corpus_summary('TtWe4dSUSwe4KIMzUvBtLA')
{'name': 'Yukaghir Corpus', 'igts': [{'id': 'igt1323-2'}, {'id': 'igt1323-3'}, {'id': 'igt3086-16'}, {'id': 'igt3086-50'}, {'id': 'igt3637-1'}, {'id': 'igt3883-5'}, {'id': 'igt3883-6'}], 'igt_count': 7, 'id': 'TtWe4dSUSwe4KIMzUvBtLA'}
REST URI
GET /corpora/<corpus_id>/summary
$ curl -i localhost:5000/v1/corpora/TtWe4dSUSwe4KIMzUvtLA/summary
HTTP/1.0 200 OK
Content-Type: application/json
Content-Length: 971

{
  "id": "TtWe4dSUSwe4KIMzUvBtLA",
  "igt_count": 7,
  "igts": [
    {
      "id": "igt1323-2",
      "url": "http://localhost:5000/v1/corpora/TtWe4dSUSwe4KIMzUvBtLA/igts/igt1323-2"
    },
    ...
  ],
  "name": "Yukaghir Corpus"
}

Get a corpus

Python Function

If you want to get the corpus as XigtCorpus object, get_corpus() will return it.

>>> sleipnir.dbi.get_corpus('TtWe4dSUSwe4KIMzUvBtLA')
<XigtCorpus object (id: --) with 7 Igts at 139971557389480>

It's also possible to get the original serialized corpus as a string if the database supports it. This is mainly useful when the serialized form is desired, because it doesn't need to deserialize and reserialize the corpus, and is thus quicker than get_corpus().

>>> sleipnir.dbi.raw_formats
['application/xml']
>>> sleipnir.dbi.fetch_raw_corpus('TtWe4dSUSwe4KIMzUvBtLA', 'application/xml')
'<xigt-corpus ...'
>>> sleipnir.dbi.fetch_raw_corpus('TtWe4dSUSwe4KIMzUvBtLA', 'application/json')
Traceback (most recent call last):
...
    'Unsupported mimetype for raw corpus: %s' % mimetype
sleipnir.errors.SleipnirDbError
REST URI
GET /corpora/<corpus_id>

The response body will be either a XigtXML or XigtJSON serialized corpus, depending on the value of the ACCEPT header. Valid values are application/xml and application/json. If unspecified, the default is application/json.

$ curl -i localhost:5000/v1/corpora/572ba99a-8940-4ae5-8937-8043f8595da1
HTTP/1.0 200 OK
Content-Type: application/json
Content-Length: 16996

{"...serialized XigtJSON corpus..."}
$ curl -H'ACCEPT: application/xml' -i localhost:5000/v1/corpora/572ba99a-8940-4ae5-8937-8043f8595da1
HTTP/1.0 200 OK
Content-Type: application/xml; charset=utf-8
Content-Length: 13763

<xigt-corpus>...serialized XigtXML corpus...</xigt-corpus>

List IGTs for a corpus

Without any parameters, this is the same as getting a corpus, except that it doesn't include metadata. With parameters, the IGTs that are returned can be filtered.

Parameters:

Name Type Description
id string Comma-separated list of IGT ids
match string An XPath (or XigtPath) expression for matching IGTs
Python Function
>>> sleipnir.dbi.get_igts('TtWe4dSUSwe4KIMzUvBtLA')
[<Igt object (id: igt1323-2) with 3 Tiers at 139781971298888>, <Igt object (id: igt1323-3) with 3 Tiers at 139781978196152>, <Igt object (id: igt3086-16) with 3 Tiers at 139781971317448>, <Igt object (id: igt3086-50) with 3 Tiers at 139781978216152>, <Igt object (id: igt3637-1) with 3 Tiers at 139781970899256>, <Igt object (id: igt3883-5) with 3 Tiers at 139781978148040>, <Igt object (id: igt3883-6) with 3 Tiers at 139781970902616>]
>>> sleipnir.dbi.get_igts('TtWe4dSUSwe4KIMzUvBtLA', ids=['igt1323-2', 'igt1323-3'])
[<Igt object (id: igt1323-2) with 3 Tiers at 140135406564360>, <Igt object (id: igt1323-3) with 3 Tiers at 140135406565800>]
>>> sleipnir.dbi.get_igts('TtWe4dSUSwe4KIMzUvBtLA', matches=['metadata//dc:subject[text()="Kolyma"]'])
[<Igt object (id: igt1323-2) with 3 Tiers at 140135399438920>, <Igt object (id: igt1323-3) with 3 Tiers at 140135399017432>, <Igt object (id: igt3086-16) with 3 Tiers at 140135399043704>, <Igt object (id: igt3086-50) with 3 Tiers at 140135399559720>]
REST URI
GET /corpora/<c_id>/igts
$ curl -i localhost:5000/v1/corpora/572ba99a-8940-4ae5-8937-8043f8595da1/igts
HTTP/1.0 200 OK
Content-Type: application/json
Content-Length: 35758

{
  "igt_count": 7,
  "igts": [
    "...serialized XigtJSON IGTs..."
  ]
}

$ curl -i localhost:5000/v1/corpora/572ba99a-8940-4ae58937-8043f8595da1/igts?id=igt1323-2%2Cigt1323-3
HTTP/1.0 200 OK
Content-Type: application/json
Content-Length: 8365

{
  "igt_count": 2,
  "igts": [
    "...serialized XigtJSON IGTs..."
  ]
}

Get an IGT

Python Function
>>> sleipnir.dbi.get_igt('TtWe4dSUSwe4KIMzUvBtLA', 'igt1323-2')
<Igt object (id: igt1323-2) with 3 Tiers at 140135399045624>
REST URI
GET /corpora/<c_id>/igts/<i_id>
$ curl -i localhost:5000/v1/corpora/572ba99a-8940-4ae5-8937-8043f8595da1/igts/igt1323-2
HTTP/1.0 200 OK
Content-Type: application/json
Content-Length: 3832

{"...serialized XigtJSON IGT..."}

Add a corpus

Python Function
>>> sleipnir.dbi.add_corpus(XigtCorpus(igts=[Igt(id='i1')]), name='Test Corpus')
{'igt_count': 1, 'id': 'BmMAHdaqT1SUOsZ4Xu0mQg'}
REST URI
POST /corpora
$ curl -i -H'Content-Type: application/json' -d'{"igts": [{"id":"i2"}]}' localhost:5000/v1/corpora
HTTP/1.0 200 OK
Content-Type: application/json
Content-Length: 55

{
  "id": "Ptmbl1o_REWJljZP20sGMA",
  "igt_count": 1
}

Add an IGT to a corpus

Python Function
>>> sleipnir.dbi.add_igt('BmMAHdaqT1SUOsZ4Xu0mQg', Igt(id='i2'))
{'id': 'i2', 'tier_count': 0}
REST URI
POST /corpora/<c_id>/igts
$ curl -i -H'Content-Type: application/json' -d'{"id":"i3"}' localhost:5000/v1/corpora/Ptmbl1o_REWJljZP20sGMA/igts
HTTP/1.0 200 OK
Content-Type: application/json
Content-Length: 36

{
  "id": "i3",
  "tier_count": 0
}

Assign or Replace an IGT

Python Function
>>> sleipnir.dbi.set_igt('BmMAHdaqT1SUOsZ4Xu0mQg', 'i1', Igt(id='i1'))
{'id': 'i1', 'created': True}
>>> sleipnir.dbi.set_igt('BmMAHdaqT1SUOsZ4Xu0mQg', 'i1', Igt(id='i1'))
{'id': 'i1', 'created': False}
REST URI
PUT /corpora/<c_id>/igts/<i_id>
$ curl -i -H'Content-Type: application/json' -d'{"id":"i3", "tiers": [{"id": "p"}]}' -X PUT localhost:5000/v1/corpora/Ptmbl1o_REWJljZP20sGMA/igts/i3
HTTP/1.0 204 NO CONTENT
Content-Type: text/html; charset=utf-8
Content-Length: 0

Update a corpus

Python Function


REST URI


PATCH /corpora/<c_id>




Update an IGT


Python Function




REST URI


PATCH /corpora/<c_id>/igts/<i_id>




Delete a corpus


Python Function


>>> sleipnir.dbi.del_corpus('BmMAHdaqT1SUOsZ4Xu0mQg')


REST URI


DELETE /corpora/<c_id>


$ curl -i -X DELETE localhost:5000/v1/corpora/Ptmbl1o_REWJljZP20sGMA
HTTP/1.0 204 NO CONTENT
Content-Type: text/html; charset=utf-8
Content-Length: 0


Delete an IGT


Python Function


>>> sleipnir.dbi.del_igt('BmMAHdaqT1SUOsZ4Xu0mQg', 'i1')


REST URI


DELETE /corpora/<c_id>/igts/<i_id>


$ curl -i -X DELETE localhost:5000/v1/corpora/Ptmbl1o_REWJljZP20sGMA/igts/i3
HTTP/1.0 204 NO CONTENT
Content-Type: text/html; charset=utf-8
Content-Length: 0