Models - List Base Models

Ottiene l'elenco dei modelli di base per la sottoscrizione autenticata.

GET {endpoint}/speechtotext/v3.2-preview.2/models/base
GET {endpoint}/speechtotext/v3.2-preview.2/models/base?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 modelli di base 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=status eq 'NotStarted' or status eq 'Running'
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

PaginatedBaseModels

OK

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

Get all english base models

Esempio di richiesta

GET {endpoint}/speechtotext/v3.2-preview.2/models/base?skip=0&top=2&filter=locale%20eq%20'en-US'

Risposta di esempio

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/base/827712a5-f942-4997-91c3-7c6cde35600b",
      "links": {
        "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b"
      },
      "properties": {
        "deprecationDates": {
          "adaptationDateTime": "2022-11-04T00:00:00Z",
          "transcriptionDateTime": "2023-05-04T00:00:00Z"
        },
        "features": {
          "supportsTranscriptions": true,
          "supportsEndpoints": true,
          "supportsTranscriptionsOnSpeechContainers": true,
          "supportsAdaptationsWith": [
            "Language",
            "Acoustic"
          ],
          "supportedOutputFormats": [
            "Display",
            "Lexical"
          ]
        },
        "chargeForAdaptation": true
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Succeeded",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "en-US Base model"
    }
  ]
}

Definizioni

Nome Descrizione
BaseModel

BaseModel

BaseModelDeprecationDates

BaseModelDeprecationDates

BaseModelFeatures

BaseModelFeatures

BaseModelLinks

BaseModelLinks

BaseModelProperties

BaseModelProperties

DatasetKind

DatasetKind

DetailedErrorCode

DettagliErrorCode

Error

Errore

ErrorCode

ErrorCode

InnerError

InnerError

OutputFormatType

OutputFormatType

PaginatedBaseModels

PaginatedBaseModels

Status

Stato

BaseModel

BaseModel

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

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

BaseModelLinks

BaseModelLinks

locale

string

Impostazioni locali dei dati contenuti.

properties

BaseModelProperties

BaseModelProperties

self

string

Posizione di questa entità.

status

Status

Stato
Descrivere lo stato corrente dell'API

BaseModelDeprecationDates

BaseModelDeprecationDates

Nome Tipo Descrizione
adaptationDateTime

string

Data in cui l'adattamento diventa deprecato.

transcriptionDateTime

string

Data in cui la trascrizione diventa deprecata.

BaseModelFeatures

BaseModelFeatures

Nome Tipo Descrizione
supportedOutputFormats

OutputFormatType[]

Formati di output supportati.

supportsAdaptationsWith

DatasetKind[]

Tipi di set di dati supportati per adattare il modello.

supportsEndpoints

boolean

Valore che indica se è supportata la creazione di endpoint per la trascrizione in tempo reale.

supportsTranscriptions

boolean

Valore che indica se la trascrizione batch è supportata.

supportsTranscriptionsOnSpeechContainers

boolean

Valore che indica se questo modello può essere usato per la trascrizione nel contenitore di riconoscimento vocale. Questa funzionalità può essere aggiunta ai modelli esistenti quando diventa utilizzabile nel contenitore voce.

BaseModelLinks

Nome Tipo Descrizione
manifest

string

Percorso per ottenere un manifesto da usare nel contenitore on-prem. Per altre informazioni, vedere l'operazione "Models_GetCustomModelManifest".

BaseModelProperties

BaseModelProperties

Nome Tipo Descrizione
chargeForAdaptation

boolean

Valore che indica se l'adattamento del modello viene addebitato.

deprecationDates

BaseModelDeprecationDates

BaseModelDeprecationDates

features

BaseModelFeatures

BaseModelFeatures
Funzionalità supportate dal modello.

DatasetKind

DatasetKind

Nome Tipo Descrizione
Acoustic

string

Un set di dati acustico.

AudioFiles

string

Set di dati di file audio.

Language

string

Un set di dati linguistico.

LanguageMarkdown

string

Set di dati markdown della lingua.

OutputFormatting

string

Set di dati che contiene regole per personalizzare la normalizzazione del testo inversa, la capitalizzazione, la riformazione, il contenuto volgare e definisce anche i test per la convalida del set di dati

Pronunciation

string

Set di dati di pronuncia.

DetailedErrorCode

DettagliErrorCode

Nome Tipo Descrizione
DataImportFailed

string

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

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

ModelCopyOperationExists

string

Esiste un'operazione di copia del modello.

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

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.

OutputFormatType

OutputFormatType

Nome Tipo Descrizione
Display

string

Il modello supporta la formattazione dell'output o degli endpoint di formattazione.

Lexical

string

Il modello fornisce l'output di trascrizione senza formattazione.

PaginatedBaseModels

PaginatedBaseModels

Nome Tipo Descrizione
@nextLink

string

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

values

BaseModel[]

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.