Models - Get Base Model

Reference

Služba:: Azure AI Services

Verze rozhraní API:: v3.2-preview.2

Získá základní model identifikovaný daným ID.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string	Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například: https://westus.api.cognitive.microsoft.com).
id	path	True	string (uuid)	Identifikátor základního modelu.

Odpovědi

Name	Typ	Description
200 OK	BaseModel	OK
Other Status Codes	Error	Došlo k chybě.

Zabezpečení

Ocp-Apim-Subscription-Key

Tady zadejte svůj klíč účtu služeb Cognitive Services.

Typ: apiKey
V: header

Authorization

Zadejte přístupový token z JWT vrácený službou STS této oblasti. Nezapomeňte do tokenu přidat obor správy přidáním následujícího řetězce dotazu do adresy URL služby STS: ?scope=speechservicesmanagement.

Typ: apiKey
V: header

Příklady

Get a base model

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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"
}

Definice

Name	Description
BaseModel	Základní model
BaseModelDeprecationDates	BaseModelDeprecationDates
BaseModelFeatures	BaseModelFeatures
BaseModelLinks	Odkazy na základní model
BaseModelProperties	Základní model – vlastnosti
DatasetKind	DatasetKind
DetailedErrorCode	Podrobný kód chyby
Error	Chyba
ErrorCode	ErrorCode
InnerError	Vnitřní chyba
OutputFormatType	OutputFormatType
Status	Stav

BaseModel

Objekt

Základní model

Name	Typ	Description
createdDateTime	string (date-time)	Časové razítko, kdy byl objekt vytvořen. Časové razítko je kódované jako formát data a času ISO 8601 ("RRRR-MM-DDThh:mm:ssZ", viz https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
description	string	Popis objektu.
displayName	string minLength: 1	Zobrazovaný název objektu.
lastActionDateTime	string (date-time)	Časové razítko, kdy byl zadán aktuální stav. Časové razítko je kódované jako formát data a času ISO 8601 ("RRRR-MM-DDThh:mm:ssZ", viz https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links	BaseModelLinks	Odkazy na základní model
locale	string minLength: 1	Národní prostředí obsažených dat.
properties	BaseModelProperties	Základní model – vlastnosti
self	string (uri)	Umístění této entity
status	Status	Stav Popis aktuálního stavu rozhraní API

BaseModelDeprecationDates

Objekt

BaseModelDeprecationDates

Name	Typ	Description
adaptationDateTime	string (date-time)	Datum, kdy se adaptace přestane používat.
transcriptionDateTime	string (date-time)	Datum, kdy se přepis přestane používat.

BaseModelFeatures

Objekt

BaseModelFeatures

Name	Typ	Description
supportedOutputFormats	OutputFormatType[]	Podporované formáty výstupu
supportsAdaptationsWith	DatasetKind[]	Podporované typy datových sad pro přizpůsobení modelu
supportsEndpoints	boolean	Hodnota označující, jestli se podporuje vytváření koncových bodů pro živý přepis.
supportsTranscriptions	boolean	Hodnota označující, jestli se podporuje dávkový přepis.
supportsTranscriptionsOnSpeechContainers	boolean	Hodnota označující, jestli se tento model dá použít pro přepis v kontejneru služby Speech. Tuto funkci je možné přidat do existujících modelů, jakmile ji bude možné použít v kontejneru služby Speech.

BaseModelLinks

Objekt

Odkazy na základní model

Name	Typ	Description
manifest	string (uri)	Umístění pro získání manifestu pro tento model, který se má použít v místním kontejneru. Další podrobnosti najdete v části operace "Models_GetCustomModelManifest".

BaseModelProperties

Objekt

Základní model – vlastnosti

Name	Typ	Description
chargeForAdaptation	boolean	Hodnota označující, jestli se účtuje adaptace modelu.
deprecationDates	BaseModelDeprecationDates	BaseModelDeprecationDates
features	BaseModelFeatures	BaseModelFeatures Funkce podporované modelem

DatasetKind

Výčet

DatasetKind

Hodnota	Description
Acoustic	Akustická datová sada.
AudioFiles	Datová sada zvukových souborů.
Language	Jazyková datová sada.
LanguageMarkdown	Datová sada markdownu jazyka.
OutputFormatting	Datová sada obsahující pravidla pro přizpůsobení normalizace inverzního textu, velká písmena, přeformátování, vulgární výrazy a také definuje testy pro ověření datové sady.
Pronunciation	Datová sada výslovnosti.

DetailedErrorCode

Výčet

Podrobný kód chyby

Hodnota	Description
DataImportFailed	Import dat se nezdařil.
DeleteNotAllowed	Odstranění není povoleno.
DeployNotAllowed	Nasazení není povoleno.
DeployingFailedModel	Nasazení neúspěšného modelu
EmptyRequest	Prázdný požadavek.
EndpointCannotBeDefault	Koncový bod nemůže být výchozí.
EndpointNotUpdatable	Koncový bod není možné aktualizovat.
EndpointWithoutLogging	Koncový bod bez protokolování
ExceededNumberOfRecordingsUris	Překročili jsme počet nahrávek uris.
FailedDataset	Datová sada selhala.
Forbidden	Zakázáno.
InUseViolation	Porušení používání.
InaccessibleCustomerStorage	Nepřístupné úložiště zákazníka.
InvalidAdaptationMapping	Neplatné mapování adaptace
InvalidBaseModel	Neplatný základní model
InvalidCallbackUri	Neplatný identifikátor URI zpětného volání
InvalidCollection	Neplatná kolekce.
InvalidDataset	Neplatná datová sada
InvalidDocument	Neplatný dokument
InvalidDocumentBatch	Neplatná dávka dokumentu.
InvalidLocale	Neplatné národní prostředí.
InvalidLogDate	Neplatné datum protokolu
InvalidLogEndTime	Neplatný koncový čas protokolu.
InvalidLogId	Neplatné ID protokolu.
InvalidLogStartTime	Neplatný čas spuštění protokolu.
InvalidModel	Neplatný model
InvalidModelUri	Neplatný identifikátor URI modelu
InvalidParameter	Neplatný parametr
InvalidParameterValue	Neplatná hodnota parametru
InvalidPayload	Neplatná datová část
InvalidPermissions	Neplatná oprávnění.
InvalidPrerequisite	Neplatná podmínka.
InvalidProductId	Neplatné ID produktu
InvalidProject	Neplatný projekt
InvalidProjectKind	Neplatný druh projektu
InvalidRecordingsUri	Neplatný identifikátor URI nahrávek
InvalidRequestBodyFormat	Neplatný formát textu požadavku.
InvalidSasValidityDuration	Neplatná doba platnosti sas.
InvalidSkipTokenForLogs	Neplatný token skip pro protokoly.
InvalidSourceAzureResourceId	Neplatné ID zdrojového prostředku Azure.
InvalidSubscription	Neplatné předplatné
InvalidTest	Neplatný test
InvalidTimeToLive	Neplatný čas do života.
InvalidTopForLogs	Neplatná horní část pro protokoly.
InvalidTranscription	Neplatný přepis.
InvalidWebHookEventKind	Neplatný druh události web hooku
MissingInputRecords	Chybí vstupní záznamy.
ModelCopyOperationExists	Existuje operace kopírování modelu.
ModelDeploymentNotCompleteState	Nasazení modelu není dokončeno.
ModelDeprecated	Model je zastaralý.
ModelExists	Model existuje.
ModelMismatch	Neshoda modelů.
ModelNotDeployable	Model nejde nasadit.
ModelVersionIncorrect	Nesprávná verze modelu.
NoUtf8WithBom	Ne utf8 s bom.
OnlyOneOfUrlsOrContainerOrDataset	Pouze jednu z adres URL nebo kontejneru nebo datové sady.
ProjectGenderMismatch	Neshoda mezi pohlavími projektu.
QuotaViolation	Porušení kvóty.
SingleDefaultEndpoint	Jeden výchozí koncový bod.
SkuLimitsExist	Existují omezení skladových položek.
SubscriptionNotFound	Předplatné se nenašlo.
UnexpectedError	Neočekávaná chyba.
UnsupportedClassBasedAdaptation	Nepodporovaná adaptace na základě tříd.
UnsupportedDelta	Nepodporovaný rozdíl.
UnsupportedDynamicConfiguration	Nepodporovaná dynamická konfigurace.
UnsupportedFilter	Nepodporovaný filtr.
UnsupportedLanguageCode	Nepodporovaný kód jazyka
UnsupportedOrderBy	Nepodporované pořadí podle.
UnsupportedPagination	Nepodporované stránkování.
UnsupportedTimeRange	Nepodporovaný časový rozsah.

Error

Objekt

Chyba

Name	Typ	Description
code	ErrorCode	ErrorCode Kódy chyb vysoké úrovně.
details	Error[]	Další podpůrné podrobnosti týkající se chyby nebo očekávaných zásad
innerError	InnerError	Vnitřní chyba Nový formát vnitřních chyb, který odpovídá pokynům k rozhraní API služeb Cognitive Services, které jsou k dispozici na adrese https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Obsahuje požadované vlastnosti ErrorCode, message a optional properties target, details(key value pair), inner error (to může být vnořené).
message	string	Chybová zpráva vysoké úrovně.
target	string	Zdroj chyby. V případě neplatného dokumentu by to bylo například "dokumenty" nebo "id dokumentu".

ErrorCode

Výčet

ErrorCode

Hodnota	Description
Conflict	Představuje kód chyby konfliktu.
Forbidden	Představuje kód chyby Zakázáno.
InternalCommunicationFailed	Představuje kód chyby vnitřní komunikace, která selhala.
InternalServerError	Představuje kód vnitřní chyby serveru.
InvalidArgument	Představuje neplatný kód chyby argumentu.
InvalidRequest	Představuje neplatný kód chyby požadavku.
NotAllowed	Představuje nepovolený kód chyby.
NotFound	Představuje kód chyby nenalezena.
PipelineError	Představuje kód chyby kanálu.
ServiceUnavailable	Představuje kód chyby nedostupné služby.
TooManyRequests	Představuje kód chyby příliš mnoho požadavků.
Unauthorized	Představuje neoprávněný kód chyby.
UnprocessableEntity	Představuje kód chyby nezpracované entity.
UnsupportedMediaType	Představuje kód chyby nepodporovaného typu média.

InnerError

Objekt

Vnitřní chyba

Name	Typ	Description
code	DetailedErrorCode	Podrobný kód chyby Podrobný výčet kódu chyby
details	object	Další podpůrné podrobnosti týkající se chyby nebo očekávaných zásad
innerError	InnerError	Vnitřní chyba Nový formát vnitřních chyb, který odpovídá pokynům k rozhraní API služeb Cognitive Services, které jsou k dispozici na adrese https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Obsahuje požadované vlastnosti ErrorCode, message a optional properties target, details(key value pair), inner error (to může být vnořené).
message	string	Chybová zpráva vysoké úrovně.
target	string	Zdroj chyby. V případě neplatného dokumentu by to bylo například "dokumenty" nebo "id dokumentu".

OutputFormatType

Výčet

OutputFormatType

Hodnota	Description
Display	Model podporuje výstup nebo koncové body přepisu formátování zobrazení.
Lexical	Model poskytuje výstup přepisu bez formátování.

Status

Výčet

Stav

Hodnota	Description
Failed	Dlouhotrvající operace selhala.
NotStarted	Dlouhotrvající operace se ještě nespustila.
Running	Dlouhotrvající operace se právě zpracovává.
Succeeded	Dlouhotrvající operace byla úspěšně dokončena.

Sdílet prostřednictvím

Models - Get Base Model

Parametry identifikátoru URI

Odpovědi

Zabezpečení

Ocp-Apim-Subscription-Key

Authorization

Příklady

Get a base model

Ukázkový požadavek

Ukázková odpověď

Definice

BaseModel

BaseModelDeprecationDates

BaseModelFeatures

BaseModelLinks

BaseModelProperties

DatasetKind

DetailedErrorCode

Error

ErrorCode

InnerError

OutputFormatType

Status

Další materiály