Migration Guide: Wrapper Version 1.4.0
Introduction
This guide outlines the changes introduced in version 1.4.0.
Summary of Changes
| Endpoint | Change Type | Requires Sparque Changes | Description |
|---|---|---|---|
/search /suggestions /health-check | Improvement | No | Changed keyword from API to context parameter. |
Changed 'keyword' from API Parameter to Context Parameter
Affected Endpoints
- /api/v2/search
- /api/v2/suggestions
- /api/v2/health-check
Changes
The keyword parameter provided to the SPARQUE.AI Wrapper as part of search and suggestions requests will now be forwarded to SPARQUE.AI as a context parameter, rather than as an API parameter.
This change allows you to use the keyword parameter in stacked endpoints called within the same context.
Note that the keyword parameter will not be added to all SPARQUE.AI calls made during, for example, the processing of a search request. Only those requests that previously had the keyword included as an API parameter will be affected by this change.
The health-check endpoint has been adjusted to comply with the new URL structure when running extended tests.
Required Sparque Changes
No changes are required. Existing SPARQUE.AI strategies will consume the context parameter instead of the API parameter automatically.