Sign in
similarity
v1

"Similarity" admin task

POST params: - similarity_threshold: int - use_tfidf: bool - delete: bool - project: int - feature_source: list - list[date, definition, duration, court, currency_name, currency_value, term, party, geoentity] - distance_type: str - see scipy.spatial.distance._METRICS

post/api/v1/similarity/document-similarity-by-features/

Request body

run_namestring required
similarity_thresholdinteger nullable
projectinteger required
feature_source'date' | 'definition' | 'duration' | 'court' | 'currency_name' | 'currency_value' | 'term' | 'party' | 'geoentity' 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": "term",
  "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"
}

Changes

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

  • 3429f921b4cb333See the full diff
    • ▲

      the request property create_reverse_relations became not nullable (media type: application/json)

      request-property-became-not-nullable

    • ▲

      the request property create_reverse_relations became not nullable (media type: application/x-www-form-urlencoded)

      request-property-became-not-nullable

    • ▲

      the request property create_reverse_relations became not nullable (media type: multipart/form-data)

      request-property-became-not-nullable

    • ▲

      the request property delete became not nullable (media type: application/json)

      request-property-became-not-nullable

    • ▲

      the request property delete became not nullable (media type: application/x-www-form-urlencoded)

      request-property-became-not-nullable

    • ▲

      the request property delete became not nullable (media type: multipart/form-data)

      request-property-became-not-nullable

    • ▲

      the request property item_id became not nullable (media type: application/json)

      request-property-became-not-nullable

    • ▲

      the request property item_id became not nullable (media type: application/x-www-form-urlencoded)

      request-property-became-not-nullable

    • ▲

      the request property item_id became not nullable (media type: multipart/form-data)

      request-property-became-not-nullable

    • ▲

      the request property run_name became not nullable (media type: application/json)

      request-property-became-not-nullable

    • ▲

      the request property run_name became not nullable (media type: application/x-www-form-urlencoded)

      request-property-became-not-nullable

    • ▲

      the request property run_name became not nullable (media type: multipart/form-data)

      request-property-became-not-nullable

    • ▲

      the request property use_tfidf became not nullable (media type: application/json)

      request-property-became-not-nullable

    • ▲

      the request property use_tfidf became not nullable (media type: application/x-www-form-urlencoded)

      request-property-became-not-nullable

    • ▲

      the request property use_tfidf became not nullable (media type: multipart/form-data)

      request-property-became-not-nullable

    • ▲

      the request property create_reverse_relations became required (media type: application/json)

      request-property-became-required

    • ▲

      the request property create_reverse_relations became required (media type: application/x-www-form-urlencoded)

      request-property-became-required

    • ▲

      the request property create_reverse_relations became required (media type: multipart/form-data)

      request-property-became-required

    • ▲

      the request property delete became required (media type: application/json)

      request-property-became-required

    • ▲

      the request property delete became required (media type: application/x-www-form-urlencoded)

      request-property-became-required

    • ▲

      the request property delete became required (media type: multipart/form-data)

      request-property-became-required

    • ▲

      the request property item_id became required (media type: application/json)

      request-property-became-required

    • ▲

      the request property item_id became required (media type: application/x-www-form-urlencoded)

      request-property-became-required

    • ▲

      the request property item_id became required (media type: multipart/form-data)

      request-property-became-required

    • ▲

      the request property run_name became required (media type: application/json)

      request-property-became-required

    • ▲

      the request property run_name became required (media type: application/x-www-form-urlencoded)

      request-property-became-required

    • ▲

      the request property run_name became required (media type: multipart/form-data)

      request-property-became-required

    • ▲

      the request property use_tfidf became required (media type: application/json)

      request-property-became-required

    • ▲

      the request property use_tfidf became required (media type: application/x-www-form-urlencoded)

      request-property-became-required

    • ▲

      the request property use_tfidf became required (media type: multipart/form-data)

      request-property-became-required

    • ▲

      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