lucretia/embeddingsearch
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added runonce to the documentation; added information about the necessary functions

Browse Source
This commit is contained in:
LD-Reborn
2025-08-23 17:16:17 +02:00
parent ca56a66713
commit 1e4d3dceb8
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/Indexer.md
View File

@@ -54,6 +54,10 @@ If you just installed the server and want to configure it:
} }
``` ```
## Call types ## Call types
- `runonce`
- What does it do: The script gets called once at startup. Use this if you need a main loop.
- (Remember the call runs in `update()` like the others!)
- Parameters: None
- `interval` - `interval`
- What does it do: The script gets called periodically based on the specified `Interval` parameter. - What does it do: The script gets called periodically based on the specified `Interval` parameter.
- Parameters: - Parameters:
@@ -68,6 +72,13 @@ If you just installed the server and want to configure it:
- Path (e.g. "Scripts/example_content") - Path (e.g. "Scripts/example_content")
# Scripting # Scripting
## General ## General
Scripts need to define the following functions:
- `init()`
- Is run at startup. Put all initialization code here.
- Do not put a main loop here! Might cause other workers not to initialize and other unintended behavior!
- `update()`
- Is called by the calls as specified in [Call types](#call-types)
- A main loop might work best here using the `runonce` call
## probMethods ## probMethods
Probmethods are used to join the multiple similarity values from multiple models and multiple datapoints into one single result. Probmethods are used to join the multiple similarity values from multiple models and multiple datapoints into one single result.