v1

latestOpenAPI 3.0.22026-07-17373198641.7 KB
analyze
v1

Project Document Similarity List for ONE document

get/api/v1/analyze/project-document-similarity/list/

Query parameters

text_max_lengthinteger

document b text max length, 0 to get all text

run_idinteger

run id or document id required

document_idinteger

run id or document id required

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

document_a_idinteger nullable
document_a_namestring nullable
total_recordsinteger

Example response

{
  "data": [
    {
      "document_b_name": "document_b_name",
      "run_id": "run_id",
      "document_a_id": "document_a_id",
      "document_b_id": "document_b_id",
      "similarity": "similarity",
      "document_a_name": "document_a_name",
      "document_b_text": "document_b_text"
    },
    {
      "document_b_name": "document_b_name",
      "run_id": "run_id",
      "document_a_id": "document_a_id",
      "document_b_id": "document_b_id",
      "similarity": "similarity",
      "document_a_name": "document_a_name",
      "document_b_text": "document_b_text"
    }
  ],
  "document_a_id": 0,
  "document_a_name": "document_a_name",
  "total_records": 6
}