Skip to content

API Format #1

@mischkew

Description

@mischkew
  • get available lists GET /api/lists
[
"listId-1",
"listId-2",
...
]
  • get lists with validated status GET /api/lists/validated
[
{
"listId": "someId",
"validated" true|false
}
]
  • request tfidf results GET /api/tfidf/:listId
    • List id matches results from /api/lists
    • returns a list of types with calculated tfidf scores
  • push tfidf a set of results from wikipedia-list-extraction POST /api/tfidfs
{
  "lists": [
    {
      "listId": "someId1",
      "results": [
        { "label": "type-label-1", "typeUri": "type-uri-1", "type": "type-name-with-prefix", "count": 50, "tfIdf": 0.4 },
        ...
      ]
    }, ...
  ]
}
  • post manual list result POST /api/evaluation
    • Content-Type: application/json
{
  "listId": "someId",
  "types": [ "listOfTypeUris" ] 
}

PUT|GET /api/evaluation/:listId

  • receive a test result GET /api/test/result/:testId
[
    {
        "listId": "List_of_Indian_writers",
        "version": 0,
        "approvedTypes": [
            "http://dbpedia.org/ontology/Person",
            "http://dbpedia.org/ontology/Writer",
            "http://dbpedia.org/ontology/Artist"
        ],
        "declinedTypes": [],
        "result": "http://dbpedia.org/ontology/Person"
    },
    {
        "listId": "List_of_compositions_by_Donald_Tovey",
        "version": 0,
        "approvedTypes": [],
        "declinedTypes": [
            "http://wikidata.dbpedia.org/resource/Q215627",
            "http://wikidata.dbpedia.org/resource/Q5",
            "http://dbpedia.org/ontology/Person",
            "http://dbpedia.org/ontology/Agent"
        ],
        "result": "http://dbpedia.org/ontology/Person"
    },
...
]
  • push a processed list from wikipedia-list-extraction POST /api/test/result/:testId
{
  "lists": {
     "someListId": [ "approved-type-1", "approved-type2", ... ],
     "someListId2": ...
  }
}

FUTURE FEATURES:

  • get available algorithms
  • get available mutators
  • request algorithm result piped through a selected mutator
  • get manual list result

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions