Models - Create

Usługa:: Azure AI Services

Wersja interfejsu API:: 2024-02-01-preview

Tworzy nowy model głosu.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string	Obsługiwane punkty końcowe usług Cognitive Services (protokół i nazwa hosta, na przykład: 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]$	Identyfikator zasobu.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Ocp-Apim-Subscription-Key	True	string	Tutaj podaj klucz zasobu usługi Mowa.
Operation-Id		string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Identyfikator monitora stanu dla operacji. Jeśli nagłówek Operation-Id pasuje do istniejącej operacji, a żądanie nie jest identyczne z poprzednim żądaniem, zakończy się niepowodzeniem z błędem 400 Nieprawidłowe żądanie.

Treść żądania

Nazwa	Wymagane	Typ	Opis
consentId	True	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Identyfikator zasobu
projectId	True	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Identyfikator zasobu
recipe	True	Recipe	Przepis na tworzenie modelu. Różne przepisy mają różne możliwości.
trainingSetId	True	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Identyfikator zasobu
description		string	Opis modelu
id		string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Identyfikator zasobu
locale		string	Ustawienia regionalne tego modelu. Kod ustawień regionalnych jest zgodny z kodem BCP-47. Tekst na liście ustawień regionalnych mowy można znaleźć tutaj https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
properties		ModelProperties	Właściwości modelu
status		Status	Stan zasobu.
voiceName		string minLength: 1	Nazwa głosu

Odpowiedzi

Nazwa	Typ	Opis
201 Created	Model	Utworzono Nagłówki Operation-Id: string Operation-Location: string
Other Status Codes	ErrorResponse	Wystąpił błąd. Nagłówki x-ms-error-code: string

Nazwa

Typ

Opis

201 Created

Model

Utworzono

Nagłówki

Operation-Id: string
Operation-Location: string

Other Status Codes

ErrorResponse

Wystąpił błąd.

Nagłówki

x-ms-error-code: string

Zabezpieczenia

Ocp-Apim-Subscription-Key

Tutaj podaj klucz zasobu usługi Mowa.

Typ: apiKey
W: header

Przykłady

Create a model

Create a multi style model

Create a model

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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"
}

Definicje

Nazwa	Opis
Error	Błąd najwyższego poziomu jest zgodny z wytycznymi interfejsu API REST platformy Microsoft Azure dostępnymi w https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Zawiera on błąd najwyższego poziomu z kodem błędu, komunikatem, szczegółami, elementem docelowym i wewnętrznym błędem z bardziej opisowymi szczegółami.
ErrorCode	Kod błędu najwyższego poziomu
ErrorResponse	Odpowiedź na błąd jest zgodna z wytycznymi interfejsu API REST platformy Microsoft Azure dostępnymi w witrynie https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
InnerError	Błąd wewnętrzny jest zgodny z wytycznymi interfejsu API REST platformy Microsoft Azure dostępnymi w https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Zawiera on wymagany kod błędu właściwości, komunikat i opcjonalny obiekt docelowy właściwości, błąd wewnętrzny (można to zagnieżdżać).
Model	Obiekt modelu
ModelFailureReason	Przyczyna niepowodzenia trenowania modelu
ModelProperties	Właściwości modelu
PresetStyleItem	Style wstępne obsługiwane przez przepis. Model głosowy może obsługiwać te style bez żadnego zestawu treningowego stylu.
Recipe	Przepis na tworzenie modelu. Różne przepisy mają różne możliwości.
Status	Stan zasobu.

Error

Objekt

Błąd najwyższego poziomu jest zgodny z wytycznymi interfejsu API REST platformy Microsoft Azure dostępnymi w https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Zawiera on błąd najwyższego poziomu z kodem błędu, komunikatem, szczegółami, elementem docelowym i wewnętrznym błędem z bardziej opisowymi szczegółami.

Nazwa	Typ	Opis
code	ErrorCode	Kod błędu najwyższego poziomu
details	Error[]	Dodatkowe szczegóły pomocnicze dotyczące błędów i/lub oczekiwanych zasad.
innererror	InnerError	Błąd wewnętrzny jest zgodny z wytycznymi interfejsu API REST platformy Microsoft Azure dostępnymi w https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Zawiera on wymagany kod błędu właściwości, komunikat i opcjonalny obiekt docelowy właściwości, błąd wewnętrzny (można to zagnieżdżać).
message	string	Komunikat o błędzie najwyższego poziomu.
target	string	Źródło błędu. Na przykład będzie to "model" lub "identyfikator modelu" w przypadku nieprawidłowego modelu.

ErrorCode

Wyliczanie

Kod błędu najwyższego poziomu

Wartość	Opis
BadRequest
BadArgument
Unauthorized
Forbidden
NotFound
UnsupportedMediaType
TooManyRequests
InternalServerError
ServiceUnavailable

ErrorResponse

Objekt

Odpowiedź na błąd jest zgodna z wytycznymi interfejsu API REST platformy Microsoft Azure dostępnymi w witrynie https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Nazwa	Typ	Opis
error	Error	Błąd najwyższego poziomu jest zgodny z wytycznymi interfejsu API REST platformy Microsoft Azure dostępnymi w https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Zawiera on błąd najwyższego poziomu z kodem błędu, komunikatem, szczegółami, elementem docelowym i wewnętrznym błędem z bardziej opisowymi szczegółami.

InnerError

Objekt

Błąd wewnętrzny jest zgodny z wytycznymi interfejsu API REST platformy Microsoft Azure dostępnymi w https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Zawiera on wymagany kod błędu właściwości, komunikat i opcjonalny obiekt docelowy właściwości, błąd wewnętrzny (można to zagnieżdżać).

Nazwa	Typ	Opis
code	string	Szczegółowy kod błędu pomocny w diagnostyce.
innererror	InnerError	Błąd wewnętrzny jest zgodny z wytycznymi interfejsu API REST platformy Microsoft Azure dostępnymi w https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Zawiera on wymagany kod błędu właściwości, komunikat i opcjonalny obiekt docelowy właściwości, błąd wewnętrzny (można to zagnieżdżać).
message	string	Szczegółowy komunikat o błędzie.
target	string	Źródło błędu. Na przykład będzie to "model" lub "identyfikator modelu" w przypadku nieprawidłowego modelu.

Model

Objekt

Obiekt modelu

Nazwa	Typ	Opis
consentId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Identyfikator zasobu
createdDateTime	string (date-time)	Sygnatura czasowa utworzenia obiektu. Znacznik czasu jest zakodowany jako format daty i godziny ISO 8601 ("RRRR-MM-DDThh:mm:ssZ", zobacz https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
description	string	Opis modelu
engineVersion	string	Wersja aparatu. Aktualizacja tej wersji może uzyskać najnowsze poprawki błędów wymowy.
id	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Identyfikator zasobu
lastActionDateTime	string (date-time)	Sygnatura czasowa po wprowadzeniu bieżącego stanu. Znacznik czasu jest zakodowany jako format daty i godziny ISO 8601 ("RRRR-MM-DDThh:mm:ssZ", zobacz https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
locale	string	Ustawienia regionalne tego modelu. Kod ustawień regionalnych jest zgodny z kodem BCP-47. Tekst na liście ustawień regionalnych mowy można znaleźć tutaj 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]$	Identyfikator zasobu
properties	ModelProperties	Właściwości modelu
recipe	Recipe	Przepis na tworzenie modelu. Różne przepisy mają różne możliwości.
status	Status	Stan zasobu.
trainingSetId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Identyfikator zasobu
voiceName	string minLength: 1	Nazwa głosu

ModelFailureReason

Wyliczanie

Przyczyna niepowodzenia trenowania modelu

Wartość	Opis
InaccessibleCustomerStorage	Klient używa usługi Bring Your Own Storage na koncie mowy. Jednak magazyn nie jest teraz dostępny. Sprawdź dokument.
SpeakerVerificationFailed	Zgoda i dźwięk treningowy nie pochodzą z tego samego głośnika.
TerminateByUser	Klient anulował szkolenie modelu.
Internal	Niestandardowy błąd usługi głosowej.

ModelProperties

Objekt

Właściwości modelu

Nazwa	Typ	Opis
failureReason	ModelFailureReason	Przyczyna niepowodzenia trenowania modelu
presetStyles	string[]	Wstępnie ustawione style tego modelu.
styleTrainingSetIds	object	Dostosowane style i skojarzone zestawy treningowe.
voiceStyles	string[]	Wszystkie style obsługiwane przez ten model.

PresetStyleItem

Objekt

Style wstępne obsługiwane przez przepis. Model głosowy może obsługiwać te style bez żadnego zestawu treningowego stylu.

Nazwa	Typ	Opis
female	string[]	Wstępnie ustawione style obsługiwane w modelu głosu kobiet.
male	string[]	Wstępnie ustawione style obsługiwane w modelu głosu męskiego.

Recipe

Objekt

Przepis na tworzenie modelu. Różne przepisy mają różne możliwości.

Nazwa	Typ	Opis
datasetLocales	string[]	Ustawienia regionalne zestawu danych trenowania. Kod ustawień regionalnych jest zgodny z kodem BCP-47. Tekst na liście ustawień regionalnych mowy można znaleźć tutaj https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
description	string	Opis przepisu
kind	string	Rodzaj przepisu
maxCustomStyleNum	integer (int32)	Maksymalna niestandardowa liczba stylów obsługiwana w jednym modelu głosu.
minStyleUtteranceCount	integer (int32)	Minimalna liczba wypowiedzi wymagana do trenowania każdego dostosowanego stylu.
minUtteranceCount	integer (int32)	Minimalna liczba wypowiedzi wymaganych do wytrenowania modelu głosu przy użyciu tego przepisu.
modelLocales	string[]	Ustawienia regionalne, które model głosowy może mówić z tym przepisem. Kod ustawień regionalnych jest zgodny z kodem BCP-47. Tekst na liście ustawień regionalnych mowy można znaleźć tutaj https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
presetStyles	<string, PresetStyleItem>	Ustawienia wstępne obsługiwane przez ten przepis na ustawienia regionalne. Możesz uzyskać te style bez żadnego zestawu treningowego stylu.
version	string	Wersja przepisu

Status

Wyliczanie

Stan zasobu.

Wartość	Opis
NotStarted
Running
Succeeded
Failed
Disabling
Disabled

Udostępnij za pośrednictwem

Models - Create

Parametry identyfikatora URI

Nagłówek żądania

Treść żądania

Odpowiedzi

Zabezpieczenia

Ocp-Apim-Subscription-Key

Przykłady

Create a model

Przykładowe żądanie

Przykładowa odpowiedź

Create a multi style model

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

Error

ErrorCode

ErrorResponse

InnerError

Model

ModelFailureReason

ModelProperties

PresetStyleItem

Recipe

Status