Projects - List

Ottiene l'elenco di progetti per la sottoscrizione autenticata.

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

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

Risposta di esempio

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

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

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

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.

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.

ModelCopyOperationExists

string

Esiste un'operazione di copia modello.

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.

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

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

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

ImpaginatiProgetti

Nome Tipo Descrizione
@nextLink

string

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

Project

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.

links

ProjectLinks

ProjectLinks

locale

string

Impostazioni locali dei dati contenuti.

properties

ProjectProperties

ProjectProperties

self

string

Posizione di questa entità.

ProjectLinks

Nome Tipo Descrizione
datasets

string

Percorso per ottenere un elenco di tutti i set di dati di questo progetto. Per altre informazioni, vedere l'operazione "Projects_ListDatasets".

endpoints

string

Percorso per ottenere un elenco di tutti gli endpoint di questo progetto. Per altre informazioni, vedere l'operazione "Projects_ListEndpoints".

evaluations

string

Posizione per ottenere un elenco di tutte le valutazioni di questo progetto. Per altre informazioni, vedere l'operazione "Projects_ListEvaluations".

models

string

Percorso per ottenere un elenco di tutti i modelli di questo progetto. Per altre informazioni, vedere l'operazione "Projects_ListModels".

transcriptions

string

Percorso per ottenere un elenco di tutte le trascrizioni di questo progetto. Per altre informazioni, vedere l'operazione "Projects_ListTranscriptions".

ProjectProperties

ProjectProperties

Nome Tipo Descrizione
datasetCount

integer

Numero di set di dati associati a questo progetto.

endpointCount

integer

Numero di endpoint associati a questo progetto.

evaluationCount

integer

Numero di valutazioni associate a questo progetto.

modelCount

integer

Numero di modelli associati a questo progetto.

transcriptionCount

integer

Numero di trascrizioni associate a questo progetto.