Models - Create

Referens

Tjänst:: Azure AI Services

API-version:: v3.2-preview.2

Skapar en ny modell.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string	Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://westus.api.cognitive.microsoft.com).

Begärandetext

Name	Obligatorisk	Typ	Description
displayName	True	string minLength: 1	Objektets visningsnamn.
locale	True	string minLength: 1	Nationella inställningar för inneslutna data.
baseModel		EntityReference	EntityReference
customProperties		object	De anpassade egenskaperna för den här entiteten. Den maximala tillåtna nyckellängden är 64 tecken, den maximala tillåtna värdelängden är 256 tecken och antalet tillåtna poster är 10.
datasets		EntityReference[]	Datauppsättningar som används för anpassning.
description		string	Beskrivningen av objektet.
project		EntityReference	EntityReference
properties		CustomModelProperties	CustomModelProperties
text		string	Texten som används för att anpassa den här språkmodellen.

Svar

Name	Typ	Description
201 Created	CustomModel	Svaret innehåller information om entiteten som nyttolast och dess plats som rubrik. Sidhuvuden Location: string
Other Status Codes	Error	Ett fel uppstod.

Name

Typ

Description

201 Created

CustomModel

Svaret innehåller information om entiteten som nyttolast och dess plats som rubrik.

Sidhuvuden

Location: string

Other Status Codes

Error

Ett fel uppstod.

Säkerhet

Ocp-Apim-Subscription-Key

Ange din cognitive services-kontonyckel här.

Typ: apiKey
I: header

Authorization

Ange en åtkomsttoken från JWT som returneras av STS i den här regionen. Se till att lägga till hanteringsomfånget i token genom att lägga till följande frågesträng i STS-URL:en: ?scope=speechservicesmanagement

Typ: apiKey
I: header

Exempel

Create a model

Create a model with custom model weight

Create a model

Exempelbegäran

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

Exempelsvar

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

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name	Description
CustomModel	CustomModel
CustomModelDeprecationDates	CustomModelDeprecationDates
CustomModelFeatures	CustomModelFeatures
CustomModelLinks	CustomModelLinks
CustomModelProperties	CustomModelProperties
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
EntityReference	EntityReference
Error	Fel
ErrorCode	Felkod
InnerError	InnerError
OutputFormatType	OutputFormatType
Status	Status

CustomModel

Objekt

CustomModel

Name	Typ	Description
baseModel	EntityReference	EntityReference
createdDateTime	string (date-time)	Tidsstämpeln när objektet skapades. Tidsstämpeln är kodad som ISO 8601-datum- och tidsformat ("ÅÅÅÅ-MM-DDThh:mm:ssZ", se https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties	object	De anpassade egenskaperna för den här entiteten. Den maximala tillåtna nyckellängden är 64 tecken, den maximala tillåtna värdelängden är 256 tecken och antalet tillåtna poster är 10.
datasets	EntityReference[]	Datauppsättningar som används för anpassning.
description	string	Beskrivningen av objektet.
displayName	string minLength: 1	Objektets visningsnamn.
lastActionDateTime	string (date-time)	Tidsstämpeln när den aktuella statusen angavs. Tidsstämpeln är kodad som ISO 8601-datum- och tidsformat ("ÅÅÅÅ-MM-DDThh:mm:ssZ", se https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links	CustomModelLinks	CustomModelLinks
locale	string minLength: 1	Nationella inställningar för inneslutna data.
project	EntityReference	EntityReference
properties	CustomModelProperties	CustomModelProperties
self	string (uri)	Platsen för den här entiteten.
status	Status	Status Beskriva api:ets aktuella tillstånd
text	string	Texten som används för att anpassa den här språkmodellen.

CustomModelDeprecationDates

Objekt

CustomModelDeprecationDates

Name	Typ	Description
transcriptionDateTime	string (date-time)	Det datum då transkriptionen blir inaktuell.

CustomModelFeatures

Objekt

CustomModelFeatures

Name	Typ	Description
supportedOutputFormats	OutputFormatType[]	Utdataformat som stöds.
supportsEndpoints	boolean	Ett värde som anger om skapande av slutpunkter för live-transkription stöds.
supportsTranscriptions	boolean	Ett värde som anger om batch-transkription stöds.
supportsTranscriptionsOnSpeechContainers	boolean	Ett värde som anger om den här modellen kan användas för transkription i talcontainer. Den här funktionen kan läggas till i befintliga modeller när den blir användbar i talcontainern.

CustomModelLinks

Objekt

CustomModelLinks

Name	Typ	Description
copy	string (uri)	Platsen för modellkopieringsåtgärden. Mer information finns i åtgärden "Models_Copy".
copyTo	string (uri)	Platsen för den föråldrade modellkopieringsåtgärden. Mer information finns i åtgärden "Models_CopyTo".
files	string (uri)	Platsen där du kan hämta alla filer för den här entiteten. Mer information finns i åtgärden "Models_ListFiles".
manifest	string (uri)	Platsen för att hämta ett manifest för den här modellen som ska användas i den lokala containern. Mer information finns i åtgärden "Models_GetCustomModelManifest".

CustomModelProperties

Objekt

CustomModelProperties

Name	Typ	Description
customModelWeightPercent	integer (int32) minimum: 1 maximum: 100	Vikten för den anpassade modellen mellan 1 (1% anpassad modell och 99% basmodell) och 100 (100% anpassad modell och 0% basmodell). När den här egenskapen inte har angetts väljer tjänsten ett lämpligt värde (hämta modellen för att hämta den valda vikten). Börja utan att använda den här egenskapen. Om det behövs väljer du en större (eller mindre) vikt för att öka (eller minska) effekten av den anpassade modellen.
deprecationDates	CustomModelDeprecationDates	CustomModelDeprecationDates
email	string	E-postadressen som e-postaviseringar ska skickas till om åtgärden slutförs. Värdet tas bort när e-postmeddelandet har skickats.
error	EntityError	EntityError
features	CustomModelFeatures	CustomModelFeatures Funktioner som stöds av modellen.

DetailedErrorCode

Uppräkning

DetailedErrorCode

Värde	Description
DataImportFailed	Dataimporten misslyckades.
DeleteNotAllowed	Ta bort tillåts inte.
DeployNotAllowed	Distribution tillåts inte.
DeployingFailedModel	Distribution av en misslyckad modell.
EmptyRequest	Tom begäran.
EndpointCannotBeDefault	Slutpunkten kan inte vara standard.
EndpointNotUpdatable	Slutpunkten kan inte uppdateras.
EndpointWithoutLogging	Slutpunkt utan loggning.
ExceededNumberOfRecordingsUris	Överskred antalet inspelningar uris.
FailedDataset	Datauppsättningen misslyckades.
Forbidden	Förbjuden.
InUseViolation	Vid användningsöverträdelse.
InaccessibleCustomerStorage	Otillgänglig kundlagring.
InvalidAdaptationMapping	Ogiltig anpassningsmappning.
InvalidBaseModel	Ogiltig basmodell.
InvalidCallbackUri	Ogiltig återanrops-URI.
InvalidCollection	Ogiltig samling.
InvalidDataset	Ogiltig datauppsättning.
InvalidDocument	Ogiltigt dokument.
InvalidDocumentBatch	Ogiltig dokumentbatch.
InvalidLocale	Ogiltigt språk.
InvalidLogDate	Ogiltigt loggdatum.
InvalidLogEndTime	Ogiltig loggsluttid.
InvalidLogId	Ogiltigt logg-ID.
InvalidLogStartTime	Ogiltig starttid för loggen.
InvalidModel	Ogiltig modell.
InvalidModelUri	Ogiltig modell-URI.
InvalidParameter	Ogiltig parameter.
InvalidParameterValue	Ogiltigt parametervärde.
InvalidPayload	Ogiltig nyttolast.
InvalidPermissions	Ogiltiga behörigheter.
InvalidPrerequisite	Ogiltigt krav.
InvalidProductId	Ogiltigt produkt-ID.
InvalidProject	Ogiltigt projekt.
InvalidProjectKind	Ogiltig projekttyp.
InvalidRecordingsUri	Ogiltig inspelnings-URI.
InvalidRequestBodyFormat	Ogiltigt brödtextformat för begäran.
InvalidSasValidityDuration	Ogiltig varaktighet för sas-giltighet.
InvalidSkipTokenForLogs	Ogiltig hopptoken för loggar.
InvalidSourceAzureResourceId	Ogiltigt azure-källresurs-ID.
InvalidSubscription	Ogiltig prenumeration.
InvalidTest	Ogiltigt test.
InvalidTimeToLive	Ogiltig tid att leva.
InvalidTopForLogs	Ogiltig topp för loggar.
InvalidTranscription	Ogiltig transkription.
InvalidWebHookEventKind	Ogiltig typ av webbhookhändelse.
MissingInputRecords	Indataposter saknas.
ModelCopyOperationExists	Modellkopieringsåtgärden finns.
ModelDeploymentNotCompleteState	Modelldistributionen har inte slutförts.
ModelDeprecated	Modellen är inaktuell.
ModelExists	Modellen finns.
ModelMismatch	Modellmatchningsfel.
ModelNotDeployable	Modellen kan inte distribueras.
ModelVersionIncorrect	Modellversionen är felaktig.
NoUtf8WithBom	Ingen utf8 med bom.
OnlyOneOfUrlsOrContainerOrDataset	Endast en av url:erna eller containern eller datamängden.
ProjectGenderMismatch	Matchningsfel för projektkön.
QuotaViolation	Kvotöverträdelse.
SingleDefaultEndpoint	Enskild standardslutpunkt.
SkuLimitsExist	Det finns SKU-gränser.
SubscriptionNotFound	Det går inte att hitta prenumerationen.
UnexpectedError	Oväntat fel.
UnsupportedClassBasedAdaptation	Klassbaserad anpassning som inte stöds.
UnsupportedDelta	Delta stöds inte.
UnsupportedDynamicConfiguration	Dynamisk konfiguration stöds inte.
UnsupportedFilter	Filter som inte stöds.
UnsupportedLanguageCode	Språkkod som inte stöds.
UnsupportedOrderBy	Order som inte stöds av.
UnsupportedPagination	Sidnumrering stöds inte.
UnsupportedTimeRange	Tidsintervall som inte stöds.

EntityError

Objekt

EntityError

Name	Typ	Description
code	string	Koden för det här felet.
message	string	Meddelandet för det här felet.

EntityReference

Objekt

EntityReference

Name	Typ	Description
self	string (uri)	Platsen för den refererade entiteten.

Error

Objekt

Fel

Name	Typ	Description
code	ErrorCode	Felkod Felkoder på hög nivå.
details	Error[]	Ytterligare stödjande information om fel och/eller förväntade principer.
innerError	InnerError	InnerError Nytt format för inre fel som överensstämmer med Cognitive Services API Guidelines som finns på https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Detta innehåller nödvändiga egenskaper ErrorCode, meddelande och valfria egenskaper mål, information (nyckel värde par), inre fel (detta kan kapslas).
message	string	Felmeddelande på hög nivå.
target	string	Källan till felet. Det skulle till exempel vara "dokument" eller "dokument-ID" om dokumentet är ogiltigt.

ErrorCode

Uppräkning

Felkod

Värde	Description
Conflict	Representerar konfliktfelkoden.
Forbidden	Representerar den otillåtna felkoden.
InternalCommunicationFailed	Det gick inte att ange felkoden för intern kommunikation.
InternalServerError	Representerar felkoden för den interna servern.
InvalidArgument	Representerar den ogiltiga argumentfelkoden.
InvalidRequest	Representerar den ogiltiga felkoden för begäran.
NotAllowed	Representerar den felkod som inte tillåts.
NotFound	Representerar felkoden som inte hittades.
PipelineError	Representerar felkoden för pipelinefel.
ServiceUnavailable	Representerar felkoden för tjänsten som inte är tillgänglig.
TooManyRequests	Representerar felkoden för för många begäranden.
Unauthorized	Representerar den obehöriga felkoden.
UnprocessableEntity	Representerar felkoden för entitetsfel som inte kan bearbetas.
UnsupportedMediaType	Representerar felkoden för medietypen som inte stöds.

InnerError

Objekt

InnerError

Name	Typ	Description
code	DetailedErrorCode	DetailedErrorCode Detaljerad felkodsuppräkning.
details	object	Ytterligare stödjande information om fel och/eller förväntade principer.
innerError	InnerError	InnerError Nytt format för inre fel som överensstämmer med Cognitive Services API Guidelines som finns på https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Detta innehåller nödvändiga egenskaper ErrorCode, meddelande och valfria egenskaper mål, information (nyckel värde par), inre fel (detta kan kapslas).
message	string	Felmeddelande på hög nivå.
target	string	Källan till felet. Det skulle till exempel vara "dokument" eller "dokument-ID" om dokumentet är ogiltigt.

OutputFormatType

Uppräkning

OutputFormatType

Värde	Description
Display	Modellen stöder utdata eller slutpunkter för visningsformateringsutskrifter.
Lexical	Modellen tillhandahåller transkriptionsutdata utan formatering.

Status

Uppräkning

Status

Värde	Description
Failed	Den tidskrävande åtgärden misslyckades.
NotStarted	Den tidskrävande åtgärden har ännu inte startats.
Running	Den tidskrävande åtgärden bearbetas för närvarande.
Succeeded	Den tidskrävande åtgärden har slutförts.

Dela via

Models - Create

URI-parametrar

Begärandetext

Svar

Säkerhet

Ocp-Apim-Subscription-Key

Authorization

Exempel

Create a model

Exempelbegäran

Exempelsvar

Create a model with custom model weight

Exempelbegäran

Exempelsvar

Definitioner

CustomModel

CustomModelDeprecationDates

CustomModelFeatures

CustomModelLinks

CustomModelProperties

DetailedErrorCode

EntityError

EntityReference

Error

ErrorCode

InnerError

OutputFormatType

Status

Ytterligare resurser