fc-plugin-codbi/com.github.xima_formcycle_entwicklerkreis.fc.plugin.codbi.logic.cb.ai/Whisper

Whisper

Transcripts speech to text via a Whisper-Server.

Domains to whitelist

github.com — whisper-server binary releases (ggml-org/whisper.cpp) & ffmpeg (BtbN/FFmpeg-Builds)
objects.githubusercontent.com — GitHub release asset CDN
huggingface.co — Whisper GGML model downloads

DSGVO / GDPR Compliance

All audio data is processed locally on the server (using a local server only). No data is transmitted to any cloud service (Google, Microsoft, OpenAI, etc.). This makes it the ideal solution for organizations that require DSGVO-compliant speech recognition.

Plugin Properties

Property	Type	Default	Description
`Active_AI`	String	—	Must contain `whisper` to activate
`AI_Remove`	—	—	If contains `whisper`, clean up all whisper files
`AI_Whisper_ModelUrl`	URL	ggml-small	GGML model URL. Alternatives: ggml-base, ggml-medium, ggml-large-v3-turbo-q5_0
`AI_Whisper_Port`	Int	`8393`	Local port for whisper-server
`AI_Whisper_Release`	String	`v1.7.6`	whisper.cpp release tag for binary downloads
`AI_Whisper_ReleaseBaseUrl`	URL	GitHub release	Base URL prefix used to download whisper.cpp release assets (release tag is appended automatically).
`AI_Whisper_NoGpu`	Bool	`false`	Set `true` to disable GPU and force CPU-only
`AI_Whisper_Threads`	Int	physical cores	CPU threads for whisper-server
`AI_Whisper_MaxRAMPercent`	Double	`101.0`	RAM usage threshold (%) — blocks requests when exceeded
`AI_Whisper_MaxComputePercent`	Double	`101.0`	Compute usage threshold (%) — gates on GPU% (CUDA) or CPU% (fallback). Blocks requests when exceeded
`AI_Whisper_MaxCPUPercent`	Double	—	Legacy alias for MaxComputePercent (accepted as fallback)
`AI_Whisper_ExternalUrl`	URL	—	Base URL of an OpenAI-compatible speech-to-text API (e.g. `https://api.openai.com`). When set, the local whisper-server is NOT started.
`AI_Whisper_ExternalApiKey`	String	—	Bearer token / API key for the external API.
`AI_Whisper_ExternalModel`	String	`whisper-1`	Model name to send in the `model` field of the external API request.

Constructors

Whisper

constructor()

Types

Companion

object Companion

Functions

execute

open override fun execute(params: IPluginServletActionParams): IPluginServletActionRetVal

getDescription

open fun ~~getDescription~~(): String

open fun getDescription(p0: Locale): String

getDisplayName

open override fun getDisplayName(p0: Locale): String

getName

open override fun getName(): String

States the Name of this AI.

initialize

open override fun initialize(configData: IPluginInitializeData)

Initializes the AI components by reading configuration properties. Specifically, it acquires the msExpirationIDedImages from the plugin property "AI_CachedImageExpiration". Subclasses should call this method at the beginning of their own initialize implementation.

initPlugin

open fun ~~initPlugin~~()

install

open fun install(p0: IPluginInstallData)

shutdown

open override fun shutdown(shutdownData: IPluginShutdownData?)

Shuts down the Whisper module — stops the resource monitor, kills the whisper-server process, and resets readiness state.

open fun ~~shutdown~~()

startJanitor

fun startJanitor()

Initiates a task that removes unused images that're expired (msExpirationIDedImages) from the cache (cacheIDedImages).

uninstall

open fun uninstall(p0: IPluginUninstallData)

validateConfigurationData

open override fun validateConfigurationData(configData: IPluginValidationData): IPluginInitializeValidationResult?

Rejects tenant-level installation. CodBi must be installed as a system plugin because its AI services (Whisper, LLAMA) bind local server ports and manage heavyweight processes that would conflict when instantiated once per tenant.