Analysis

Starts an Analysis process for User/query match on Deep Thought known facts.

post

Path parameters

strTokenstringRequired

The login token

strMemoriIDstringRequired

The ID of the Memori object

Body

application/json

querystring · nullableOptional

Query to be matched with User objects in the analysis. Required.

thresholdnumber · float · nullableOptional

Threshold between 0.0 and 1.0. User objects whose match level is below this threshold will be discarded. If null, all User objects will be returned.

Responses

200

Success

application/json

Response of an Import, Analysis or Get Process Status requests.

requestIDinteger · int64Optional

Progressive number of the request (since the Server started). Use this number, together with the RequestDateTime property, to report an anomalous reponse.

requestDateTimestring · date-timeOptional

Timestamp of the request. Use this timestamp, together with the RequestID property, to report an anomalous reponse.

resultCodeinteger · int32Optional

Result code. A code of 0 means no errors. When the request fails, its value is indicative of the actual error.

resultMessagestring · nullableOptional

Result message. A message of Ok means no errors.

post

/api/v2/Analysis/AnalyzeUserQuery/{strToken}/{strMemoriID}

HTTPcURLJavaScriptPython

POST /api/v2/Analysis/AnalyzeUserQuery/{strToken}/{strMemoriID} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "query": "text",
  "threshold": 1
}

200

Success

{
  "status": {
    "analysisType": "text",
    "query": "text",
    "analysisWarningsCount": 1,
    "analysisWarnings": [
      {
        "warningType": "text",
        "text": "text"
      }
    ],
    "processID": "text",
    "memoriID": "text",
    "processUserName": "text",
    "processType": "text",
    "status": "text",
    "error": "text",
    "totalElements": 1,
    "processedElements": 1,
    "progress": 1,
    "processSpecsJSON": "text",
    "begin": "2026-03-06T18:46:04.105Z",
    "end": "2026-03-06T18:46:04.105Z",
    "eta": 1,
    "creationTimestamp": "2026-03-06T18:46:04.105Z",
    "lastChangeTimestamp": "2026-03-06T18:46:04.105Z"
  },
  "requestID": 1,
  "requestDateTime": "2026-03-06T18:46:04.105Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Lists Deep Thought User/query Match objects of the specified Analysis object, with pagination.

get

Path parameters

strTokenstringRequired

The login token

strAnalysisIDstringRequired

The Analysis process ID

frominteger · int32Required

The 0-based index of the first Match object to list

howManyinteger · int32Required

The number of the Match objects to list

thresholdnumber · floatOptional

Optional threshold between 0.0 and 1.0: Match objects below the threshold are excluded from the list

Responses

200

Success

application/json

Response of a List Deep Thought User/query Matches request.

countinteger · int32Optional

Total number of Deep Thought User/query Match objects.

requestIDinteger · int64Optional

Progressive number of the request (since the Server started). Use this number, together with the RequestDateTime property, to report an anomalous reponse.

requestDateTimestring · date-timeOptional

Timestamp of the request. Use this timestamp, together with the RequestID property, to report an anomalous reponse.

resultCodeinteger · int32Optional

Result code. A code of 0 means no errors. When the request fails, its value is indicative of the actual error.

resultMessagestring · nullableOptional

Result message. A message of Ok means no errors.

get

/api/v2/Analysis/UserQueryMatches/{strToken}/{strAnalysisID}/{from}/{howMany}/{threshold}

HTTPcURLJavaScriptPython

GET /api/v2/Analysis/UserQueryMatches/{strToken}/{strAnalysisID}/{from}/{howMany}/{threshold} HTTP/1.1
Accept: */*

200

Success

{
  "count": 1,
  "matches": [
    {
      "userQueryMatchID": "text",
      "analysisID": "text",
      "memoriID": "text",
      "engineUserID": "text",
      "userName": "text",
      "tenantName": "text",
      "userEmail": "text",
      "match": 1
    }
  ],
  "requestID": 1,
  "requestDateTime": "2026-03-06T18:46:04.105Z",
  "resultCode": 1,
  "resultMessage": "text"
}