Manage transcription models and transcription model aliases. Transcription models represent the underlying transcription engines, while transcription model aliases provide stable, user-facing identifiers that resolve to specific transcription model versions.
Whether the transcription model supports automatic language detection. Default: false.
supportsStreaming
boolean
No
Whether the transcription model supports streaming transcription. Default: false. At least one of supportsStreaming or supportsBatch must be true.
supportsBatch
boolean
No
Whether the transcription model supports batch (offline) transcription. Default: false. At least one of supportsStreaming or supportsBatch must be true.
supportsPunctuation
boolean
No
Whether the engine provides punctuation and capitalization. Default: false.
supportsDiarization
boolean
No
Whether the engine provides speaker diarization. Default: false.
supportsItn
boolean
No
Whether the engine provides inverse text normalization. Default: false. When true, the engine always produces normalized output regardless of the user's inverseTextNormalization setting.
itnDomain
string
No
ITN domain identifier (e.g., HEB_GEN, HEB_MED). When set on a model that does not have built-in ITN (supportsItn: false), users can request ITN via the inverseTextNormalization option.
importrequestsresp=requests.post("https://koldan.dixilang.com/api/v1/speech-services/admin/models",headers={"Authorization":f"Bearer {JWT}"},json={"name":"koldan-he-medical-v2.1","displayName":"Koldan Hebrew Medical v2.1","backendType":"INTERNAL","internal":{"discoveryServiceName":"koldan-engine-k2"},"engineType":"K2","supportedLanguages":["he"],"supportsStreaming":True,"supportsBatch":True})print(resp.json())
{"model":"koldan-he-medical-v2.1","backendType":"INTERNAL","status":"AVAILABLE","checks":[{"name":"engine_type_configured","passed":true,"detail":"Engine type: K2"},{"name":"discovery_service_name","passed":true,"detail":"Discovery service name: koldan-engine-k2"},{"name":"engine_discovery","passed":true,"detail":"Engine instance found at 10.0.1.5:50051"}]}
Creates a new transcription model alias or updates an existing one. The alias maps a stable user-facing identifier to a specific transcription model version.
Marks a transcription model alias as deprecated with an optional sunset date. Deprecated aliases continue to function but clients receive deprecation warnings.
Removes the deprecated status from a transcription model alias, clearing the deprecation date, sunset date, and deprecation message. The alias becomes fully active again.
Whether the transcription model alias is deprecated.
deprecationDate
string (date)
Date when the alias was deprecated.
deprecationMessage
string
Deprecation message.
ModelCapabilitiesResponse
Field
Type
Description
languages
string[]
Supported BCP-47 language codes.
supportsLangAutodetect
boolean
Whether the transcription model supports automatic language detection.
supportsStreaming
boolean
Whether the transcription model supports streaming transcription.
supportsBatch
boolean
Whether the transcription model supports batch (offline) transcription.
supportsPunctuation
boolean
Whether the engine provides punctuation and capitalization.
supportsDiarization
boolean
Whether the engine provides speaker diarization.
supportsItn
boolean
Whether the engine provides inverse text normalization.
itnDomain
string
ITN domain identifier for inverse text normalization.
CreateUpdateAliasRequest
Field
Type
Required
Description
resolvedModel
string
Yes
Name of the transcription model this alias resolves to.
fallbackModel
string
No
Name of the fallback transcription model.
type
string
Yes
Alias type: FAMILY, PINNED, or CONCRETE.
displayName
string
Yes
Human-readable display name.
description
string
No
Alias description.
isDefault
boolean
No
Whether this alias is the default for the tenant. Default: false.
minHierarchyOrder
integer
No
Minimum role hierarchy order required to access this alias. 0 means accessible to all authenticated users. Default: 0.
UpdateAliasResolutionRequest
Field
Type
Required
Description
resolvedModel
string
Yes
Name of the new resolved transcription model.
fallbackModel
string
No
Name of the new fallback transcription model (null to remove).
DeprecateAliasRequest
Field
Type
Required
Description
deprecationDate
string (date)
No
Date when the alias becomes deprecated (ISO 8601).
sunsetDate
string (date)
No
Date when the alias will be removed.
message
string
No
Deprecation message for users.
Enumerations
BackendType
Value
Description
INTERNAL
Self-hosted speech engine (K2 or SLIBE). Supports transcription model file upload.
WERNICKE
External Wernicke speech service backend.
ModelStatus
Value
Description
AVAILABLE
Model is active and ready for transcription.
UNAVAILABLE
Model is temporarily unavailable.
MAINTENANCE
Model is under maintenance.
DEPRECATED
Model is deprecated and scheduled for removal.
GrpcClientConfig
gRPC client configuration for connecting to a remote inference server.
All model-backed gRPC clients use round-robin load balancing. Supported target forms are:
dns:///wernicke-headless:50052 for DNS-based discovery.
server-a:2222,server-b:2222 for an explicit endpoint list; this is normalized at runtime.
static:///server-a:2222,server-b:2222 for the preferred explicit endpoint-list form.
DNS targets are refreshed periodically so a long-lived channel discovers replacement or newly added endpoints even while another endpoint remains healthy. Each streaming RPC stays on the backend selected when that RPC starts. If that backend disappears, the stream fails; only a new RPC can be assigned elsewhere. With TLS and multiple hostnames, all endpoints must share a certificate identity or authority must name the shared identity.
Field
Type
Required
Description
target
string
Yes
Single, DNS, or explicit static gRPC target as described above.
tlsMode
string
Yes
TLS mode: PLAINTEXT, SYSTEM_TRUST, or MTLS.
authority
string
No
Authority override for TLS verification.
deadlineMs
integer
No
gRPC deadline in milliseconds. Default: 30000.
maxInboundMessageBytes
integer
No
Maximum inbound message size in bytes.
metadata
object
No
Metadata headers sent with every gRPC request.
InternalBackendConfig
Configuration for an internal backend that uses service discovery.
Field
Type
Required
Description
discoveryServiceName
string
Yes
Service discovery name for the internal engine instance.
AliasType
Value
Description
FAMILY
A transcription model family alias that can be updated to point to newer versions.
PINNED
An alias pinned to a specific transcription model version.