Search / Search gpt
Get GPT response initiated by the regular search
Route: /api/{tenant:minlength(2)}/v{version:apiVersion}/search/search_gpt
Method: GET
Authorisation: Minimum role: USER
Request Arguments
| Name | Type | Source |
|---|---|---|
| key | String | Query |
Request body example
Response object
Response status: 200 (OK)
Response type: DTO_search_response_gpt_wrapper
Wrapper: DTO_response_wrap
Other response statuses: 400 (BadRequest), 403 (Forbidden)
Response body example
DTO_search_response_gpt_wrapper
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| response | String | Response | |
| error_message | String | Error message | |
| status | ENUM search_status | Status | |
| debug | DTO_search_gpt_debug_response | Debug |
DTO_search_gpt_debug_response
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| took_explained | DTO_took[] | Took explained | |
| error_message | String | Error message | |
| tokens_count_input | Int32 | Tokens count input | |
| tokens_count_completion | Int32 | Tokens count completion | |
| debug_messages | String[] | Debug messages |
DTO_took
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| item | String | Item | |
| took_ms | Int64 | Took ms |
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 |
