Models - Get

Service:: Azure AI Services

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

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

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

URI-parameters

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 minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	De id van de resource.
api-version	query	True	string minLength: 1	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	Succes
Other Status Codes	ErrorResponse	Er is een fout opgetreden. Kopteksten x-ms-error-code: string

Name

Type

Description

200 OK

Model

Succes

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 Richtlijnen voor Microsoft Azure REST API 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	Foutreactie volgt richtlijnen voor Microsoft Azure REST API die beschikbaar zijn op https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
InnerError	Interne fout volgt richtlijnen voor Microsoft Azure REST API die beschikbaar zijn op https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Dit bevat de vereiste eigenschappenfoutcode, bericht en optionele eigenschappendoel, interne fout (dit kan worden genest).
Model	Modelobject
ModelFailureReason	Reden van modeltrainingsfout
ModelProperties	Modeleigenschappen
PresetStyleItem	Vooraf ingestelde stijlen die worden ondersteund door het recept. Het spraakmodel kan deze stijlen ondersteunen zonder een stijltrainingsset.
Recipe	Recept voor modelbouw. Verschillende recepten hebben verschillende mogelijkheden.
Status	Status van een resource.

Error

Object

Fout op het hoogste niveau volgt de Richtlijnen voor Microsoft Azure REST API 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 over de fout en/of het verwachte beleid.
innererror	InnerError	Interne fout volgt richtlijnen voor Microsoft Azure REST API die beschikbaar zijn op https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Dit bevat de vereiste eigenschappenfoutcode, bericht en optionele eigenschappendoel, 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

Inventarisatie

Foutcode op het hoogste niveau

Waarde	Description
BadRequest
BadArgument
Unauthorized
Forbidden
NotFound
UnsupportedMediaType
TooManyRequests
InternalServerError
ServiceUnavailable

ErrorResponse

Object

Foutreactie volgt richtlijnen voor Microsoft Azure REST API 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 Richtlijnen voor Microsoft Azure REST API 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

Object

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

Name	Type	Description
code	string	Gedetailleerde foutcode voor diagnostische gegevens.
innererror	InnerError	Interne fout volgt richtlijnen voor Microsoft Azure REST API die beschikbaar zijn op https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Dit bevat de vereiste eigenschappenfoutcode, bericht en optionele eigenschappendoel, 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

Object

Modelobject

Name	Type	Description
consentId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Resource-id
createdDateTime	string (date-time)	De tijdstempel waarop het object is gemaakt. De tijdstempel wordt 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. Als u deze versie bijwerkt, kunt u de meest recente uitspraak van fouten oplossen.
id	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Resource-id
lastActionDateTime	string (date-time)	De tijdstempel waarop de huidige status is ingevoerd. De tijdstempel wordt 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 spraakinstellingen hier 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]$	Resource-id
properties	ModelProperties	Modeleigenschappen
recipe	Recipe	Recept voor modelbouw. Verschillende recepten hebben verschillende mogelijkheden.
status	Status	Status van een resource.
trainingSetId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Resource-id
voiceName	string minLength: 1	Spraaknaam

ModelFailureReason

Inventarisatie

Reden van modeltrainingsfout

Waarde	Description
InaccessibleCustomerStorage	De klant gebruikt Bring Your Own Storage in spraakaccount. Maar de opslag is nu niet toegankelijk. Raadpleeg doc.
SpeakerVerificationFailed	De toestemmings- en trainingsaudio zijn niet afkomstig van dezelfde spreker.
TerminateByUser	De klant heeft modeltraining geannuleerd.
Internal	Custom Voice Service-fout.

ModelProperties

Object

Modeleigenschappen

Name	Type	Description
failureReason	ModelFailureReason	Reden van modeltrainingsfout
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

Object

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

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

Recipe

Object

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 spraakinstellingen 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 (int32)	Maximaal aangepast stijlnummer dat wordt ondersteund in één spraakmodel.
minStyleUtteranceCount	integer (int32)	Minimaal aantal utterances dat vereist is om elke aangepaste stijl te trainen.
minUtteranceCount	integer (int32)	Minimaal aantal uitingen dat is vereist voor het trainen van een spraakmodel met dit recept.
modelLocales	string[]	De landinstelling die een spraakmodel kan spreken met dit recept. Landinstellingscode volgt BCP-47. U vindt de lijst met spraakinstellingen hier https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
presetStyles	<string, PresetStyleItem>	Vooraf ingestelde stijlen die worden ondersteund door dit recept per landinstelling. U kunt deze stijlen verkrijgen zonder een stijltrainingsset.
version	string	Receptversie

Status

Inventarisatie

Status van een resource.

Waarde	Description
NotStarted
Running
Succeeded
Failed
Disabling
Disabled

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