Page History

Saga_rest_endpoint

Endpoint	processText

Will return a Saga interpretation graph in the format specified
By default, it returns the graph in HTML format which is used by the UI
It also can return JSON or plain text

Parameters

Parameter
summary This is the text to process
name q
required true
Parameter
summary List of tags to use to process the text
name tags
type string array
required true
Parameter
summary Tag to use to process the text
name tag
Parameter
summary Pipeline or pipeline stage to use to process the text
name processor
Parameter
summary Specifies the regex to use to split text into TEXT_BLOCKs
default [\r\n ]+
name splitRegex
Parameter
summary If true, it will combine all the SEMANTIC_TAGs, which has same matching text and same confidence value
default false
name combine
type boolean
- The combination includes the metadata, of every SEMANTIC_TAG
Parameter
summary If true, it will also add the components from the highest route confidence tokens.
default true
name addComponents
type boolean
Parameter
summary Applicable when addComponents is true. Indicates which components to add to the response
name compFields
type string array
- If missing all the components will be added
Parameter
summary If true, it will add the metadata of the entities found in every SEMANTIC_TAG
default false
name metadata
type boolean
Parameter
summary Specifies the format of the results. It could be one of these values: "ux", "text" or "json"
default ux
name type
- ux - Returns an output useful for Saga to show the graph on a web display.
- text - Returns a "line" with the highest confidence route and a text representation of the graph.
- json - Returns all the semantic tags on the graph.

Parameter
summary Used to pretty format the JSON result
default false
name pretty
type boolean

Note

The parameters tags, tag and processor are mutually exclusive, only one is required, and the priority order is:

tags
tag
processor

Request Examples

Code Block

language	powershell
theme	FadeToGrey

curl -X ${method} \
  http://localhost:${port}/${url} \
  -H 'Content-Type: application/json' \
  -d '
{
    "q": "I like traveling with Air Paris",
	"tags": ["airline"],
    "combine": true,
    "addComponents": true,
    "compFields": "paris",
	"splitRegex": "[\r\n]+",
	"type": "text",
	"pretty": true
}'

Response

Saga_json

{
  "_success": true,
  "data": {
    "line": [
      {
        "stage": "WhitespaceTokenizer",
        "confidence": 0.5,
        "match": "I",
        "flags": [
          "ORIGINAL",
          "ALL_UPPER_CASE",
          "TOKEN"
        ],
        "text": "I",
        "startPos": 0,
        "endPos": 1
      },
      {
        "stage": "WhitespaceTokenizer",
        "confidence": 0.5,
        "match": "like",
        "flags": [
          "ORIGINAL",
          "TOKEN",
          "ALL_LOWER_CASE"
        ],
        "text": "like",
        "startPos": 2,
        "endPos": 6
      },
      {
        "stage": "WhitespaceTokenizer",
        "confidence": 0.5,
        "match": "traveling",
        "flags": [
          "ORIGINAL",
          "TOKEN",
          "ALL_LOWER_CASE"
        ],
        "text": "traveling",
        "startPos": 7,
        "endPos": 16
      },
      {
        "stage": "WhitespaceTokenizer",
        "confidence": 0.4,
        "match": "with",
        "flags": [
          "ORIGINAL",
          "STOP_WORD",
          "TOKEN",
          "ALL_LOWER_CASE"
        ],
        "text": "with",
        "startPos": 17,
        "endPos": 21
      },
      {
        "components": [
          {
            "stage": "CaseAnalysis",
            "confidence": 0.45,
            "match": "Paris",
            "flags": [
              "ORIGINAL",
              "LOWERED",
              "TOKEN",
              "ALL_LOWER_CASE"
            ],
            "text": "paris",
            "startPos": 26,
            "endPos": 31
          }
        ],
        "stage": "DictionaryTagger",
        "confidence": 0.6975,
        "display": "Air Paris",
        "match": "Air Paris",
        "flags": [
          "SEMANTIC_TAG",
          "ENTITY"
        ],
        "text": "{airline}",
        "id": "34365531",
        "startPos": 22,
        "endPos": 31,
        "tags": [
          "airline"
        ]
      }
    ],
    "graph": " V-----------[I like traveling with Air Paris]-----------V \n ^-[I]-V-[like]-V-[traveling]-V-[with]-V-[Air]-V-[Paris]-^ \n ^-[i]-^                               ^-[air]-^-[paris]-^ \n                                       ^---[{airline}]---^ \n"
  }
}

Saga_rest_endpoint

Endpoint	processBatch

Will return a Saga interpretation graph in the format specified
By default, it returns the graph in HTML format which is used by the UI
It also can return JSON or plain text

Parameters

Parameter
summary List of texts to process
name batch
type string array
required true
Parameter
summary List of tags to use to process the text
name tags
type string array
required true
Parameter
summary Tag to use to process the text
name tag
Parameter
summary Pipeline or pipeline stage to use to process the text
name processor
Parameter
summary Specifies the regex to use to split text into TEXT_BLOCKs
default [\r |\n ]+
name splitRegex
Parameter
summary If true, it will combine all the SEMANTIC_TAGs, which has same matching text and same confidence value
default false
name combine
type boolean
- The combination includes the metadata, of every SEMANTIC_TAG
Parameter
summary If true, it will also add the components from the highest route confidence tokens. ()
default true
name addComponents
type boolean
Parameter
summary Applicable when addComponents is true. Indicates which components to add to the response
name compFields
type string array
- If missing all the components will be added
Parameter
summary If true, it will add the metadata of the entities found in every SEMANTIC_TAG
default false
name metadata
type boolean

Note

The parameters tags, tag and processor are mutually exclusive, only one is required, and the priority order is:

tags
tag
processor

Request Examples

Code Block

language	powershell
theme	FadeToGrey

curl -X ${method} \
  http://localhost:${port}/${url} \
  -H 'Content-Type: application/json' \
  -d '
{
    "batch": ["I like traveling with Air Paris", "I enjoy traveling with Delta"],
	"tags": ["airline"],
    "combine": true,
    "addComponents": true,
    "compFields": "paris"
}'

Response

Saga_json

[
    {
        "data": {
            "line": [
                {
                    "stage": "WhitespaceTokenizer",
                    "confidence": 0.5,
                    "match": "I",
                    "flags": [
                        "ORIGINAL",
                        "ALL_UPPER_CASE",
                        "TOKEN"
                    ],
                    "text": "I",
                    "startPos": 0,
                    "endPos": 1
                },
                {
                    "stage": "WhitespaceTokenizer",
                    "confidence": 0.5,
                    "match": "like",
                    "flags": [
                        "ORIGINAL",
                        "ALL_LOWER_CASE",
                        "TOKEN"
                    ],
                    "text": "like",
                    "startPos": 2,
                    "endPos": 6
                },
                {
                    "stage": "WhitespaceTokenizer",
                    "confidence": 0.5,
                    "match": "traveling",
                    "flags": [
                        "ORIGINAL",
                        "ALL_LOWER_CASE",
                        "TOKEN"
                    ],
                    "text": "traveling",
                    "startPos": 7,
                    "endPos": 16
                },
                {
                    "stage": "WhitespaceTokenizer",
                    "confidence": 0.4,
                    "match": "with",
                    "flags": [
                        "ORIGINAL",
                        "STOP_WORD",
                        "ALL_LOWER_CASE",
                        "TOKEN"
                    ],
                    "text": "with",
                    "startPos": 17,
                    "endPos": 21
                },
                {
                    "components": [
                        {
                            "stage": "CaseAnalysis",
                            "confidence": 0.45,
                            "match": "Paris",
                            "flags": [
                                "ORIGINAL",
                                "ALL_LOWER_CASE",
                                "LOWERED",
                                "TOKEN"
                            ],
                            "text": "paris",
                            "startPos": 26,
                            "endPos": 31
                        }
                    ],
                    "stage": "DictionaryTagger",
                    "confidence": 0.6975,
                    "display": "Air Paris",
                    "match": "Air Paris",
                    "flags": [
                        "ENTITY",
                        "SEMANTIC_TAG"
                    ],
                    "text": "{airline}",
                    "id": "34365531",
                    "startPos": 22,
                    "endPos": 31,
                    "tags": [
                        "airline"
                    ]
                }
            ],
            "matches": [
                {
                    "components": [
                        {
                            "stage": "CaseAnalysis",
                            "confidence": 0.45,
                            "match": "Paris",
                            "flags": [
                                "ORIGINAL",
                                "ALL_LOWER_CASE",
                                "LOWERED",
                                "TOKEN"
                            ],
                            "text": "paris",
                            "startPos": 26,
                            "endPos": 31
                        }
                    ],
                    "stage": "DictionaryTagger",
                    "confidence": 0.6975,
                    "display": "Air Paris",
                    "match": "Air Paris",
                    "flags": [
                        "ENTITY",
                        "SEMANTIC_TAG"
                    ],
                    "text": "{airline}",
                    "id": "34365531",
                    "startPos": 22,
                    "endPos": 31,
                    "tags": [
                        "airline"
                    ]
                }
            ]
        }
    },
    {
        "data": {
            "line": [
                {
                    "stage": "WhitespaceTokenizer",
                    "confidence": 0.5,
                    "match": "I",
                    "flags": [
                        "ORIGINAL",
                        "ALL_UPPER_CASE",
                        "TOKEN"
                    ],
                    "text": "I",
                    "startPos": 0,
                    "endPos": 1
                },
                {
                    "stage": "WhitespaceTokenizer",
                    "confidence": 0.5,
                    "match": "enjoy",
                    "flags": [
                        "ORIGINAL",
                        "ALL_LOWER_CASE",
                        "TOKEN"
                    ],
                    "text": "enjoy",
                    "startPos": 2,
                    "endPos": 7
                },
                {
                    "stage": "WhitespaceTokenizer",
                    "confidence": 0.5,
                    "match": "traveling",
                    "flags": [
                        "ORIGINAL",
                        "ALL_LOWER_CASE",
                        "TOKEN"
                    ],
                    "text": "traveling",
                    "startPos": 8,
                    "endPos": 17
                },
                {
                    "stage": "WhitespaceTokenizer",
                    "confidence": 0.4,
                    "match": "with",
                    "flags": [
                        "ORIGINAL",
                        "STOP_WORD",
                        "ALL_LOWER_CASE",
                        "TOKEN"
                    ],
                    "text": "with",
                    "startPos": 18,
                    "endPos": 22
                },
                {
                    "stage": "WhitespaceTokenizer",
                    "confidence": 0.5,
                    "match": "Delta",
                    "flags": [
                        "ORIGINAL",
                        "TOKEN",
                        "TITLE_CASE"
                    ],
                    "text": "Delta",
                    "startPos": 23,
                    "endPos": 28
                }
            ],
            "matches": [
                {
                    "stage": "DictionaryTagger",
                    "confidence": 0.44999999999999996,
                    "display": "Delta Air Lines",
                    "match": "Delta",
                    "flags": [
                        "ENTITY",
                        "SEMANTIC_TAG"
                    ],
                    "text": "{airline}",
                    "id": "188920",
                    "startPos": 23,
                    "endPos": 28,
                    "tags": [
                        "airline"
                    ]
                }
            ]
        }
    }
]

Saga_rest_endpoint

Endpoint	solution
Method	GET

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

Request Examples

Code Block

language	powershell
theme	FadeToGrey

curl --location --request GET 'http://localhost:${port}/${url}'

Response

Saga_json
"_success": true, "elasticSearch": { "retries": 3, "hostname": "localhost", "delay": 5, "scheme": "http", "port": 9200, "indexName": "saga", "maxResults": 2000000, "timeout": 30 }, "display": "Saga"

Saga_rest_endpoint

Endpoint	info
Method	GET

Returns build-specific and configuration information about Saga
Build information contains title, vendor, version, build revision and date
Configuration information contains the solution (Elastic index) and providers configured at the moment

Request Examples

Code Block

language	powershell
theme	FadeToGrey

curl --location --request GET 'http://localhost:${port}/${url}'

Response

Saga_json

    "msg": "Saga API online",
    "_success": true,
    "buildInfo": {
        "Implementation-Title": "Saga Server",
        "Implementation-Build": "9dde0a32f17264f7b9004fc8d141e5b1cd0838b0",
        "Implementation-Version": "1.2.0",
        "Implementation-Timestamp": "1550261725668",
        "Implementation-Vendor-Id": "com.accenture.saga",
        "Built-By": "ronny.ortega.ugalde",
        "Build-Jdk": "11.0.2",
        "Implementation-Branch": "develop"
    },
    "solutions": [
        {
            "elasticSearch": {
                "retries": 3,
                "hostname": "localhost",
                "delay": 5,
                "scheme": "http",
                "port": 9200,
                "indexName": "saga",
                "maxResults": 2000000,
                "timeout": 30
            },
            "display": "Saga"
        }
    ],
    "ssl": false,
    "providers": [
        {
            "baseDir": "./config",
            "name": "filesystem-provider",
            "type": "FileSystem"
        },
        {
            "hostname": "localhost",
            "scheme": "http",
            "port": 9200,
            "maxResults": 2000000,
            "name": "saga-provider",
            "exclude": [
                "updatedAt",
                "createdAt"
            ],
            "type": "Elastic",
            "timestamp": "updatedAt"
        }
    ]
    ]

Saga_rest_endpoint

Endpoint	stopServer
Method	GET

Stops the Saga Server

Warning
If you stop the server via HTTP request, it can only be restarted on-premise

Request Examples

Code Block

language	powershell
theme	FadeToGrey

curl --location --request GET 'http://localhost:${port}/${url}'

Page tree

Versions Compared

Old Version 23

New Version 24

Key

Parameters

Request Examples

Response

Parameters

Response

Request Examples

Response

Request Examples

Response

Request Examples

Response