What a note adds to what was known before

GET

/api/v1/saga/notes/{id}/insights

const url = 'https://api.yggy.tech/api/v1/saga/notes/example/insights';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.yggy.tech/api/v1/saga/notes/example/insights \
  --header 'Authorization: Bearer <token>'

The statements of one note, each marked new, confirmed, added or contradicting by a plain comparison with the notes written before it. No model is involved. A note yggy has not read yet has none.

Authorizations

bearerAuth
apiKeyAuth

Parameters

Path Parameters

required

string

>= 1 characters

Responses

200

Insights

application/json

object

noteId

required

string

status

required

string

Allowed values: PENDING PROCESSING COMPLETED FAILED STORED

insights

required

Array<object>

object

Graph id of the statement, for its details.

string

predicate

required

The relation, as the extraction named it. The app turns it into words.

string

subject

required

object

Graph id of the entity, for its details.

string

label

required

string

group

required

string

Allowed values: people organizations places topics

object

required

object

Graph id of the entity, for its details.

string

label

required

string

group

required

string

Allowed values: people organizations places topics

mark

required

New, said before, another value of a relation with many, or a different value of one with only one.

string

Allowed values: new confirmed added contradicts

evidence

The passage of this note the statement was taken from.

string

sourceId

Id of the attached file the statement was read from; absent for the note’s own text.

string

earlier

What an earlier note said about the same thing.

object

noteId

required

string

title

required

string

createdAt

required

string

object

required

string

evidence

string

Example

{
  "status": "PENDING",
  "insights": [
    {
      "subject": {
        "group": "people"
      },
      "object": {
        "group": "people"
      },
      "mark": "new"
    }
  ]
}

403

Not a yggy notes workspace

application/json

object

success

required

boolean

error

required

object

code

required

string

message

required

string

details

Example

{
  "success": false
}

404

Note not found

application/json

object

success

required

boolean

error

required

object

code

required

string

message

required

string

details

Example

{
  "success": false
}