Versions Compared

Old Version 1

changes.mady.by.user Ronny Ortega Ugalde

Saved on

compared with

New Version 2

changes.mady.by.user Ronny Ortega Ugalde

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This REST Handler contains general/utility functionality

Table of Contents
maxLevel2

Saga_rest_endpoint
Endpointpreview

Will return SAGA interpretation graph. At the moment it is HTML based but eventually the user will be able to choose the format.

Parameters

  • Parameter
    summaryThis is the text to process
    nameq
    requiredtrue
  • Parameter
    summaryList of tags to use to process the text
    nametags
    typestring array
    requiredtrue
  • Parameter
    summarySpecifies the regex to use to split text into sentences
    default[\r |\n ]+
    namesplitRegex
  • Parameter
    summaryUsed to pretty format the JSON result
    defaultfalse
    namepretty
    typeboolean

Request Examples

Code Block
languagepowershell
themeFadeToGrey
curl -X ${method} \
  http://localhost:${port}/${url} \
  -H 'Content-Type: application/json' \
  -d '
{
    "q": "who is morgan freeman",
	"tags": ["human"],
	"splitRegex": "[\r|\n]+",
	"pretty": true
}'

Response

Saga_json
    "_success": true,
    "data": {
        "line": [
            {
                "tooltip": "<div class=\"li-tooltip\"><span class=\"type\">LexItem</span><span class=\"field\"><b>Matching: </b>who</span><span class=\"field\"><b>Characters: </b>0:3</span><span class=\"field\"><b>Confidence: </b>0.5</span><span class=\"field\"><b>Stage: </b>WhitespaceTokenizer</span><div class=\"fieldset\"><b>Flags</b><span class=\"flag\">ORIGINAL</span><span class=\"flag\">TOKEN</span><span class=\"flag\">ALL_LOWER_CASE</span></div></div>",
                "text": "[who]",
                "type": "item",
                "hash": 1851608413
            },
            {
                "tooltip": "<div class=\"li-tooltip\"><span class=\"type\">LexItem</span><span class=\"field\"><b>Matching: </b>is</span><span class=\"field\"><b>Characters: </b>4:6</span><span class=\"field\"><b>Confidence: </b>0.4</span><span class=\"field\"><b>Stage: </b>WhitespaceTokenizer</span><div class=\"fieldset\"><b>Flags</b><span class=\"flag\">ORIGINAL</span><span class=\"flag\">SKIP</span><span class=\"flag\">TOKEN</span><span class=\"flag\">ALL_LOWER_CASE</span></div></div>",
                "text": "[is]",
                "type": "item",
                "hash": 1221679425
            },
            {
                "tooltip": "<div class=\"li-tooltip\"><span class=\"type\">LexItem</span><span class=\"field\"><b>Matching: </b>morgan</span><span class=\"field\"><b>Characters: </b>7:13</span><span class=\"field\"><b>Confidence: </b>0.5</span><span class=\"field\"><b>Stage: </b>WhitespaceTokenizer</span><div class=\"fieldset\"><b>Flags</b><span class=\"flag\">ORIGINAL</span><span class=\"flag\">PROCESSED</span><span class=\"flag\">TOKEN</span><span class=\"flag\">ALL_LOWER_CASE</span></div></div>",
                "text": "[morgan]",
                "type": "item",
                "hash": 1927964688
            },
            {
                "tooltip": "<div class=\"li-tooltip\"><span class=\"type\">LexItem</span><span class=\"field\"><b>Matching: </b>freeman</span><span class=\"field\"><b>Characters: </b>14:21</span><span class=\"field\"><b>Confidence: </b>0.5</span><span class=\"field\"><b>Stage: </b>WhitespaceTokenizer</span><div class=\"fieldset\"><b>Flags</b><span class=\"flag\">ORIGINAL</span><span class=\"flag\">PROCESSED</span><span class=\"flag\">TOKEN</span><span class=\"flag\">ALL_LOWER_CASE</span></div></div>",
                "text": "[freeman]",
                "type": "item",
                "hash": 439037856
            }
        ],
        "graph": [
            [
                {
                    "text": " ",
                    "type": "padding"
                },
                {
                    "tooltip": "<div class=\"li-tooltip\"><span class=\"type\">Vertex</span><span class=\"field\"><b>Text: </b><b>null</b></span><span class=\"field\"><b>Characters: </b>0:0</span><span class=\"field\"><b>Stage: </b>null</span>",
                    "text": "V",
                    "type": "vertex",
                    "hash": 305419896
                },
                {
                    "text": "-------",
                    "type": "padding"
                },
                {
                    "tooltip": "<div class=\"li-tooltip\"><span class=\"type\">LexItem</span><span class=\"field\"><b>Matching: </b>who is morgan freeman</span><span class=\"field\"><b>Characters: </b>0:21</span><span class=\"field\"><b>Confidence: </b>0.5</span><span class=\"field\"><b>Stage: </b>SimpleReader</span><div class=\"fieldset\"><b>Flags</b><span class=\"flag\">TEXT_BLOCK</span><span class=\"flag\">SENTENCE</span></div></div>",
                    "text": "[who is morgan freeman]",
                    "type": "item",
                    "hash": 0
                },
                {
                    "text": "-------",
                    "type": "padding"
                },
                {
                    "tooltip": "<div class=\"li-tooltip\"><span class=\"type\">Vertex</span><span class=\"field\"><b>Text: </b>\"\"</span><span class=\"field\"><b>Characters: </b>21:21</span><span class=\"field\"><b>Stage: </b>SimpleReader</span><div class=\"fieldset\"><b>Flags</b><span class=\"flag\">TEXT_BLOCK_SPLIT</span><span class=\"flag\">OVERFLOW_SPLIT</span><span class=\"flag\">SENTENCE_SPLIT</span></div></div>",
                    "text": "V",
                    "type": "vertex",
                    "hash": 305419896
                },
                {
                    "text": " ",
                    "type": "padding"
                }
            ],
            [
                {
                    "text": " ",
                    "type": "padding"
                },
                {
                    "tooltip": "<div class=\"li-tooltip\"><span class=\"type\">Vertex</span><span class=\"field\"><b>Text: </b><b>null</b></span><span class=\"field\"><b>Characters: </b>0:0</span><span class=\"field\"><b>Stage: </b>null</span>",
                    "text": "^",
                    "type": "vertex",
                    "hash": 305419896
                },
                {
                    "text": "-",
                    "type": "padding"
                },
                {
                    "tooltip": "<div class=\"li-tooltip\"><span class=\"type\">LexItem</span><span class=\"field\"><b>Matching: </b>who</span><span class=\"field\"><b>Characters: </b>0:3</span><span class=\"field\"><b>Confidence: </b>0.5</span><span class=\"field\"><b>Stage: </b>WhitespaceTokenizer</span><div class=\"fieldset\"><b>Flags</b><span class=\"flag\">ORIGINAL</span><span class=\"flag\">TOKEN</span><span class=\"flag\">ALL_LOWER_CASE</span></div></div>",
                    "text": "[who]",
                    "type": "item",
                    "hash": 1851608413
                },
                {
                    "text": "-",
                    "type": "padding"
                },
                {
                    "tooltip": "<div class=\"li-tooltip\"><span class=\"type\">Vertex</span><span class=\"field\"><b>Text: </b>\" \"</span><span class=\"field\"><b>Characters: </b>3:4</span><span class=\"field\"><b>Stage: </b>WhitespaceTokenizer</span><div class=\"fieldset\"><b>Flags</b><span class=\"flag\">ALL_WHITESPACE</span></div></div>",
                    "text": "V",
                    "type": "vertex",
                    "hash": 610839760
                },
                {
                    "text": "-",
                    "type": "padding"
                },
                {
                    "tooltip": "<div class=\"li-tooltip\"><span class=\"type\">LexItem</span><span class=\"field\"><b>Matching: </b>is</span><span class=\"field\"><b>Characters: </b>4:6</span><span class=\"field\"><b>Confidence: </b>0.4</span><span class=\"field\"><b>Stage: </b>WhitespaceTokenizer</span><div class=\"fieldset\"><b>Flags</b><span class=\"flag\">ORIGINAL</span><span class=\"flag\">SKIP</span><span class=\"flag\">TOKEN</span><span class=\"flag\">ALL_LOWER_CASE</span></div></div>",
                    "text": "[is]",
                    "type": "item",
                    "hash": 1221679425
                },
                {
                    "text": "-",
                    "type": "padding"
                },
                {
                    "tooltip": "<div class=\"li-tooltip\"><span class=\"type\">Vertex</span><span class=\"field\"><b>Text: </b>\" \"</span><span class=\"field\"><b>Characters: </b>6:7</span><span class=\"field\"><b>Stage: </b>WhitespaceTokenizer</span><div class=\"fieldset\"><b>Flags</b><span class=\"flag\">ALL_WHITESPACE</span></div></div>",
                    "text": "V",
                    "type": "vertex",
                    "hash": 610839760
                },
                {
                    "text": "-",
                    "type": "padding"
                },
                {
                    "tooltip": "<div class=\"li-tooltip\"><span class=\"type\">LexItem</span><span class=\"field\"><b>Matching: </b>morgan</span><span class=\"field\"><b>Characters: </b>7:13</span><span class=\"field\"><b>Confidence: </b>0.5</span><span class=\"field\"><b>Stage: </b>WhitespaceTokenizer</span><div class=\"fieldset\"><b>Flags</b><span class=\"flag\">ORIGINAL</span><span class=\"flag\">PROCESSED</span><span class=\"flag\">TOKEN</span><span class=\"flag\">ALL_LOWER_CASE</span></div></div>",
                    "text": "[morgan]",
                    "type": "item",
                    "hash": 1927964688
                },
                {
                    "text": "-",
                    "type": "padding"
                },
                {
                    "tooltip": "<div class=\"li-tooltip\"><span class=\"type\">Vertex</span><span class=\"field\"><b>Text: </b>\" \"</span><span class=\"field\"><b>Characters: </b>13:14</span><span class=\"field\"><b>Stage: </b>WhitespaceTokenizer</span><div class=\"fieldset\"><b>Flags</b><span class=\"flag\">ALL_WHITESPACE</span></div></div>",
                    "text": "V",
                    "type": "vertex",
                    "hash": 610839760
                },
                {
                    "text": "-",
                    "type": "padding"
                },
                {
                    "tooltip": "<div class=\"li-tooltip\"><span class=\"type\">LexItem</span><span class=\"field\"><b>Matching: </b>freeman</span><span class=\"field\"><b>Characters: </b>14:21</span><span class=\"field\"><b>Confidence: </b>0.5</span><span class=\"field\"><b>Stage: </b>WhitespaceTokenizer</span><div class=\"fieldset\"><b>Flags</b><span class=\"flag\">ORIGINAL</span><span class=\"flag\">PROCESSED</span><span class=\"flag\">TOKEN</span><span class=\"flag\">ALL_LOWER_CASE</span></div></div>",
                    "text": "[freeman]",
                    "type": "item",
                    "hash": 439037856
                },
                {
                    "text": "-",
                    "type": "padding"
                },
                {
                    "tooltip": "<div class=\"li-tooltip\"><span class=\"type\">Vertex</span><span class=\"field\"><b>Text: </b>\"\"</span><span class=\"field\"><b>Characters: </b>21:21</span><span class=\"field\"><b>Stage: </b>SimpleReader</span><div class=\"fieldset\"><b>Flags</b><span class=\"flag\">TEXT_BLOCK_SPLIT</span><span class=\"flag\">OVERFLOW_SPLIT</span><span class=\"flag\">SENTENCE_SPLIT</span></div></div>",
                    "text": "^",
                    "type": "vertex",
                    "hash": 305419896
                },
                {
                    "text": " ",
                    "type": "padding"
                }
            ],
            [
                {
                    "text": "                ",
                    "type": "padding"
                },
                {
                    "tooltip": "<div class=\"li-tooltip\"><span class=\"type\">Vertex</span><span class=\"field\"><b>Text: </b>\" \"</span><span class=\"field\"><b>Characters: </b>6:7</span><span class=\"field\"><b>Stage: </b>WhitespaceTokenizer</span><div class=\"fieldset\"><b>Flags</b><span class=\"flag\">ALL_WHITESPACE</span></div></div>",
                    "text": "^",
                    "type": "vertex",
                    "hash": 610839760
                },
                {
                    "text": "------",
                    "type": "padding"
                },
                {
                    "tooltip": "<div class=\"li-tooltip\"><span class=\"type\">LexItem</span><span class=\"field\"><b>Id: </b>Q48337</span><span class=\"field\"><b>Display: </b>Morgan Freeman</span><span class=\"field\"><b>Patterns: </b>Morgan Freeman</span><span class=\"field\"><b>Matching: </b>morgan freeman</span><span class=\"field\"><b>Characters: </b>7:21</span><span class=\"field\"><b>Confidence: </b>0.004424129621858132</span><span class=\"field\"><b>Stage: </b>DictionaryTagger</span><div class=\"fieldset\"><b>Flags</b><span class=\"flag\">SEMANTIC_TAG</span><span class=\"flag\">ENTITY</span></div><div class=\"fieldset\"><b>Tags</b><span class=\"tag\">human</span></div></div>",
                    "text": "[{human}]",
                    "type": "item",
                    "hash": 439036637
                },
                {
                    "text": "-------",
                    "type": "padding"
                },
                {
                    "tooltip": "<div class=\"li-tooltip\"><span class=\"type\">Vertex</span><span class=\"field\"><b>Text: </b>\"\"</span><span class=\"field\"><b>Characters: </b>21:21</span><span class=\"field\"><b>Stage: </b>SimpleReader</span><div class=\"fieldset\"><b>Flags</b><span class=\"flag\">TEXT_BLOCK_SPLIT</span><span class=\"flag\">OVERFLOW_SPLIT</span><span class=\"flag\">SENTENCE_SPLIT</span></div></div>",
                    "text": "^",
                    "type": "vertex",
                    "hash": 305419896
                },
                {
                    "text": " ",
                    "type": "padding"
                }
            ]
        ]
    }
Saga_rest_endpoint
Endpointsolution
MethodGET

Returns the information of the " solution " currently being used. A solution is basically the set of Elasticsearch indices in use.

Request Examples

Code Block
languagepowershell
themeFadeToGrey
curl -X ${method} \
  http://localhost:${port}/${url} \
  -H 'Content-Type: application/json' \
  -d '
{
}'

Response

Saga_json
    "_success": true,
    "elasticSearch": {
        "scrollTimeout": "1m",
        "hostname": "localhost",
        "debug": false,
        "scheme": "http",
        "size": 100,
        "port": 9200,
        "maxResults": 100000,
        "indexName": "saga"
    },
    "display": "Saga - EN"