analyze

GET /api/v1/analyze/text-unit-similarity/list/

Changed on Feb 9, 2022

Base Text Unit Similarity List

Request

Base URL
/ (relative, and the document was published on a file host, not at the API’s origin)
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/lexpredict/apis/contraxsuite-api/docs/api/v1/analyze/text-unit-similarity/list/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

jq_filtersobject

Filter params similar to JQWidgets grid filter params: filterscount=1, filterdatafield0="a", filtervalue0="b", filtercondition0="CONTAINS", filteroperator0=1, sortdatafied="c", sortorder="asc"

Response

text_unit_a_idstring

text_unit_a__unit_typestring

text_unit_a__languagestring

text_unit_a__textstring

document_a_idstring

document_a__namestring

text_unit_b_idstring

text_unit_b__unit_typestring

text_unit_b__languagestring

text_unit_b__textstring

document_b_idstring

document_b__namestring

similaritystring decimal required

Example response

[
  {
    "document_a__name": "document_a__name",
    "document_a_id": "document_a_id",
    "document_b_id": "document_b_id",
    "text_unit_a__unit_type": "text_unit_a__unit_type",
    "text_unit_b_id": "text_unit_b_id",
    "run": {
      "items_count": 1,
      "project_id": "project_id",
      "feature_source": "feature_source",
      "unit_source": "unit_source",
      "id": 0,
      "created_date": "2000-01-23T04:56:07.000+00:00",
      "unit_type": "unit_type",
      "unit_id": 441289069,
      "created_by": 5
    },
    "text_unit_a_id": "text_unit_a_id",
    "text_unit_a__text": "text_unit_a__text",
    "text_unit_a__language": "text_unit_a__language",
    "text_unit_b__unit_type": "text_unit_b__unit_type",
    "text_unit_b__text": "text_unit_b__text",
    "text_unit_b__language": "text_unit_b__language",
    "similarity": "similarity",
    "document_b__name": "document_b__name"
  }
]

Changes

Feb 9, 20223f71684c9cff Revision changes
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
May 24, 20218167164be9cc Revision changes
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status

Operation history (3 revisions)