---
title: "GET /api/v1/analyze/text-unit-similarity/list/"
method: GET
path: "/api/v1/analyze/text-unit-similarity/list/"
tags: ["analyze", "v1"]
---

# GET /api/v1/analyze/text-unit-similarity/list/

`GET /api/v1/analyze/text-unit-similarity/list/`

Base Text Unit Similarity List

## Query parameters

- `jq_filters` object

## Response `200`

- TextUnitSimilarity[]
  - `text_unit_a_id` string
  - `text_unit_a__unit_type` string
  - `text_unit_a__language` string
  - `text_unit_a__text` string
  - `document_a_id` string
  - `document_a__name` string
  - `text_unit_b_id` string
  - `text_unit_b__unit_type` string
  - `text_unit_b__language` string
  - `text_unit_b__text` string
  - `document_b_id` string
  - `document_b__name` string
  - `similarity` string, decimal, required
  - `run` DocumentSimilarityRun
    - `id` integer
    - `project_id` string
    - `feature_source` string, nullable
    - `unit_source` string, nullable
    - `unit_type` string, nullable
    - `unit_id` integer, nullable
    - `items_count` integer, required
    - `created_by` integer, nullable
    - `created_date` string, date-time

## Changes

- **2022-02-09** `3f71684c9cff` — 2 warning, 2 info
  - removed the optional property `items/text_unit_a__textunittext__text` from the response with the `200` status
  - removed the optional property `items/text_unit_b__textunittext__text` from the response with the `200` status
  - added the optional property `items/text_unit_a__text` to the response with the `200` status
  - added the optional property `items/text_unit_b__text` to the response with the `200` status
- **2021-05-24** `8167164be9cc` — 7 warning, 7 info
  - removed the optional property `items/pk` from the response with the `200` status
  - removed the optional property `items/text_unit_a__document__name` from the response with the `200` status
  - removed the optional property `items/text_unit_a__document__pk` from the response with the `200` status
  - removed the optional property `items/text_unit_a__pk` from the response with the `200` status
  - …10 more
- **2020-12-11** `0957c4a7ae3d` — 9 warning, 9 info
  - removed the optional property `items/document_a__name` from the response with the `200` status
  - removed the optional property `items/document_a_id` from the response with the `200` status
  - removed the optional property `items/document_b__name` from the response with the `200` status
  - removed the optional property `items/document_b_id` from the response with the `200` status
  - …14 more

[Change history](https://skmtc.dev/lexpredict/apis/contraxsuite-api/changes/api/v1/analyze/text-unit-similarity/list/get.md)

---

[API](https://skmtc.dev/lexpredict/apis/contraxsuite-api.md) · [All operations](https://skmtc.dev/lexpredict/apis/contraxsuite-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/lexpredict/contraxsuite-api/revisions/3429f921b4cb/schema)