Models - Get

Referentie

Service:: Azure AI Services

API-versie:: 2024-02-01-preview

Hiermee haalt u het model op dat wordt geïdentificeerd door de opgegeven id.

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

URI-parameters

Name In Vereist Type Description

Name	In	Vereist	Type	Description
endpoint	path	True	string	Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: https://eastus.api.cognitive.microsoft.com).
id	path	True	string	De id van de resource. Regex-patroon: `^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$`
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

endpoint

path

True

string

Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: https://eastus.api.cognitive.microsoft.com).

path

True

string

De id van de resource.

Regex-patroon: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

api-version

query

True

string

De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagkoptekst

Name	Vereist	Type	Description
Ocp-Apim-Subscription-Key	True	string	Geef hier uw spraakresourcesleutel op.

Antwoorden

Name	Type	Description
200 OK	Model	Geslaagd
Other Status Codes	ErrorResponse	Er is een fout opgetreden. Kopteksten x-ms-error-code: string

Name

Type

Description

200 OK

Model

Geslaagd

Other Status Codes

ErrorResponse

Er is een fout opgetreden.

Kopteksten

x-ms-error-code: string

Beveiliging

Ocp-Apim-Subscription-Key

Geef hier uw spraakresourcesleutel op.

Type: apiKey
In: header

Voorbeelden

Get a model

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:: 200

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

Definities

Name	Description
Error	Fout op het hoogste niveau volgt de Microsoft Azure REST API-richtlijnen die beschikbaar zijn op https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Dit bevat een fout op het hoogste niveau met foutcode, bericht, details, doel en een interne fout met meer beschrijvende details.
ErrorCode	Foutcode op het hoogste niveau
ErrorResponse	Het antwoord op de fout volgt de Microsoft Azure REST API-richtlijnen die beschikbaar zijn op https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
InnerError	Interne fout volgt de Microsoft Azure REST API-richtlijnen die beschikbaar zijn op https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Dit bevat de vereiste eigenschappen foutcode, bericht en optionele eigenschappen doel, interne fout (dit kan worden genest).
Model	Modelobject
ModelFailureReason	Reden van fout bij modeltraining
ModelProperties	Modeleigenschappen
PresetStyleItem	Vooraf ingestelde stijlen die worden ondersteund door het recept. Het spraakmodel kan deze stijlen ondersteunen zonder stijltrainingsset.
Recipe	Recept voor modelbouw. Verschillende recepten hebben verschillende mogelijkheden.
Status	Status van een resource.

Error

Fout op het hoogste niveau volgt de Microsoft Azure REST API-richtlijnen die beschikbaar zijn op https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Dit bevat een fout op het hoogste niveau met foutcode, bericht, details, doel en een interne fout met meer beschrijvende details.

Name	Type	Description
code	ErrorCode	Foutcode op het hoogste niveau
details	Error[]	Aanvullende ondersteunende informatie met betrekking tot de fout en/of het verwachte beleid.
innererror	InnerError	Interne fout volgt de Microsoft Azure REST API-richtlijnen die beschikbaar zijn op https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Dit bevat de vereiste eigenschappen foutcode, bericht en optionele eigenschappen doel, interne fout (dit kan worden genest).
message	string	Foutbericht op het hoogste niveau.
target	string	De bron van de fout. Dit is bijvoorbeeld 'model' of 'model-id' in het geval van een ongeldig model.

ErrorCode

Foutcode op het hoogste niveau

Name	Type	Description
BadArgument	string
BadRequest	string
Forbidden	string
InternalServerError	string
NotFound	string
ServiceUnavailable	string
TooManyRequests	string
Unauthorized	string
UnsupportedMediaType	string

ErrorResponse

Het antwoord op de fout volgt de Microsoft Azure REST API-richtlijnen die beschikbaar zijn op https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Name	Type	Description
error	Error	Fout op het hoogste niveau volgt de Microsoft Azure REST API-richtlijnen die beschikbaar zijn op https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Dit bevat een fout op het hoogste niveau met foutcode, bericht, details, doel en een interne fout met meer beschrijvende details.

InnerError

Interne fout volgt de Microsoft Azure REST API-richtlijnen die beschikbaar zijn op https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Dit bevat de vereiste eigenschappen foutcode, bericht en optionele eigenschappen doel, interne fout (dit kan worden genest).

Name	Type	Description
code	string	Gedetailleerde foutcode voor diagnostische gegevens.
innererror	InnerError	Interne fout volgt de Microsoft Azure REST API-richtlijnen die beschikbaar zijn op https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Dit bevat de vereiste eigenschappen foutcode, bericht en optionele eigenschappen doel, interne fout (dit kan worden genest).
message	string	Gedetailleerd foutbericht.
target	string	De bron van de fout. Dit is bijvoorbeeld 'model' of 'model-id' in het geval van een ongeldig model.

Model

Modelobject

Name	Type	Description
consentId	string	Resource-id
createdDateTime	string	De tijdstempel toen het object is gemaakt. De tijdstempel is gecodeerd als ISO 8601-datum- en tijdnotatie ('JJJJ-MM-DDThh:mm:ssZ', zie https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
description	string	Modelbeschrijving
engineVersion	string	Engineversie. Bijwerken van deze versie kan de meest recente uitspraak bugfixing krijgen.
id	string	Resource-id
lastActionDateTime	string	De tijdstempel waarop de huidige status is ingevoerd. De tijdstempel is gecodeerd als ISO 8601-datum- en tijdnotatie ('JJJJ-MM-DDThh:mm:ssZ', zie https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
locale	string	De landinstelling van dit model. Landinstellingscode volgt BCP-47. U vindt de lijst met landinstellingen voor tekst naar spraak hier https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
projectId	string	Resource-id
properties	ModelProperties	Modeleigenschappen
recipe	Recipe	Recept voor modelbouw. Verschillende recepten hebben verschillende mogelijkheden.
status	Status	Status van een resource.
trainingSetId	string	Resource-id
voiceName	string	Spraaknaam

ModelFailureReason

Reden van fout bij modeltraining

Name	Type	Description
InaccessibleCustomerStorage	string	De klant gebruikt Bring Your Own Storage in Speech Account. Maar de opslag is nu niet toegankelijk. Raadpleeg het document.
Internal	string	Fout in Custom Voice Service.
SpeakerVerificationFailed	string	De toestemmings- en trainingsaudio zijn niet van dezelfde spreker.
TerminateByUser	string	De klant heeft de modeltraining geannuleerd.

ModelProperties

Modeleigenschappen

Name	Type	Description
failureReason	ModelFailureReason	Reden van fout bij modeltraining
presetStyles	string[]	Vooraf ingestelde stijlen van dit model.
styleTrainingSetIds	object	Aangepaste stijlen en bijbehorende trainingssets.
voiceStyles	string[]	Alle stijlen die door dit model worden ondersteund.

PresetStyleItem

Vooraf ingestelde stijlen die worden ondersteund door het recept. Het spraakmodel kan deze stijlen ondersteunen zonder stijltrainingsset.

Name	Type	Description
female	string[]	Vooraf ingestelde stijlen die worden ondersteund in het vrouwelijke stemmodel.
male	string[]	Vooraf ingestelde stijlen die worden ondersteund op het mannelijke stemmodel.

Recipe

Recept voor modelbouw. Verschillende recepten hebben verschillende mogelijkheden.

Name	Type	Description
datasetLocales	string[]	De landinstelling van de trainingsgegevensset. Landinstellingscode volgt BCP-47. U vindt de lijst met landinstellingen voor tekst naar spraak hier https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
description	string	Beschrijving van recept
kind	string	Soort recept
maxCustomStyleNum	integer	Het maximum aantal aangepaste stijlen dat wordt ondersteund in één spraakmodel.
minStyleUtteranceCount	integer	Het minimumaantal uitingen dat vereist is om elke aangepaste stijl te trainen.
minUtteranceCount	integer	Het minimumaantal uitingen dat is vereist om een spraakmodel te trainen met dit recept.
modelLocales	string[]	De landinstelling die een spraakmodel kan spreken met dit recept. Landinstellingscode volgt BCP-47. U vindt de lijst met landinstellingen voor tekst naar spraak hier https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
presetStyles	<string, PresetStyleItem>	Vooraf ingestelde stijlen die door dit recept worden ondersteund, per landinstelling. U kunt deze stijlen krijgen zonder stijltrainingsset.
version	string	Receptversie

Status

Status van een resource.

Name	Type	Description
Disabled	string
Disabling	string
Failed	string
NotStarted	string
Running	string
Succeeded	string

Delen via

Models - Get

URI-parameters

Aanvraagkoptekst

Antwoorden

Beveiliging

Ocp-Apim-Subscription-Key

Voorbeelden

Get a model

Voorbeeldaanvraag

Voorbeeldrespons

Definities

Error

ErrorCode

ErrorResponse

InnerError

Model

ModelFailureReason

ModelProperties

PresetStyleItem

Recipe

Status

Aanvullende resources