Analysis

Evidence - Returns the evidence for a given fact

get
Authorizations
Path parameters
factIDstringRequired

The factID for which to retrieve evidence

sessionIDstringRequired

The sessionID where the fact was created

Responses
200
Fact detail
application/json
get
GET /analysis/evidence/{factID}/{sessionID} HTTP/1.1
Host: api.rainbird.ai
x-evidence-key: YOUR_API_KEY
Accept: */*
200

Fact detail

{
  "factID": "WA:RF:46270715221c02dca319bd10",
  "source": "rule",
  "fact": {
    "subject": {
      "type": "person",
      "value": "Bob",
      "dataType": "string"
    },
    "relationship": {
      "type": "speaks"
    },
    "object": {
      "type": "language",
      "dataType": "string",
      "value": "English"
    },
    "certainty": 75
  },
  "time": 1522060091106,
  "rule": {
    "bindings": {
      "S": "Bob",
      "O": "English",
      "COUNTRY": "England"
    },
    "conditions": [
      {
        "subject": "England",
        "relationship": "national language",
        "object": "English",
        "salience": 100,
        "certainty": 100,
        "impact": 37.5,
        "factID": "WA:KF:7ccf0415f3af204b5eb3",
        "objectType": "string",
        "alt": "alternative text",
        "factKey": "1a1a1a1a-1a1a-1a1a-1a1a-1a1a1a1a1a1a1"
      },
      {
        "subject": "Bob",
        "relationship": "lives in",
        "object": "England",
        "salience": 100,
        "certainty": 100,
        "impact": 37.5,
        "factID": "WA:AF:8e5b2c204b5eb3b24ba1",
        "objectType": "string",
        "alt": "alternative text",
        "factKey": "1b1b1b1b-1b1b-1b1b-1b1b-1b1b1b1b1b1b1"
      }
    ],
    "ruleMaxCertainty": 75
  }
}

Interaction Log - Retrieves interaction events

get
Authorizations
Path parameters
sessionIDstringRequired

The session id to access the interaction logs

Query parameters
formatstringOptional

Format of the retrieved data. CSV or JSON

Responses
200
Interaction log detail
application/json
get
GET /analysis/interactions/{sessionID} HTTP/1.1
Host: api.rainbird.ai
x-interaction-key: YOUR_API_KEY
Accept: */*
200

Interaction log detail

{
  "values": {
    "start": {
      "useDraft": true,
      "kmVersionID": "fb215245-4be2-4d23-a64c-97c50530684f",
      "sessionID": "b77cdb34-5904-4dac-9fe9-3697ed1d73e3"
    }
  },
  "event": "start",
  "created": "2022-03-04T10:13:04.224Z"
}

Session - Returns session information

get
Authorizations
Path parameters
sessionIDstringRequired

The sessionID of the session

Query parameters
relationshipsstring[]Optional

A comma-separated list of relationships to filter the session data by.

Responses
200
Session detail
application/json
get
GET /analysis/session/{sessionID} HTTP/1.1
Host: api.rainbird.ai
X-API-Key: YOUR_API_KEY
Accept: */*
200

Session detail

{
  "km": {
    "id": "abcdefgh-abcd-abcd-abcdefghijkl",
    "name": "speaks",
    "versionID": "abcdefgh-abcd-abcd-abcdefghijkl",
    "versionNumber": 1,
    "versionCreated": "2022-01-01T12:00:00.000Z",
    "versionStatus": "Draft"
  },
  "facts": {
    "global": [
      {
        "id": "WA:KF:abcdefgh-abcd-abcd-abcdefghijkl",
        "subject": {
          "concept": "Country",
          "value": "France",
          "dataType": "string"
        },
        "relationship": "has language",
        "object": {
          "concept": "Language",
          "value": "French",
          "dataType": "string"
        },
        "certainty": 100,
        "source": "knowledgemap"
      }
    ],
    "context": [],
    "local": [
      {
        "id": "WA:KF:abcdefgh-abcd-abcd-abcdefghijkl",
        "subject": {
          "concept": "Person",
          "value": "Mat",
          "dataType": "string"
        },
        "relationship": "lives in",
        "object": {
          "concept": "Country",
          "value": "France",
          "dataType": "string"
        },
        "certainty": 100,
        "source": "knowledgemap"
      }
    ]
  }
}