Models - Get Custom Model

Referentie

Service:: Azure AI Services

API Version:: v3.2-preview.2

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

GET {endpoint}/speechtotext/v3.2-preview.2/models/{id}

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string	Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: https://westus.api.cognitive.microsoft.com).
id	path	True	string uuid	De id van het model.

Antwoorden

Name	Type	Description
200 OK	CustomModel	OK Headers Retry-After: integer
Other Status Codes	Error	Er is een fout opgetreden.

Name

Type

Description

200 OK

CustomModel

Headers

Retry-After: integer

Other Status Codes

Error

Er is een fout opgetreden.

Beveiliging

Ocp-Apim-Subscription-Key

Geef hier de sleutel van uw Cognitive Services-account op.

Type: apiKey
In: header

Authorization

Geef een toegangstoken op van de JWT die wordt geretourneerd door de STS van deze regio. Zorg ervoor dat u het beheerbereik aan het token toevoegt door de volgende queryreeks toe te voegen aan de STS-URL: ?scope=speechservicesmanagement

Type: apiKey
In: header

Voorbeelden

Get a model

Get a model with custom model weight

Get a model

Sample Request

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b

Sample Response

Status code:: 200

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

Get a model with custom model weight

Sample Request

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b

Sample Response

Status code:: 200

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

Definities

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

CustomModel

Name	Type	Description
baseModel	EntityReference	EntityReference
createdDateTime	string	De tijdstempel waarop 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).
customProperties	object	De aangepaste eigenschappen van deze entiteit. De maximaal toegestane sleutellengte is 64 tekens, de maximaal toegestane waardelengte is 256 tekens en het aantal toegestane vermeldingen is 10.
datasets	EntityReference[]	Gegevenssets die worden gebruikt voor aanpassing.
description	string	De beschrijving van het object.
displayName	string	De weergavenaam van het object.
lastActionDateTime	string	Het 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).
links	CustomModelLinks	CustomModelLinks
locale	string	De landinstelling van de opgenomen gegevens.
project	EntityReference	EntityReference
properties	CustomModelProperties	CustomModelProperties
self	string	De locatie van deze entiteit.
status	Status	Status De huidige status van de API beschrijven
text	string	De tekst die wordt gebruikt om dit taalmodel aan te passen.

CustomModelDeprecationDates

Name	Type	Description
transcriptionDateTime	string	De datum waarop transcriptie wordt afgeschaft.

CustomModelFeatures

Name	Type	Description
supportedOutputFormats	OutputFormatType[]	Ondersteunde uitvoerindelingen.
supportsEndpoints	boolean	Een waarde die aangeeft of het maken van eindpunten voor livetranscriptie wordt ondersteund.
supportsTranscriptions	boolean	Een waarde die aangeeft of batchtranscriptie wordt ondersteund.
supportsTranscriptionsOnSpeechContainers	boolean	Een waarde die aangeeft of dit model kan worden gebruikt voor transcriptie op de spraakcontainer. Deze functie kan worden toegevoegd aan bestaande modellen wanneer deze kan worden gebruikt in de spraakcontainer.

CustomModelLinks

Name	Type	Description
copy	string	De locatie van de actie voor het kopiëren van het model. Zie bewerking 'Models_Copy' voor meer informatie.
copyTo	string	De locatie van de actie voor het kopiëren van het verouderde model. Zie bewerking 'Models_CopyTo' voor meer informatie.
files	string	De locatie voor het ophalen van alle bestanden van deze entiteit. Zie bewerking 'Models_ListFiles' voor meer informatie.
manifest	string	De locatie voor het ophalen van een manifest voor dit model dat moet worden gebruikt in de on-premises container. Zie bewerking 'Models_GetCustomModelManifest' voor meer informatie.

CustomModelProperties

Name	Type	Description
customModelWeightPercent	integer	Het gewicht van het aangepaste model tussen 1 (1% aangepast model en 99% basismodel) en 100 (100% aangepast model en 0% basismodel). Wanneer deze eigenschap niet is ingesteld, kiest de service een geschikte waarde (haal het model op om het geselecteerde gewicht op te halen). Begin zonder deze eigenschap te gebruiken. Kies indien nodig een groter (of kleiner) gewicht om de impact van het aangepaste model te vergroten (of te verkleinen).
deprecationDates	CustomModelDeprecationDates	CustomModelDeprecationDates
email	string	Het e-mailadres waarnaar u e-mailmeldingen wilt verzenden voor het geval de bewerking is voltooid. De waarde wordt verwijderd nadat het e-mailbericht is verzonden.
error	EntityError	EntityError
features	CustomModelFeatures	CustomModelFeatures Functies die door het model worden ondersteund.

DetailedErrorCode

Name	Type	Description
DataImportFailed	string	Het importeren van gegevens is mislukt.
DeleteNotAllowed	string	Verwijderen is niet toegestaan.
DeployNotAllowed	string	Implementeren is niet toegestaan.
DeployingFailedModel	string	Het implementeren van een mislukt model.
EmptyRequest	string	Lege aanvraag.
EndpointCannotBeDefault	string	Eindpunt kan niet standaard zijn.
EndpointNotUpdatable	string	Eindpunt kan niet worden bijgewerkt.
EndpointWithoutLogging	string	Eindpunt zonder logboekregistratie.
ExceededNumberOfRecordingsUris	string	Het aantal opnamen is overschreden.
FailedDataset	string	Mislukte gegevensset.
Forbidden	string	Verboden.
InUseViolation	string	Schending van gebruik.
InaccessibleCustomerStorage	string	Ontoegankelijke klantopslag.
InvalidAdaptationMapping	string	Ongeldige aanpassingstoewijzing.
InvalidBaseModel	string	Ongeldig basismodel.
InvalidCallbackUri	string	Ongeldige callback-URI.
InvalidCollection	string	Ongeldige verzameling.
InvalidDataset	string	Ongeldige gegevensset.
InvalidDocument	string	Ongeldig document.
InvalidDocumentBatch	string	Ongeldige documentbatch.
InvalidLocale	string	Ongeldige landinstelling.
InvalidLogDate	string	Ongeldige logboekdatum.
InvalidLogEndTime	string	Ongeldige eindtijd van logboek.
InvalidLogId	string	Ongeldige logboek-id.
InvalidLogStartTime	string	Ongeldige begintijd van logboek.
InvalidModel	string	Ongeldig model.
InvalidModelUri	string	Ongeldige model-URI.
InvalidParameter	string	Ongeldige parameter.
InvalidParameterValue	string	Ongeldige parameterwaarde.
InvalidPayload	string	Ongeldige nettolading.
InvalidPermissions	string	Ongeldige machtigingen.
InvalidPrerequisite	string	Ongeldige vereiste.
InvalidProductId	string	Ongeldige product-id.
InvalidProject	string	Ongeldig project.
InvalidProjectKind	string	Ongeldige projectsoort.
InvalidRecordingsUri	string	Ongeldige URI voor opnamen.
InvalidRequestBodyFormat	string	Ongeldige indeling van aanvraagbody.
InvalidSasValidityDuration	string	Ongeldige sas-geldigheidsduur.
InvalidSkipTokenForLogs	string	Ongeldig token voor het overslaan van logboeken.
InvalidSourceAzureResourceId	string	Ongeldige bron-azure-resource-id.
InvalidSubscription	string	Ongeldig abonnement.
InvalidTest	string	Ongeldige test.
InvalidTimeToLive	string	Ongeldige time to live.
InvalidTopForLogs	string	Ongeldige bovenkant voor logboeken.
InvalidTranscription	string	Ongeldige transcriptie.
InvalidWebHookEventKind	string	Ongeldig soort webhook gebeurtenis.
MissingInputRecords	string	Ontbrekende invoerrecords.
ModelCopyOperationExists	string	De modelkopiebewerking bestaat.
ModelDeploymentNotCompleteState	string	De status modelimplementatie is niet voltooid.
ModelDeprecated	string	Het model is afgeschaft.
ModelExists	string	Het model bestaat.
ModelMismatch	string	Model komt niet overeen.
ModelNotDeployable	string	Model kan niet worden geïmplementeerd.
ModelVersionIncorrect	string	Modelversie onjuist.
NoUtf8WithBom	string	Geen utf8 met bom.
OnlyOneOfUrlsOrContainerOrDataset	string	Slechts één van de URL's of container of gegevensset.
ProjectGenderMismatch	string	Het geslacht van het project komt niet overeen.
QuotaViolation	string	Quotumschending.
SingleDefaultEndpoint	string	Eén standaardeindpunt.
SkuLimitsExist	string	Er bestaan SKU-limieten.
SubscriptionNotFound	string	Kan het abonnement niet vinden.
UnexpectedError	string	Onverwachte fout.
UnsupportedClassBasedAdaptation	string	Niet-ondersteunde aanpassing op basis van klassen.
UnsupportedDelta	string	Niet-ondersteunde delta.
UnsupportedDynamicConfiguration	string	Niet-ondersteunde dynamische configuratie.
UnsupportedFilter	string	Niet-ondersteund filter.
UnsupportedLanguageCode	string	Niet-ondersteunde taalcode.
UnsupportedOrderBy	string	Niet-ondersteunde bestelling op.
UnsupportedPagination	string	Niet-ondersteunde paginering.
UnsupportedTimeRange	string	Niet-ondersteund tijdsbereik.

EntityError

Name	Type	Description
code	string	De code van deze fout.
message	string	Het bericht voor deze fout.

EntityReference

Name	Type	Description
self	string	De locatie van de entiteit waarnaar wordt verwezen.

Error

Fout

Name	Type	Description
code	ErrorCode	ErrorCode Foutcodes op hoog niveau.
details	Error[]	Aanvullende ondersteunende informatie met betrekking tot de fout en/of het verwachte beleid.
innerError	InnerError	InnerError Nieuwe indeling voor interne fouten die voldoet aan de API-richtlijnen voor Cognitive Services die beschikbaar zijn op https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Dit bevat de vereiste eigenschappen Foutcode, bericht en optionele eigenschappen doel, details (sleutelwaardepaar), interne fout (dit kan worden genest).
message	string	Foutbericht op hoog niveau.
target	string	De bron van de fout. Dit is bijvoorbeeld 'documenten' of 'document-id' in het geval van een ongeldig document.

ErrorCode

Name	Type	Description
Conflict	string	Vertegenwoordigt de conflictfoutcode.
Forbidden	string	Vertegenwoordigt de verboden foutcode.
InternalCommunicationFailed	string	De foutcode voor de interne communicatie mislukt.
InternalServerError	string	Vertegenwoordigt de foutcode van de interne serverfout.
InvalidArgument	string	Vertegenwoordigt de foutcode van het ongeldige argument.
InvalidRequest	string	Vertegenwoordigt de ongeldige aanvraagfoutcode.
NotAllowed	string	Vertegenwoordigt de niet-toegestane foutcode.
NotFound	string	Vertegenwoordigt de foutcode die niet is gevonden.
PipelineError	string	Vertegenwoordigt de foutcode van de pijplijnfout.
ServiceUnavailable	string	Vertegenwoordigt de foutcode die niet beschikbaar is voor de service.
TooManyRequests	string	Vertegenwoordigt de foutcode voor te veel aanvragen.
Unauthorized	string	Vertegenwoordigt de foutcode voor onbevoegden.
UnprocessableEntity	string	Vertegenwoordigt de foutcode van de niet-verwerkbare entiteit.
UnsupportedMediaType	string	Vertegenwoordigt de foutcode van het niet-ondersteunde mediatype.

InnerError

Name	Type	Description
code	DetailedErrorCode	DetailedErrorCode Gedetailleerde foutcode- enum.
details	object	Aanvullende ondersteunende informatie met betrekking tot de fout en/of het verwachte beleid.
innerError	InnerError	InnerError Nieuwe indeling voor interne fouten die voldoet aan de API-richtlijnen voor Cognitive Services die beschikbaar zijn op https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Dit bevat de vereiste eigenschappen Foutcode, bericht en optionele eigenschappen doel, details (sleutelwaardepaar), interne fout (dit kan worden genest).
message	string	Foutbericht op hoog niveau.
target	string	De bron van de fout. Dit is bijvoorbeeld 'documenten' of 'document-id' in het geval van een ongeldig document.

OutputFormatType

Name	Type	Description
Display	string	Het model ondersteunt weergaveopmaak van uitvoer of eindpunten van transcripties.
Lexical	string	Model biedt de transcriptie-uitvoer zonder opmaak.

Status

Name	Type	Description
Failed	string	De langdurige bewerking is mislukt.
NotStarted	string	De langdurige bewerking is nog niet gestart.
Running	string	De langdurige bewerking wordt momenteel verwerkt.
Succeeded	string	De langdurige bewerking is voltooid.

Models - Get Custom Model

URI-parameters

Antwoorden

Beveiliging

Ocp-Apim-Subscription-Key

Authorization

Voorbeelden

Get a model

Sample Request

Sample Response

Get a model with custom model weight

Sample Request

Sample Response

Definities

CustomModel

CustomModelDeprecationDates

CustomModelFeatures

CustomModelLinks

CustomModelProperties

DetailedErrorCode

EntityError

EntityReference

Error

ErrorCode

InnerError

OutputFormatType

Status

Aanvullende resources