Stats

Computes text quality indexes for a Memori.

get

This API requires a Giver session.

Path parameters

strSessionIDstringRequired

The session ID

strLatestUpdatestringOptional

The optional latest update timestamp, in UTC time, in the format yyyyMMddHHmmssfff

Responses

200

Success

application/json

Response of a Get Text Quality Indexes request.

textQualityIndexnumber · double · nullableOptional

An index of text quality of this Memori. It is the ratio of defined words vs. the total of unique words used in questions and stories. A value of 1.0 means that no words are undefined, a value of 0.0 means that all words are undefined. If Null it means the index has not changed since the last time it was updated.

undefinedWordsstring[] · nullableOptional

List of undefined words found in questions and stories. Undefined words may have a profound negative impact on the ability to match content with user input. If Null it means the list has not changed since the last time it was updated.

contentTextQualityIndexnumber · double · nullableOptional

An index of text quality of the content of this Memori. It is the ratio of correct questions and stories vs. the total number of questions and stories. A question or story is defined as "correct" if it contains no undefined words, while it is defined as "faulty" if it contains at least one undefined word. A value of 1.0 means that all questions and stories have no undefined words, a value of 0.0 means that all questions and stories contain at least an undefined word. If Null it means the index has not changed since the last time it was updated.

requestIDinteger · int64Optional

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

requestDateTimestring · date-timeOptional

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

resultCodeinteger · int32Optional

Result code. A code of 0 means no errors. When the request fails, its value is equivalent to the HTTP status code.

resultMessagestring · nullableOptional

Result message. A message of Ok means no errors.

get

/memori/v2/TextQualityIndexes/{strSessionID}/{strLatestUpdate}

HTTPcURLJavaScriptPython

GET /memori/v2/TextQualityIndexes/{strSessionID}/{strLatestUpdate} HTTP/1.1
Accept: */*

200

Success

{
  "textQualityIndex": 1,
  "undefinedWords": [
    "text"
  ],
  "contentTextQualityIndex": 1,
  "faultyMemories": [
    {
      "memoryID": "text",
      "memoryType": "text",
      "lastRead": "2026-03-07T11:53:49.282Z",
      "readOccurrences": 1,
      "receiverID": "text",
      "receiverTag": "text",
      "receiverName": "text",
      "media": [
        {
          "mediumID": "text",
          "url": "text",
          "content": "text",
          "mimeType": "text",
          "title": "text",
          "properties": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "creationTimestamp": "2026-03-07T11:53:49.282Z",
          "creationSessionID": "text",
          "lastChangeTimestamp": "2026-03-07T11:53:49.282Z",
          "lastChangeSessionID": "text"
        }
      ],
      "title": "text",
      "titleVariants": [
        "text"
      ],
      "answers": [
        {
          "text": "text",
          "preformatted": true,
          "creationTimestamp": "2026-03-07T11:53:49.282Z",
          "creationSessionID": "text",
          "lastChangeTimestamp": "2026-03-07T11:53:49.282Z",
          "lastChangeSessionID": "text"
        }
      ],
      "date": "2026-03-07T11:53:49.282Z",
      "dateUncertaintyDays": 1,
      "placeName": "text",
      "placeLatitude": 1,
      "placeLongitude": 1,
      "placeUncertaintyKm": 1,
      "conclusive": true,
      "notPickable": true,
      "help": true,
      "hints": [
        "text"
      ],
      "minTimeout": 1,
      "maxTimeout": 1,
      "contextVarsToSet": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "contextVarsToMatch": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "dcmOutcomeType": "text",
      "dcmOutcomeCode": "text",
      "tags": [
        "text"
      ],
      "creationTimestamp": "2026-03-07T11:53:49.282Z",
      "creationSessionID": "text",
      "lastChangeTimestamp": "2026-03-07T11:53:49.282Z",
      "lastChangeSessionID": "text"
    }
  ],
  "requestID": 1,
  "requestDateTime": "2026-03-07T11:53:49.282Z",
  "resultCode": 1,
  "resultMessage": "text"
}