All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to the Semantic Versioning.
- A new
webWorkerScript
asset type that points to the web worker script. The complete URL (base URL + URL suffix) needs to be passed as aString
via the assets map to theSetupData
. - On web XaynAI runs in a web-worker.
- Every method/static function of
XaynAI
throws aTimeoutException
if the web worker does not respond within 15 seconds. (see #290)
wasmScript
no longer needs to be injected into the HTML document. The complete URL (base URL + URL suffix) needs to be passed as aString
via the assets map to theSetupData
.
- The multi-thread version of XaynAI runs in a multi-threading capable browser.
- AI data is synchronizable between devices via the new functions
syncdata_bytes
andsynchronize
. - Add multi-threading support: Parallelism is always enabled for mobile targets and can optionally be enabled for web targets.
An optional set of
Feature
s is introduced to pick the assets for the chosen target during the setup (seegetInputData()
in the example).Feature
are currently only supported on the web: the caller needs to pass the set of available features on the browser to thegetAssets
function and the library automatically returns the most suitable WASM assets for the given features. For the AI to run in parallel on the web it is required that it runs on a WebWorker. - Add methods to instantiate the AI from a state:
restore
. - All methods of
XaynAi
have been made asynchronous. - The
RerankMode
s ofXaynAi.rerank()
have been extended with unpersonalized variants. - MAB system is not executed anymore. Only the context value is used instead to rank the documents.
- For standard search QA-mBert is used to rerank.
- The AI does not fail at the first error but try to rerank the documents with the remaining systems.
- The method
create
does not accept anymore a serialized state and it can only be used to create a clean AI.
- Removed the optional
features
parameter in theSetupData
constructor. - Removed the
wasmParallelX
AssetType
s. Both parallel and sequential WASM assets share now the sameAssetType
(wasmModule
/wasmScript
).
- Allow
query_count
s starting with 0, if possible they now also should start with 0.
- Outsourcing of ai assets. The assets are no longer part of the library. See #94 for more information about the API changes.
XaynAi.rerank
takes as parameterRerankMode
that allows to specify if we are reranking news or results from a search.- Assets for releases on the
staging
branch are uploaded to a S3 bucket (https://xayn_ai_staging_assets.s3-de-central.profitbricks.com
). - Renamed
Feedback
toUserFeedback
andHistory.feedback
toHistory.userFeedback
. - Use keyword arguments for
Document
/History
constructors. XainAi
is initialized with an additional parameter to support the domain reranker.- Assets for releases on the
release
branch are uploaded to KeyCDN. - The token size of smbert has been decreased to
52
.
The first release of oxidized XAYN AI.