Sign in
project
v1

post/api/v1/project/projects/{id}/search_similar_text_units/

Path parameters

idstring required

A unique integer value identifying this project.

Request body

run_namestring
distance_type'braycurtis' | 'canberra' | 'chebyshev' | 'cityblock' | 'correlation' | 'cosine' | 'dice' | 'euclidean' | 'hamming' | 'jaccard' | 'jensenshannon' | 'kulsinski' | 'kulczynski1' | 'mahalanobis' | 'minkowski' | 'rogerstanimoto' | 'russellrao' | 'seuclidean' | 'sokalmichener' | 'sokalsneath' | 'sqeuclidean' | 'yule'
similarity_thresholdinteger
create_reverse_relationsboolean
use_tfidfboolean
deleteboolean
item_idinteger
unit_type'sentence' | 'paragraph'
document_idinteger
location_startinteger
location_endinteger

Example request

{
  "use_tfidf": false,
  "location_start": 5,
  "distance_type": "cosine",
  "item_id": 6,
  "similarity_threshold": 0,
  "location_end": 5,
  "unit_type": "sentence",
  "document_id": 1,
  "run_name": "run_name",
  "create_reverse_relations": true,
  "delete": true
}

Response

task_idstring uuid required

Example response

{
  "task_id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Changes

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

  • 3429f921b4cb33See the full diff
    • ▲

      removed the enum value wminkowski of the request property distance_type (media type: application/json)

      request-property-enum-value-removed

    • ▲

      removed the enum value wminkowski of the request property distance_type (media type: application/x-www-form-urlencoded)

      request-property-enum-value-removed

    • ▲

      removed the enum value wminkowski of the request property distance_type (media type: multipart/form-data)

      request-property-enum-value-removed

    • ○

      added the new kulczynski1 enum value to the request property distance_type (media type: application/json)

      request-property-enum-value-added

    • ○

      added the new kulczynski1 enum value to the request property distance_type (media type: application/x-www-form-urlencoded)

      request-property-enum-value-added

    • ○

      added the new kulczynski1 enum value to the request property distance_type (media type: multipart/form-data)

      request-property-enum-value-added

    This revision also has 18 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8167164be9cc1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 0957c4a7ae3d1See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 63 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog