API Version Release Notes

Version 2025-02-27

New Features

• Added the ability for users to control the advancedExplainability flag in RikAI2. This flag determines whether the full context is included in the response.
  • When advancedExplainability is set to false, the model processes requests more quickly but does not include the full context.
  • When advancedExplainability is set to true, the full context is included in the response.
  Previously, advancedExplainability defaulted to true (full context included by default). The default is now set to false (no full context by default).
• The returnJSON field now defaults to true instead of false.
  • When set to true, the outputURL will return a JSON file instead of a ZIP file.

Bug Fixes

• Resolved an issue with supporting Chinese translation.

General Improvements

• Improved processing efficiency for lower latency and faster API responses.
• Enhanced system reliability, logging accuracy, and code maintainability.

---

Version 2025-02-13

Improvements

• The outputURL parameter is no longer a required field. Webhook or outputURL is required to receive the model output.

Bug Fixes

• Resolved inaccuracies in page and question count metrics.
• Requests to RikAI2 will not receive OCR results when the returnOCR parameter is set to false.

---

Version 2025-02-06

New Features

• API Versioning
  • If you want to send a request to a specific API Version, you will have to define the apiVersion header. See how to here: How to Use API Versioning.
  • If you want the latest API version always, do not specify apiVersion. Your request will default to the latest API version.
  • You will see the apiVersion field with the date of the latest API version in your response body, response headers, and webhook data. This date will update as new API versions are released.
  • API versions are backwards compatible.