Sign in

v1

latestOpenAPI 3.0.22026-07-17373198641.7 KB
similarity
v1

"Similarity" admin task

POST params: - project_id: int - distance_type: str - see scipy.spatial.distance._METRICS - similarity_threshold: int - feature_source: "vector" - create_reverse_relations: bool - create B-A relations - item_id: int - use_tfidf: bool - delete: bool

post/api/v1/similarity/project-documents-similarity-by-vectors/

Request body

run_namestring required
similarity_thresholdinteger nullable
projectinteger required
feature_sourcestring nullable
distance_type'braycurtis' | 'canberra' | 'chebyshev' | 'cityblock' | 'correlation' | 'cosine' | 'dice' | 'euclidean' | 'hamming' | 'jaccard' | 'jensenshannon' | 'kulsinski' | 'kulczynski1' | 'mahalanobis' | 'minkowski' | 'rogerstanimoto' | 'russellrao' | 'seuclidean' | 'sokalmichener' | 'sokalsneath' | 'sqeuclidean' | 'yule' nullable
item_idinteger required
create_reverse_relationsboolean required
use_tfidfboolean required
deleteboolean required

Example request

{
  "use_tfidf": true,
  "feature_source": "vector",
  "distance_type": "cosine",
  "item_id": 1,
  "similarity_threshold": 0,
  "project": 6,
  "run_name": "run_name",
  "create_reverse_relations": true,
  "delete": true
}

Response

detailstring required
task_idstring
confirmboolean

Example response

{
  "confirm": true,
  "task_id": "task_id",
  "detail": "detail"
}