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

analyze

Base Text Unit Similarity List

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

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

Changed in 3 of the 5 revisions of this API.1818

Feb 9, 20223f71684c9cff22See the full diff
- ●
  removed the optional property items/text_unit_a__textunittext__text from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property items/text_unit_b__textunittext__text from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property items/text_unit_a__text to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/text_unit_b__text to the response with the 200 status
  response-optional-property-added
May 24, 20218167164be9cc77See the full diff
- ●
  removed the optional property items/pk from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property items/text_unit_a__document__name from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property items/text_unit_a__document__pk from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property items/text_unit_a__pk from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property items/text_unit_b__document__name from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property items/text_unit_b__document__pk from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property items/text_unit_b__pk from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property items/document_a__name to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/document_a_id to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/document_b__name to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/document_b_id to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/run to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/text_unit_a_id to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/text_unit_b_id to the response with the 200 status
  response-optional-property-added
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Dec 11, 20200957c4a7ae3d99See the full diff
- ●
  removed the optional property items/document_a__name from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property items/document_a_id from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property items/document_b__name from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property items/document_b_id from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property items/run from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property items/text_unit_a__text from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property items/text_unit_a_id from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property items/text_unit_b__text from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property items/text_unit_b_id from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property items/pk to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/text_unit_a__document__name to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/text_unit_a__document__pk to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/text_unit_a__pk to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/text_unit_a__textunittext__text to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/text_unit_b__document__name to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/text_unit_b__document__pk to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/text_unit_b__pk to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/text_unit_b__textunittext__text to the response with the 200 status
  response-optional-property-added
This revision also has 63 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history