Models - Create

Služba:

Azure AI Services

Verze rozhraní API:

v3.2-preview.2

Vytvoří nový model.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string	Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například: https://westus.api.cognitive.microsoft.com).

Text požadavku

Name	Vyžadováno	Typ	Description
displayName	True	string minLength: 1	Zobrazovaný název objektu.
locale	True	string minLength: 1	Národní prostředí obsažených dat.
baseModel		EntityReference	EntityReference
customProperties		object	Vlastní vlastnosti této entity. Maximální povolená délka klíče je 64 znaků, maximální povolená délka je 256 znaků a počet povolených položek je 10.
datasets		EntityReference[]	Datové sady používané pro přizpůsobení.
description		string	Popis objektu.
project		EntityReference	EntityReference
properties		CustomModelProperties	CustomModelProperties
text		string	Text použitý k přizpůsobení tohoto jazykového modelu.

Odpovědi

Name	Typ	Description
201 Created	CustomModel	Odpověď obsahuje informace o entitě jako datové části a jeho umístění jako záhlaví. Hlavičky Location: string
Other Status Codes	Error	Došlo k chybě.

Zabezpečení

Ocp-Apim-Subscription-Key

Tady zadejte svůj klíč účtu služeb Cognitive Services.

Typ: apiKey
V: header

Authorization

Zadejte přístupový token z JWT vráceného službou STS této oblasti. Nezapomeňte do tokenu přidat obor správy přidáním následujícího řetězce dotazu do adresy URL služby STS: ?scope=speechservicesmanagement

Typ: apiKey
V: header

Příklady

Create a model

Create a model with custom model weight

Create a model

Ukázkový požadavek

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

Ukázková odpověď

Stavový kó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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kó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"
}

Definice

Name	Description
CustomModel	CustomModel
CustomModelDeprecationDates	CustomModelDeprecationDates
CustomModelFeatures	CustomModelFeatures
CustomModelLinks	CustomModelLinks
CustomModelProperties	CustomModelProperties
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
EntityReference	EntityReference
Error	Chyba
ErrorCode	Kód chyby
InnerError	Vnitřní chyba
OutputFormatType	OutputFormatType
Status	Stav

CustomModel

Objekt

CustomModel

Name	Typ	Description
baseModel	EntityReference	EntityReference
createdDateTime	string (date-time)	Časové razítko při vytvoření objektu. Časové razítko je kódováno jako formát data a času ISO 8601 ("RRRR-MM-DDThh:mm:ssZ", viz https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties	object	Vlastní vlastnosti této entity. Maximální povolená délka klíče je 64 znaků, maximální povolená délka je 256 znaků a počet povolených položek je 10.
datasets	EntityReference[]	Datové sady používané pro přizpůsobení.
description	string	Popis objektu.
displayName	string minLength: 1	Zobrazovaný název objektu.
lastActionDateTime	string (date-time)	Časové razítko, kdy byl zadán aktuální stav. Časové razítko je kódováno jako formát data a času ISO 8601 ("RRRR-MM-DDThh:mm:ssZ", viz https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links	CustomModelLinks	CustomModelLinks
locale	string minLength: 1	Národní prostředí obsažených dat.
project	EntityReference	EntityReference
properties	CustomModelProperties	CustomModelProperties
self	string (uri)	Umístění této entity.
status	Status	Stav Popis aktuálního stavu rozhraní API
text	string	Text použitý k přizpůsobení tohoto jazykového modelu.

CustomModelDeprecationDates

Objekt

CustomModelDeprecationDates

Name	Typ	Description
transcriptionDateTime	string (date-time)	Datum, kdy se přepis přestane používat.

CustomModelFeatures

Objekt

CustomModelFeatures

Name	Typ	Description
supportedOutputFormats	OutputFormatType[]	Podporované formáty výstupu
supportsEndpoints	boolean	Hodnota označující, jestli se podporuje vytváření koncových bodů pro přepis za provozu.
supportsTranscriptions	boolean	Hodnota označující, jestli se podporuje dávkový přepis.
supportsTranscriptionsOnSpeechContainers	boolean	Hodnota označující, jestli se tento model dá použít k přepisu v kontejneru služby Speech. Tuto funkci je možné přidat do stávajících modelů, jakmile bude použitelná v kontejneru služby Speech.

CustomModelLinks

Objekt

CustomModelLinks

Name	Typ	Description
copy	string (uri)	Umístění akce kopírování modelu. Další podrobnosti najdete v operaci "Models_Copy".
copyTo	string (uri)	Umístění pro zastaralou akci kopírování modelu. Další podrobnosti najdete v operaci "Models_CopyTo".
files	string (uri)	Umístění pro získání všech souborů této entity. Další podrobnosti najdete v operaci "Models_ListFiles".
manifest	string (uri)	Umístění pro získání manifestu pro tento model, který se má použít v místním kontejneru. Další podrobnosti najdete v operaci "Models_GetCustomModelManifest".

CustomModelProperties

Objekt

CustomModelProperties

Name	Typ	Description
customModelWeightPercent	integer (int32) minimum: 1 maximum: 100	Váha vlastního modelu mezi 1 (1% vlastní model a 99% základní model) a 100 (100% vlastní model a 0% základní model). Pokud tato vlastnost není nastavená, služba zvolí vhodnou hodnotu (získejte model pro načtení vybrané váhy). Začněte bez použití této vlastnosti. V případě potřeby zvolte větší (nebo menší) váhu, abyste zvýšili (nebo snížili) dopad vlastního modelu.
deprecationDates	CustomModelDeprecationDates	CustomModelDeprecationDates
email	string	E-mailová adresa pro odesílání e-mailových oznámení pro případ, že se operace dokončí. Hodnota se odebere po úspěšném odeslání e-mailu.
error	EntityError	EntityError
features	CustomModelFeatures	CustomModelFeatures Funkce podporované modelem

DetailedErrorCode

Výčet

DetailedErrorCode

Hodnota	Description
InvalidParameterValue	Neplatná hodnota parametru
InvalidRequestBodyFormat	Neplatný formát textu požadavku
EmptyRequest	Prázdný požadavek.
MissingInputRecords	Chybí vstupní záznamy.
InvalidDocument	Neplatný dokument
ModelVersionIncorrect	Verze modelu není správná.
InvalidDocumentBatch	Neplatná dávka dokumentu
UnsupportedLanguageCode	Nepodporovaný kód jazyka
DataImportFailed	Import dat se nezdařil.
InUseViolation	V narušení používání.
InvalidLocale	Neplatné národní prostředí
InvalidBaseModel	Neplatný základní model
InvalidAdaptationMapping	Neplatné mapování adaptací
InvalidDataset	Neplatná datová sada
InvalidTest	Neplatný test.
FailedDataset	Datová sada se nezdařila.
InvalidModel	Neplatný model.
InvalidTranscription	Neplatný přepis
InvalidPayload	Neplatná datová část
InvalidParameter	Neplatný parametr.
EndpointWithoutLogging	Koncový bod bez protokolování
InvalidPermissions	Neplatná oprávnění
InvalidPrerequisite	Neplatný požadavek.
InvalidProductId	Neplatné ID produktu
InvalidSubscription	Neplatné předplatné
InvalidProject	Neplatný projekt.
InvalidProjectKind	Neplatný druh projektu.
InvalidRecordingsUri	Identifikátor URI pro neplatné nahrávky
OnlyOneOfUrlsOrContainerOrDataset	Pouze jedna z adres URL nebo kontejneru nebo datové sady.
ExceededNumberOfRecordingsUris	Byl překročen počet nahrávek.
ModelMismatch	Neshoda modelů
ProjectGenderMismatch	Neshoda pohlaví projektu
ModelDeprecated	Model je zastaralý.
ModelExists	Model existuje.
ModelNotDeployable	Model nejde nasadit.
EndpointNotUpdatable	Koncový bod nejde aktualizovat.
SingleDefaultEndpoint	Jeden výchozí koncový bod
EndpointCannotBeDefault	Koncový bod nemůže být výchozí.
InvalidModelUri	Neplatný identifikátor URI modelu
SubscriptionNotFound	Předplatné se nenašlo.
QuotaViolation	Porušení kvóty
UnsupportedDelta	Nepodporovaný rozdíl.
UnsupportedFilter	Nepodporovaný filtr
UnsupportedPagination	Nepodporované stránkování
UnsupportedDynamicConfiguration	Nepodporovaná dynamická konfigurace
UnsupportedOrderBy	Nepodporované pořadí podle.
NoUtf8WithBom	Žádné utf8 s bom.
ModelDeploymentNotCompleteState	Nasazení modelu není dokončeno.
SkuLimitsExist	Existují omezení skladové položky.
DeployingFailedModel	Nasazení neúspěšného modelu
UnsupportedTimeRange	Nepodporovaný časový rozsah
InvalidLogDate	Neplatné datum protokolu
InvalidLogId	Neplatné ID protokolu
InvalidLogStartTime	Neplatný čas spuštění protokolu
InvalidLogEndTime	Neplatný čas ukončení protokolu
InvalidTopForLogs	Neplatný horní okraj pro protokoly.
InvalidSkipTokenForLogs	Neplatný token pro přeskočení protokolů
DeleteNotAllowed	Odstranění není povoleno.
Forbidden	Zakázaný.
DeployNotAllowed	Nasazení není povoleno.
UnexpectedError	Neočekávaná chyba
InvalidCollection	Neplatná kolekce.
InvalidCallbackUri	Neplatný identifikátor URI zpětného volání.
InvalidSasValidityDuration	Neplatná doba platnosti SAS.
InaccessibleCustomerStorage	Nepřístupné úložiště zákazníka
UnsupportedClassBasedAdaptation	Nepodporovaná úprava založená na třídách.
InvalidWebHookEventKind	Neplatný druh události webhooku
InvalidTimeToLive	Neplatný čas naživo.
InvalidSourceAzureResourceId	Neplatné ID zdroje prostředku Azure
ModelCopyOperationExists	Operace kopírování modelu existuje.

EntityError

Objekt

EntityError

Name	Typ	Description
code	string	Kód této chyby.
message	string	Zpráva pro tuto chybu.

EntityReference

Objekt

EntityReference

Name	Typ	Description
self	string (uri)	Umístění odkazované entity.

Error

Objekt

Chyba

Name	Typ	Description
code	ErrorCode	Kód chyby Kódy chyb vysoké úrovně.
details	Error[]	Další podrobnosti podpory týkající se chyb a/nebo očekávaných zásad
innerError	InnerError	Vnitřní chyba Nový formát vnitřní chyby, který odpovídá pokynům rozhraní API služeb Cognitive Services, které jsou k dispozici v https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Obsahuje požadované vlastnosti ErrorCode, message and optional properties target, details(key value pair), inner error(this can be vnořováno).
message	string	Chybová zpráva vysoké úrovně
target	string	Zdroj chyby. Například v případě neplatného dokumentu by to bylo "dokumenty" nebo "ID dokumentu".

ErrorCode

Výčet

Kód chyby

Hodnota	Description
InvalidRequest	Představuje neplatný kód chyby požadavku.
InvalidArgument	Představuje neplatný kód chyby argumentu.
InternalServerError	Představuje kód chyby vnitřní chyby serveru.
ServiceUnavailable	Představuje kód chyby nedostupné služby.
NotFound	Představuje kód chyby, který nebyl nalezen.
PipelineError	Představuje kód chyby kanálu.
Conflict	Představuje kód chyby konfliktu.
InternalCommunicationFailed	Představuje kód chyby selhání interní komunikace.
Forbidden	Představuje zakázaný kód chyby.
NotAllowed	Představuje kód chyby, který není povolený.
Unauthorized	Představuje neautorizovaný kód chyby.
UnsupportedMediaType	Představuje nepodporovaný kód chyby typu média.
TooManyRequests	Představuje kód chyby příliš velkého počtu požadavků.
UnprocessableEntity	Představuje nezpracovaný kód chyby entity.

InnerError

Objekt

Vnitřní chyba

Name	Typ	Description
code	DetailedErrorCode	DetailedErrorCode Podrobný výčet kódu chyby
details	object	Další podrobnosti podpory týkající se chyb a/nebo očekávaných zásad
innerError	InnerError	Vnitřní chyba Nový formát vnitřní chyby, který odpovídá pokynům rozhraní API služeb Cognitive Services, které jsou k dispozici v https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Obsahuje požadované vlastnosti ErrorCode, message and optional properties target, details(key value pair), inner error(this can be vnořováno).
message	string	Chybová zpráva vysoké úrovně
target	string	Zdroj chyby. Například v případě neplatného dokumentu by to bylo "dokumenty" nebo "ID dokumentu".

OutputFormatType

Výčet

OutputFormatType

Hodnota	Description
Lexical	Model poskytuje výstup přepisu bez formátování.
Display	Model podporuje zobrazení výstupu nebo koncových bodů přepisů formátování.

Status

Výčet

Stav

Hodnota	Description
NotStarted	Dlouhotrvající operace ještě nebyla spuštěna.
Running	Dlouhotrvající operace se právě zpracovává.
Succeeded	Dlouhotrvající operace byla úspěšně dokončena.
Failed	Dlouhotrvající operace se nezdařila.