Models - List Custom Models

Usługa:: Azure AI Services

Wersja interfejsu API:: v3.2-preview.2

Pobiera listę modeli niestandardowych dla uwierzytelnionej subskrypcji.

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

Z parametrami opcjonalnymi:

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

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).
filter	query		string	Wyrażenie filtrowania służące do wybierania podzestawu dostępnych modeli. `- 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)	Liczba zestawów danych, które zostaną pominięte.
top	query		integer (int32)	Liczba zestawów danych, które zostaną uwzględnione po pomijaniu.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	PaginatedCustomModels	OK Nagłówki Retry-After: integer
Other Status Codes	Error	Wystąpił błąd.

Nazwa

Typ

Opis

200 OK

PaginatedCustomModels

Nagłówki

Retry-After: integer

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 all models in state 'Running'

Przykładowe żądanie

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/models?skip=0&top=2&filter=status%20eq%20'Running'

Przykładowa odpowiedź

Kod stanu:: 200

{
  "values": [
    {
      "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"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b",
      "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/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1"
        }
      ],
      "links": {
        "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/manifest/a04e77e6-2009-462c-8d1c-65d718ee4b7b",
        "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b:copyto",
        "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b:copy",
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b/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": "Acoustic model",
      "description": "Example for an acoustic model"
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models?skip=2&top=2&filter=status%20eq%20'Running'"
}

Definicje

Nazwa	Opis
CustomModel	Model niestandardowy
CustomModelDeprecationDates	CustomModelDeprecationDates
CustomModelFeatures	CustomModelFeatures
CustomModelLinks	CustomModelLinks
CustomModelProperties	Właściwości modelu CustomModel
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
EntityReference	EntityReference
Error	Błąd
ErrorCode	Kod błędu
InnerError	InnerError
OutputFormatType	OutputFormatType
PaginatedCustomModels	PaginatedCustomModels
Status	Status

CustomModel

Objekt

Model niestandardowy

Nazwa	Typ	Opis
baseModel	EntityReference	EntityReference
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).
customProperties	object	Właściwości niestandardowe tej jednostki. Maksymalna dozwolona długość klucza to 64 znaki, maksymalna dozwolona długość wartości to 256 znaków, a liczba dozwolonych wpisów wynosi 10.
datasets	EntityReference[]	Zestawy danych używane do adaptacji.
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	CustomModelLinks	CustomModelLinks
locale	string minLength: 1	Ustawienia regionalne zawartych danych.
project	EntityReference	EntityReference
properties	CustomModelProperties	Właściwości modelu CustomModel
self	string (uri)	Lokalizacja tej jednostki.
status	Status	Status Opis bieżącego stanu interfejsu API
text	string	Tekst używany do dostosowywania tego modelu językowego.

CustomModelDeprecationDates

Objekt

CustomModelDeprecationDates

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

CustomModelFeatures

Objekt

CustomModelFeatures

Nazwa	Typ	Opis
supportedOutputFormats	OutputFormatType[]	Obsługiwane formaty danych wyjściowych.
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.

CustomModelLinks

Objekt

CustomModelLinks

Nazwa	Typ	Opis
copy	string (uri)	Lokalizacja akcji kopiowania modelu. Aby uzyskać więcej informacji, zobacz operację "Models_Copy".
copyTo	string (uri)	Lokalizacja przestarzałej akcji kopiowania modelu. Aby uzyskać więcej informacji, zobacz operację "Models_CopyTo".
files	string (uri)	Lokalizacja pobierania wszystkich plików tej jednostki. Aby uzyskać więcej informacji, zobacz operację "Models_ListFiles".
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".

CustomModelProperties

Objekt

Właściwości modelu CustomModel

Nazwa	Typ	Opis
customModelWeightPercent	integer (int32) minimum: 1 maximum: 100	Waga modelu niestandardowego z zakresu od 1 (1% modelu niestandardowego do 99% modelu podstawowego) i 100 (100% modelu niestandardowego i 0% modelu podstawowego). Jeśli ta właściwość nie zostanie ustawiona, usługa wybierze odpowiednią wartość (pobierz model, aby pobrać wybraną wagę). Rozpocznij bez użycia tej właściwości. W razie potrzeby wybierz większą (lub mniejszą) wagę, aby zwiększyć (lub zmniejszyć) wpływ modelu niestandardowego.
deprecationDates	CustomModelDeprecationDates	CustomModelDeprecationDates
email	string	Adres e-mail do wysyłania powiadomień e-mail na adres w przypadku zakończenia operacji. Wartość zostanie usunięta po pomyślnym wysłaniu wiadomości e-mail.
error	EntityError	EntityError
features	CustomModelFeatures	CustomModelFeatures Funkcje obsługiwane przez model.

DetailedErrorCode

Wyliczanie

DetailedErrorCode

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

EntityError

Objekt

EntityError

Nazwa	Typ	Opis
code	string	Kod tego błędu.
message	string	Komunikat o tym błędzie.

EntityReference

Objekt

EntityReference

Nazwa	Typ	Opis
self	string (uri)	Lokalizacja odwoływania się do jednostki.

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

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
Lexical	Model udostępnia dane wyjściowe transkrypcji bez formatowania.
Display	Model obsługuje wyświetlanie formatowania danych wyjściowych lub punktów końcowych transkrypcji.

PaginatedCustomModels

Objekt

PaginatedCustomModels

Nazwa	Typ	Opis
@nextLink	string (uri)	Link do następnego zestawu wyników podzielonych na strony, jeśli jest dostępnych więcej jednostek; w przeciwnym razie wartość null.
values	CustomModel[]	Lista jednostek ograniczonych przez przekazane parametry zapytania "skip" i "top" lub ich wartości domyślne. Podczas iteracji za pośrednictwem listy przy użyciu stronicowania i usuwania jednostek równolegle niektóre jednostki zostaną pominięte w wynikach. Zaleca się utworzenie listy na kliencie i usunięcie jej po pobraniu pełnej listy.

Nazwa

Typ

Opis

@nextLink

string (uri)

Link do następnego zestawu wyników podzielonych na strony, jeśli jest dostępnych więcej jednostek; w przeciwnym razie wartość null.

values

CustomModel[]

Lista jednostek ograniczonych przez przekazane parametry zapytania "skip" i "top" lub ich wartości domyślne.

Podczas iteracji za pośrednictwem listy przy użyciu stronicowania i usuwania jednostek równolegle niektóre jednostki zostaną pominięte w wynikach. Zaleca się utworzenie listy na kliencie i usunięcie jej po pobraniu pełnej listy.

Status

Wyliczanie

Status

Wartość	Opis
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.
Failed	Długotrwała operacja nie powiodła się.

Udostępnij za pośrednictwem

Models - List Custom Models

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

Ocp-Apim-Subscription-Key

Authorization

Przykłady

Get all models in state 'Running'

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

CustomModel

CustomModelDeprecationDates

CustomModelFeatures

CustomModelLinks

CustomModelProperties

DetailedErrorCode

EntityError

EntityReference

Error

ErrorCode

InnerError

OutputFormatType

PaginatedCustomModels

Status