Deriving conclusions through inquiry - Chat AI

Endpoint

POST /v1/ai_chat/infer_conclusion_from_question

Try it out in API Playground →arrow-up-right

Description

This API provides the ability to chat with AI by analyzing the language of user's question, breaking it down into multiple sub-questions, and summarizing relevant information. It aims to assist users in quickly obtaining key insights and conclusions related to their inquiries.


Request

Headers

Name
Type
Required
Description

Content-Type

string

Yes

application/json

X-API-KEY

string

Yes

Your API key

Request Body Parameters

Parameter
Type
Required
Description

question

string

Yes

The question posed by the user

report_type_list

array[string]

No

List of report types to narrow down search results

start_date

string

No

Start date for the search, formatted as YYYY-MM-DD

end_date

string

No

End date for the search, formatted as YYYY-MM-DD

market

array[string]

No

List of markets to filter search results

sector_list

array[string]

No

List of sectors to narrow down search results

exchange_list

array[string]

No

List of exchanges to filter search results

country_list

array[string]

No

List of countries to narrow down search results

Note: Options for market, exchange_list, country_list, and sector_list are included in Appendix B: Metainfo.

Note: Options for market, exchange_list, country_list, and sector_list are included in Appendix B: Metainfo.

Example Request


Response

Response Fields

Top-Level Fields

Field
Type
Description

status_code

integer

HTTP status code (200 for success)

data

object

Container object holding AI analysis results

message

string

Response status message

Data Object

Field
Type
Description

sub_question_list_results

array

Array of sub-questions and their corresponding AI-generated answers

reports_list

array

List of relevant reports referenced in the analysis

summary

string

Comprehensive summary synthesizing all sub-question answers

Sub-Question Result Object (data.sub_question_list_results[])

Field
Type
Description

sub_question

string

A decomposed sub-question derived from the main query

sub_answer

string

AI-generated answer to the specific sub-question

Report Object (data.reports_list[])

Field
Type
Description

report_id

string

Unique identifier for the report

file_hash

string

Hash value of the report file

es_score

float

Elasticsearch relevance score

report_title

string

Title of the report

snippet

string

Relevant text excerpt from the report

report_type_id_list

array[string]

List of report type IDs

attachment_id

string

Unique identifier for the attachment

page

integer

Page number where the relevant information is found

perm_id_list

array[string]

List of permanent entity identifiers

report_url

string

S3 URL path to the report file

reported_at

string

Date when the report was published, formatted as YYYY-MM-DD

Example Response

Error Handling

All endpoints follow the standard error response format. When an error occurs, the API returns an appropriate HTTP status code along with a structured error response.

For detailed information about error codes, response formats, and troubleshooting guidelines, please refer to Appendix A: Error Code Reference.

Last updated