Models - Create

Szolgáltatás:

Azure AI Services

API-verzió:

v3.2-preview.2

Új modellt hoz létre.

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

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).

Kérelem törzse

Name	Kötelező	Típus	Description
displayName	True	string minLength: 1	Az objektum megjelenítendő neve.
locale	True	string minLength: 1	A tartalmazott adatok területi beállítása.
baseModel		EntityReference	EntityReference
customProperties		object	Az entitás egyéni tulajdonságai. A maximálisan megengedett kulcshossz 64 karakter, az engedélyezett érték maximális hossza 256 karakter, az engedélyezett bejegyzések száma pedig 10.
datasets		EntityReference[]	Adaptáláshoz használt adathalmazok.
description		string	Az objektum leírása.
project		EntityReference	EntityReference
properties		CustomModelProperties	CustomModelProperties
text		string	A nyelvi modell adaptálásához használt szöveg.

Válaszok

Name	Típus	Description
201 Created	CustomModel	A válasz hasznos adatként tartalmazza az entitás adatait és fejlécként való helyét. Fejlécek Location: string
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

Create a model

Create a model with custom model weight

Create a model

Mintakérelem

HTTP

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

{
  "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"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
    }
  ],
  "locale": "en-US",
  "displayName": "Model with acoustic and language datasets"
}

Mintaválasz

Állapotkód:

201

{
  "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"
}

Create a model with custom model weight

Mintakérelem

HTTP

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

{
  "baseModel": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/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"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
    }
  ],
  "properties": {
    "customModelWeightPercent": 42
  },
  "locale": "en-US",
  "displayName": "Model with acoustic and language datasets"
}

Mintaválasz

Állapotkód:

201

Location: https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/827712a5-f942-4997-91c3-7c6cde35600b",
  "baseModel": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/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": 42,
    "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"
}

Definíciók

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

CustomModel

Objektum

CustomModel

Name	Típus	Description
baseModel	EntityReference	EntityReference
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).
customProperties	object	Az entitás egyéni tulajdonságai. A maximálisan megengedett kulcshossz 64 karakter, az engedélyezett érték maximális hossza 256 karakter, az engedélyezett bejegyzések száma pedig 10.
datasets	EntityReference[]	Adaptáláshoz használt adathalmazok.
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	CustomModelLinks	CustomModelLinks
locale	string minLength: 1	A tartalmazott adatok területi beállítása.
project	EntityReference	EntityReference
properties	CustomModelProperties	CustomModelProperties
self	string (uri)	Az entitás helye.
status	Status	Állapot Az API aktuális állapotának ismertetése
text	string	A nyelvi modell adaptálásához használt szöveg.

CustomModelDeprecationDates

Objektum

CustomModelDeprecationDates

Name	Típus	Description
transcriptionDateTime	string (date-time)	Az átírás elavulttá válásának dátuma.

CustomModelFeatures

Objektum

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 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.

CustomModelLinks

Objektum

CustomModelLinks

Name	Típus	Description
copy	string (uri)	A modell másolási műveletének helye. További részletekért tekintse meg a "Models_Copy" műveletet.
copyTo	string (uri)	Az elavult modell másolási műveletének helye. További részletekért tekintse meg a "Models_CopyTo" műveletet.
files	string (uri)	Az entitás összes fájljának lekérési helye. További részletekért lásd a "Models_ListFiles" műveletet.
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.

CustomModelProperties

Objektum

CustomModelProperties

Name	Típus	Description
customModelWeightPercent	integer (int32) minimum: 1 maximum: 100	Az egyéni modell súlya 1 (1% egyéni és 99% alapmodell) és 100 (100% egyéni modell és 0% alapmodell) között. Ha ez a tulajdonság nincs beállítva, a szolgáltatás kiválaszt egy megfelelő értéket (lekéri 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 egy 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	A művelet befejeződése esetén az e-mail-értesítések küldéséhez szükséges e-mail-cím. 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

Enumerálás

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.

EntityError

Objektum

EntityError

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

EntityReference

Objektum

EntityReference

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

Error

Objektum

Hiba

Name	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

Enumerálás

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

Objektum

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

Enumerálás

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.

Status

Enumerálás

Á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.