modelpackage.h File Reference

Product-owned model package manifest and validated package value types. More...

#include "transcription/transcriptiontypes.h"
#include <QJsonObject>
#include <optional>
#include <vector>

Go to the source code of this file.

Classes
struct	ModelCompatibilityMarker
	One engine/model-format compatibility marker recorded in a package manifest. More...
struct	ModelAssetMetadata
	One packaged asset entry recorded in a package manifest. More...
struct	ModelPackageManifest
	Product-owned manifest data parsed from model.json. More...
struct	ValidatedModelPackage
	Fully validated model package resolved from disk. More...

Functions
QString	cpuReferenceEngineName ()
	Stable engine identifier for the native CPU reference runtime.
QString	cpuReferenceModelFormat ()
	Stable model-format identifier for the native CPU reference runtime.
QString	legacyWhisperEngineName ()
	Stable engine identifier for the legacy whisper.cpp adapter.
QString	legacyWhisperModelFormat ()
	Stable model-format identifier for the legacy whisper.cpp adapter.
bool	modelPackageSupportsCompatibility (const ModelPackageManifest &manifest, QStringView engine, QStringView modelFormat)
	Reports whether a manifest advertises compatibility with a runtime marker pair.
QString	defaultModelPackageDirectory ()
	Returns the default root directory for native model packages.
QString	sanitizePackageId (const QString &value)
	Normalizes a human-provided package id into a stable filesystem-safe form.
QJsonObject	modelPackageManifestToJson (const ModelPackageManifest &manifest)
	Serializes a product-owned package manifest to JSON.
std::optional< ModelPackageManifest >	modelPackageManifestFromJson (const QJsonObject &root, QString *errorMessage=nullptr)
	Parses a product-owned package manifest from JSON.

Detailed Description

Product-owned model package manifest and validated package value types.

Definition in file modelpackage.h.

Function Documentation

cpuReferenceEngineName()

QString cpuReferenceEngineName

(

)

Stable engine identifier for the native CPU reference runtime.

Returns

Product-owned engine marker recorded in package manifests.

cpuReferenceModelFormat()

QString cpuReferenceModelFormat

(

)

Stable model-format identifier for the native CPU reference runtime.

Returns

Product-owned model-format marker recorded in package manifests.

defaultModelPackageDirectory()

QString defaultModelPackageDirectory

(

)

Returns the default root directory for native model packages.

Returns

Default package directory under the app data root.

legacyWhisperEngineName()

QString legacyWhisperEngineName

(

)

Stable engine identifier for the legacy whisper.cpp adapter.

Returns

Legacy engine marker recorded in package manifests.

legacyWhisperModelFormat()

QString legacyWhisperModelFormat

(

)

Stable model-format identifier for the legacy whisper.cpp adapter.

Returns

Legacy model-format marker recorded in package manifests.

modelPackageManifestFromJson()

std::optional< ModelPackageManifest > modelPackageManifestFromJson	(	const QJsonObject &	root,
		QString *	errorMessage = nullptr
	)

Parses a product-owned package manifest from JSON.

Parameters

root	JSON object read from model.json.
errorMessage	Optional destination for parse failures.

Returns

Parsed manifest on success.

modelPackageManifestToJson()

QJsonObject modelPackageManifestToJson

(

const ModelPackageManifest &

manifest

)

Serializes a product-owned package manifest to JSON.

Parameters

manifest

Manifest value to serialize.

Returns

JSON object suitable for writing to model.json.

modelPackageSupportsCompatibility()

bool modelPackageSupportsCompatibility	(	const ModelPackageManifest &	manifest,
		QStringView	engine,
		QStringView	modelFormat
	)

Reports whether a manifest advertises compatibility with a runtime marker pair.

Parameters

manifest	Parsed model package manifest.
engine	Stable engine identifier to match.
modelFormat	Stable model-format marker to match.

Returns

true when the manifest contains a matching compatibility marker.

sanitizePackageId()

QString sanitizePackageId

(

const QString &

value

)

Normalizes a human-provided package id into a stable filesystem-safe form.

Parameters

value

Raw package id or display string.

Returns

Lowercase sanitized package id.