Models - List Base Models

Lekéri a hitelesített előfizetés alapmodelljeinek listáját.

GET {endpoint}/speechtotext/v3.2-preview.2/models/base
GET {endpoint}/speechtotext/v3.2-preview.2/models/base?skip={skip}&top={top}&filter={filter}

URI-paraméterek

Név In Kötelező Típus Description
endpoint
path True

string

Támogatott Cognitive Services-végpontok (protokoll és állomásnév, például: https://westus.api.cognitive.microsoft.com).

filter
query

string

Szűrőkifejezés az elérhető alapmodellek egy részhalmazának kiválasztásához.

        - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale.

        - Operators:

          - eq, ne are supported for all properties.

          - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.

          - and, or, not are supported.

        - Example:

          filter=status eq 'NotStarted' or status eq 'Running'
skip
query

integer (int32)

Kihagyandó adathalmazok száma.

top
query

integer (int32)

A kihagyás után belefoglalt adathalmazok száma.

Válaszok

Név Típus Description
200 OK

PaginatedBaseModels

OKÉ

Other Status Codes

Error

Hiba történt.

Biztonság

Ocp-Apim-Subscription-Key

Itt adja meg a Cognitive Services-fiókkulcsot.

Típus: apiKey
In: header

Authorization

Adjon meg egy hozzáférési jogkivonatot a régió STS által visszaadott JWT-ből. Győződjön meg arról, hogy hozzáadja a felügyeleti hatókört a jogkivonathoz, ha hozzáadja a következő lekérdezési sztringet az STS URL-címéhez: ?scope=speechservicesmanagement

Típus: apiKey
In: header

Példák

Get all english base models

Mintakérelem

GET {endpoint}/speechtotext/v3.2-preview.2/models/base?skip=0&top=2&filter=locale%20eq%20'en-US'

Mintaválasz

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/base/827712a5-f942-4997-91c3-7c6cde35600b",
      "links": {
        "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b"
      },
      "properties": {
        "deprecationDates": {
          "adaptationDateTime": "2022-11-04T00:00:00Z",
          "transcriptionDateTime": "2023-05-04T00:00:00Z"
        },
        "features": {
          "supportsTranscriptions": true,
          "supportsEndpoints": true,
          "supportsTranscriptionsOnSpeechContainers": true,
          "supportsAdaptationsWith": [
            "Language",
            "Acoustic"
          ],
          "supportedOutputFormats": [
            "Display",
            "Lexical"
          ]
        },
        "chargeForAdaptation": true
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Succeeded",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "en-US Base model"
    }
  ]
}

Definíciók

Név Description
BaseModel

BaseModel

BaseModelDeprecationDates

BaseModelDeprecationDates

BaseModelFeatures

BaseModelFeatures

BaseModelLinks

BaseModelLinks

BaseModelProperties

BaseModelProperties

DatasetKind

DatasetKind

DetailedErrorCode

DetailedErrorCode

Error

Hiba

ErrorCode

Hibakód

InnerError

InnerError

OutputFormatType

OutputFormatType

PaginatedBaseModels

TöbboldalasBaseModels

Status

Állapot

BaseModel

BaseModel

Név Típus Description
createdDateTime

string (date-time)

Az objektum létrehozásának időbélyege. Az időbélyeg ISO 8601 dátum- és időformátumként van kódolva ("YYYY-MM-DDThh:mm:ssZ", lásd https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).

description

string

Az objektum leírása.

displayName

string

minLength: 1

Az objektum megjelenítendő neve.

lastActionDateTime

string (date-time)

Az aktuális állapot megadásának időbélyege. Az időbélyeg ISO 8601 dátum- és időformátumként van kódolva ("YYYY-MM-DDThh:mm:ssZ", lásd https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).

links

BaseModelLinks

BaseModelLinks

locale

string

minLength: 1

A tartalmazott adatok területi beállítása.

properties

BaseModelProperties

BaseModelProperties

self

string (uri)

Az entitás helye.

status

Status

Állapot
Az API aktuális állapotának ismertetése

BaseModelDeprecationDates

BaseModelDeprecationDates

Név Típus Description
adaptationDateTime

string (date-time)

Az alkalmazkodás elavulttá válásának dátuma.

transcriptionDateTime

string (date-time)

Az átírás elavulttá válásának dátuma.

BaseModelFeatures

BaseModelFeatures

Név Típus Description
supportedOutputFormats

OutputFormatType[]

Támogatott kimeneti formátumok.

supportsAdaptationsWith

DatasetKind[]

Támogatott adathalmaz-típusok a modell adaptálásához.

supportsEndpoints

boolean

Egy érték, amely azt jelzi, hogy támogatott-e végpontok létrehozása az élő átíráshoz.

supportsTranscriptions

boolean

Egy érték, amely jelzi, hogy a kötegelt átírás támogatott-e.

supportsTranscriptionsOnSpeechContainers

boolean

Egy érték, amely azt jelzi, hogy ez a modell használható-e a beszédtároló átírásához. Ez a funkció akkor vehető fel a meglévő modellekre, ha használhatóvá válik a beszédtárolón.

BaseModelLinks

Név Típus Description
manifest

string (uri)

A modell jegyzékfájljának lekérési helye, amelyet a helyszíni tárolóban kell használni. További részletekért tekintse meg a "Models_GetCustomModelManifest" műveletet.

BaseModelProperties

BaseModelProperties

Név Típus Description
chargeForAdaptation

boolean

Egy érték, amely jelzi, hogy a modelladaptálás díjköteles-e.

deprecationDates

BaseModelDeprecationDates

BaseModelDeprecationDates

features

BaseModelFeatures

BaseModelFeatures
A modell által támogatott funkciók.

DatasetKind

DatasetKind

Érték Description
Language

Egy nyelvi adatkészlet.

Acoustic

Akusztikai adatkészlet.

Pronunciation

Kiejtési adatkészlet.

AudioFiles

Hangfájlok adatkészlete.

LanguageMarkdown

Nyelvi Markdown-adatkészlet.

OutputFormatting

Az inverz szöveg normalizálásának, a nagybetűsítésnek, az újraformázásnak, a trágárságnak a testreszabására szolgáló szabályokat tartalmazó adathalmaz, valamint meghatározza az adathalmaz-érvényesítési teszteket is

DetailedErrorCode

DetailedErrorCode

Érték Description
InvalidParameterValue

Érvénytelen paraméterérték.

InvalidRequestBodyFormat

Érvénytelen kérelem törzsformátuma.

EmptyRequest

Üres kérelem.

MissingInputRecords

Hiányzó bemeneti rekordok.

InvalidDocument

Érvénytelen dokumentum.

ModelVersionIncorrect

A modell verziója helytelen.

InvalidDocumentBatch

Érvénytelen dokumentumköteg.

UnsupportedLanguageCode

Nem támogatott nyelvi kód.

DataImportFailed

Az adatimportálás nem sikerült.

InUseViolation

Használaton belüli szabálysértés.

InvalidLocale

Érvénytelen területi beállítás.

InvalidBaseModel

Érvénytelen alapmodell.

InvalidAdaptationMapping

Érvénytelen adaptációs leképezés.

InvalidDataset

Érvénytelen adatkészlet.

InvalidTest

Érvénytelen teszt.

FailedDataset

Sikertelen adathalmaz.

InvalidModel

Érvénytelen modell.

InvalidTranscription

Érvénytelen átírás.

InvalidPayload

Érvénytelen hasznos adat.

InvalidParameter

Érvénytelen paraméter.

EndpointWithoutLogging

Végpont naplózás nélkül.

InvalidPermissions

Érvénytelen engedélyek.

InvalidPrerequisite

Érvénytelen előfeltétel.

InvalidProductId

Érvénytelen termékazonosító.

InvalidSubscription

Érvénytelen előfizetés.

InvalidProject

Érvénytelen projekt.

InvalidProjectKind

Érvénytelen projekttípus.

InvalidRecordingsUri

Érvénytelen felvételek uri.

OnlyOneOfUrlsOrContainerOrDataset

Csak egy URL-cím, tároló vagy adatkészlet.

ExceededNumberOfRecordingsUris

Túllépte a felvételek URI-jainak számát.

ModelMismatch

Modelleltérés.

ProjectGenderMismatch

A projekt neme nem egyezik.

ModelDeprecated

A modell elavult.

ModelExists

A modell létezik.

ModelNotDeployable

A modell nem telepíthető.

EndpointNotUpdatable

A végpont nem frissíthető.

SingleDefaultEndpoint

Egyetlen alapértelmezett végpont.

EndpointCannotBeDefault

A végpont nem lehet alapértelmezett.

InvalidModelUri

Érvénytelen modell uri.

SubscriptionNotFound

Az előfizetés nem található.

QuotaViolation

Kvóta megsértése.

UnsupportedDelta

Nem támogatott változás.

UnsupportedFilter

Nem támogatott szűrő.

UnsupportedPagination

Nem támogatott lapozás.

UnsupportedDynamicConfiguration

Nem támogatott dinamikus konfiguráció.

UnsupportedOrderBy

Nem támogatott sorrend szerint.

NoUtf8WithBom

Nincs utf8 a bom.

ModelDeploymentNotCompleteState

A modell üzembe helyezése nem fejeződött be.

SkuLimitsExist

A termékváltozat korlátai léteznek.

DeployingFailedModel

Sikertelen modell üzembe helyezése.

UnsupportedTimeRange

Nem támogatott időtartomány.

InvalidLogDate

Érvénytelen naplódátum.

InvalidLogId

Érvénytelen naplóazonosító.

InvalidLogStartTime

Érvénytelen naplóindítási időpont.

InvalidLogEndTime

Érvénytelen naplóvégzési idő.

InvalidTopForLogs

A naplók felső része érvénytelen.

InvalidSkipTokenForLogs

Érvénytelen kihagyó jogkivonat a naplókhoz.

DeleteNotAllowed

A törlés nem engedélyezett.

Forbidden

Tiltott.

DeployNotAllowed

Az üzembe helyezés nem engedélyezett.

UnexpectedError

Váratlan hiba.

InvalidCollection

Érvénytelen gyűjtemény.

InvalidCallbackUri

Érvénytelen visszahívási uri.

InvalidSasValidityDuration

Érvénytelen sas-érvényességi időtartam.

InaccessibleCustomerStorage

Elérhetetlen ügyféltároló.

UnsupportedClassBasedAdaptation

Nem támogatott osztályalapú adaptáció.

InvalidWebHookEventKind

Érvénytelen webhookesemény-típus.

InvalidTimeToLive

Érvénytelen élettartam.

InvalidSourceAzureResourceId

Érvénytelen forrás Azure-erőforrás-azonosító.

ModelCopyOperationExists

Létezik modellmásolási művelet.

Error

Hiba

Név Típus Description
code

ErrorCode

Hibakód
Magas szintű hibakódok.

details

Error[]

További támogató részletek a hibával és/vagy a várt szabályzatokkal kapcsolatban.

innerError

InnerError

InnerError
Új belső hibaformátum, amely megfelel az https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8owcímen elérhető Cognitive Services API-irányelveknek. Ez tartalmazza a szükséges tulajdonságokat: ErrorCode, üzenet és választható tulajdonságok célértéke, részletek (kulcsértékpár), belső hiba (ez beágyazható).

message

string

Magas szintű hibaüzenet.

target

string

A hiba forrása. Érvénytelen dokumentum esetén például "dokumentumok" vagy "dokumentumazonosító".

ErrorCode

Hibakód

Érték Description
InvalidRequest

Az érvénytelen kérés hibakódját jelöli.

InvalidArgument

Az érvénytelen argumentum hibakódját jelöli.

InternalServerError

A belső kiszolgáló hibakódját jelöli.

ServiceUnavailable

A szolgáltatás nem érhető el hibakódjának ábrázolása.

NotFound

A nem található hibakódot jelöli.

PipelineError

A folyamat hibakódjának ábrázolása.

Conflict

Az ütközési hibakódot jelöli.

InternalCommunicationFailed

A belső kommunikáció nem sikerült hibakódját jelöli.

Forbidden

A tiltott hibakódot jelöli.

NotAllowed

A nem engedélyezett hibakódot jelöli.

Unauthorized

A jogosulatlan hibakódot jelöli.

UnsupportedMediaType

A nem támogatott médiatípus hibakódját jelöli.

TooManyRequests

A túl sok kérés hibakódját jelöli.

UnprocessableEntity

A feldolgozhatatlan entitás hibakódját jelöli.

InnerError

InnerError

Név Típus Description
code

DetailedErrorCode

DetailedErrorCode
Részletes hibakód enumerálás.

details

object

További támogató részletek a hibával és/vagy a várt szabályzatokkal kapcsolatban.

innerError

InnerError

InnerError
Új belső hibaformátum, amely megfelel az https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8owcímen elérhető Cognitive Services API-irányelveknek. Ez tartalmazza a szükséges tulajdonságokat: ErrorCode, üzenet és választható tulajdonságok célértéke, részletek (kulcsértékpár), belső hiba (ez beágyazható).

message

string

Magas szintű hibaüzenet.

target

string

A hiba forrása. Érvénytelen dokumentum esetén például "dokumentumok" vagy "dokumentumazonosító".

OutputFormatType

OutputFormatType

Érték Description
Lexical

A modell formázás nélkül biztosítja az átirat kimenetét.

Display

A modell támogatja a megjelenítési formázás átiratainak kimenetét vagy végpontjait.

PaginatedBaseModels

TöbboldalasBaseModels

Név Típus Description
@nextLink

string (uri)

A lapszámozott eredmények következő készletére mutató hivatkozás, ha több entitás érhető el; egyébként null értékű.

values

BaseModel[]

Az átadott lekérdezési paraméterek (skip) és a "top" vagy az alapértelmezett értékek által korlátozott entitások listája.

Ha egy listát lapszámozással és entitások egyidejű törlésével űz át, a rendszer kihagy néhány entitást az eredményekből. Javasoljuk, hogy készítsen listát az ügyfélen, és törölje a teljes lista lekérése után.

Status

Állapot

Érték Description
NotStarted

A hosszú ideig futó művelet még nem indult el.

Running

A hosszú ideig futó művelet jelenleg feldolgozásra kerül.

Succeeded

A hosszú ideig futó művelet sikeresen befejeződött.

Failed

A hosszú ideig futó művelet nem sikerült.