Models - List Custom Models

Referencia

Service:: Azure AI Services

API Version:: v3.2-preview.2

Lekéri a hitelesített előfizetéshez tartozó egyéni modellek listáját.

GET {endpoint}/speechtotext/v3.2-preview.2/models

With optional parameters:

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

URI-paraméterek

Name	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ő modellek 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

Name	Típus	Description
200 OK	PaginatedCustomModels	OK Headers Retry-After: integer
Other Status Codes	Error	Hiba történt.

Name

Típus

Description

200 OK

PaginatedCustomModels

Headers

Retry-After: integer

Other Status Codes

Error

Hiba történt.

Biztonság

Ocp-Apim-Subscription-Key

Itt adja meg a Cognitive Services-fiókkulcsot.

Type: 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

Type: apiKey
In: header

Példák

Get all models in state 'Running'

Sample Request

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/models?skip=0&top=2&filter=status%20eq%20'Running'

Sample Response

Status code:: 200

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b",
      "baseModel": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
      },
      "datasets": [
        {
          "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
        }
      ],
      "links": {
        "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b",
        "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copyto",
        "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copy",
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b/files"
      },
      "properties": {
        "deprecationDates": {
          "transcriptionDateTime": "2023-05-04T00:00:00Z"
        },
        "customModelWeightPercent": 30,
        "features": {
          "supportsTranscriptions": true,
          "supportsEndpoints": true,
          "supportsTranscriptionsOnSpeechContainers": false,
          "supportedOutputFormats": [
            "Lexical",
            "Display"
          ]
        }
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Running",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Language model",
      "description": "This is a language model"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b",
      "baseModel": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
      },
      "datasets": [
        {
          "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1"
        }
      ],
      "links": {
        "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/manifest/a04e77e6-2009-462c-8d1c-65d718ee4b7b",
        "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b:copyto",
        "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b:copy",
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b/files"
      },
      "properties": {
        "deprecationDates": {
          "transcriptionDateTime": "2023-05-04T00:00:00Z"
        },
        "customModelWeightPercent": 30,
        "features": {
          "supportsTranscriptions": true,
          "supportsEndpoints": true,
          "supportsTranscriptionsOnSpeechContainers": false,
          "supportedOutputFormats": [
            "Lexical",
            "Display"
          ]
        }
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Running",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Acoustic model",
      "description": "Example for an acoustic model"
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models?skip=2&top=2&filter=status%20eq%20'Running'"
}

Definíciók

Name	Description
CustomModel	CustomModel
CustomModelDeprecationDates	CustomModelDeprecationDates
CustomModelFeatures	CustomModelFeatures
CustomModelLinks	CustomModelLinks
CustomModelProperties	CustomModelProperties
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
EntityReference	EntityReference
Error	Hiba
ErrorCode	ErrorCode
InnerError	InnerError
OutputFormatType	OutputFormatType
PaginatedCustomModels	PaginatedCustomModels
Status	Állapot

CustomModel

Name	Típus	Description
baseModel	EntityReference	EntityReference
createdDateTime	string	Az objektum létrehozásának időbélyege. Az időbélyeg iso 8601-es dátum- és időformátumként van kódolva ("ÉÉÉÉ-HH-NNH:mm:ssZ", lásd: https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties	object	Az entitás egyéni tulajdonságai. A maximálisan megengedett kulcshossz 64 karakter, a maximális megengedett értékhossz 256 karakter, az engedélyezett bejegyzések száma pedig 10.
datasets	EntityReference[]	Az adaptációhoz használt adatkészletek.
description	string	Az objektum leírása.
displayName	string	Az objektum megjelenítendő neve.
lastActionDateTime	string	Az aktuális állapot megadásának időbélyege. Az időbélyeg iso 8601-es dátum- és időformátumként van kódolva ("ÉÉÉÉ-HH-NNH:mm:ssZ", lásd: https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links	CustomModelLinks	CustomModelLinks
locale	string	A tartalmazott adatok területi beállítása.
project	EntityReference	EntityReference
properties	CustomModelProperties	CustomModelProperties
self	string	Az entitás helye.
status	Status	Állapot Az API aktuális állapotának leírása
text	string	A nyelvi modell adaptálásához használt szöveg.

CustomModelDeprecationDates

Name	Típus	Description
transcriptionDateTime	string	Az átírás elavulttá válásának dátuma.

CustomModelFeatures

Name	Típus	Description
supportedOutputFormats	OutputFormatType[]	Támogatott kimeneti formátumok.
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 azt jelzi, hogy támogatott-e a kötegelt átírás.
supportsTranscriptionsOnSpeechContainers	boolean	Egy érték, amely azt jelzi, hogy ez a modell használható-e a beszédtárolón történő átíráshoz. Ez a funkció akkor vehető fel a meglévő modellekre, ha használhatóvá válik a beszédtárolóban.

CustomModelLinks

Name	Típus	Description
copy	string	A modell másolási műveletének helye. További részletekért lásd a "Models_Copy" műveletet.
copyTo	string	Az elavult modell másolási műveletének helye. További részletekért lásd a "Models_CopyTo" műveletet.
files	string	Az entitás összes fájljának lekérésének helye. További részletekért lásd a "Models_ListFiles" műveletet.
manifest	string	A modell jegyzékfájljának lekérési helye a helyszíni tárolóban. További részletekért lásd a "Models_GetCustomModelManifest" műveletet.

CustomModelProperties

Name	Típus	Description
customModelWeightPercent	integer	Az egyéni modell súlya 1 (1% egyéni és 99%-os alapmodell) és 100 (100%-os egyéni és 0%-os alapmodell) között. Ha ez a tulajdonság nincs beállítva, a szolgáltatás kiválaszt egy megfelelő értéket (kérje le a modellt a kiválasztott súly lekéréséhez). Kezdje a tulajdonság használata nélkül. Ha szükséges, válasszon nagyobb (vagy kisebb) súlyt az egyéni modell hatásának növeléséhez (vagy csökkentéséhez).
deprecationDates	CustomModelDeprecationDates	CustomModelDeprecationDates
email	string	Az e-mail-értesítések küldéséhez használt e-mail-cím, ha a művelet befejeződik. Az érték az e-mail sikeres elküldése után törlődik.
error	EntityError	EntityError
features	CustomModelFeatures	CustomModelFeatures A modell által támogatott funkciók.

DetailedErrorCode

Name	Típus	Description
DataImportFailed	string	Az adatimportálás nem sikerült.
DeleteNotAllowed	string	A törlés nem engedélyezett.
DeployNotAllowed	string	Az üzembe helyezés nem engedélyezett.
DeployingFailedModel	string	Sikertelen modell üzembe helyezése.
EmptyRequest	string	Üres kérelem.
EndpointCannotBeDefault	string	A végpont nem lehet alapértelmezett.
EndpointNotUpdatable	string	A végpont nem frissíthető.
EndpointWithoutLogging	string	Végpont naplózás nélkül.
ExceededNumberOfRecordingsUris	string	Túllépte a felvételek URI-jainak számát.
FailedDataset	string	Nem sikerült az adathalmaz.
Forbidden	string	Tiltott.
InUseViolation	string	Használaton belüli szabálysértés.
InaccessibleCustomerStorage	string	Elérhetetlen ügyféltároló.
InvalidAdaptationMapping	string	Érvénytelen adaptációs leképezés.
InvalidBaseModel	string	Érvénytelen alapmodell.
InvalidCallbackUri	string	Érvénytelen visszahívási URI.
InvalidCollection	string	Érvénytelen gyűjtemény.
InvalidDataset	string	Érvénytelen adatkészlet.
InvalidDocument	string	Érvénytelen dokumentum.
InvalidDocumentBatch	string	Érvénytelen dokumentumköteg.
InvalidLocale	string	Érvénytelen területi beállítás.
InvalidLogDate	string	Érvénytelen naplódátum.
InvalidLogEndTime	string	Érvénytelen a napló befejezési ideje.
InvalidLogId	string	Érvénytelen naplóazonosító.
InvalidLogStartTime	string	Érvénytelen a napló kezdési időpontja.
InvalidModel	string	Érvénytelen modell.
InvalidModelUri	string	Érvénytelen modell URI-ja.
InvalidParameter	string	Érvénytelen paraméter.
InvalidParameterValue	string	Érvénytelen paraméterérték.
InvalidPayload	string	Érvénytelen hasznos adat.
InvalidPermissions	string	Érvénytelen engedélyek.
InvalidPrerequisite	string	Érvénytelen előfeltétel.
InvalidProductId	string	Érvénytelen termékazonosító.
InvalidProject	string	Érvénytelen projekt.
InvalidProjectKind	string	Érvénytelen projekttípus.
InvalidRecordingsUri	string	Érvénytelen felvételek URI-ja.
InvalidRequestBodyFormat	string	Érvénytelen kérelemtörzs-formátum.
InvalidSasValidityDuration	string	Érvénytelen sas-érvényességi időtartam.
InvalidSkipTokenForLogs	string	Érvénytelen kihagyó jogkivonat a naplókhoz.
InvalidSourceAzureResourceId	string	Érvénytelen forrás Azure-erőforrás-azonosító.
InvalidSubscription	string	Érvénytelen előfizetés.
InvalidTest	string	Érvénytelen teszt.
InvalidTimeToLive	string	Érvénytelen élettartam.
InvalidTopForLogs	string	A naplók felső része érvénytelen.
InvalidTranscription	string	Érvénytelen átírás.
InvalidWebHookEventKind	string	Érvénytelen webhookesemény-típus.
MissingInputRecords	string	Hiányzó bemeneti rekordok.
ModelCopyOperationExists	string	Létezik modellmásolási művelet.
ModelDeploymentNotCompleteState	string	A modell üzembe helyezése nem fejeződött be.
ModelDeprecated	string	A modell elavult.
ModelExists	string	A modell létezik.
ModelMismatch	string	Modelleltérés.
ModelNotDeployable	string	A modell nem helyezhető üzembe.
ModelVersionIncorrect	string	A modell verziója helytelen.
NoUtf8WithBom	string	Nincs utf8 a bom.
OnlyOneOfUrlsOrContainerOrDataset	string	Csak egy URL-cím, tároló vagy adatkészlet.
ProjectGenderMismatch	string	A projekt neme nem egyezik.
QuotaViolation	string	Kvóta megsértése.
SingleDefaultEndpoint	string	Egyetlen alapértelmezett végpont.
SkuLimitsExist	string	A termékváltozatra vonatkozó korlátozások léteznek.
SubscriptionNotFound	string	Az előfizetés nem található.
UnexpectedError	string	Váratlan hiba.
UnsupportedClassBasedAdaptation	string	Nem támogatott osztályalapú adaptáció.
UnsupportedDelta	string	Nem támogatott változás.
UnsupportedDynamicConfiguration	string	Nem támogatott dinamikus konfiguráció.
UnsupportedFilter	string	Nem támogatott szűrő.
UnsupportedLanguageCode	string	Nem támogatott nyelvi kód.
UnsupportedOrderBy	string	Nem támogatott sorrend szerint.
UnsupportedPagination	string	Nem támogatott lapozás.
UnsupportedTimeRange	string	Nem támogatott időtartomány.

EntityError

Name	Típus	Description
code	string	A hiba kódja.
message	string	A hiba üzenete.

EntityReference

Name	Típus	Description
self	string	A hivatkozott entitás helye.

Error

Hiba

Name	Típus	Description
code	ErrorCode	ErrorCode 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 a Cognitive Services API-irányelveknek, amely a címen https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8owérhető el. Ez tartalmazza a szükséges tulajdonságokat: ErrorCode, üzenet és választható tulajdonságok célhelye, 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

Name	Típus	Description
Conflict	string	Az ütközési hibakód jelölője.
Forbidden	string	A tiltott hibakódot jelöli.
InternalCommunicationFailed	string	A belső kommunikáció meghiúsult hibakódját jelképező hibakód.
InternalServerError	string	A belső kiszolgáló hibakódját jelöli.
InvalidArgument	string	Az érvénytelen argumentum hibakódját jelöli.
InvalidRequest	string	Az érvénytelen kérelem hibakódját jelöli.
NotAllowed	string	A nem engedélyezett hibakódot jelöli.
NotFound	string	A nem található hibakódot jelöli.
PipelineError	string	A folyamat hibakódjának jelölője.
ServiceUnavailable	string	A szolgáltatás nem érhető el hibakódját jelöli.
TooManyRequests	string	A túl sok kérelem hibakódját jelöli.
Unauthorized	string	A jogosulatlan hibakódot jelöli.
UnprocessableEntity	string	A feldolgozhatatlan entitás hibakódját jelöli.
UnsupportedMediaType	string	A nem támogatott médiatípus hibakódját jelöli.

InnerError

Name	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 a Cognitive Services API-irányelveknek, amely a címen https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8owérhető el. Ez tartalmazza a szükséges tulajdonságokat: ErrorCode, üzenet és választható tulajdonságok célhelye, 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

Name	Típus	Description
Display	string	A modell támogatja a megjelenítési formázás átiratainak kimenetét vagy végpontjait.
Lexical	string	A modell formázás nélkül biztosítja az átírás kimenetét.

PaginatedCustomModels

Name	Típus	Description
@nextLink	string	Hivatkozás a lapszámozott eredmények következő készletére, ha több entitás érhető el; egyébként null értékű.
values	CustomModel[]	A "skip" és a "top" átadott lekérdezési paraméterek vagy az alapértelmezett értékek által korlátozott entitások listája. Ha a listákat oldalakra tördeléssel és entitások párhuzamos törlésével iterálja, egyes entitások kimaradnak az eredményekből. Javasoljuk, hogy hozzon létre egy listát az ügyfélen, és törölje a teljes lista lekérése után.

Name

Típus

Description

@nextLink

string

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

values

CustomModel[]

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

Ha a listákat oldalakra tördeléssel és entitások párhuzamos törlésével iterálja, egyes entitások kimaradnak az eredményekből. Javasoljuk, hogy hozzon létre egy listát az ügyfélen, és törölje a teljes lista lekérése után.

Status

Állapot

Name	Típus	Description
Failed	string	A hosszú ideig futó művelet nem sikerült.
NotStarted	string	A hosszú ideig futó művelet még nem indult el.
Running	string	A hosszú ideig futó művelet jelenleg feldolgozásra kerül.
Succeeded	string	A hosszú ideig futó művelet sikeresen befejeződött.

Share via

Models - List Custom Models

URI-paraméterek

Válaszok

Biztonság

Ocp-Apim-Subscription-Key

Authorization

Példák

Get all models in state 'Running'

Sample Request

Sample Response

Definíciók

CustomModel

CustomModelDeprecationDates

CustomModelFeatures

CustomModelLinks

CustomModelProperties

DetailedErrorCode

EntityError

EntityReference

Error

ErrorCode

InnerError

OutputFormatType

PaginatedCustomModels

Status

További források