Models - Update

Riferimento

Servizio:: Azure AI Services

Versione API:: v3.2-preview.2

Aggiornamenti i metadati del modello identificati dall'ID specificato.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string	Endpoint di Servizi cognitivi supportati (protocollo e nome host, ad esempio: https://westus.api.cognitive.microsoft.com).
id	path	True	string (uuid)	Identificatore del modello.

Corpo della richiesta

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

Nome	Tipo	Descrizione
customProperties	object	Proprietà personalizzate di questa entità. La lunghezza massima consentita della chiave è di 64 caratteri, la lunghezza massima consentita è di 256 caratteri e il numero di voci consentite è 10.
description	string	Descrizione dell'oggetto .
displayName	string	Nome dell'oggetto.
project	EntityReference	EntityReference

Risposte

Nome	Tipo	Descrizione
200 OK	CustomModel	OK Intestazioni Retry-After: integer
Other Status Codes	Error	Si è verificato un errore.

Nome

Tipo

Descrizione

200 OK

CustomModel

Intestazioni

Retry-After: integer

Other Status Codes

Error

Si è verificato un errore.

Sicurezza

Ocp-Apim-Subscription-Key

Specificare qui la chiave dell'account di Servizi cognitivi.

Tipo: apiKey
In: header

Authorization

Fornire un token di accesso dal token JWT restituito dal servizio token di sicurezza di questa area. Assicurarsi di aggiungere l'ambito di gestione al token aggiungendo la stringa di query seguente all'URL stS: ?scope=speechservicesmanagement

Tipo: apiKey
In: header

Esempio

Update a model

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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"
}

Definizioni

Nome	Descrizione
CustomModel	CustomModel
CustomModelDeprecationDates	CustomModelDeprecationDates
CustomModelFeatures	CustomModelFeatures
CustomModelLinks	CustomModelLinks
CustomModelProperties	CustomModelProperties
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
EntityReference	EntityReference
Error	Errore
ErrorCode	ErrorCode
InnerError	InnerError
ModelUpdate	ModelUpdate
OutputFormatType	OutputFormatType
Status	Stato

CustomModel

Object

CustomModel

Nome	Tipo	Descrizione
baseModel	EntityReference	EntityReference
createdDateTime	string (date-time)	Timestamp al momento della creazione dell'oggetto. Il timestamp è codificato come formato di data e ora ISO 8601 ("AAAA-MM-GGThh:mm:ssZ", vedere https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties	object	Proprietà personalizzate di questa entità. La lunghezza massima consentita della chiave è di 64 caratteri, la lunghezza massima consentita è di 256 caratteri e il numero di voci consentite è 10.
datasets	EntityReference[]	Set di dati usati per l'adattamento.
description	string	Descrizione dell'oggetto .
displayName	string minLength: 1	Nome visualizzato dell'oggetto.
lastActionDateTime	string (date-time)	Timestamp quando è stato immesso lo stato corrente. Il timestamp è codificato come formato di data e ora ISO 8601 ("AAAA-MM-GGThh:mm:ssZ", vedere https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links	CustomModelLinks	CustomModelLinks
locale	string minLength: 1	Impostazioni locali dei dati contenuti.
project	EntityReference	EntityReference
properties	CustomModelProperties	CustomModelProperties
self	string (uri)	Posizione dell'entità.
status	Status	Stato Descrivere lo stato corrente dell'API
text	string	Testo utilizzato per adattare questo modello linguistico.

CustomModelDeprecationDates

Object

CustomModelDeprecationDates

Nome	Tipo	Descrizione
transcriptionDateTime	string (date-time)	Data in cui la trascrizione diventa deprecata.

CustomModelFeatures

Object

CustomModelFeatures

Nome	Tipo	Descrizione
supportedOutputFormats	OutputFormatType[]	Formati di output supportati.
supportsEndpoints	boolean	Valore che indica se è supportata la creazione di endpoint per la trascrizione in tempo reale.
supportsTranscriptions	boolean	Valore che indica se la trascrizione batch è supportata.
supportsTranscriptionsOnSpeechContainers	boolean	Valore che indica se questo modello può essere usato per la trascrizione nel contenitore di riconoscimento vocale. Questa funzionalità può essere aggiunta ai modelli esistenti quando diventa utilizzabile nel contenitore voce.

CustomModelLinks

Object

CustomModelLinks

Nome	Tipo	Descrizione
copy	string (uri)	Posizione dell'azione di copia del modello. Per altri dettagli, vedere l'operazione "Models_Copy".
copyTo	string (uri)	Percorso dell'azione di copia del modello obsoleto. Per altri dettagli, vedere l'operazione "Models_CopyTo".
files	string (uri)	Percorso per ottenere tutti i file di questa entità. Per altri dettagli, vedere l'operazione "Models_ListFiles".
manifest	string (uri)	Percorso in cui ottenere un manifesto per questo modello da usare nel contenitore locale. Per altri dettagli, vedere l'operazione "Models_GetCustomModelManifest".

CustomModelProperties

Object

CustomModelProperties

Nome	Tipo	Descrizione
customModelWeightPercent	integer (int32) minimum: 1 maximum: 100	Peso del modello personalizzato compreso tra 1 (modello personalizzato 1% e modello di base 99%) e 100 (modello personalizzato al 100% e modello di base 0%). Quando questa proprietà non è impostata, il servizio sceglie un valore appropriato (ottenere il modello per recuperare il peso selezionato). Iniziare senza usare questa proprietà. Se necessario, scegliere un peso maggiore (o inferiore) per aumentare o diminuire l'impatto del modello personalizzato.
deprecationDates	CustomModelDeprecationDates	CustomModelDeprecationDates
email	string	Indirizzo di posta elettronica a cui inviare notifiche tramite posta elettronica nel caso in cui l'operazione venga completata. Il valore verrà rimosso dopo aver inviato correttamente il messaggio di posta elettronica.
error	EntityError	EntityError
features	CustomModelFeatures	CustomModelFeatures Funzionalità supportate dal modello.

DetailedErrorCode

Enumerazione

DetailedErrorCode

Valore	Descrizione
DataImportFailed	Importazione dati non riuscita.
DeleteNotAllowed	Eliminazione non consentita.
DeployNotAllowed	Distribuzione non consentita.
DeployingFailedModel	Distribuzione del modello non riuscito.
EmptyRequest	Richiesta vuota.
EndpointCannotBeDefault	L'endpoint non può essere predefinito.
EndpointNotUpdatable	Endpoint non aggiornabile.
EndpointWithoutLogging	Endpoint senza registrazione.
ExceededNumberOfRecordingsUris	È stato superato il numero di URI delle registrazioni.
FailedDataset	Set di dati non riuscito.
Forbidden	Non consentito.
InUseViolation	Violazione dell'uso.
InaccessibleCustomerStorage	Archiviazione dei clienti inaccessibile.
InvalidAdaptationMapping	Mapping di adattamento non valido.
InvalidBaseModel	Modello di base non valido.
InvalidCallbackUri	URI di callback non valido.
InvalidCollection	Raccolta non valida.
InvalidDataset	Set di dati non valido.
InvalidDocument	Documento non valido.
InvalidDocumentBatch	Batch di documenti non valido.
InvalidLocale	Impostazioni locali non valide.
InvalidLogDate	Data del log non valida.
InvalidLogEndTime	Ora di fine del log non valida.
InvalidLogId	ID di log non valido.
InvalidLogStartTime	Ora di inizio del log non valida.
InvalidModel	Modello non valido.
InvalidModelUri	URI del modello non valido.
InvalidParameter	Parametro non valido.
InvalidParameterValue	Valore del parametro non valido.
InvalidPayload	Payload non valido.
InvalidPermissions	Autorizzazioni non valide.
InvalidPrerequisite	Prerequisito non valido.
InvalidProductId	ID prodotto non valido.
InvalidProject	Progetto non valido.
InvalidProjectKind	Tipo di progetto non valido.
InvalidRecordingsUri	URI registrazioni non valide.
InvalidRequestBodyFormat	Formato del corpo della richiesta non valido.
InvalidSasValidityDuration	Durata di validità della firma di accesso condiviso non valida.
InvalidSkipTokenForLogs	Token skip non valido per i log.
InvalidSourceAzureResourceId	ID risorsa di Azure di origine non valido.
InvalidSubscription	Sottoscrizione non valida.
InvalidTest	Test non valido.
InvalidTimeToLive	Tempo non valido per la durata.
InvalidTopForLogs	Top non valido per i log.
InvalidTranscription	Trascrizione non valida.
InvalidWebHookEventKind	Tipo di evento web hook non valido.
MissingInputRecords	Record di input mancanti.
ModelCopyOperationExists	Esiste un'operazione di copia del modello.
ModelDeploymentNotCompleteState	Lo stato della distribuzione del modello non è completo.
ModelDeprecated	Modello deprecato.
ModelExists	Il modello esiste.
ModelMismatch	Mancata corrispondenza del modello.
ModelNotDeployable	Modello non distribuibile.
ModelVersionIncorrect	Versione del modello non corretta.
NoUtf8WithBom	Nessun utf8 con bom.
OnlyOneOfUrlsOrContainerOrDataset	Solo uno degli URL o del contenitore o del set di dati.
ProjectGenderMismatch	Mancata corrispondenza del genere del progetto.
QuotaViolation	Violazione della quota.
SingleDefaultEndpoint	Singolo endpoint predefinito.
SkuLimitsExist	Esistono limiti di SKU.
SubscriptionNotFound	Sottoscrizione non trovata.
UnexpectedError	Errore imprevisto.
UnsupportedClassBasedAdaptation	Adattamento basato sulla classe non supportato.
UnsupportedDelta	Delta non supportato.
UnsupportedDynamicConfiguration	Configurazione dinamica non supportata.
UnsupportedFilter	Filtro non supportato.
UnsupportedLanguageCode	Codice del linguaggio non supportato.
UnsupportedOrderBy	Ordine non supportato da.
UnsupportedPagination	Impaginazione non supportata.
UnsupportedTimeRange	Intervallo di tempo non supportato.

EntityError

Object

EntityError

Nome	Tipo	Descrizione
code	string	Codice di questo errore.
message	string	Messaggio per questo errore.

EntityReference

Object

EntityReference

Nome	Tipo	Descrizione
self	string (uri)	Posizione dell'entità a cui si fa riferimento.

Error

Object

Errore

Nome	Tipo	Descrizione
code	ErrorCode	ErrorCode Codici di errore di alto livello.
details	Error[]	Dettagli aggiuntivi di supporto relativi all'errore e/o ai criteri previsti.
innerError	InnerError	InnerError Nuovo formato di errore interno conforme alle linee guida per l'API Servizi cognitivi, disponibile in https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Contiene le proprietà obbligatorie ErrorCode, message e proprietà facoltative di destinazione, details(coppia chiave-valore), errore interno(può essere annidato).
message	string	Messaggio di errore di alto livello.
target	string	Indica l'origine dell'errore. Ad esempio, si tratta di "documenti" o "ID documento" in caso di documento non valido.

ErrorCode

Enumerazione

ErrorCode

Valore	Descrizione
Conflict	Rappresentazione del codice di errore del conflitto.
Forbidden	Rappresentazione del codice di errore non consentito.
InternalCommunicationFailed	Rappresentazione del codice di errore della comunicazione interna non riuscita.
InternalServerError	Rappresentazione del codice di errore interno del server.
InvalidArgument	Rappresenta il codice di errore dell'argomento non valido.
InvalidRequest	Rappresenta il codice di errore della richiesta non valido.
NotAllowed	Rappresenta il codice di errore non consentito.
NotFound	Rappresentazione del codice di errore non trovato.
PipelineError	Rappresentazione del codice di errore della pipeline.
ServiceUnavailable	Rappresenta il codice di errore del servizio non disponibile.
TooManyRequests	Rappresenta il codice di errore troppe richieste.
Unauthorized	Rappresenta il codice di errore non autorizzato.
UnprocessableEntity	Rappresenta il codice di errore dell'entità non elaborabile.
UnsupportedMediaType	Rappresenta il codice di errore del tipo di supporto non supportato.

InnerError

Object

InnerError

Nome	Tipo	Descrizione
code	DetailedErrorCode	DetailedErrorCode Enumerazione dettagliata del codice di errore.
details	object	Dettagli aggiuntivi di supporto relativi all'errore e/o ai criteri previsti.
innerError	InnerError	InnerError Nuovo formato di errore interno conforme alle linee guida per l'API Servizi cognitivi, disponibile in https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Contiene le proprietà obbligatorie ErrorCode, message e proprietà facoltative di destinazione, details(coppia chiave-valore), errore interno(può essere annidato).
message	string	Messaggio di errore di alto livello.
target	string	Indica l'origine dell'errore. Ad esempio, si tratta di "documenti" o "ID documento" in caso di documento non valido.

ModelUpdate

Object

ModelUpdate

Nome	Tipo	Descrizione
customProperties	object	Proprietà personalizzate di questa entità. La lunghezza massima consentita della chiave è di 64 caratteri, la lunghezza massima consentita è di 256 caratteri e il numero di voci consentite è 10.
description	string	Descrizione dell'oggetto .
displayName	string	Nome dell'oggetto.
project	EntityReference	EntityReference

OutputFormatType

Enumerazione

OutputFormatType

Valore	Descrizione
Display	Il modello supporta la formattazione dell'output o degli endpoint di formattazione.
Lexical	Il modello fornisce l'output di trascrizione senza formattazione.

Status

Enumerazione

Stato

Valore	Descrizione
Failed	L'operazione a esecuzione prolungata non è riuscita.
NotStarted	L'operazione a esecuzione prolungata non è ancora stata avviata.
Running	L'operazione a esecuzione prolungata è attualmente in elaborazione.
Succeeded	L'operazione a esecuzione prolungata è stata completata correttamente.

Condividi tramite

Models - Update

Parametri dell'URI

Corpo della richiesta

Risposte

Sicurezza

Ocp-Apim-Subscription-Key

Authorization

Esempio

Update a model

Esempio di richiesta

Risposta di esempio

Definizioni

CustomModel

CustomModelDeprecationDates

CustomModelFeatures

CustomModelLinks

CustomModelProperties

DetailedErrorCode

EntityError

EntityReference

Error

ErrorCode

InnerError

ModelUpdate

OutputFormatType

Status

Risorse aggiuntive