Sdílet prostřednictvím


Models - Create

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

Zobrazovaný název objektu.

locale True

string

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

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

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

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

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

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

Vlastní model

Name Typ Description
baseModel

EntityReference

EntityReference

createdDateTime

string

Č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

Zobrazovaný název objektu.

lastActionDateTime

string

Č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

Národní prostředí obsažených dat.

project

EntityReference

EntityReference

properties

CustomModelProperties

Vlastní model – vlastnosti

self

string

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

CustomModelDeprecationDates

Name Typ Description
transcriptionDateTime

string

Datum, kdy se přepis přestane používat.

CustomModelFeatures

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

Name Typ Description
copy

string

Umístění akce kopírování modelu. Další podrobnosti najdete v části operace "Models_Copy".

copyTo

string

Umístění akce kopírování zastaralého modelu. Další podrobnosti najdete v části operace "Models_CopyTo".

files

string

Umístění pro získání všech souborů této entity Další podrobnosti najdete v části operace "Models_ListFiles".

manifest

string

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

Vlastní model – vlastnosti

Name Typ Description
customModelWeightPercent

integer

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

Podrobný kód chyby

Name Typ Description
DataImportFailed

string

Import dat se nezdařil.

DeleteNotAllowed

string

Odstranění není povoleno.

DeployNotAllowed

string

Nasazení není povoleno.

DeployingFailedModel

string

Nasazení modelu, který selhal

EmptyRequest

string

Prázdný požadavek.

EndpointCannotBeDefault

string

Koncový bod nemůže být výchozí.

EndpointNotUpdatable

string

Koncový bod není aktualizovatelný.

EndpointWithoutLogging

string

Koncový bod bez protokolování

ExceededNumberOfRecordingsUris

string

Byl překročen počet nahrávek uris.

FailedDataset

string

Datová sada selhala.

Forbidden

string

Zakázáno.

InUseViolation

string

Porušení používání.

InaccessibleCustomerStorage

string

Nepřístupné úložiště zákazníka

InvalidAdaptationMapping

string

Neplatné mapování adaptace

InvalidBaseModel

string

Neplatný základní model

InvalidCallbackUri

string

Neplatný identifikátor URI zpětného volání

InvalidCollection

string

Neplatná kolekce.

InvalidDataset

string

Neplatná datová sada

InvalidDocument

string

Neplatný dokument

InvalidDocumentBatch

string

Neplatná dávka dokumentu.

InvalidLocale

string

Neplatné národní prostředí.

InvalidLogDate

string

Neplatné datum protokolu.

InvalidLogEndTime

string

Neplatný čas ukončení protokolu.

InvalidLogId

string

Neplatné ID protokolu

InvalidLogStartTime

string

Neplatný čas spuštění protokolu.

InvalidModel

string

Neplatný model

InvalidModelUri

string

Neplatný identifikátor URI modelu

InvalidParameter

string

Neplatný parametr

InvalidParameterValue

string

Neplatná hodnota parametru

InvalidPayload

string

Neplatná datová část

InvalidPermissions

string

Neplatná oprávnění.

InvalidPrerequisite

string

Neplatná podmínka.

InvalidProductId

string

Neplatné ID produktu

InvalidProject

string

Neplatný projekt

InvalidProjectKind

string

Neplatný druh projektu

InvalidRecordingsUri

string

Neplatný identifikátor URI nahrávek

InvalidRequestBodyFormat

string

Neplatný formát textu požadavku.

InvalidSasValidityDuration

string

Neplatná doba platnosti SAS.

InvalidSkipTokenForLogs

string

Neplatný token skip pro protokoly.

InvalidSourceAzureResourceId

string

Neplatné ID zdrojového prostředku Azure

InvalidSubscription

string

Neplatné předplatné

InvalidTest

string

Neplatný test

InvalidTimeToLive

string

Hodnota TTL (Time to Live) je neplatná.

InvalidTopForLogs

string

Neplatné top pro protokoly.

InvalidTranscription

string

Neplatný přepis.

InvalidWebHookEventKind

string

Neplatný druh události webhooku

MissingInputRecords

string

Chybí vstupní záznamy.

ModelCopyOperationExists

string

Existuje operace kopírování modelu.

ModelDeploymentNotCompleteState

string

Nasazení modelu není dokončeno.

ModelDeprecated

string

Model je zastaralý.

ModelExists

string

Model existuje.

ModelMismatch

string

Neshoda modelů.

ModelNotDeployable

string

Model nejde nasadit.

ModelVersionIncorrect

string

Nesprávná verze modelu.

NoUtf8WithBom

string

No utf8 s bom.

OnlyOneOfUrlsOrContainerOrDataset

string

Pouze jednu z adres URL nebo kontejner nebo datovou sadu.

ProjectGenderMismatch

string

Neshoda pohlaví v projektu.

QuotaViolation

string

Porušení kvóty.

SingleDefaultEndpoint

string

Jeden výchozí koncový bod.

SkuLimitsExist

string

Existují omezení skladových položek.

SubscriptionNotFound

string

Předplatné se nenašlo.

UnexpectedError

string

Neočekávaná chyba.

UnsupportedClassBasedAdaptation

string

Nepodporovaná adaptace na základě třídy

UnsupportedDelta

string

Nepodporovaná rozdílová.

UnsupportedDynamicConfiguration

string

Nepodporovaná dynamická konfigurace

UnsupportedFilter

string

Nepodporovaný filtr

UnsupportedLanguageCode

string

Nepodporovaný kód jazyka

UnsupportedOrderBy

string

Nepodporované řazení podle.

UnsupportedPagination

string

Nepodporovaná stránkování.

UnsupportedTimeRange

string

Nepodporovaný časový rozsah.

EntityError

Chyba entity

Name Typ Description
code

string

Kód této chyby.

message

string

Zpráva o této chybě.

EntityReference

EntityReference

Name Typ Description
self

string

Umístění odkazované entity

Error

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

ErrorCode

Name Typ Description
Conflict

string

Představuje kód chyby konfliktu.

Forbidden

string

Představuje kód chyby Zakázáno.

InternalCommunicationFailed

string

Představuje kód chyby vnitřní komunikace, která selhala.

InternalServerError

string

Představuje kód vnitřní chyby serveru.

InvalidArgument

string

Představuje neplatný kód chyby argumentu.

InvalidRequest

string

Představuje neplatný kód chyby požadavku.

NotAllowed

string

Představuje nepovolený kód chyby.

NotFound

string

Představuje kód chyby nenalezena.

PipelineError

string

Představuje kód chyby kanálu.

ServiceUnavailable

string

Představuje kód chyby nedostupné služby.

TooManyRequests

string

Představuje kód chyby příliš mnoho požadavků.

Unauthorized

string

Představuje neoprávněný kód chyby.

UnprocessableEntity

string

Představuje kód chyby nezpracované entity.

UnsupportedMediaType

string

Představuje kód chyby nepodporovaného typu média.

InnerError

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

OutputFormatType

Name Typ Description
Display

string

Model podporuje výstup nebo koncové body přepisu formátování zobrazení.

Lexical

string

Model poskytuje výstup přepisu bez formátování.

Status

Stav

Name Typ Description
Failed

string

Dlouhotrvající operace selhala.

NotStarted

string

Dlouhotrvající operace se ještě nespustila.

Running

string

Dlouhotrvající operace se právě zpracovává.

Succeeded

string

Dlouhotrvající operace byla úspěšně dokončena.