Models - Create

Tjänst:: Azure AI Services

API-version:: 2024-02-01-preview

Skapar en ny röstmodell.

PUT {endpoint}/customvoice/models/{id}?api-version=2024-02-01-preview

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string	Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://eastus.api.cognitive.microsoft.com).
id	path	True	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Resursens ID.
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Ocp-Apim-Subscription-Key	True	string	Ange din Speech-resursnyckel här.
Operation-Id		string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	ID för statusövervakaren för åtgärden. Om Operation-Id-huvudet matchar en befintlig åtgärd och begäran inte är identisk med den tidigare begäran misslyckas den med en 400 Felaktig begäran.

Begärandetext

Name	Obligatorisk	Typ	Description
consentId	True	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Resurs-ID
projectId	True	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Resurs-ID
recipe	True	Recipe	Recept för modellbyggnad. Olika recept har olika funktioner.
trainingSetId	True	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Resurs-ID
description		string	Modellbeskrivning
id		string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Resurs-ID
locale		string	Språkvarianten för den här modellen. Språkkod följer BCP-47. Du hittar språklistan för text till tal här https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
properties		ModelProperties	Modellegenskaper
status		Status	Status för en resurs.
voiceName		string minLength: 1	Röstnamn

Svar

Name	Typ	Description
201 Created	Model	Skapad Sidhuvuden Operation-Id: string Operation-Location: string
Other Status Codes	ErrorResponse	Ett fel uppstod. Sidhuvuden x-ms-error-code: string

Name

Typ

Description

201 Created

Model

Skapad

Sidhuvuden

Operation-Id: string
Operation-Location: string

Other Status Codes

ErrorResponse

Ett fel uppstod.

Sidhuvuden

x-ms-error-code: string

Säkerhet

Ocp-Apim-Subscription-Key

Ange din Speech-resursnyckel här.

Typ: apiKey
I: header

Exempel

Create a model

Create a multi style model

Create a model

Exempelbegäran

HTTP

PUT {endpoint}/customvoice/models/Jessica?api-version=2024-02-01-preview



{
  "voiceName": "JessicaNeural",
  "description": "Jessica voice",
  "recipe": {
    "kind": "Default"
  },
  "projectId": "Jessica",
  "consentId": "Jessica",
  "trainingSetId": "Jessica-300"
}

Exempelsvar

Statuskod:: 201

Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/1f4352df-f247-40c0-a7b1-a54d017933e1?api-version=2024-02-01-preview
Operation-Id: 1f4352df-f247-40c0-a7b1-a54d017933e1

{
  "id": "Jessica",
  "voiceName": "JessicaNeural",
  "description": "Jessica voice",
  "recipe": {
    "kind": "Default",
    "version": "V7.2023.03"
  },
  "projectId": "Jessica",
  "consentId": "Jessica",
  "trainingSetId": "Jessica-300",
  "locale": "en-US",
  "engineVersion": "2023.07.04.0",
  "status": "NotStarted",
  "createdDateTime": "2023-04-01T05:30:00.000Z",
  "lastActionDateTime": "2023-04-02T10:15:30.000Z"
}

Create a multi style model

Exempelbegäran

HTTP

PUT {endpoint}/customvoice/models/JessicaMultiStyle?api-version=2024-02-01-preview



{
  "voiceName": "JessicaMultiStyleNeural",
  "description": "Jessica multi style voice",
  "recipe": {
    "kind": "MultiStyle"
  },
  "projectId": "Jessica",
  "consentId": "Jessica",
  "trainingSetId": "Jessica-300",
  "locale": "en-US",
  "properties": {
    "presetStyles": [
      "cheerful",
      "sad"
    ],
    "styleTrainingSetIds": {
      "happy": "JessicaHappy-300",
      "myStyle2": "JessicaStyle2"
    }
  }
}

Exempelsvar

Statuskod:: 201

Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/a01a127a-c204-4e46-a8c1-fab01559b05b?api-version=2024-02-01-preview
Operation-Id: a01a127a-c204-4e46-a8c1-fab01559b05b

{
  "id": "JessicaMultiStyle",
  "voiceName": "JessicaMultiStyleNeural",
  "description": "Jessica multi style voice",
  "recipe": {
    "kind": "MultiStyle",
    "version": "V3.2023.06"
  },
  "projectId": "Jessica",
  "consentId": "Jessica",
  "trainingSetId": "Jessica-300",
  "locale": "en-US",
  "engineVersion": "2023.07.04.0",
  "properties": {
    "presetStyles": [
      "cheerful",
      "sad"
    ],
    "styleTrainingSetIds": {
      "happy": "JessicaHappy-300",
      "myStyle2": "JessicaStyle2"
    },
    "voiceStyles": [
      "cheerful",
      "sad",
      "happy",
      "myStyle2"
    ]
  },
  "status": "NotStarted",
  "createdDateTime": "2023-04-01T05:30:00.000Z",
  "lastActionDateTime": "2023-04-02T10:15:30.000Z"
}

Definitioner

Name	Description
Error	Fel på toppnivå följer Riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Detta innehåller ett fel på den översta nivån med felkod, meddelande, information, mål och ett inre fel med mer beskrivande information.
ErrorCode	Felkod på toppnivå
ErrorResponse	Felsvaret följer riktlinjerna för Microsoft Azure REST API som är tillgängliga på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
InnerError	Inre fel följer riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Detta innehåller nödvändig egenskapsfelkod, meddelande och valfritt egenskapsmål, inre fel (detta kan kapslas).
Model	Modellobjekt
ModelFailureReason	Orsak till modellträningsfel
ModelProperties	Modellegenskaper
PresetStyleItem	Förinställda format som stöds av receptet. Röstmodellen kan stödja dessa format utan någon formatträningsuppsättning.
Recipe	Recept för modellbyggnad. Olika recept har olika funktioner.
Status	Status för en resurs.

Error

Objekt

Fel på toppnivå följer Riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Detta innehåller ett fel på den översta nivån med felkod, meddelande, information, mål och ett inre fel med mer beskrivande information.

Name	Typ	Description
code	ErrorCode	Felkod på toppnivå
details	Error[]	Ytterligare stödjande information om fel och/eller förväntade principer.
innererror	InnerError	Inre fel följer riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Detta innehåller nödvändig egenskapsfelkod, meddelande och valfritt egenskapsmål, inre fel (detta kan kapslas).
message	string	Felmeddelande på den översta nivån.
target	string	Källan till felet. Det skulle till exempel vara "modell" eller "modell-ID" i händelse av en ogiltig modell.

ErrorCode

Uppräkning

Felkod på toppnivå

Värde	Description
BadRequest
BadArgument
Unauthorized
Forbidden
NotFound
UnsupportedMediaType
TooManyRequests
InternalServerError
ServiceUnavailable

ErrorResponse

Objekt

Felsvaret följer riktlinjerna för Microsoft Azure REST API som är tillgängliga på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Name	Typ	Description
error	Error	Fel på toppnivå följer Riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Detta innehåller ett fel på den översta nivån med felkod, meddelande, information, mål och ett inre fel med mer beskrivande information.

InnerError

Objekt

Inre fel följer riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Detta innehåller nödvändig egenskapsfelkod, meddelande och valfritt egenskapsmål, inre fel (detta kan kapslas).

Name	Typ	Description
code	string	Detaljerad felkod för diagnostik.
innererror	InnerError	Inre fel följer riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Detta innehåller nödvändig egenskapsfelkod, meddelande och valfritt egenskapsmål, inre fel (detta kan kapslas).
message	string	Detaljerat felmeddelande.
target	string	Källan till felet. Det skulle till exempel vara "modell" eller "modell-ID" i händelse av en ogiltig modell.

Model

Objekt

Modellobjekt

Name	Typ	Description
consentId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Resurs-ID
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).
description	string	Modellbeskrivning
engineVersion	string	Motorversion. Uppdatera den här versionen kan få den senaste uttalsfelkorrigeringen.
id	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Resurs-ID
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).
locale	string	Språkvarianten för den här modellen. Språkkod följer BCP-47. Du hittar språklistan för text till tal här https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
projectId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Resurs-ID
properties	ModelProperties	Modellegenskaper
recipe	Recipe	Recept för modellbyggnad. Olika recept har olika funktioner.
status	Status	Status för en resurs.
trainingSetId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Resurs-ID
voiceName	string minLength: 1	Röstnamn

ModelFailureReason

Uppräkning

Orsak till modellträningsfel

Värde	Description
InaccessibleCustomerStorage	Kunden använder Bring Your Own Storage i Speech-kontot. Men lagringen är inte tillgänglig nu. Kontrollera dokument.
SpeakerVerificationFailed	Medgivandet och träningsljudet kommer inte från samma talare.
TerminateByUser	Kunden avbröt modellträningen.
Internal	Custom Voice Service-fel.

ModelProperties

Objekt

Modellegenskaper

Name	Typ	Description
failureReason	ModelFailureReason	Orsak till modellträningsfel
presetStyles	string[]	Förinställda format för den här modellen.
styleTrainingSetIds	object	Anpassade format och tillhörande träningsuppsättningar.
voiceStyles	string[]	Alla format som stöds av den här modellen.

PresetStyleItem

Objekt

Förinställda format som stöds av receptet. Röstmodellen kan stödja dessa format utan någon formatträningsuppsättning.

Name	Typ	Description
female	string[]	Förinställda format stöds på kvinnlig röstmodell.
male	string[]	Förinställda format som stöds på en manlig röstmodell.

Recipe

Objekt

Recept för modellbyggnad. Olika recept har olika funktioner.

Name	Typ	Description
datasetLocales	string[]	Språkvarianten för träningsdatauppsättningen. Språkkod följer BCP-47. Du hittar språklistan för text till tal här https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
description	string	Beskrivning av recept
kind	string	Recepttyp
maxCustomStyleNum	integer (int32)	Maximalt anpassat formatnummer som stöds i en röstmodell.
minStyleUtteranceCount	integer (int32)	Minsta antal yttranden som krävs för att träna varje anpassat format.
minUtteranceCount	integer (int32)	Minsta antal yttranden som krävs för att träna en röstmodell med det här receptet.
modelLocales	string[]	Språket som en röstmodell kan tala med det här receptet. Språkkod följer BCP-47. Du hittar språklistan för text till tal här https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
presetStyles	<string, PresetStyleItem>	Förinställda format som stöds av det här receptet per språk. Du kan hämta dessa format utan någon formatträningsuppsättning.
version	string	Receptversion

Status

Uppräkning

Status för en resurs.

Värde	Description
NotStarted
Running
Succeeded
Failed
Disabling
Disabled

Dela via

Models - Create

URI-parametrar

Begärandehuvud

Begärandetext

Svar

Säkerhet

Ocp-Apim-Subscription-Key

Exempel

Create a model

Exempelbegäran

Exempelsvar

Create a multi style model

Exempelbegäran

Exempelsvar

Definitioner

Error

ErrorCode

ErrorResponse

InnerError

Model

ModelFailureReason

ModelProperties

PresetStyleItem

Recipe

Status