Condividi tramite

Endpoints - Get

  • Riferimento
Servizio:
Azure AI Services
Versione API:
v3.2-preview.2

Ottiene l'endpoint identificato dall'ID specificato.

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

Risposte

Nome Tipo Descrizione
200 OK

Endpoint

Va bene

Intestazioni

Retry-After: integer
Other Status Codes

Error

Si è verificato un errore.

Sicurezza

Ocp-Apim-Subscription-Key

Specificare la chiave dell'account di Servizi cognitivi qui.

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

Get an endpoint

Esempio di richiesta

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

Risposta di esempio

Codice di stato:
200 
{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6",
  "model": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
  },
  "links": {
    "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.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

Punto finale
EndpointLinks

EndpointLinks
EndpointProperties

EndpointProperties
EntityError

EntityError
EntityReference

EntityReference
Error

Errore
ErrorCode

Codice Errore
InnerError

InnerError
Status

Stato

DetailedErrorCode

Enumerazione

DetailedErrorCode

Valore Descrizione
DataImportFailed

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

Vietato.
InUseViolation

In 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 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 delle registrazioni non valido.
InvalidRequestBodyFormat

Formato del corpo della richiesta non valido.
InvalidSasValidityDuration

Durata della 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 di vita non valido.
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 di 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 su 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 per.
UnsupportedPagination

Impaginazione non supportata.
UnsupportedTimeRange

Intervallo di tempo non supportato.

Endpoint

Object

Punto finale

Nome Tipo Descrizione
createdDateTime

string (date-time)

Timestamp al momento della creazione dell'oggetto. Il timestamp viene 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 del valore è di 256 caratteri e il numero di voci consentite è 10.
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 viene 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

minLength: 1

Impostazioni locali dei dati contenuti.
model

EntityReference

EntityReference
project

EntityReference

EntityReference
properties

EndpointProperties

EndpointProperties
self

string (uri)

Posizione dell'entità.
status

Status

Stato
Descrivere lo stato corrente dell'API
text

string

Testo utilizzato per adattare un modello linguistico per questo endpoint.
Object

EndpointLinks

Nome Tipo Descrizione
logs

string (uri)

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

string (uri)

Endpoint REST per le richieste fino a 60 secondi.
restDictation

string (uri)

L'endpoint REST per le richieste fino a 60 secondi, supportando la dettatura dei segni di punteggiatura.
restInteractive

string (uri)

Endpoint REST per richieste brevi fino a 15 secondi.
webSocketConversation

string (uri)

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

string (uri)

Endpoint speech SDK per richieste lunghe con più risultati finali, supportando la dettatura dei segni di punteggiatura.
webSocketInteractive

string (uri)

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

EndpointProperties

Object

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 l'invio corretto del 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 di esecuzione dopo il completamento (operazione riuscita o non riuscita), 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).

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

Codice Errore
Codici di errore di alto livello.
details

Error[]

Ulteriori dettagli di supporto relativi all'errore e/o ai criteri previsti.
innerError

InnerError

InnerError
Nuovo formato di errore interno conforme alle linee guida dell'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, dettagli(coppia chiave-valore), errore interno (che 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

Codice Errore

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

Rappresentazione del codice di errore dell'argomento non valido.
InvalidRequest

Rappresentazione del codice di errore della richiesta non valido.
NotAllowed

Rappresentazione del codice di errore non consentito.
NotFound

Rappresentazione del codice di errore non trovato.
PipelineError

Rappresentazione del codice di errore della pipeline.
ServiceUnavailable

Rappresentazione del codice di errore del servizio non disponibile.
TooManyRequests

Rappresentazione del codice di errore troppe richieste.
Unauthorized

Rappresentazione del codice di errore non autorizzato.
UnprocessableEntity

Rappresentazione del codice di errore dell'entità non elaborabile.
UnsupportedMediaType

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

Ulteriori dettagli di supporto relativi all'errore e/o ai criteri previsti.
innerError

InnerError

InnerError
Nuovo formato di errore interno conforme alle linee guida dell'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, dettagli(coppia chiave-valore), errore interno (che 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

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.