Endpoints - Update

  • Riferimento
Servizio:
Azure AI Services
Versione API:
3.2

Aggiorna i metadati dell'endpoint identificato dall'ID specificato.

PATCH {endpoint}/speechtotext/v3.2/endpoints/{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 dell'endpoint.

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

EntityReference

EntityReference
project

EntityReference

EntityReference
properties

EndpointPropertiesUpdate

EndpointPropertiesUpdate

Risposte

Nome Tipo Descrizione
200 OK

Endpoint

OK

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

Esempio di richiesta

PATCH {endpoint}/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6

{
  "model": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
  },
  "properties": {
    "contentLoggingEnabled": true
  },
  "displayName": "Updated endpoint with new model",
  "customProperties": {
    "key": "value"
  }
}

Risposta di esempio

Codice di stato:
200 
{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6",
  "model": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
  },
  "links": {
    "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs",
    "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
    "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
    "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
    "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
    "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
    "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6"
  },
  "properties": {
    "timeToLive": "PT30M",
    "loggingEnabled": true
  },
  "lastActionDateTime": "2019-01-07T11:36:07Z",
  "status": "Succeeded",
  "createdDateTime": "2019-01-07T11:34:12Z",
  "locale": "en-US",
  "displayName": "Speech endpoint",
  "description": "Example for speech endpoint"
}

Definizioni

Nome Descrizione
DetailedErrorCode

DetailedErrorCode
Endpoint

Endpoint
EndpointLinks

EndpointLinks
EndpointProperties

EndpointProperties
EndpointPropertiesUpdate

EndpointPropertiesUpdate
EndpointUpdate

EndpointUpdate
EntityError

EntityError
EntityReference

EntityReference
Error

Errore
ErrorCode

ErrorCode
InnerError

InnerError
Status

Stato

DetailedErrorCode

DetailedErrorCode

Nome Tipo Descrizione
DataImportFailed

string

Importazione dati non riuscita.
DeleteNotAllowed

string

Eliminazione non consentita.
DeployNotAllowed

string

Distribuzione non consentita.
DeployingFailedModel

string

Distribuzione del modello non riuscito.
EmptyRequest

string

Richiesta vuota.
EndpointCannotBeDefault

string

L'endpoint non può essere predefinito.
EndpointNotUpdatable

string

Endpoint non aggiornabile.
EndpointWithoutLogging

string

Endpoint senza registrazione.
ExceededNumberOfRecordingsUris

string

È stato superato il numero di URI delle registrazioni.
FailedDataset

string

Set di dati non riuscito.
Forbidden

string

Non consentito.
InUseViolation

string

Violazione dell'uso.
InaccessibleCustomerStorage

string

Archiviazione dei clienti inaccessibile.
InvalidAdaptationMapping

string

Mapping di adattamento non valido.
InvalidBaseModel

string

Modello di base non valido.
InvalidCallbackUri

string

URI di callback non valido.
InvalidChannels

string

Canali non validi.
InvalidCollection

string

Raccolta non valida.
InvalidDataset

string

Set di dati non valido.
InvalidDocument

string

Documento non valido.
InvalidDocumentBatch

string

Batch di documenti non valido.
InvalidLocale

string

Impostazioni locali non valide.
InvalidLogDate

string

Data del log non valida.
InvalidLogEndTime

string

Ora di fine del log non valida.
InvalidLogId

string

ID di log non valido.
InvalidLogStartTime

string

Ora di inizio del log non valida.
InvalidModel

string

Modello non valido.
InvalidModelUri

string

URI del modello non valido.
InvalidParameter

string

Parametro non valido.
InvalidParameterValue

string

Valore del parametro non valido.
InvalidPayload

string

Payload non valido.
InvalidPermissions

string

Autorizzazioni non valide.
InvalidPrerequisite

string

Prerequisito non valido.
InvalidProductId

string

ID prodotto non valido.
InvalidProject

string

Progetto non valido.
InvalidProjectKind

string

Tipo di progetto non valido.
InvalidRecordingsUri

string

URI registrazioni non valide.
InvalidRequestBodyFormat

string

Formato del corpo della richiesta non valido.
InvalidSasValidityDuration

string

Durata di validità della firma di accesso condiviso non valida.
InvalidSkipTokenForLogs

string

Token skip non valido per i log.
InvalidSourceAzureResourceId

string

ID risorsa di Azure di origine non valido.
InvalidSubscription

string

Sottoscrizione non valida.
InvalidTest

string

Test non valido.
InvalidTimeToLive

string

Tempo non valido per la durata.
InvalidTopForLogs

string

Top non valido per i log.
InvalidTranscription

string

Trascrizione non valida.
InvalidWebHookEventKind

string

Tipo di evento web hook non valido.
MissingInputRecords

string

Record di input mancanti.
ModelCopyAuthorizationExpired

string

ModelCopyAuthorization scaduto.
ModelDeploymentNotCompleteState

string

Lo stato della distribuzione del modello non è completo.
ModelDeprecated

string

Modello deprecato.
ModelExists

string

Il modello esiste.
ModelMismatch

string

Mancata corrispondenza del modello.
ModelNotDeployable

string

Modello non distribuibile.
ModelVersionIncorrect

string

Versione del modello non corretta.
NoUtf8WithBom

string

Nessun utf8 con bom.
OnlyOneOfUrlsOrContainerOrDataset

string

Solo uno degli URL o del contenitore o del set di dati.
ProjectGenderMismatch

string

Mancata corrispondenza del genere del progetto.
QuotaViolation

string

Violazione della quota.
SingleDefaultEndpoint

string

Singolo endpoint predefinito.
SkuLimitsExist

string

Esistono limiti di SKU.
SubscriptionNotFound

string

Sottoscrizione non trovata.
UnexpectedError

string

Errore imprevisto.
UnsupportedClassBasedAdaptation

string

Adattamento basato sulla classe non supportato.
UnsupportedDelta

string

Delta non supportato.
UnsupportedDynamicConfiguration

string

Configurazione dinamica non supportata.
UnsupportedFilter

string

Filtro non supportato.
UnsupportedLanguageCode

string

Codice del linguaggio non supportato.
UnsupportedOrderBy

string

Ordine non supportato da.
UnsupportedPagination

string

Impaginazione non supportata.
UnsupportedTimeRange

string

Intervallo di tempo non supportato.

Endpoint

Endpoint

Nome Tipo Descrizione
createdDateTime

string

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

string

Descrizione dell'oggetto .
displayName

string

Nome visualizzato dell'oggetto.
lastActionDateTime

string

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

EndpointLinks

EndpointLinks
locale

string

Impostazioni locali dei dati contenuti.
model

EntityReference

EntityReference
project

EntityReference

EntityReference
properties

EndpointProperties

EndpointProperties
self

string

Posizione dell'entità.
status

Status

Stato
Descrivere lo stato corrente dell'API.
text

string

Testo utilizzato per adattare un modello linguistico per questo endpoint.

EndpointLinks

Nome Tipo Descrizione
logs

string

Log di trascrizione e audio per questo endpoint. Per altri dettagli, vedere l'operazione "Endpoints_ListLogs".
restConversation

string

Endpoint REST per le richieste fino a 60 secondi.
restDictation

string

Endpoint REST per le richieste fino a 60 secondi, che supporta la dettatura dei segni di punteggiatura.
restInteractive

string

Endpoint REST per richieste brevi fino a 15 secondi.
webSocketConversation

string

Endpoint di Speech SDK per richieste lunghe con più risultati finali.
webSocketDictation

string

L'endpoint di Speech SDK per richieste lunghe con più risultati finali, supportando la dettatura dei segni di punteggiatura.
webSocketInteractive

string

L'endpoint di Speech SDK per richieste brevi fino a 15 secondi con un singolo risultato finale.

EndpointProperties

EndpointProperties

Nome Tipo Descrizione
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
loggingEnabled

boolean

Valore che indica se la registrazione del contenuto (trascrizioni audio &) viene usata per una distribuzione.
timeToLive

string

Per quanto tempo l'endpoint verrà mantenuto nel sistema. Quando l'endpoint raggiunge il tempo necessario dopo il completamento (esito positivo o negativo), l'endpoint verrà eliminato automaticamente. Non impostando questo valore o impostando su 0 verrà disabilitata l'eliminazione automatica. La durata supportata più lunga è di 31 giorni. La durata viene codificata come durata ISO 8601 ("PnYnMnDTnHnMnS", vedere https://en.wikipedia.org/wiki/ISO_8601#Durations).

EndpointPropertiesUpdate

EndpointPropertiesUpdate

Nome Tipo Descrizione
contentLoggingEnabled

boolean

Valore che indica se la registrazione del contenuto (trascrizioni audio &) viene usata per una distribuzione.

EndpointUpdate

EndpointUpdate

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

EntityReference

EntityReference
project

EntityReference

EntityReference
properties

EndpointPropertiesUpdate

EndpointPropertiesUpdate

EntityError

EntityError

Nome Tipo Descrizione
code

string

Codice di questo errore.
message

string

Messaggio per questo errore.

EntityReference

EntityReference

Nome Tipo Descrizione
self

string

Posizione dell'entità a cui si fa riferimento.

Error

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

ErrorCode

Nome Tipo Descrizione
Conflict

string

Rappresentazione del codice di errore del conflitto.
Forbidden

string

Rappresentazione del codice di errore non consentito.
InternalCommunicationFailed

string

Rappresentazione del codice di errore della comunicazione interna non riuscita.
InternalServerError

string

Rappresentazione del codice di errore interno del server.
InvalidArgument

string

Rappresenta il codice di errore dell'argomento non valido.
InvalidRequest

string

Rappresenta il codice di errore della richiesta non valido.
NotAllowed

string

Rappresenta il codice di errore non consentito.
NotFound

string

Rappresentazione del codice di errore non trovato.
PipelineError

string

Rappresentazione del codice di errore della pipeline.
ServiceUnavailable

string

Rappresenta il codice di errore del servizio non disponibile.
TooManyRequests

string

Rappresenta il codice di errore troppe richieste.
Unauthorized

string

Rappresenta il codice di errore non autorizzato.
UnprocessableEntity

string

Rappresenta il codice di errore dell'entità non elaborabile.
UnsupportedMediaType

string

Rappresenta il codice di errore del tipo di supporto non supportato.

InnerError

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.

Status

Stato

Nome Tipo Descrizione
Failed

string

L'operazione a esecuzione prolungata non è riuscita.
NotStarted

string

L'operazione a esecuzione prolungata non è ancora stata avviata.
Running

string

L'operazione a esecuzione prolungata è attualmente in elaborazione.
Succeeded

string

L'operazione a esecuzione prolungata è stata completata correttamente.