Models - List Base Models

Reference

Služba:: Azure AI Services

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

Získá seznam základních modelů pro ověřené předplatné.

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

S volitelnými parametry:

GET {endpoint}/speechtotext/v3.2-preview.2/models/base?skip={skip}&top={top}&filter={filter}

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).
filter	query		string	Filtrovací výraz pro výběr podmnožině dostupných základních modelů `- Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale. - Operators: - eq, ne are supported for all properties. - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime. - and, or, not are supported. - Example: filter=status eq 'NotStarted' or status eq 'Running'`
skip	query		integer int32	Počet datových sad, které budou vynechány.
top	query		integer int32	Počet datových sad, které budou zahrnuty po přeskočení

Odpovědi

Name	Typ	Description
200 OK	PaginatedBaseModels	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 all english base models

Ukázkový požadavek

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/models/base?skip=0&top=2&filter=locale%20eq%20'en-US'

Ukázková odpověď

Stavový kód:: 200

{
  "values": [
    {
      "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 modelu BaseModel
BaseModelProperties	BaseModelVlastnosti
DatasetKind	DatasetKind
DetailedErrorCode	Podrobný kód chyby
Error	Chyba
ErrorCode	ErrorCode
InnerError	Vnitřní chyba
OutputFormatType	OutputFormatType
PaginatedBaseModels	PaginatedBaseModels
Status	Stav

BaseModel

Základní model

Name	Typ	Description
createdDateTime	string	Časové razítko, kdy byl objekt vytvořen. Časové razítko je kódováno 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	Zobrazovaný název objektu.
lastActionDateTime	string	Časové razítko, kdy byl zadán aktuální stav. Časové razítko je kódováno 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 modelu BaseModel
locale	string	Národní prostředí obsažených dat.
properties	BaseModelProperties	BaseModelVlastnosti
self	string	Umístění této entity.
status	Status	Stav Popis aktuálního stavu rozhraní API

BaseModelDeprecationDates

Name	Typ	Description
adaptationDateTime	string	Datum, kdy bude úprava zastaralá.
transcriptionDateTime	string	Datum, kdy se přepis přestane používat.

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 speech. Tuto funkci je možné přidat do existujících modelů, jakmile se stane použitelnou v kontejneru speech.

BaseModelLinks

Odkazy modelu BaseModel

Name	Typ	Description
manifest	string	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 operaci "Models_GetCustomModelManifest".

BaseModelProperties

BaseModelVlastnosti

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

DatasetKind

Name	Typ	Description
Acoustic	string	Akustická datová sada.
AudioFiles	string	Datová sada zvukových souborů.
Language	string	Jazyková datová sada.
LanguageMarkdown	string	Datová sada markdownu jazyka.
OutputFormatting	string	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	string	Datová sada výslovnosti.

DetailedErrorCode

Podrobný kód chyby

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

Error

Chyba

Name	Typ	Description
code	ErrorCode	ErrorCode Kódy chyb vysoké úrovně.
details	Error[]	Další podrobnosti podpory týkající se chyby nebo očekávaných zásad
innerError	InnerError	Vnitřní chyba Nový formát vnitřní chyby, 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. Například v případě neplatného dokumentu by to byly "dokumenty" nebo "ID dokumentu".

ErrorCode

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

InnerError

Vnitřní chyba

Name	Typ	Description
code	DetailedErrorCode	Podrobný kód chyby Podrobný výčet kódu chyby
details	object	Další podrobnosti podpory týkající se chyby nebo očekávaných zásad
innerError	InnerError	Vnitřní chyba Nový formát vnitřní chyby, 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. Například v případě neplatného dokumentu by to byly "dokumenty" nebo "ID dokumentu".

OutputFormatType

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

PaginatedBaseModels

Name	Typ	Description
@nextLink	string	Odkaz na další sadu stránkovaných výsledků, pokud je k dispozici více entit; jinak null.
values	BaseModel[]	Seznam entit omezených parametry předaného dotazu "skip" a "top" nebo jejich výchozími hodnotami. Při iteraci seznamem pomocí stránkování a paralelním odstraňování entit se některé entity ve výsledcích přeskočí. Doporučujeme vytvořit seznam na klientovi a po načtení úplného seznamu ho odstranit.

Name

Typ

Description

@nextLink

string

Odkaz na další sadu stránkovaných výsledků, pokud je k dispozici více entit; jinak null.

values

BaseModel[]

Seznam entit omezených parametry předaného dotazu "skip" a "top" nebo jejich výchozími hodnotami.

Při iteraci seznamem pomocí stránkování a paralelním odstraňování entit se některé entity ve výsledcích přeskočí. Doporučujeme vytvořit seznam na klientovi a po načtení úplného seznamu ho odstranit.

Status

Stav

Name	Typ	Description
Failed	string	Dlouhotrvající operace selhala.
NotStarted	string	Dlouhotrvající operace ještě nebyla spuštěna.
Running	string	Dlouhotrvající operace se právě zpracovává.
Succeeded	string	Dlouhotrvající operace se úspěšně dokončila.

Sdílet prostřednictvím