Models - Update

Odwołanie

Usługa:: Azure AI Services

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

Aktualizacje metadanych modelu zidentyfikowanych przez dany identyfikator.

PATCH {endpoint}/speechtotext/v3.2-preview.2/models/{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.

Treść żądania

Media Types: "application/json", "application/merge-patch+json"

Nazwa	Typ	Opis
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.
description	string	Opis obiektu.
displayName	string	Nazwa obiektu.
project	EntityReference	Odwołanie do jednostki

Odpowiedzi

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

Nazwa

Typ

Opis

200 OK

CustomModel

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

Update a model

Przykładowe żądanie

HTTP

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

{
  "displayName": "Language model update",
  "description": "This is a language model update",
  "customProperties": {
    "key": "value"
  }
}

Przykładowa odpowiedź

Kod stanu:: 200

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

Definicje

Nazwa	Opis
CustomModel	CustomModel
CustomModelDeprecationDates	CustomModelDeprecationDates
CustomModelFeatures	CustomModelFeatures
CustomModelLinks	CustomModelLinks
CustomModelProperties	CustomModelProperties
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
EntityReference	Odwołanie do jednostki
Error	Błąd
ErrorCode	ErrorCode
InnerError	InnerError
ModelUpdate	ModelUpdate
OutputFormatType	OutputFormatType
Status	Stan

CustomModel

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 wynosi 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	CustomModelProperties
self	string	Lokalizacja tej jednostki.
status	Status	Stan Opis bieżącego stanu interfejsu API
text	string	Tekst używany do dostosowywania tego modelu językowego.

CustomModelDeprecationDates

Nazwa	Typ	Opis
transcriptionDateTime	string	Data, kiedy transkrypcja staje 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 stanie się ona użyteczna w kontenerze mowy.

CustomModelLinks

Nazwa	Typ	Opis
copy	string	Lokalizacja akcji kopiowania modelu. Aby uzyskać więcej informacji, zobacz operację "Models_Copy".
copyTo	string	Lokalizacja przestarzałej akcji kopiowania modelu. Aby uzyskać więcej informacji, zobacz operację "Models_CopyTo".
files	string	Lokalizacja pobierania 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

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 jest ustawiona, usługa wybiera 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	Zakazane.
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.
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.
ModelCopyOperationExists	string	Operacja kopiowania modelu istnieje.
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 przywołynej jednostki.

Error

Błąd

Nazwa	Typ	Opis
code	ErrorCode	ErrorCode 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 pod adresem 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

Nazwa	Typ	Opis
Conflict	string	Reprezentowanie kodu błędu powodującego konflikt.
Forbidden	string	Reprezentuje kod błędu zabronionego.
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	Reprezentując kod błędu nie znaleziono.
PipelineError	string	Reprezentowanie kodu błędu potoku.
ServiceUnavailable	string	Reprezentuje kod błędu niedostępności usługi.
TooManyRequests	string	Reprezentowanie zbyt wielu żądań kod błędu.
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

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

ModelUpdate

Nazwa	Typ	Opis
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.
description	string	Opis obiektu.
displayName	string	Nazwa obiektu.
project	EntityReference	Odwołanie do jednostki

OutputFormatType

Nazwa	Typ	Opis
Display	string	Model obsługuje wyświetlanie danych wyjściowych transkrypcji lub punktów końcowych formatowania.
Lexical	string	Model udostępnia 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	Operacja długotrwała została pomyślnie ukończona.

Udostępnij za pośrednictwem

Models - Update

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

Ocp-Apim-Subscription-Key

Authorization

Przykłady

Update a model

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

CustomModel

CustomModelDeprecationDates

CustomModelFeatures

CustomModelLinks

CustomModelProperties

DetailedErrorCode

EntityError

EntityReference

Error

ErrorCode

InnerError

ModelUpdate

OutputFormatType

Status

Dodatkowe zasoby