Models - Create

Reference

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 hodnoty je 256 znaků a počet povolených položek je 10.
datasets		EntityReference[]	Datové sady používané k přizpůsobení.
description		string	Popis objektu.
project		EntityReference	EntityReference
properties		CustomModelProperties	Vlastní model – vlastnosti
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 jejím umístění jako hlavičce. Hlavičky Location: string
Other Status Codes	Error	Došlo k chybě.

Name

Typ

Description

201 Created

CustomModel

Odpověď obsahuje informace o entitě jako datové části a jejím umístění jako hlavičce.

Hlavičky

Location: string

Other Status Codes

Error

Došlo k chybě.

Zabezpečení

Ocp-Apim-Subscription-Key

Sem zadejte klíč účtu služeb Cognitive Services.

Typ: apiKey
V: header

Authorization

Zadejte přístupový token z JWT vrácený 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 na adresu 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	Vlastní model
CustomModelDeprecationDates	CustomModelDeprecationDates
CustomModelFeatures	CustomModelFeatures
CustomModelLinks	CustomModelLinks
CustomModelProperties	Vlastní model – vlastnosti
DetailedErrorCode	Podrobný kód chyby
EntityError	Chyba entity
EntityReference	EntityReference
Error	Chyba
ErrorCode	ErrorCode
InnerError	Vnitřní chyba
OutputFormatType	OutputFormatType
Status	Stav

CustomModel

Objekt

Vlastní model

Name	Typ	Description
baseModel	EntityReference	EntityReference
createdDateTime	string (date-time)	Časové razítko, kdy byl objekt vytvořen. Časové razítko je kódované 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 hodnoty je 256 znaků a počet povolených položek je 10.
datasets	EntityReference[]	Datové sady používané k 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ódované 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	Vlastní model – vlastnosti
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 živý přepis.
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 pro přepis v kontejneru služby Speech. Tuto funkci je možné přidat do existujících modelů, jakmile ji bude možné použít 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 části operace "Models_Copy".
copyTo	string (uri)	Umístění akce kopírování zastaralého modelu. Další podrobnosti najdete v části operace "Models_CopyTo".
files	string (uri)	Umístění pro získání všech souborů této entity Další podrobnosti najdete v části operace "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 části operace "Models_GetCustomModelManifest".

CustomModelProperties

Objekt

Vlastní model – vlastnosti

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ískáním modelu načtěte vybranou váhu). 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, na kterou se budou odesílat e-mailová oznámení pro případ, že se operace dokončí. Hodnota se po úspěšném odeslání e-mailu odebere.
error	EntityError	Chyba entity
features	CustomModelFeatures	CustomModelFeatures Funkce podporované modelem

DetailedErrorCode

Výčet

Podrobný kód chyby

Hodnota	Description
DataImportFailed	Import dat se nezdařil.
DeleteNotAllowed	Odstranění není povoleno.
DeployNotAllowed	Nasazení není povoleno.
DeployingFailedModel	Nasazení modelu, který selhal
EmptyRequest	Prázdný požadavek.
EndpointCannotBeDefault	Koncový bod nemůže být výchozí.
EndpointNotUpdatable	Koncový bod není aktualizovatelný.
EndpointWithoutLogging	Koncový bod bez protokolování
ExceededNumberOfRecordingsUris	Byl překročen počet nahrávek uris.
FailedDataset	Datová sada selhala.
Forbidden	Zakázáno.
InUseViolation	Porušení používání.
InaccessibleCustomerStorage	Nepřístupné úložiště zákazníka
InvalidAdaptationMapping	Neplatné mapování adaptace
InvalidBaseModel	Neplatný základní model
InvalidCallbackUri	Neplatný identifikátor URI zpětného volání
InvalidCollection	Neplatná kolekce.
InvalidDataset	Neplatná datová sada
InvalidDocument	Neplatný dokument
InvalidDocumentBatch	Neplatná dávka dokumentu.
InvalidLocale	Neplatné národní prostředí.
InvalidLogDate	Neplatné datum protokolu.
InvalidLogEndTime	Neplatný čas ukončení protokolu.
InvalidLogId	Neplatné ID protokolu
InvalidLogStartTime	Neplatný čas spuštění protokolu.
InvalidModel	Neplatný model
InvalidModelUri	Neplatný identifikátor URI modelu
InvalidParameter	Neplatný parametr
InvalidParameterValue	Neplatná hodnota parametru
InvalidPayload	Neplatná datová část
InvalidPermissions	Neplatná oprávnění.
InvalidPrerequisite	Neplatná podmínka.
InvalidProductId	Neplatné ID produktu
InvalidProject	Neplatný projekt
InvalidProjectKind	Neplatný druh projektu
InvalidRecordingsUri	Neplatný identifikátor URI nahrávek
InvalidRequestBodyFormat	Neplatný formát textu požadavku.
InvalidSasValidityDuration	Neplatná doba platnosti SAS.
InvalidSkipTokenForLogs	Neplatný token skip pro protokoly.
InvalidSourceAzureResourceId	Neplatné ID zdrojového prostředku Azure
InvalidSubscription	Neplatné předplatné
InvalidTest	Neplatný test
InvalidTimeToLive	Hodnota TTL (Time to Live) je neplatná.
InvalidTopForLogs	Neplatné top pro protokoly.
InvalidTranscription	Neplatný přepis.
InvalidWebHookEventKind	Neplatný druh události webhooku
MissingInputRecords	Chybí vstupní záznamy.
ModelCopyOperationExists	Existuje operace kopírování modelu.
ModelDeploymentNotCompleteState	Nasazení modelu není dokončeno.
ModelDeprecated	Model je zastaralý.
ModelExists	Model existuje.
ModelMismatch	Neshoda modelů.
ModelNotDeployable	Model nejde nasadit.
ModelVersionIncorrect	Nesprávná verze modelu.
NoUtf8WithBom	No utf8 s bom.
OnlyOneOfUrlsOrContainerOrDataset	Pouze jednu z adres URL nebo kontejner nebo datovou sadu.
ProjectGenderMismatch	Neshoda pohlaví v projektu.
QuotaViolation	Porušení kvóty.
SingleDefaultEndpoint	Jeden výchozí koncový bod.
SkuLimitsExist	Existují omezení skladových položek.
SubscriptionNotFound	Předplatné se nenašlo.
UnexpectedError	Neočekávaná chyba.
UnsupportedClassBasedAdaptation	Nepodporovaná adaptace na základě třídy
UnsupportedDelta	Nepodporovaná rozdílová.
UnsupportedDynamicConfiguration	Nepodporovaná dynamická konfigurace
UnsupportedFilter	Nepodporovaný filtr
UnsupportedLanguageCode	Nepodporovaný kód jazyka
UnsupportedOrderBy	Nepodporované řazení podle.
UnsupportedPagination	Nepodporovaná stránkování.
UnsupportedTimeRange	Nepodporovaný časový rozsah.

EntityError

Objekt

Chyba entity

Name	Typ	Description
code	string	Kód této chyby.
message	string	Zpráva o této chybě.

EntityReference

Objekt

EntityReference

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

Error

Objekt

Chyba

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

ErrorCode

Výčet

ErrorCode

Hodnota	Description
Conflict	Představuje kód chyby konfliktu.
Forbidden	Představuje kód chyby Zakázáno.
InternalCommunicationFailed	Představuje kód chyby vnitřní komunikace, která selhala.
InternalServerError	Představuje kód vnitřní chyby serveru.
InvalidArgument	Představuje neplatný kód chyby argumentu.
InvalidRequest	Představuje neplatný kód chyby požadavku.
NotAllowed	Představuje nepovolený kód chyby.
NotFound	Představuje kód chyby nenalezena.
PipelineError	Představuje kód chyby kanálu.
ServiceUnavailable	Představuje kód chyby nedostupné služby.
TooManyRequests	Představuje kód chyby příliš mnoho požadavků.
Unauthorized	Představuje neoprávněný kód chyby.
UnprocessableEntity	Představuje kód chyby nezpracované entity.
UnsupportedMediaType	Představuje kód chyby nepodporovaného typu média.

InnerError

Objekt

Vnitřní chyba

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

OutputFormatType

Výčet

OutputFormatType

Hodnota	Description
Display	Model podporuje výstup nebo koncové body přepisu formátování zobrazení.
Lexical	Model poskytuje výstup přepisu bez formátování.

Status

Výčet

Stav

Hodnota	Description
Failed	Dlouhotrvající operace selhala.
NotStarted	Dlouhotrvající operace se ještě nespustila.
Running	Dlouhotrvající operace se právě zpracovává.
Succeeded	Dlouhotrvající operace byla úspěšně dokončena.

Sdílet prostřednictvím

Models - Create

Parametry identifikátoru URI

Text požadavku

Odpovědi

Zabezpečení

Ocp-Apim-Subscription-Key

Authorization

Příklady

Create a model

Ukázkový požadavek

Ukázková odpověď

Create a model with custom model weight

Ukázkový požadavek

Ukázková odpověď

Definice

CustomModel

CustomModelDeprecationDates

CustomModelFeatures

CustomModelLinks

CustomModelProperties

DetailedErrorCode

EntityError

EntityReference

Error

ErrorCode

InnerError

OutputFormatType

Status

Další materiály