Sign in
analyze
v1

Project Text Unit Similarity List for ONE text unit

get/api/v1/analyze/project-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"

text_max_lengthinteger

text unit b text max length, 0 to get all text

run_idinteger

run id or text unit id required

last_runboolean

run id or last_run or text unit id required

text_unit_idinteger

run id or text unit id required

document_idinteger

document ID

location_startinteger

start of chosen text block in a Document

location_endinteger

end of chosen text block in a Document

selectionobject[]

selection coordinates

Response

document_a_namestring required
document_a_idstring
text_unit_a_idstring
text_unit_a_textstring required
text_unit_a__unit_typestring
text_unit_a__location_startstring
text_unit_a__location_endstring
document_b_namestring required
document_b_idstring
text_unit_b_idstring
text_unit_b_textstring required
text_unit_b__location_startstring
text_unit_b__location_endstring
similaritystring decimal required
run_idstring

Example response

[
  {
    "run_id": "run_id",
    "document_a_id": "document_a_id",
    "document_b_id": "document_b_id",
    "text_unit_b__location_end": "text_unit_b__location_end",
    "text_unit_b_text": "text_unit_b_text",
    "document_a_name": "document_a_name",
    "text_unit_a__unit_type": "text_unit_a__unit_type",
    "text_unit_b_id": "text_unit_b_id",
    "text_unit_a_id": "text_unit_a_id",
    "text_unit_a__location_start": "text_unit_a__location_start",
    "document_b_name": "document_b_name",
    "text_unit_a_text": "text_unit_a_text",
    "similarity": "similarity",
    "text_unit_b__location_start": "text_unit_b__location_start",
    "text_unit_a__location_end": "text_unit_a__location_end"
  }
]

Changes

Changed in 2 of the 5 revisions of this API.11