Sign in

v1

latestOpenAPI 3.0.22026-07-17373198641.7 KB
document
v1

Re-use ProjectDocumentSimilarityListAPIView to get similarities as resource for this API is not Document model, but DocumentSimilarity

get/api/v1/document/documents/{id}/similar/

Path parameters

idstring required

A unique integer value identifying this document.

Query parameters

text_max_lengthinteger

document b text max length, 0 to get all text

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_namestring required
document_a_idstring
document_b_namestring required
document_b_idstring
document_b_textstring required
similaritystring decimal required
run_idstring

Example response

{
  "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"
}