Models - Get Base Model

Usługa:

Azure AI Services

Wersja interfejsu API:

v3.2-preview.2

Pobiera model podstawowy zidentyfikowany przez dany identyfikator.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string	Obsługiwane punkty końcowe usług Cognitive Services (protokół i nazwa hosta, na przykład: https://westus.api.cognitive.microsoft.com).
id	path	True	string (uuid)	Identyfikator modelu podstawowego.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	BaseModel	OK
Other Status Codes	Error	Wystąpił błąd.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Tutaj podaj klucz konta usług Cognitive Services.

Typ: apiKey
W: header

Authorization

Podaj token dostępu z zestawu JWT zwróconego przez usługę STS tego regionu. Pamiętaj, aby dodać zakres zarządzania do tokenu, dodając następujący ciąg zapytania do adresu URL usługi STS: ?scope=speechservicesmanagement

Typ: apiKey
W: header

Przykłady

Get a base model

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

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

Definicje

Nazwa	Opis
BaseModel	Model podstawowy
BaseModelDeprecationDates	BaseModelDeprecationDates
BaseModelFeatures	BaseModelFeatures
BaseModelLinks	BaseModelLinks
BaseModelProperties	Właściwości modelu BaseModel
DatasetKind	DatasetKind
DetailedErrorCode	DetailedErrorCode
Error	Błąd
ErrorCode	Kod błędu
InnerError	InnerError
OutputFormatType	OutputFormatType
Status	Status

BaseModel

Objekt

Model podstawowy

Nazwa	Typ	Opis
createdDateTime	string (date-time)	Sygnatura czasowa utworzenia obiektu. Sygnatura czasowa jest kodowana jako format daty i godziny ISO 8601 ("RRRR-MM-DDThh:mm:ssZ", zobacz https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
description	string	Opis obiektu.
displayName	string minLength: 1	Nazwa wyświetlana obiektu.
lastActionDateTime	string (date-time)	Sygnatura czasowa po wprowadzeniu bieżącego stanu. Sygnatura czasowa jest kodowana jako format daty i godziny ISO 8601 ("RRRR-MM-DDThh:mm:ssZ", zobacz https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links	BaseModelLinks	BaseModelLinks
locale	string minLength: 1	Ustawienia regionalne zawartych danych.
properties	BaseModelProperties	Właściwości modelu BaseModel
self	string (uri)	Lokalizacja tej jednostki.
status	Status	Status Opis bieżącego stanu interfejsu API

BaseModelDeprecationDates

Objekt

BaseModelDeprecationDates

Nazwa	Typ	Opis
adaptationDateTime	string (date-time)	Data, kiedy adaptacja stanie się przestarzała.
transcriptionDateTime	string (date-time)	Data, kiedy transkrypcja stanie się przestarzała.

BaseModelFeatures

Objekt

BaseModelFeatures

Nazwa	Typ	Opis
supportedOutputFormats	OutputFormatType[]	Obsługiwane formaty danych wyjściowych.
supportsAdaptationsWith	DatasetKind[]	Obsługiwane rodzaje zestawów danych w celu dostosowania modelu.
supportsEndpoints	boolean	Wartość wskazująca, czy tworzenie punktów końcowych dla transkrypcji na żywo jest obsługiwane.
supportsTranscriptions	boolean	Wartość wskazująca, czy transkrypcja wsadowa jest obsługiwana.
supportsTranscriptionsOnSpeechContainers	boolean	Wartość wskazująca, czy ten model może być używany do transkrypcji w kontenerze mowy. Tę funkcję można dodać do istniejących modeli, gdy będzie można jej używać w kontenerze mowy.

BaseModelLinks

Objekt

BaseModelLinks

Nazwa	Typ	Opis
manifest	string (uri)	Lokalizacja do pobrania manifestu dla tego modelu, który ma być używany w kontenerze lokalnego. Aby uzyskać więcej informacji, zobacz operację "Models_GetCustomModelManifest".

BaseModelProperties

Objekt

Właściwości modelu BaseModel

Nazwa	Typ	Opis
chargeForAdaptation	boolean	Wartość wskazująca, czy jest obciążana adaptacja modelu.
deprecationDates	BaseModelDeprecationDates	BaseModelDeprecationDates
features	BaseModelFeatures	BaseModelFeatures Funkcje obsługiwane przez model.

DatasetKind

Wyliczanie

DatasetKind

Wartość	Opis
Acoustic	Zestaw danych akustycznych.
AudioFiles	Zestaw danych plików audio.
Language	Zestaw danych języka.
LanguageMarkdown	Zestaw danych języka Markdown.
OutputFormatting	Zestaw danych, który zawiera reguły dostosowywania normalizacji odwrotnej tekstu, wielkości liter, reformacji, wulgaryzmów, a także definiuje testy weryfikacji zestawu danych
Pronunciation	Zestaw danych wymowy.

DetailedErrorCode

Wyliczanie

DetailedErrorCode

Wartość	Opis
DataImportFailed	Importowanie danych nie powiodło się.
DeleteNotAllowed	Usuń niedozwolone.
DeployNotAllowed	Wdrażanie jest niedozwolone.
DeployingFailedModel	Wdrażanie modelu nie powiodło się.
EmptyRequest	Puste żądanie.
EndpointCannotBeDefault	Punkt końcowy nie może być domyślny.
EndpointNotUpdatable	Punkt końcowy nie można aktualizować.
EndpointWithoutLogging	Punkt końcowy bez rejestrowania.
ExceededNumberOfRecordingsUris	Przekroczono liczbę nagrań uris.
FailedDataset	Zestaw danych, który zakończył się niepowodzeniem.
Forbidden	Zakazany.
InUseViolation	Naruszenie użycia.
InaccessibleCustomerStorage	Niedostępny magazyn klienta.
InvalidAdaptationMapping	Nieprawidłowe mapowanie adaptacji.
InvalidBaseModel	Nieprawidłowy model podstawowy.
InvalidCallbackUri	Nieprawidłowy identyfikator URI wywołania zwrotnego.
InvalidCollection	Nieprawidłowa kolekcja.
InvalidDataset	Nieprawidłowy zestaw danych.
InvalidDocument	Nieprawidłowy dokument.
InvalidDocumentBatch	Nieprawidłowa partia dokumentów.
InvalidLocale	Nieprawidłowe ustawienia regionalne.
InvalidLogDate	Nieprawidłowa data dziennika.
InvalidLogEndTime	Nieprawidłowy czas zakończenia dziennika.
InvalidLogId	Nieprawidłowy identyfikator dziennika.
InvalidLogStartTime	Nieprawidłowy czas rozpoczęcia dziennika.
InvalidModel	Nieprawidłowy model.
InvalidModelUri	Nieprawidłowy identyfikator URI modelu.
InvalidParameter	Nieprawidłowy parametr.
InvalidParameterValue	Nieprawidłowa wartość parametru.
InvalidPayload	Nieprawidłowy ładunek.
InvalidPermissions	Nieprawidłowe uprawnienia.
InvalidPrerequisite	Nieprawidłowe wymaganie wstępne.
InvalidProductId	Nieprawidłowy identyfikator produktu.
InvalidProject	Nieprawidłowy projekt.
InvalidProjectKind	Nieprawidłowy rodzaj projektu.
InvalidRecordingsUri	Nieprawidłowy identyfikator URI nagrań.
InvalidRequestBodyFormat	Nieprawidłowy format treści żądania.
InvalidSasValidityDuration	Nieprawidłowy czas ważności sygnatury dostępu współdzielonego.
InvalidSkipTokenForLogs	Nieprawidłowy token pomijania dzienników.
InvalidSourceAzureResourceId	Nieprawidłowy źródłowy identyfikator zasobu platformy Azure.
InvalidSubscription	Nieprawidłowa subskrypcja.
InvalidTest	Nieprawidłowy test.
InvalidTimeToLive	Nieprawidłowy czas wygaśnięcia.
InvalidTopForLogs	Nieprawidłowy górny element dla dzienników.
InvalidTranscription	Nieprawidłowa transkrypcja.
InvalidWebHookEventKind	Nieprawidłowy rodzaj zdarzenia elementu webhook.
MissingInputRecords	Brak rekordów wejściowych.
ModelCopyOperationExists	Istnieje operacja kopiowania modelu.
ModelDeploymentNotCompleteState	Wdrożenie modelu nie zostało ukończone.
ModelDeprecated	Model jest przestarzały.
ModelExists	Model istnieje.
ModelMismatch	Niezgodność modelu.
ModelNotDeployable	Nie można wdrożyć modelu.
ModelVersionIncorrect	Nieprawidłowa wersja modelu.
NoUtf8WithBom	Brak utf8 z bom.
OnlyOneOfUrlsOrContainerOrDataset	Tylko jeden z adresów URL lub kontenera lub zestawu danych.
ProjectGenderMismatch	Niezgodność płci projektu.
QuotaViolation	Naruszenie limitu przydziału.
SingleDefaultEndpoint	Pojedynczy domyślny punkt końcowy.
SkuLimitsExist	Istnieją limity jednostek SKU.
SubscriptionNotFound	Nie można odnaleźć subskrypcji.
UnexpectedError	Nieoczekiwany błąd.
UnsupportedClassBasedAdaptation	Nieobsługiwana adaptacja oparta na klasach.
UnsupportedDelta	Nieobsługiwana delta.
UnsupportedDynamicConfiguration	Nieobsługiwana konfiguracja dynamiczna.
UnsupportedFilter	Nieobsługiwany filtr.
UnsupportedLanguageCode	Nieobsługiwany kod języka.
UnsupportedOrderBy	Nieobsługiwana kolejność według.
UnsupportedPagination	Nieobsługiwane stronicowanie.
UnsupportedTimeRange	Nieobsługiwany zakres czasu.

Error

Objekt

Błąd

Nazwa	Typ	Opis
code	ErrorCode	Kod błędu Kody błędów wysokiego poziomu.
details	Error[]	Dodatkowe szczegóły pomocnicze dotyczące błędów i/lub oczekiwanych zasad.
innerError	InnerError	InnerError Nowy format błędu wewnętrznego zgodny z wytycznymi interfejsu API usług Cognitive Services dostępnymi w witrynie https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Zawiera to wymagane właściwości ErrorCode, komunikat i opcjonalny obiekt docelowy właściwości, szczegóły (para wartości klucza), błąd wewnętrzny (można to zagnieżdżać).
message	string	Komunikat o błędzie wysokiego poziomu.
target	string	Źródło błędu. Na przykład będzie to "dokumenty" lub "identyfikator dokumentu" w przypadku nieprawidłowego dokumentu.

ErrorCode

Wyliczanie

Kod błędu

Wartość	Opis
Conflict	Reprezentowanie kodu błędu powodującego konflikt.
Forbidden	Reprezentowanie niedozwolonego kodu błędu.
InternalCommunicationFailed	Reprezentowanie wewnętrznego kodu błędu komunikacji nie powiodło się.
InternalServerError	Reprezentowanie wewnętrznego kodu błędu serwera.
InvalidArgument	Reprezentowanie nieprawidłowego kodu błędu argumentu.
InvalidRequest	Reprezentowanie nieprawidłowego kodu błędu żądania.
NotAllowed	Reprezentowanie niedozwolonego kodu błędu.
NotFound	Reprezentacja kodu błędu, który nie został znaleziony.
PipelineError	Reprezentowanie kodu błędu potoku.
ServiceUnavailable	Reprezentowanie niedostępnego kodu błędu usługi.
TooManyRequests	Reprezentując kod błędu zbyt wielu żądań.
Unauthorized	Reprezentowanie nieautoryzowanego kodu błędu.
UnprocessableEntity	Reprezentowanie nieprzetworzonego kodu błędu jednostki.
UnsupportedMediaType	Reprezentowanie nieobsługiwanego kodu błędu typu nośnika.

InnerError

Objekt

InnerError

Nazwa	Typ	Opis
code	DetailedErrorCode	DetailedErrorCode Szczegółowy wyliczenie kodu błędu.
details	object	Dodatkowe szczegóły pomocnicze dotyczące błędów i/lub oczekiwanych zasad.
innerError	InnerError	InnerError Nowy format błędu wewnętrznego zgodny z wytycznymi interfejsu API usług Cognitive Services dostępnymi w witrynie https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Zawiera to wymagane właściwości ErrorCode, komunikat i opcjonalny obiekt docelowy właściwości, szczegóły (para wartości klucza), błąd wewnętrzny (można to zagnieżdżać).
message	string	Komunikat o błędzie wysokiego poziomu.
target	string	Źródło błędu. Na przykład będzie to "dokumenty" lub "identyfikator dokumentu" w przypadku nieprawidłowego dokumentu.

OutputFormatType

Wyliczanie

OutputFormatType

Wartość	Opis
Display	Model obsługuje wyświetlanie formatowania danych wyjściowych lub punktów końcowych transkrypcji.
Lexical	Model udostępnia dane wyjściowe transkrypcji bez formatowania.

Status

Wyliczanie

Status

Wartość	Opis
Failed	Długotrwała operacja nie powiodła się.
NotStarted	Długotrwała operacja nie została jeszcze uruchomiona.
Running	Długotrwała operacja jest obecnie przetwarzana.
Succeeded	Długotrwała operacja została pomyślnie ukończona.