Models - Create

Odwołanie

Usługa:: Azure AI Services

Wersja interfejsu API:: 3.2

Tworzy nowy model.

POST {endpoint}/speechtotext/v3.2/models

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).

Treść żądania

Nazwa	Wymagane	Typ	Opis
displayName	True	string	Nazwa wyświetlana obiektu.
locale	True	string	Ustawienia regionalne zawartych danych.
baseModel		EntityReference	Odwołanie do jednostki
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.
project		EntityReference	Odwołanie do jednostki
properties		CustomModelProperties	CustomModelProperties
text		string	Tekst używany do dostosowywania tego modelu językowego.

Odpowiedzi

Nazwa	Typ	Opis
201 Created	CustomModel	Odpowiedź zawiera informacje o jednostce jako ładunku i jego lokalizacji jako nagłówku. Nagłówki Location: string
Other Status Codes	Error	Wystąpił błąd.

Nazwa

Typ

Opis

201 Created

CustomModel

Odpowiedź zawiera informacje o jednostce jako ładunku i jego lokalizacji jako nagłówku.

Nagłówki

Location: string

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 JWT zwrócony 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

Create a model

Create a model with custom model weight

Create a model

Przykładowe żądanie

HTTP

POST {endpoint}/speechtotext/v3.2/models

{
  "baseModel": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
  },
  "datasets": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
    }
  ],
  "locale": "en-US",
  "displayName": "Model with acoustic and language datasets"
}

Przykładowa odpowiedź

Kod stanu:: 201

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b",
  "baseModel": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
  },
  "datasets": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
    }
  ],
  "links": {
    "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b",
    "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copy",
    "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.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"
}

Create a model with custom model weight

Przykładowe żądanie

HTTP

POST {endpoint}/speechtotext/v3.2/models

{
  "baseModel": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
  },
  "datasets": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
    }
  ],
  "properties": {
    "customModelWeightPercent": 42
  },
  "locale": "en-US",
  "displayName": "Model with acoustic and language datasets"
}

Przykładowa odpowiedź

Kod stanu:: 201

Location: https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b",
  "baseModel": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
  },
  "datasets": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
    }
  ],
  "links": {
    "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b",
    "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copy",
    "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b/files"
  },
  "properties": {
    "deprecationDates": {
      "transcriptionDateTime": "2023-05-04T00:00:00Z"
    },
    "customModelWeightPercent": 42,
    "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"
}

Definicje

Nazwa	Opis
CustomModel	Model niestandardowy
CustomModelDeprecationDates	CustomModelDeprecationDates
CustomModelFeatures	CustomModelFeatures
CustomModelLinks	CustomModelLinks
CustomModelProperties	Właściwości modelu CustomModel
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
EntityReference	Odwołanie do jednostki
Error	Błąd
ErrorCode	ErrorCode
InnerError	Błąd wewnętrzny
OutputFormatType	OutputFormatType
Status	Stan

CustomModel

Model niestandardowy

Nazwa	Typ	Opis
baseModel	EntityReference	Odwołanie do jednostki
createdDateTime	string	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 to 10.
datasets	EntityReference[]	Zestawy danych używane do adaptacji.
description	string	Opis obiektu.
displayName	string	Nazwa wyświetlana obiektu.
lastActionDateTime	string	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	Ustawienia regionalne zawartych danych.
project	EntityReference	Odwołanie do jednostki
properties	CustomModelProperties	Właściwości modelu CustomModel
self	string	Lokalizacja tej jednostki.
status	Status	Stan Opisz bieżący stan interfejsu API.
text	string	Tekst używany do dostosowywania tego modelu językowego.

CustomModelDeprecationDates

Nazwa	Typ	Opis
transcriptionDateTime	string	Data, kiedy transkrypcja stanie się przestarzała.

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

Nazwa	Typ	Opis
copy	string	Lokalizacja akcji kopiowania modelu. Aby uzyskać więcej informacji, zobacz operację "Models_Copy".
files	string	Lokalizacja do pobrania wszystkich plików tej jednostki. Aby uzyskać więcej informacji, zobacz operację "Models_ListFiles".
manifest	string	Lokalizacja do pobrania manifestu dla tego modelu do użycia w kontenerze lokalnym. Aby uzyskać więcej informacji, zobacz operację "Models_GetCustomModelManifest".

CustomModelProperties

Właściwości modelu CustomModel

Nazwa	Typ	Opis
customModelWeightPercent	integer	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żywania 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 wypadek 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

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

EntityError

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

EntityReference

Odwołanie do jednostki

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

Error

Błąd

Nazwa	Typ	Opis
code	ErrorCode	ErrorCode Kody błędów wysokiego poziomu.
details	Error[]	Dodatkowe szczegóły dotyczące błędów i/lub oczekiwanych zasad.
innerError	InnerError	Błąd wewnętrzny Nowy format błędu wewnętrznego zgodny z wytycznymi interfejsu API usług Cognitive Services dostępnymi pod adresem https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Zawiera on wymagane właściwości ErrorCode, komunikat i opcjonalne właściwości obiektu docelowego, szczegóły (para klucz-wartość), 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

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

InnerError

Błąd wewnętrzny

Nazwa	Typ	Opis
code	DetailedErrorCode	DetailedErrorCode Szczegółowe wyliczenie kodu błędu.
details	object	Dodatkowe szczegóły dotyczące błędów i/lub oczekiwanych zasad.
innerError	InnerError	Błąd wewnętrzny Nowy format błędu wewnętrznego zgodny z wytycznymi interfejsu API usług Cognitive Services dostępnymi pod adresem https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Zawiera on wymagane właściwości ErrorCode, komunikat i opcjonalne właściwości obiektu docelowego, szczegóły (para klucz-wartość), 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

Nazwa	Typ	Opis
Display	string	Model obsługuje wyświetlanie danych wyjściowych lub punktów końcowych transkrypcji formatowania.
Lexical	string	Model zapewnia dane wyjściowe transkrypcji bez formatowania.

Status

Stan

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

Udostępnij za pośrednictwem

Models - Create

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

Ocp-Apim-Subscription-Key

Authorization

Przykłady

Create a model

Przykładowe żądanie

Przykładowa odpowiedź

Create a model with custom model weight

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

CustomModel

CustomModelDeprecationDates

CustomModelFeatures

CustomModelLinks

CustomModelProperties

DetailedErrorCode

EntityError

EntityReference

Error

ErrorCode

InnerError

OutputFormatType

Status

Dodatkowe zasoby