Skip to content

Sentence Verification Models

Discover sentence verification (sentver) models 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 Models
GET /api/v1/speech-services/sentence-verification/models/{model} Get Sentver Model

List Sentver Models

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

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

Returns sentver models visible to the current user. isDefault identifies the default used when sentenceVerification.model is omitted from an enrollment or verification request.

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",
    "isDefault": true,
    "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 models returned.
401 Unauthorized Missing or invalid authentication.
403 Forbidden Insufficient scope.

Get Sentver Model

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

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

Returns details for one sentver model.

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

Data Types

SentverModelAliasResponse

Field Type Nullable Description
id string No Model identifier clients pass as sentenceVerification.model.
type string No Model type: FAMILY, PINNED, or CONCRETE.
displayName string No Human-readable model name.
description string Yes Optional model description.
status string No Effective status of the model version represented by resolvedModel.
resolvedModel string No Model version selected for processing. If fallback is used, this is the fallback model.
isDefault boolean No Whether this is the default sentence verification model.
capabilities SentverModelCapabilities No Model capabilities.
fallbackModel string Yes Optional fallback model name.
deprecated boolean No Whether the model 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 model.
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 model and the sentver model version actually used. If model fallback selects a fallback model, the record stores that fallback as resolvedModel.