Projects - List Endpoints

Riferimento

Servizio:: Azure AI Services

Versione API:: 3.2

Ottiene l'elenco degli endpoint per il progetto specificato.

GET {endpoint}/speechtotext/v3.2/projects/{id}/endpoints

Con parametri facoltativi:

GET {endpoint}/speechtotext/v3.2/projects/{id}/endpoints?skip={skip}&top={top}&filter={filter}

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 progetto.
filter	query		string	Espressione di filtro per la selezione di un subset degli endpoint disponibili. `- Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale. - Operators: - eq, ne are supported for all properties. - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime. - and, or, not are supported. - Example: filter=locale eq 'en-US'`
skip	query		integer int32	Numero di set di dati che verranno ignorati.
top	query		integer int32	Numero di set di dati che verranno inclusi dopo aver ignorato.

Risposte

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

Nome

Tipo

Descrizione

200 OK

PaginatedEndpoints

Intestazioni

Retry-After: integer

Other Status Codes

Error

Si è verificato un errore.

Sicurezza

Ocp-Apim-Subscription-Key

Specificare qui la chiave dell'account dei servizi cognitivi.

Tipo: apiKey
In: header

Authorization

Fornire un token di accesso dal JWT restituito dal servizio 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 all endpoints

Esempio di richiesta

HTTP

GET {endpoint}/speechtotext/v3.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints?skip=0&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z

Risposta di esempio

Codice di stato:: 200

{
  "values": [
    {
      "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"
    },
    {
      "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/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
      },
      "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": false
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "NotStarted",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Speech endpoint",
      "description": "Example for speech endpoint"
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z"
}

Definizioni

Nome	Descrizione
DetailedErrorCode	DettagliErrorCode
Endpoint	Endpoint
EndpointLinks	EndpointLinks
EndpointProperties	EndpointProperties
EntityError	EntityError
EntityReference	EntityReference
Error	Errore
ErrorCode	ErrorCode
InnerError	InnerError
PaginatedEndpoints	ImpaginatiEndpoints
Status	Stato

DetailedErrorCode

DettagliErrorCode

Nome	Tipo	Descrizione
DataImportFailed	string	Importazione dei dati non riuscita.
DeleteNotAllowed	string	Eliminazione non consentita.
DeployNotAllowed	string	Distribuire non consentito.
DeployingFailedModel	string	Distribuzione di un 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	Superato il numero di uri delle registrazioni.
FailedDataset	string	Set di dati non riuscito.
Forbidden	string	Non consentito.
InUseViolation	string	In violazione dell'uso.
InaccessibleCustomerStorage	string	Archiviazione 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 di log non valida.
InvalidLogEndTime	string	Ora di fine del log non valida.
InvalidLogId	string	ID log non valido.
InvalidLogStartTime	string	Ora di inizio del log non valida.
InvalidModel	string	Modello non valido.
InvalidModelUri	string	URI 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 della validità della firma di accesso condiviso non valida.
InvalidSkipTokenForLogs	string	Token ignora 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 da vivere.
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	Distribuzione del modello non completa stato.
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 di genere del progetto.
QuotaViolation	string	Violazione della quota.
SingleDefaultEndpoint	string	Endpoint predefinito singolo.
SkuLimitsExist	string	Esistono limiti di SKU.
SubscriptionNotFound	string	Sottoscrizione non trovata.
UnexpectedError	string	Errore imprevisto.
UnsupportedClassBasedAdaptation	string	Adattamento basato su classi non supportate.
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 per.
UnsupportedPagination	string	Impaginazione non supportata.
UnsupportedTimeRange	string	Intervallo di tempo non supportato.

Endpoint

Nome	Tipo	Descrizione
createdDateTime	string	Timestamp al momento della creazione dell'oggetto. Il timestamp viene codificato come formato di data e ora ISO 8601 ("AAAAA-MM-DDThh: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 viene codificato come formato di data e ora ISO 8601 ("AAAAA-MM-DDThh: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 di questa 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	I log di trascrizione e audio per questo endpoint. Per altre informazioni, 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 speech SDK per richieste lunghe con più risultati finali.
webSocketDictation	string	L'endpoint speech SDK per richieste lunghe con più risultati finali, supportando la dettatura dei segni di punteggiatura.
webSocketInteractive	string	Endpoint speech SDK per richieste brevi fino a 15 secondi con un singolo risultato finale.

EndpointProperties

Nome	Tipo	Descrizione
email	string	Indirizzo di posta elettronica per inviare notifiche di posta elettronica a 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. Dopo che l'endpoint raggiunge il tempo di esecuzione dopo il completamento (esito positivo o non riuscito) 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

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

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 le API servizi cognitivi disponibili in https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Contiene proprietà necessarie ErrorCode, message e proprietà facoltative di destinazione, dettagli(coppia di valori chiave), errore interno(può essere annidato).
message	string	Messaggio di errore di alto livello.
target	string	Indica l'origine dell'errore. Ad esempio, sarebbe "documenti" o "ID documento" nel caso di documento non valido.

ErrorCode

Nome	Tipo	Descrizione
Conflict	string	Rappresenta il codice di errore del conflitto.
Forbidden	string	Rappresenta il codice di errore non consentito.
InternalCommunicationFailed	string	Rappresentazione del codice di errore interno della comunicazione non riuscita.
InternalServerError	string	Rappresenta il codice di errore del server interno.
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	Rappresenta il codice di errore non trovato.
PipelineError	string	Rappresenta il codice di errore della pipeline.
ServiceUnavailable	string	Rappresenta il codice di errore non disponibile del servizio.
TooManyRequests	string	Rappresenta il codice di errore di 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

Nome	Tipo	Descrizione
code	DetailedErrorCode	DettagliErrorCode 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 le API servizi cognitivi disponibili in https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Contiene proprietà necessarie ErrorCode, message e proprietà facoltative di destinazione, dettagli(coppia di valori chiave), errore interno(può essere annidato).
message	string	Messaggio di errore di alto livello.
target	string	Indica l'origine dell'errore. Ad esempio, sarebbe "documenti" o "ID documento" nel caso di documento non valido.

PaginatedEndpoints

ImpaginatiEndpoints

Nome	Tipo	Descrizione
@nextLink	string	Collegamento al set successivo di risultati impaginati se sono disponibili più entità; in caso contrario null.
values	Endpoint[]	Elenco di entità limitate dai parametri di query passati "skip" e "top" o dai relativi valori predefiniti. Quando si esegue l'iterazione tramite un elenco usando la paginazione e l'eliminazione di entità in parallelo, alcune entità verranno ignorate nei risultati. È consigliabile compilare un elenco nel client ed eliminare dopo il recupero dell'elenco completo.

Nome

Tipo

Descrizione

@nextLink

string

Collegamento al set successivo di risultati impaginati se sono disponibili più entità; in caso contrario null.

values

Endpoint[]

Elenco di entità limitate dai parametri di query passati "skip" e "top" o dai relativi valori predefiniti.

Quando si esegue l'iterazione tramite un elenco usando la paginazione e l'eliminazione di entità in parallelo, alcune entità verranno ignorate nei risultati. È consigliabile compilare un elenco nel client ed eliminare dopo il recupero dell'elenco completo.

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.

Condividi tramite

Projects - List Endpoints

Parametri dell'URI

Risposte

Sicurezza

Ocp-Apim-Subscription-Key

Authorization

Esempio

Get all endpoints

Esempio di richiesta

Risposta di esempio

Definizioni

DetailedErrorCode

Endpoint

EndpointLinks

EndpointProperties

EntityError

EntityReference

Error

ErrorCode

InnerError

PaginatedEndpoints

Status

Risorse aggiuntive