Models - Update

Dienst:: Azure AI Services

API-Version:: v3.2-preview.2

Aktualisiert die Metadaten des Modells, das durch die angegebene ID identifiziert wird.

PATCH {endpoint}/speechtotext/v3.2-preview.2/models/{id}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string	Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B. https://westus.api.cognitive.microsoft.com).
id	path	True	string (uuid)	Der Bezeichner des Modells.

Anforderungstext

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

Name	Typ	Beschreibung
customProperties	object	Die benutzerdefinierten Eigenschaften dieser Entität. Die maximal zulässige Schlüssellänge beträgt 64 Zeichen, die maximal zulässige Wertlänge beträgt 256 Zeichen und die Anzahl zulässiger Einträge beträgt 10.
description	string	Die Beschreibung des Objekts.
displayName	string	Der Name des Objekts.
project	EntityReference	EntityReference

Antworten

Name	Typ	Beschreibung
200 OK	CustomModel	OKAY Header Retry-After: integer
Other Status Codes	Error	Ein Fehler ist aufgetreten.

Name

Typ

Beschreibung

200 OK

CustomModel

OKAY

Header

Retry-After: integer

Other Status Codes

Error

Ein Fehler ist aufgetreten.

Sicherheit

Ocp-Apim-Subscription-Key

Stellen Sie hier Ihren kognitiven Leistungskontoschlüssel bereit.

Typ: apiKey
In: header

Authorization

Stellen Sie ein Zugriffstoken von JWT bereit, das vom STS dieser Region zurückgegeben wird. Stellen Sie sicher, dass Sie dem Token den Verwaltungsbereich hinzufügen, indem Sie der STS-URL die folgende Abfragezeichenfolge hinzufügen: ?scope=speechservicesmanagement

Typ: apiKey
In: header

Beispiele

Update a model

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:: 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"
}

Definitionen

Name	Beschreibung
CustomModel	CustomModel
CustomModelDeprecationDates	CustomModelDeprecationDates
CustomModelFeatures	CustomModelFeatures
CustomModelLinks	CustomModelLinks
CustomModelProperties	CustomModelProperties
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
EntityReference	EntityReference
Error	Fehler
ErrorCode	Fehlercode
InnerError	InnerError
ModelUpdate	ModelUpdate
OutputFormatType	OutputFormatType
Status	Status

CustomModel

Objekt

CustomModel

Name	Typ	Beschreibung
baseModel	EntityReference	EntityReference
createdDateTime	string (date-time)	Der Zeitstempel, zu dem das Objekt erstellt wurde. Der Zeitstempel wird als ISO 8601-Datums- und Uhrzeitformat codiert ("JJJJ-MM-DDThh:mm:ssZ", siehe https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties	object	Die benutzerdefinierten Eigenschaften dieser Entität. Die maximal zulässige Schlüssellänge beträgt 64 Zeichen, die maximal zulässige Wertlänge beträgt 256 Zeichen und die Anzahl zulässiger Einträge beträgt 10.
datasets	EntityReference[]	Datasets, die für die Anpassung verwendet werden.
description	string	Die Beschreibung des Objekts.
displayName	string minLength: 1	Der Anzeigename des Objekts.
lastActionDateTime	string (date-time)	Der Zeitstempel, zu dem der aktuelle Status eingegeben wurde. Der Zeitstempel wird als ISO 8601-Datums- und Uhrzeitformat codiert ("JJJJ-MM-DDThh:mm:ssZ", siehe https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links	CustomModelLinks	CustomModelLinks
locale	string minLength: 1	Das Gebietsschema der enthaltenen Daten.
project	EntityReference	EntityReference
properties	CustomModelProperties	CustomModelProperties
self	string (uri)	Der Speicherort dieser Entität.
status	Status	Status Beschreiben des aktuellen Status der API
text	string	Der Text, der zum Anpassen dieses Sprachmodells verwendet wird.

CustomModelDeprecationDates

Objekt

CustomModelDeprecationDates

Name	Typ	Beschreibung
transcriptionDateTime	string (date-time)	Das Datum, an dem die Transkription veraltet ist.

CustomModelFeatures

Objekt

CustomModelFeatures

Name	Typ	Beschreibung
supportedOutputFormats	OutputFormatType[]	Unterstützte Ausgabeformate.
supportsEndpoints	boolean	Ein Wert, der angibt, ob die Erstellung von Endpunkten für die Livetranskription unterstützt wird.
supportsTranscriptions	boolean	Ein Wert, der angibt, ob die Batchtranskription unterstützt wird.
supportsTranscriptionsOnSpeechContainers	boolean	Ein Wert, der angibt, ob dieses Modell für die Transkription im Sprachcontainer verwendet werden kann. Dieses Feature kann in vorhandenen Modellen hinzugefügt werden, wenn es im Sprachcontainer verwendet werden kann.

CustomModelLinks

Objekt

CustomModelLinks

Name	Typ	Beschreibung
copy	string (uri)	Der Speicherort für die Modellkopieaktion. Weitere Informationen finden Sie unter Operation "Models_Copy".
copyTo	string (uri)	Der Speicherort für die veraltete Modellkopienaktion. Weitere Informationen finden Sie unter Operation "Models_CopyTo".
files	string (uri)	Der Speicherort zum Abrufen aller Dateien dieser Entität. Weitere Informationen finden Sie unter Operation "Models_ListFiles".
manifest	string (uri)	Der Speicherort zum Abrufen eines Manifests für dieses Modell, das im lokalen Container verwendet werden soll. Weitere Informationen finden Sie unter Operation "Models_GetCustomModelManifest".

CustomModelProperties

Objekt

CustomModelProperties

Name	Typ	Beschreibung
customModelWeightPercent	integer (int32) minimum: 1 maximum: 100	Die Gewichtung des benutzerdefinierten Modells zwischen 1 (1% benutzerdefiniertem Modell und 99% Basismodell) und 100 (100% benutzerdefiniertes Modell und 0% Basismodell). Wenn diese Eigenschaft nicht festgelegt ist, wählt der Dienst einen geeigneten Wert aus (rufen Sie das Modell ab, um die ausgewählte Gewichtung abzurufen). Beginnen Sie, ohne diese Eigenschaft zu verwenden. Wählen Sie bei Bedarf eine größere (oder kleinere) Gewichtung aus, um die Auswirkungen des benutzerdefinierten Modells zu erhöhen (oder zu verringern).
deprecationDates	CustomModelDeprecationDates	CustomModelDeprecationDates
email	string	Die E-Mail-Adresse, an die E-Mail-Benachrichtigungen gesendet werden sollen, falls der Vorgang abgeschlossen ist. Der Wert wird nach dem erfolgreichen Senden der E-Mail entfernt.
error	EntityError	EntityError
features	CustomModelFeatures	CustomModelFeatures Vom Modell unterstützte Features.

DetailedErrorCode

Enumeration

DetailedErrorCode

Wert	Beschreibung
InvalidParameterValue	Ungültiger Parameterwert.
InvalidRequestBodyFormat	Ungültiges Anforderungstextformat.
EmptyRequest	Leere Anforderung.
MissingInputRecords	Fehlende Eingabedatensätze.
InvalidDocument	Ungültiges Dokument.
ModelVersionIncorrect	Modellversion falsch.
InvalidDocumentBatch	Ungültiger Dokumentbatch.
UnsupportedLanguageCode	Nicht unterstützter Sprachcode.
DataImportFailed	Fehler beim Datenimport.
InUseViolation	Verletzung des Einsatzes.
InvalidLocale	Ungültiges Gebietsschema.
InvalidBaseModel	Ungültiges Basismodell.
InvalidAdaptationMapping	Ungültige Anpassungszuordnung.
InvalidDataset	Ungültiges Dataset.
InvalidTest	Ungültiger Test.
FailedDataset	Fehler beim Dataset.
InvalidModel	Ungültiges Modell.
InvalidTranscription	Ungültige Transkription.
InvalidPayload	Ungültige Nutzlast.
InvalidParameter	Ungültiger Parameter.
EndpointWithoutLogging	Endpunkt ohne Protokollierung.
InvalidPermissions	Ungültige Berechtigungen.
InvalidPrerequisite	Ungültige Voraussetzung.
InvalidProductId	Ungültige Produkt-ID.
InvalidSubscription	Ungültiges Abonnement.
InvalidProject	Ungültiges Projekt.
InvalidProjectKind	Ungültige Projektart.
InvalidRecordingsUri	Ungültiger Aufzeichnungs-URI.
OnlyOneOfUrlsOrContainerOrDataset	Nur eine url oder ein Container oder Dataset.
ExceededNumberOfRecordingsUris	Die Anzahl der Aufzeichnungs-URIs wurde überschritten.
ModelMismatch	Modellkonflikt.
ProjectGenderMismatch	Projekt Gender-Mismatch.
ModelDeprecated	Das Modell ist veraltet.
ModelExists	Das Modell ist vorhanden.
ModelNotDeployable	Das Modell kann nicht bereitgestellt werden.
EndpointNotUpdatable	Endpunkt nicht aktualisierbar.
SingleDefaultEndpoint	Einzelner Standardendpunkt.
EndpointCannotBeDefault	Der Endpunkt kann nicht standardmäßig sein.
InvalidModelUri	Ungültiger Modell-URI.
SubscriptionNotFound	Das Abonnement wurde nicht gefunden.
QuotaViolation	Kontingentverletzung.
UnsupportedDelta	Nicht unterstütztes Delta.
UnsupportedFilter	Nicht unterstützter Filter.
UnsupportedPagination	Nicht unterstützte Paginierung.
UnsupportedDynamicConfiguration	Nicht unterstützte dynamische Konfiguration.
UnsupportedOrderBy	Nicht unterstützte Reihenfolge nach.
NoUtf8WithBom	Kein utf8 mit bom.
ModelDeploymentNotCompleteState	Der Status der Modellbereitstellung ist nicht abgeschlossen.
SkuLimitsExist	Sku-Grenzwerte sind vorhanden.
DeployingFailedModel	Fehler beim Bereitstellen des Modells.
UnsupportedTimeRange	Nicht unterstützter Zeitraum.
InvalidLogDate	Ungültiges Protokolldatum.
InvalidLogId	Ungültige Protokoll-ID.
InvalidLogStartTime	Ungültige Startzeit des Protokolls.
InvalidLogEndTime	Ungültige Protokollendzeit.
InvalidTopForLogs	Ungültiger Anfang für Protokolle.
InvalidSkipTokenForLogs	Ungültiges Skip-Token für Protokolle.
DeleteNotAllowed	Löschen nicht zulässig.
Forbidden	Verboten.
DeployNotAllowed	Bereitstellen nicht zulässig.
UnexpectedError	Unerwarteter Fehler.
InvalidCollection	Ungültige Auflistung.
InvalidCallbackUri	Ungültiger Rückruf-URI.
InvalidSasValidityDuration	Ungültige Gültigkeitsdauer für sas.
InaccessibleCustomerStorage	Nicht zugänglicher Kundenspeicher.
UnsupportedClassBasedAdaptation	Nicht unterstützte klassenbasierte Anpassung.
InvalidWebHookEventKind	Ungültiger Web hook-Ereignistyp.
InvalidTimeToLive	Ungültige Zeit für live.
InvalidSourceAzureResourceId	Ungültige Azure-Quellressourcen-ID.
ModelCopyOperationExists	Der Modellkopievorgang ist vorhanden.

EntityError

Objekt

EntityError

Name	Typ	Beschreibung
code	string	Der Code dieses Fehlers.
message	string	Die Meldung für diesen Fehler.

EntityReference

Objekt

EntityReference

Name	Typ	Beschreibung
self	string (uri)	Der Speicherort der Entität, auf die verwiesen wird.

Error

Objekt

Fehler

Name	Typ	Beschreibung
code	ErrorCode	Fehlercode Fehlercodes auf hoher Ebene.
details	Error[]	Zusätzliche unterstützende Details zu den Fehler- und/oder erwarteten Richtlinien.
innerError	InnerError	InnerError Neues inneres Fehlerformat, das den Cognitive Services-API-Richtlinien entspricht, die unter https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8owverfügbar sind. Dies enthält die erforderlichen Eigenschaften ErrorCode, Meldung und optionale Eigenschaftenziel, Details(Schlüsselwertpaar), inneren Fehler(dies kann geschachtelt werden).
message	string	Fehlermeldung auf hoher Ebene.
target	string	Die Quelle des Fehlers. Bei ungültigen Dokumenten wäre es z. B. "Dokumente" oder "Dokument-ID".

ErrorCode

Enumeration

Fehlercode

Wert	Beschreibung
InvalidRequest	Stellt den ungültigen Anforderungsfehlercode dar.
InvalidArgument	Stellt den fehlercode für ungültiges Argument dar.
InternalServerError	Stellt den internen Fehlercode des Servers dar.
ServiceUnavailable	Stellt den dienst nicht verfügbaren Fehlercode dar.
NotFound	Stellt den nicht gefundenen Fehlercode dar.
PipelineError	Stellt den Pipelinefehlerfehlercode dar.
Conflict	Stellt den Konfliktfehlercode dar.
InternalCommunicationFailed	Fehlercode für die interne Kommunikation.
Forbidden	Stellt den verbotenen Fehlercode dar.
NotAllowed	Stellt den nicht zulässigen Fehlercode dar.
Unauthorized	Stellt den nicht autorisierten Fehlercode dar.
UnsupportedMediaType	Stellt den Fehlercode für den nicht unterstützten Medientyp dar.
TooManyRequests	Stellt den Fehlercode für zu viele Anforderungen dar.
UnprocessableEntity	Stellt den nicht verarbeiteten Entitätsfehlercode dar.

InnerError

Objekt

InnerError

Name	Typ	Beschreibung
code	DetailedErrorCode	DetailedErrorCode Detaillierte Fehlercode-Enumeration.
details	object	Zusätzliche unterstützende Details zu den Fehler- und/oder erwarteten Richtlinien.
innerError	InnerError	InnerError Neues inneres Fehlerformat, das den Cognitive Services-API-Richtlinien entspricht, die unter https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8owverfügbar sind. Dies enthält die erforderlichen Eigenschaften ErrorCode, Meldung und optionale Eigenschaftenziel, Details(Schlüsselwertpaar), inneren Fehler(dies kann geschachtelt werden).
message	string	Fehlermeldung auf hoher Ebene.
target	string	Die Quelle des Fehlers. Bei ungültigen Dokumenten wäre es z. B. "Dokumente" oder "Dokument-ID".

ModelUpdate

Objekt

ModelUpdate

Name	Typ	Beschreibung
customProperties	object	Die benutzerdefinierten Eigenschaften dieser Entität. Die maximal zulässige Schlüssellänge beträgt 64 Zeichen, die maximal zulässige Wertlänge beträgt 256 Zeichen und die Anzahl zulässiger Einträge beträgt 10.
description	string	Die Beschreibung des Objekts.
displayName	string	Der Name des Objekts.
project	EntityReference	EntityReference

OutputFormatType

Enumeration

OutputFormatType

Wert	Beschreibung
Lexical	Das Modell stellt die Transkriptionsausgabe ohne Formatierung bereit.
Display	Das Modell unterstützt die Ausgabe oder Endpunkte der Anzeigeformatierung.

Status

Enumeration

Status

Wert	Beschreibung
NotStarted	Der lange ausgeführte Vorgang wurde noch nicht gestartet.
Running	Der lange ausgeführte Vorgang wird zurzeit verarbeitet.
Succeeded	Der lange ausgeführte Vorgang wurde erfolgreich abgeschlossen.
Failed	Fehler beim vorgang mit langer Ausführung.

Freigeben über

Models - Update

URI-Parameter

Anforderungstext

Antworten

Sicherheit

Ocp-Apim-Subscription-Key

Authorization

Beispiele

Update a model

Beispielanforderung

Beispiel für eine Antwort

Definitionen

CustomModel

CustomModelDeprecationDates

CustomModelFeatures

CustomModelLinks

CustomModelProperties

DetailedErrorCode

EntityError

EntityReference

Error

ErrorCode

InnerError

ModelUpdate

OutputFormatType

Status