Explain Search Results

curl --request POST \ --url https://api.aisa.one/apis/v1/scholar/search/explain \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "search_id": "<string>", "response_mode": "COMPLETE", "language": "ar", "detail_level": "MODERATE" } '

{ "search_id": "<string>", "explanation": "<string>", "language": "<string>", "response_mode": "<string>", "summary": "<string>", "key_insights": [ "<string>" ], "confidence_score": 0.5, "generated_at": "2023-11-07T05:31:56Z" }

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

search_id

string

required

ID of the search to explain

response_mode

enum<string>

default:COMPLETE

Format of the explanation response

Available options:

COMPLETE,

SUMMARY,

BULLET_POINTS

language

string

default:en

Language code for the explanation (e.g., en, zh, ar)

Example:

"ar"

detail_level

enum<string>

default:MODERATE

Level of detail in the explanation

Available options:

BRIEF,

MODERATE,

DETAILED

Response

Successful explanation response

search_id

string

required

ID of the search being explained

explanation

string

required

Detailed explanation of the search results

language

string

Language of the explanation

response_mode

string

Format of the response

summary

string

Brief summary of the explanation

key_insights

string[]

List of key insights from the search results

confidence_score

number

Confidence score for the explanation

Required range: 0 <= x <= 1

generated_at

string<date-time>

Timestamp when the explanation was generated