Models - Get Base Model

Referens

Tjänst:: Azure AI Services

API-version:: v3.2-preview.2

Hämtar basmodellen som identifieras av det angivna ID:t.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string	Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://westus.api.cognitive.microsoft.com).
id	path	True	string uuid	Basmodellens identifierare.

Svar

Name	Typ	Description
200 OK	BaseModel	OK
Other Status Codes	Error	Ett fel inträffade.

Säkerhet

Ocp-Apim-Subscription-Key

Ange din cognitive services-kontonyckel här.

Typ: apiKey
I: header

Authorization

Ange en åtkomsttoken från den JWT som returneras av STS i den här regionen. Se till att lägga till hanteringsomfånget i token genom att lägga till följande frågesträng i STS-URL:en: ?scope=speechservicesmanagement

Typ: apiKey
I: header

Exempel

Get a base model

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 200

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/base/827712a5-f942-4997-91c3-7c6cde35600b",
  "links": {
    "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b"
  },
  "properties": {
    "deprecationDates": {
      "adaptationDateTime": "2022-11-04T00:00:00Z",
      "transcriptionDateTime": "2023-05-04T00:00:00Z"
    },
    "features": {
      "supportsTranscriptions": true,
      "supportsEndpoints": true,
      "supportsTranscriptionsOnSpeechContainers": true,
      "supportsAdaptationsWith": [
        "Language",
        "Acoustic"
      ],
      "supportedOutputFormats": [
        "Display",
        "Lexical"
      ]
    },
    "chargeForAdaptation": true
  },
  "lastActionDateTime": "2019-01-07T11:36:07Z",
  "status": "Succeeded",
  "createdDateTime": "2019-01-07T11:34:12Z",
  "locale": "en-US",
  "displayName": "en-US Base model"
}

Definitioner

Name	Description
BaseModel	BaseModel
BaseModelDeprecationDates	BaseModelDeprecationDates
BaseModelFeatures	BaseModelFeatures
BaseModelLinks	BaseModelLinks
BaseModelProperties	BaseModelProperties
DatasetKind	DatasetKind
DetailedErrorCode	DetailedErrorCode
Error	Fel
ErrorCode	Felkod
InnerError	InnerError
OutputFormatType	OutputFormatType
Status	Status

BaseModel

Name	Typ	Description
createdDateTime	string	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	Beskrivningen av objektet.
displayName	string	Visningsnamnet för objektet.
lastActionDateTime	string	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).
links	BaseModelLinks	BaseModelLinks
locale	string	Nationella inställningar för inneslutna data.
properties	BaseModelProperties	BaseModelProperties
self	string	Platsen för den här entiteten.
status	Status	Status Beskriva api:ets aktuella tillstånd

BaseModelDeprecationDates

Name	Typ	Description
adaptationDateTime	string	Datumet då anpassningen blir inaktuell.
transcriptionDateTime	string	Det datum då transkriptionen blir inaktuell.

BaseModelFeatures

Name	Typ	Description
supportedOutputFormats	OutputFormatType[]	Utdataformat som stöds.
supportsAdaptationsWith	DatasetKind[]	Datauppsättningstyper som stöds för att anpassa modellen.
supportsEndpoints	boolean	Ett värde som anger om skapande av slutpunkter för live-transkription stöds.
supportsTranscriptions	boolean	Ett värde som anger om batch-transkription stöds.
supportsTranscriptionsOnSpeechContainers	boolean	Ett värde som anger om den här modellen kan användas för transkription i talcontainern. Den här funktionen kan läggas till på befintliga modeller när den blir användbar i talcontainern.

BaseModelLinks

Name	Typ	Description
manifest	string	Platsen för att hämta ett manifest för den här modellen som ska användas i den lokala containern. Mer information finns i åtgärden "Models_GetCustomModelManifest".

BaseModelProperties

Name	Typ	Description
chargeForAdaptation	boolean	Ett värde som anger om modellanpassning debiteras.
deprecationDates	BaseModelDeprecationDates	BaseModelDeprecationDates
features	BaseModelFeatures	BaseModelFeatures Funktioner som stöds av modellen.

DatasetKind

Name	Typ	Description
Acoustic	string	En akustisk datauppsättning.
AudioFiles	string	En datauppsättning för ljudfiler.
Language	string	En språkdatauppsättning.
LanguageMarkdown	string	En markdown-datauppsättning för språk.
OutputFormatting	string	Datauppsättning som innehåller regler för att anpassa inverterad textnormalisering, versalisering, omformulering, svordomar och definierar även tester för validering av datauppsättningar
Pronunciation	string	En uttalsdatauppsättning.

DetailedErrorCode

Name	Typ	Description
DataImportFailed	string	Dataimporten misslyckades.
DeleteNotAllowed	string	Ta bort tillåts inte.
DeployNotAllowed	string	Distribution tillåts inte.
DeployingFailedModel	string	Det gick inte att distribuera modellen.
EmptyRequest	string	Tom begäran.
EndpointCannotBeDefault	string	Slutpunkten kan inte vara standard.
EndpointNotUpdatable	string	Slutpunkten kan inte uppdateras.
EndpointWithoutLogging	string	Slutpunkt utan loggning.
ExceededNumberOfRecordingsUris	string	Överskred antalet inspelningar.
FailedDataset	string	Datauppsättningen misslyckades.
Forbidden	string	Förbjudet.
InUseViolation	string	Vid användningsöverträdelse.
InaccessibleCustomerStorage	string	Otillgänglig kundlagring.
InvalidAdaptationMapping	string	Ogiltig anpassningsmappning.
InvalidBaseModel	string	Ogiltig basmodell.
InvalidCallbackUri	string	Ogiltig återanrops-URI.
InvalidCollection	string	Ogiltig samling.
InvalidDataset	string	Ogiltig datauppsättning.
InvalidDocument	string	Ogiltigt dokument.
InvalidDocumentBatch	string	Ogiltig dokumentbatch.
InvalidLocale	string	Ogiltigt språk.
InvalidLogDate	string	Ogiltigt loggdatum.
InvalidLogEndTime	string	Ogiltig sluttid för logg.
InvalidLogId	string	Ogiltigt logg-ID.
InvalidLogStartTime	string	Ogiltig starttid för logg.
InvalidModel	string	Ogiltig modell.
InvalidModelUri	string	Ogiltig modell-URI.
InvalidParameter	string	Ogiltig parameter.
InvalidParameterValue	string	Ogiltigt parametervärde.
InvalidPayload	string	Ogiltig nyttolast.
InvalidPermissions	string	Ogiltiga behörigheter.
InvalidPrerequisite	string	Ogiltig förutsättning.
InvalidProductId	string	Ogiltigt produkt-ID.
InvalidProject	string	Ogiltigt projekt.
InvalidProjectKind	string	Ogiltig projekttyp.
InvalidRecordingsUri	string	Ogiltig inspelnings-URI.
InvalidRequestBodyFormat	string	Ogiltigt brödtextformat för begäran.
InvalidSasValidityDuration	string	Ogiltig varaktighet för SAS-giltighet.
InvalidSkipTokenForLogs	string	Ogiltig hopptoken för loggar.
InvalidSourceAzureResourceId	string	Ogiltigt käll-resurs-ID för Azure.
InvalidSubscription	string	Ogiltig prenumeration.
InvalidTest	string	Ogiltigt test.
InvalidTimeToLive	string	Ogiltigt time to live.
InvalidTopForLogs	string	Ogiltig topp för loggar.
InvalidTranscription	string	Ogiltig transkription.
InvalidWebHookEventKind	string	Ogiltig webhookhändelsetyp.
MissingInputRecords	string	Indataposter saknas.
ModelCopyOperationExists	string	Modellkopieringsåtgärden finns.
ModelDeploymentNotCompleteState	string	Modelldistributionen är inte fullständigt.
ModelDeprecated	string	Modellen är inaktuell.
ModelExists	string	Modellen finns.
ModelMismatch	string	Modellmatchningsfel.
ModelNotDeployable	string	Modellen kan inte distribueras.
ModelVersionIncorrect	string	Modellversionen är felaktig.
NoUtf8WithBom	string	Ingen utf8 med bom.
OnlyOneOfUrlsOrContainerOrDataset	string	Endast en av URL:erna, containern eller datauppsättningen.
ProjectGenderMismatch	string	Projektets könsmatchningsfel.
QuotaViolation	string	Kvotöverträdelse.
SingleDefaultEndpoint	string	Enskild standardslutpunkt.
SkuLimitsExist	string	Det finns SKU-gränser.
SubscriptionNotFound	string	Det går inte att hitta prenumerationen.
UnexpectedError	string	Oväntat fel.
UnsupportedClassBasedAdaptation	string	Klassbaserad anpassning stöds inte.
UnsupportedDelta	string	Delta stöds inte.
UnsupportedDynamicConfiguration	string	Dynamisk konfiguration som inte stöds.
UnsupportedFilter	string	Filter som inte stöds.
UnsupportedLanguageCode	string	Språkkod som inte stöds.
UnsupportedOrderBy	string	Beställningen stöds inte av.
UnsupportedPagination	string	Sidnumrering stöds inte.
UnsupportedTimeRange	string	Tidsintervallet stöds inte.

Error

Fel

Name	Typ	Description
code	ErrorCode	Felkod Felkoder på hög nivå.
details	Error[]	Ytterligare stödjande information om fel- och/eller förväntade principer.
innerError	InnerError	InnerError Nytt format för inre fel som överensstämmer med Cognitive Services API Guidelines som finns på https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Detta innehåller nödvändiga egenskaper ErrorCode, meddelande och valfria egenskaper mål, information (nyckelvärdepar), inre fel (detta kan kapslas).
message	string	Felmeddelande på hög nivå.
target	string	Källan till felet. Det skulle till exempel vara "dokument" eller "dokument-ID" om dokumentet är ogiltigt.

ErrorCode

Felkod

Name	Typ	Description
Conflict	string	Representerar konfliktfelkoden.
Forbidden	string	Representerar den otillåtna felkoden.
InternalCommunicationFailed	string	Det gick inte att representera felkoden för intern kommunikation.
InternalServerError	string	Representerar felkoden för den interna servern.
InvalidArgument	string	Representerar den ogiltiga argumentfelkoden.
InvalidRequest	string	Representerar felkoden för ogiltig begäran.
NotAllowed	string	Representerar den felkod som inte tillåts.
NotFound	string	Representerar felkoden som inte hittades.
PipelineError	string	Representerar felkoden för pipelinefel.
ServiceUnavailable	string	Representerar felkoden för tjänsten som inte är tillgänglig.
TooManyRequests	string	Representerar felkoden för många begäranden.
Unauthorized	string	Representerar den otillåtna felkoden.
UnprocessableEntity	string	Representerar felkoden för entiteten som inte kan bearbetas.
UnsupportedMediaType	string	Representerar felkoden för medietypen som inte stöds.

InnerError

Name	Typ	Description
code	DetailedErrorCode	DetailedErrorCode Detaljerad felkodsuppräkning.
details	object	Ytterligare stödjande information om fel- och/eller förväntade principer.
innerError	InnerError	InnerError Nytt format för inre fel som överensstämmer med Cognitive Services API Guidelines som finns på https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Detta innehåller nödvändiga egenskaper ErrorCode, meddelande och valfria egenskaper mål, information (nyckelvärdepar), inre fel (detta kan kapslas).
message	string	Felmeddelande på hög nivå.
target	string	Källan till felet. Det skulle till exempel vara "dokument" eller "dokument-ID" om dokumentet är ogiltigt.

OutputFormatType

Name	Typ	Description
Display	string	Modellen stöder utdata eller slutpunkter för transkriptioner av visningsformat.
Lexical	string	Modellen tillhandahåller transkriptionsutdata utan formatering.

Status

Name	Typ	Description
Failed	string	Den långvariga åtgärden misslyckades.
NotStarted	string	Den långvariga åtgärden har ännu inte startats.
Running	string	Den tidskrävande åtgärden bearbetas för närvarande.
Succeeded	string	Den långvariga åtgärden har slutförts.

Dela via