Performs an AI-powered search that streams results as NDJSON. The response contains multiple objects that are progressively enhanced as the search and AI processing pipeline completes.
This is a BETA API -- This API may change unexpectedly.
In this api, you can ask a question and the Happeo Search AI will try to find an answer based on the data that is inside Happeo. The api response is a stream providing updates on the thinking process.
This api is only accessible with an OAuth 2.0 client. It responds with an ndjson stream.
The api expects these headers:
- Authorization: Bearer your_access_token
- Accept: application/x-ndjson
Response
The AI Search API streams ndjson with multiple different objects that are added to the response during the streaming process. The final response object contains all objects before it, so you can rely on the last ndjson chunk to contain all the information.
Response parts
sessionId - This contains a unique id to identify the AI session
searchId - This contains a unique id to identify the search session
queryAnalysis - This contains an analysis of the query. It hold information like date filters, query fixes, intent analysis and other similar fields.
searchResults - This contains the retrieval with all the search results & context.
resultsEvaluation - This contains a filtered list of search results where a potential answer can be found.
answer - This contains the AI answer and related fields.
answerEvaluation - This contains an AI evaluation of the answer.