Search / Search
Search across the platform.
Route: /api/{tenant:minlength(2)}/v{version:apiVersion}/search/search
Method: GET
Authorisation: Minimum role: USER
Response object
Response status: 200 (OK)
Response type: DTO_search_response_wrapper
Wrapper: DTO_response_wrap
Other response statuses: 400 (BadRequest), 403 (Forbidden)
Response body example
DTO_search_input
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| id_search | Int32 (nullable) | Id search | |
| debug_vector_match_threshold | Double | Debug vector match threshold | |
| debug_max_estimated_tokens | Int32 | Debug max estimated tokens | |
| debug_similarity_rejection_threshold | Double | Debug similarity rejection threshold | |
| sort_by_key | String | Sort by key | |
| response_field_keys | String[] | Response field keys | |
| filters | String[] | Filters | |
| include_aggregations | Boolean | Include aggregations | |
| include_imported | Boolean | Include imported | |
| search | String | Search | |
| sort_order | ENUM sort_order | Sort order | |
| take | Int32 | Take | |
| page | Int32 | Page |
DTO_search_response_wrapper
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| lists | DTO_search_response[] | Lists | |
| tickets | DTO_search_response[] | Tickets | |
| kbs | DTO_search_response[] | Kbs | |
| groups | DTO_search_response[] | Groups | |
| users | DTO_search_response[] | Users | |
| more_like_this | DTO_search_response[] | More like this | |
| key | String | Key | |
| status | ENUM search_status | Status | |
| gpt_applicable | Boolean | Gpt applicable | |
| additional_lists_matching | Int32 | Additional lists matching | |
| additional_tickets_matching | Int32 | Additional tickets matching | |
| additional_kbs_matching | Int32 | Additional kbs matching | |
| error_message | String | Error message | |
| debug | DTO_search_debug_response | Debug |
DTO_search_response
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| sys_status | DTO_reference | Sys status | |
| category | DTO_reference | Category | |
| group | DTO_reference | Group | |
| id | Int32 | Id | |
| title | String | Title | |
| highlight | String | Highlight | |
| additional_info | String | Additional info | |
| entity | ENUM entity | ReadOnly | Entity |
| score | Double | ReadOnly | Score |
| score_weighted | Double | ReadOnly | Score weighted |
| external_link | String | ReadOnly | External link |
| created | DateTime | Created | |
| body | String | Store the full text of the entity in plain text. |
DTO_reference
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| id | Int32 | The id of the reference | |
| label | Object | ReadOnly | Name/Label from referenced object. |
DTO_search_debug_response
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| took_explained | DTO_took[] | Took explained | |
| error_message | String | Error message | |
| chat_messages | String[] | Chat messages | |
| tokens_count_estimated | Int32 | Tokens count estimated | |
| key_phrases | String[] | Key phrases | |
| debug_messages | String[] | Debug messages |
DTO_took
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| item | String | Item | |
| took_ms | Int64 | Took ms |
ENUM entity
| Value | Name | Description |
|---|---|---|
| 0 | UNKNOWN | UNKNOWN |
| 1 | LIST | LIST |
| 2 | GROUP | GROUP |
| 3 | USER | USER |
| 4 | LIST_ENTRY | LIST_ENTRY |
| 5 | TICKET | TICKET |
| 6 | SEARCH | SEARCH |
| 7 | INVOICE | INVOICE |
| 8 | KNOWLEDGE_BASE | KNOWLEDGE_BASE |
| 9 | SCRAPED_ITEM | SCRAPED_ITEM |
| 10 | FIELD | FIELD |
| 11 | TICKET_CONVERSATION | TICKET_CONVERSATION |
| 12 | EXPORT | EXPORT |
| 13 | EXTERNAL_PRODUCT | EXTERNAL_PRODUCT |
| 14 | TEMPLATE | TEMPLATE |
ENUM sort_order
| Value | Name | Description |
|---|---|---|
| 0 | ASC | ASC |
| 1 | DESC | DESC |
ENUM search_status
| Value | Name | Description |
|---|---|---|
| 0 | UNKNOWN | UNKNOWN |
| 1 | INVALID | Invalid |
| 2 | NOT_APPLICABLE | Not applicable |
| 3 | IN_PROGRESS | In progress |
| 4 | COMPLETED | Completed |
| 5 | OTHER_SEARCH_IN_PROGRESS | Another search in progress |
| 6 | NO_DATA | No data |
| 7 | NO_ACTIVE_SEARCH | No active search |
| 8 | TIMED_OUT | Timed out |
