Generate Answer | Hitchhikers

Answer: Generate

Leverages large language models (LLMs) to deliver generated summaries based on search results.

This endpoint works with the Universal/Vertical Search endpoint, which provides the search results for the LLM to analyze and generate direct answers.

path Parameters

accountId

required

string

query Parameters

v required	string A date in `YYYYMMDD` format.
experienceKey required	string String key that uniquely identifies the Search experience.
locale required	string The locale code of the experience (e.g. `en_GB`). Only returns entities that have an entity profile associated with this locale.

Request Body schema: application/json

JSON object containing the search results and user query to generate an answer.

searchId required	string ID of the search associated to the results.
searchTerm required	string The search term that was used to generate results.
required	object or object

Responses

Request samples

Payload

Content type

application/json

{"searchId": "string",
"searchTerm": "string",
"results": {"verticalConfigId": "string",
"resultCount": 0,
"encodedState": "string",
"results": [{"data": { },
"highlightedFields": { },
"distance": 0,
"distanceFromFilter": 0
}
],
"appliedQueryFilters": [{"displayKey": "string",
"displayValue": "string",
"filter": "c_exampleFieldId: { $eq\": \"Search\" }\n",
"type": "FIELD_VALUE",
"details": { }
}
]
}
}

Response samples

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"directAnswer": "string",
"resultStatus": "string",
"citations": ["string"
]
}
}