Skip to content

Sentence Verification Models

Discover sentence verification (sentver) model aliases available to the current user. Sentver models verify that the submitted audio says the expected sentence. They are Speech Services sentence-verification resources, separate from transcription models, and are currently consumed by Speaker Verification.

Base path: /api/v1/speech-services/sentence-verification/models

Method Endpoint Description
GET /api/v1/speech-services/sentence-verification/models List Sentver Model Aliases
GET /api/v1/speech-services/sentence-verification/models/{model} Get Sentver Model Alias

List Sentver Model Aliases

GET /api/v1/speech-services/sentence-verification/models

Requires Authentication - Scopes: speech:sentver-model-aliases:read

Returns sentver model aliases visible to the current user.

SentverModelAliasResponse[]
SentverModelAliasResponse[]
[
  {
    "id": "sentver-default",
    "type": "FAMILY",
    "displayName": "Sentence Verification Default",
    "description": "Default sentence verification model for short speaker-verification prompts",
    "status": "AVAILABLE",
    "resolvedModel": "sentver-he-v2",
    "capabilities": {
      "supportedLocales": ["he-IL", "en-US"],
      "maxExpectedTextLength": 500
    },
    "fallbackModel": "sentver-he-v1",
    "deprecated": false,
    "deprecationDate": null,
    "sunsetDate": null,
    "deprecationMessage": null
  }
]
Status Description
200 OK Accessible sentver aliases returned.
401 Unauthorized Missing or invalid authentication.
403 Forbidden Insufficient scope.

Get Sentver Model Alias

GET /api/v1/speech-services/sentence-verification/models/{model}

Requires Authentication - Scopes: speech:sentver-model-aliases:read

Returns details for one sentver model alias.

Path Parameters
Parameter Type Required Description
model string Yes Sentver model alias.
SentverModelAliasResponse
Status Description
200 OK Alias returned.
401 Unauthorized Missing or invalid authentication.
403 Forbidden Insufficient scope or alias visibility restriction.
404 Not Found Alias not found.
410 Gone Alias has passed its sunset date.

Data Types

SentverModelAliasResponse

Field Type Nullable Description
id string No Alias identifier clients pass as sentenceVerification.model.
type string No Alias type: FAMILY, PINNED, or CONCRETE.
displayName string No Human-readable alias name.
description string Yes Optional alias description.
status string No Effective status of the concrete model represented by resolvedModel.
resolvedModel string No Concrete model selected by alias resolution. If fallback is used, this is the fallback model.
capabilities SentverModelCapabilities No Model capabilities.
fallbackModel string Yes Optional fallback model name.
deprecated boolean No Whether the alias is deprecated.
deprecationDate string (ISO 8601 timestamp) Yes Timestamp when deprecation started.
sunsetDate string (ISO 8601 timestamp) Yes Timestamp after which public requests reject the alias.
deprecationMessage string Yes Optional migration guidance.

SentverModelCapabilities

Field Type Nullable Description
supportedLocales string[] No Supported BCP-47 locales.
maxExpectedTextLength integer Yes Maximum accepted expected sentence length.

Reproducibility

Enrollment and verification records store the requested sentver alias and the concrete sentver model actually used. If alias fallback selects a fallback model, the record stores that fallback as resolvedModel.