Models - Create

Odwołanie

Usługa:: Azure AI Services

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

Tworzy nowy model.

POST {endpoint}/speechtotext/v3.2-preview.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 minLength: 1	Nazwa wyświetlana obiektu.
locale	True	string minLength: 1	Ustawienia regionalne zawartych danych.
baseModel		EntityReference	EntityReference
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	EntityReference
properties		CustomModelProperties	Właściwości modelu CustomModel
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 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

Create a model

Create a model with custom model weight

Create a model

Przykładowe żądanie

HTTP

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

{
  "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"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.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-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"
}

Create a model with custom model weight

Przykładowe żądanie

HTTP

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

{
  "baseModel": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/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"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.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-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/827712a5-f942-4997-91c3-7c6cde35600b",
  "baseModel": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/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": 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	EntityReference
Error	Błąd
ErrorCode	Kod błędu
InnerError	InnerError
OutputFormatType	OutputFormatType
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
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.

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

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