---
title: "Returns similar sentences according to a textual or visual query."
method: POST
path: "/simsearch/sentences"
tags: ["simsearch"]
---

# Returns similar sentences according to a textual or visual query.

`POST /simsearch/sentences`

## Query parameters

- `proj_id` integer, required
- `top_k` integer, required
- `threshold` number, required

## Request body

- BodySimsearchFindSimilarSentences
  - `query` union, required
    - string
    - string[]
    - integer
  - `filter` FilterSdocColumnsInput, required
    - `id` string, required
    - `items` union[], required
      - union
        - FilterExpressionSdocColumns
          - `id` string, required
          - `column` union, required
            - 'SD_SOURCE_DOCUMENT_TYPE' | 'SD_SOURCE_DOCUMENT_NAME' | 'SD_TAG_ID_LIST_RECURSIVE' | 'SD_CODE_ID_LIST_RECURSIVE' | 'SD_FOLDER_ID_LIST_RECURSIVE' | 'SD_USER_ID_LIST' | 'SD_SPAN_ANNOTATIONS'
            - integer
          - `operator` union, required
            - 'ID_EQUALS' | 'ID_NOT_EQUALS'
            - 'NUMBER_EQUALS' | 'NUMBER_NOT_EQUALS' | 'NUMBER_GT' | 'NUMBER_LT' | 'NUMBER_GTE' | 'NUMBER_LTE'
            - 'STRING_CONTAINS' | 'STRING_EQUALS' | 'STRING_NOT_EQUALS' | 'STRING_STARTS_WITH' | 'STRING_ENDS_WITH'
            - 'ID_LIST_CONTAINS' | 'ID_LIST_NOT_CONTAINS'
            - 'IDLR_CONTAINS' | 'IDLR_NOT_CONTAINS' | 'IDLR_CONTAINS_RECURSIVE'
            - 'LIST_CONTAINS' | 'LIST_NOT_CONTAINS'
            - 'DATE_EQUALS' | 'DATE_GT' | 'DATE_LT' | 'DATE_GTE' | 'DATE_LTE'
            - 'BOOLEAN_EQUALS' | 'BOOLEAN_NOT_EQUALS'
          - `value` union, required
            - boolean
            - string
            - integer
            - string[]
            - array[]
              - …
        - FilterSdocColumnsInput — recursive
    - `logic_operator` 'or' | 'and', required — This tells our filter how to combine multiple column expressions.

## Response `200`

Successful Response

- SimSearchSentenceHit[]
  - `sdoc_id` integer, required — The ID of the SourceDocument similar to the query.
  - `score` number, required — The similarity score.
  - `sentence_id` integer, required — The sentence id with respect to the SourceDocument

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/uhh-lt/apis/discourse-analysis-tool-suite-api.md) · [All operations](https://skmtc.net/uhh-lt/apis/discourse-analysis-tool-suite-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/uhh-lt/discourse-analysis-tool-suite-api/revisions/6b22366ce2d1/schema)