relretrieval API References

`POST /docs`

Post each documents

Content-Type: "application/json"

Include the text text in the body:

{
  "article_id": 1,
  "text": "The tech company Soundcloud is based in Berlin, capital of Germany."
}

===

Status: 200
Content-Type: "application/json; charset=UTF-8"

{
  "status": "ok"
}

`POST /start`

Start BREADS iterations

Content-Type: "application/json"

Include options:

{
  "max_iter": 10
}

===

Status: 200
Content-Type: "application/json; charset=UTF-8"

{
  "status": "ok"
}

`GET /relations?query=CEO`

Gets clusters including "CEO" as a relations word

Content-Type: "application/json"

===

Status: 200
Content-Type: "application/json; charset=UTF-8"

{
  "clusters": [
    {
      "relations": [
        {
          "BEF": "",
          "BET": "is CEO of",
          "AFT": "",
          "tuples": [
            {
              "first": "Larry Page",
              "second": "Google"
            }
          ]
        }
      ]
    }
  ]
}