Projects - List

Riferimento

Servizio:: Azure AI Services

Versione API:: v3.2-preview.2

Ottiene l'elenco di progetti per la sottoscrizione autenticata.

GET {endpoint}/speechtotext/v3.2-preview.2/projects

Con parametri facoltativi:

GET {endpoint}/speechtotext/v3.2-preview.2/projects?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).
filter	query		string	Espressione di filtro per la selezione di un subset dei progetti disponibili. `- Supported properties: displayName, description, createdDateTime, locale. - Operators: - eq, ne are supported for all properties. - gt, ge, lt, le are supported for createdDateTime. - and, or, not are supported. - Example: filter=displayName eq 'My test'`
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	PaginatedProjects	OK
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 projects

Get all projects created in 2018 or 2019

Get all projects

Esempio di richiesta

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/projects?skip=0&top=3

Risposta di esempio

Codice di stato:: 200

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/projects/abc46f33-90b8-443d-adad-4870517356e0",
      "links": {
        "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations",
        "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets",
        "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models",
        "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints",
        "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions"
      },
      "properties": {
        "datasetCount": 23,
        "evaluationCount": 42,
        "modelCount": 2,
        "transcriptionCount": 1994,
        "endpointCount": 12
      },
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "My speech project"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/projects/abc46f33-90b8-443d-adad-4870517356e0",
      "links": {
        "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations",
        "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets",
        "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models",
        "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints",
        "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions"
      },
      "properties": {
        "datasetCount": 23,
        "evaluationCount": 42,
        "modelCount": 2,
        "transcriptionCount": 1994,
        "endpointCount": 12
      },
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "My speech project"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/projects/abc46f33-90b8-443d-adad-4870517356e0",
      "links": {
        "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations",
        "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets",
        "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models",
        "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints",
        "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions"
      },
      "properties": {
        "datasetCount": 23,
        "evaluationCount": 42,
        "modelCount": 2,
        "transcriptionCount": 1994,
        "endpointCount": 12
      },
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "My speech project"
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects?skip=3&top=3"
}

Get all projects created in 2018 or 2019

Esempio di richiesta

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/projects?skip=0&top=3&filter=createdDateTime%20ge%202018-01-01T00:00:00Z%20and%20createdDateTime%20lt%202020-01-01T00:00:00Z

Risposta di esempio

Codice di stato:: 200

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/projects/abc46f33-90b8-443d-adad-4870517356e0",
      "links": {
        "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations",
        "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets",
        "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models",
        "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints",
        "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions"
      },
      "properties": {
        "datasetCount": 23,
        "evaluationCount": 42,
        "modelCount": 2,
        "transcriptionCount": 1994,
        "endpointCount": 12
      },
      "createdDateTime": "2018-03-03T12:45:27Z",
      "locale": "en-US",
      "displayName": "My speech project"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/projects/abc46f33-90b8-443d-adad-4870517356e0",
      "links": {
        "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations",
        "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets",
        "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models",
        "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints",
        "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions"
      },
      "properties": {
        "datasetCount": 23,
        "evaluationCount": 42,
        "modelCount": 2,
        "transcriptionCount": 1994,
        "endpointCount": 12
      },
      "createdDateTime": "2018-12-19T17:54:57Z",
      "locale": "en-US",
      "displayName": "My speech project"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/projects/abc46f33-90b8-443d-adad-4870517356e0",
      "links": {
        "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations",
        "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets",
        "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models",
        "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints",
        "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions"
      },
      "properties": {
        "datasetCount": 23,
        "evaluationCount": 42,
        "modelCount": 2,
        "transcriptionCount": 1994,
        "endpointCount": 12
      },
      "createdDateTime": "2019-02-01T00:45:27Z",
      "locale": "en-US",
      "displayName": "My speech project"
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects?skip=6&top=3&filter=createdDateTime%20ge%202018-01-01T00:00:00Z%20and%20createdDateTime%20lt%202020-01-01T00:00:00Z"
}

Definizioni

Nome	Descrizione
DetailedErrorCode	DettagliErrorCode
Error	Errore
ErrorCode	ErrorCode
InnerError	InnerError
PaginatedProjects	ImpaginatiProgetti
Project	Project
ProjectLinks	ProjectLinks
ProjectProperties	ProjectProperties

DetailedErrorCode

Enumerazione

DettagliErrorCode

Valore	Descrizione
DataImportFailed	Importazione dei dati non riuscita.
DeleteNotAllowed	Eliminazione non consentita.
DeployNotAllowed	Distribuire non consentito.
DeployingFailedModel	Distribuzione di un modello non riuscito.
EmptyRequest	Richiesta vuota.
EndpointCannotBeDefault	L'endpoint non può essere predefinito.
EndpointNotUpdatable	Endpoint non aggiornabile.
EndpointWithoutLogging	Endpoint senza registrazione.
ExceededNumberOfRecordingsUris	Superato il numero di uri delle registrazioni.
FailedDataset	Set di dati non riuscito.
Forbidden	Non consentito.
InUseViolation	In violazione dell'uso.
InaccessibleCustomerStorage	Archiviazione 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 di 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 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 della validità della firma di accesso condiviso non valida.
InvalidSkipTokenForLogs	Token ignora 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 da vivere.
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 modello.
ModelDeploymentNotCompleteState	Distribuzione del modello non completa stato.
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	Endpoint predefinito singolo.
SkuLimitsExist	Esistono limiti di SKU.
SubscriptionNotFound	Sottoscrizione non trovata.
UnexpectedError	Errore imprevisto.
UnsupportedClassBasedAdaptation	Adattamento basato su classi non supportate.
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.

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

Enumerazione

ErrorCode

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

PaginatedProjects

Object

ImpaginatiProgetti

Nome	Tipo	Descrizione
@nextLink	string (uri)	Collegamento al set successivo di risultati impaginati se sono disponibili più entità; in caso contrario null.
values	Project[]	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 (uri)

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

values

Project[]

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.

Project

Object

Project

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 ("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 minLength: 1	Nome visualizzato dell'oggetto.
links	ProjectLinks	ProjectLinks
locale	string minLength: 1	Impostazioni locali dei dati contenuti.
properties	ProjectProperties	ProjectProperties
self	string (uri)	Posizione di questa entità.

ProjectLinks

Object

ProjectLinks

Nome	Tipo	Descrizione
datasets	string (uri)	Percorso per ottenere un elenco di tutti i set di dati di questo progetto. Per altre informazioni, vedere l'operazione "Projects_ListDatasets".
endpoints	string (uri)	Percorso per ottenere un elenco di tutti gli endpoint di questo progetto. Per altre informazioni, vedere l'operazione "Projects_ListEndpoints".
evaluations	string (uri)	Posizione per ottenere un elenco di tutte le valutazioni di questo progetto. Per altre informazioni, vedere l'operazione "Projects_ListEvaluations".
models	string (uri)	Percorso per ottenere un elenco di tutti i modelli di questo progetto. Per altre informazioni, vedere l'operazione "Projects_ListModels".
transcriptions	string (uri)	Percorso per ottenere un elenco di tutte le trascrizioni di questo progetto. Per altre informazioni, vedere l'operazione "Projects_ListTranscriptions".

ProjectProperties

Object

ProjectProperties

Nome	Tipo	Descrizione
datasetCount	integer (int32)	Numero di set di dati associati a questo progetto.
endpointCount	integer (int32)	Numero di endpoint associati a questo progetto.
evaluationCount	integer (int32)	Numero di valutazioni associate a questo progetto.
modelCount	integer (int32)	Numero di modelli associati a questo progetto.
transcriptionCount	integer (int32)	Numero di trascrizioni associate a questo progetto.

Condividi tramite

Projects - List

Parametri dell'URI

Risposte

Sicurezza

Ocp-Apim-Subscription-Key

Authorization

Esempio

Get all projects

Esempio di richiesta

Risposta di esempio

Get all projects created in 2018 or 2019

Esempio di richiesta

Risposta di esempio

Definizioni

DetailedErrorCode

Error

ErrorCode

InnerError

PaginatedProjects

Project

ProjectLinks

ProjectProperties

Risorse aggiuntive