Partilhar via


Models - List Base Models

Obtém a lista de modelos base para a subscrição autenticada.

GET {endpoint}/speechtotext/v3.2-preview.2/models/base
GET {endpoint}/speechtotext/v3.2-preview.2/models/base?skip={skip}&top={top}&filter={filter}

Parâmetros do URI

Name Em Necessário Tipo Description
endpoint
path True

string

Pontos finais dos Serviços Cognitivos suportados (protocolo e nome do anfitrião, por exemplo: https://westus.api.cognitive.microsoft.com).

filter
query

string

Uma expressão de filtragem para selecionar um subconjunto dos modelos base disponíveis.

        - 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

Número de conjuntos de dados que serão ignorados.

top
query

integer

int32

Número de conjuntos de dados que serão incluídos após ignorar.

Respostas

Name Tipo Description
200 OK

PaginatedBaseModels

OK

Other Status Codes

Error

Ocorreu um erro.

Segurança

Ocp-Apim-Subscription-Key

Forneça a chave da conta dos serviços cognitivos aqui.

Tipo: apiKey
Em: header

Authorization

Forneça um token de acesso do JWT devolvido pelo STS desta região. Certifique-se de que adiciona o âmbito de gestão ao token ao adicionar a seguinte cadeia de consulta ao URL de STS: ?scope=speechservicesmanagement

Tipo: apiKey
Em: header

Exemplos

Get all english base models

Pedido de amostra

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

Resposta da amostra

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

Definições

Name Description
BaseModel

BaseModel

BaseModelDeprecationDates

BaseModelDeprecationDates

BaseModelFeatures

BaseModelFeatures

BaseModelLinks

BaseModelLinks

BaseModelProperties

BaseModelProperties

DatasetKind

DatasetKind

DetailedErrorCode

DetailedErrorCode

Error

Erro

ErrorCode

CódigoDoErro

InnerError

InnerError

OutputFormatType

OutputFormatType

PaginatedBaseModels

PaginatedBaseModels

Status

Estado

BaseModel

BaseModel

Name Tipo Description
createdDateTime

string

O carimbo de data/hora quando o objeto foi criado. O carimbo de data e hora é codificado como formato de data e hora ISO 8601 ("YYYYY-MM-DDThh:mm:ssZ", consulte https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).

description

string

A descrição do objeto.

displayName

string

O nome a apresentar do objeto.

lastActionDateTime

string

O carimbo de data/hora quando o estado atual foi introduzido. O carimbo de data e hora é codificado como formato de data e hora ISO 8601 ("YYYYY-MM-DDThh:mm:ssZ", consulte https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).

links

BaseModelLinks

BaseModelLinks

locale

string

A região dos dados contidos.

properties

BaseModelProperties

BaseModelProperties

self

string

A localização desta entidade.

status

Status

Estado
Descrever o estado atual da API

BaseModelDeprecationDates

BaseModelDeprecationDates

Name Tipo Description
adaptationDateTime

string

A data em que a adaptação é preterida.

transcriptionDateTime

string

A data em que a transcrição é preterida.

BaseModelFeatures

BaseModelFeatures

Name Tipo Description
supportedOutputFormats

OutputFormatType[]

Formatos de saída suportados.

supportsAdaptationsWith

DatasetKind[]

Tipos de conjuntos de dados suportados para adaptar o modelo.

supportsEndpoints

boolean

Um valor que indica se a criação de pontos finais para transcrição em direto é suportada.

supportsTranscriptions

boolean

Um valor que indica se a transcrição de lotes é suportada.

supportsTranscriptionsOnSpeechContainers

boolean

Um valor que indica se este modelo pode ser utilizado para transcrição no contentor de voz. Esta funcionalidade pode ser adicionada aos modelos existentes quando se torna utilizável no contentor de voz.

BaseModelLinks

Name Tipo Description
manifest

string

A localização para obter um manifesto para este modelo ser utilizado no contentor no local. Veja a operação "Models_GetCustomModelManifest" para obter mais detalhes.

BaseModelProperties

BaseModelProperties

Name Tipo Description
chargeForAdaptation

boolean

Um valor que indica se a adaptação do modelo é cobrada.

deprecationDates

BaseModelDeprecationDates

BaseModelDeprecationDates

features

BaseModelFeatures

BaseModelFeatures
Funcionalidades suportadas pelo modelo.

DatasetKind

DatasetKind

Name Tipo Description
Acoustic

string

Um conjunto de dados acústico.

AudioFiles

string

Um conjunto de dados de ficheiros de áudio.

Language

string

Um conjunto de dados de idioma.

LanguageMarkdown

string

Um conjunto de dados de markdown de idioma.

OutputFormatting

string

Conjunto de dados que contém regras para personalizar a normalização inversa de texto, a capitalização, a reformulação, a profanidade e também define testes para validação de conjuntos de dados

Pronunciation

string

Um conjunto de dados de pronúncia.

DetailedErrorCode

DetailedErrorCode

Name Tipo Description
DataImportFailed

string

Falha na importação de dados.

DeleteNotAllowed

string

Eliminar não permitido.

DeployNotAllowed

string

A implementação não é permitida.

DeployingFailedModel

string

A implementação do modelo com falha.

EmptyRequest

string

Pedido Vazio.

EndpointCannotBeDefault

string

O ponto final não pode ser predefinido.

EndpointNotUpdatable

string

O ponto final não é atualizável.

EndpointWithoutLogging

string

Ponto final sem registo.

ExceededNumberOfRecordingsUris

string

Número excedido de uris de gravações.

FailedDataset

string

Conjunto de dados com falha.

Forbidden

string

Proibido.

InUseViolation

string

Violação de utilização.

InaccessibleCustomerStorage

string

Armazenamento de clientes inacessível.

InvalidAdaptationMapping

string

Mapeamento de adaptação inválido.

InvalidBaseModel

string

Modelo base inválido.

InvalidCallbackUri

string

URI de chamada de retorno inválido.

InvalidCollection

string

Coleção inválida.

InvalidDataset

string

Conjunto de dados inválido.

InvalidDocument

string

Documento inválido.

InvalidDocumentBatch

string

Lote de Documentos inválido.

InvalidLocale

string

Região inválida.

InvalidLogDate

string

Data de registo inválida.

InvalidLogEndTime

string

Hora de fim do registo inválida.

InvalidLogId

string

ID de registo inválido.

InvalidLogStartTime

string

Hora de início do registo inválida.

InvalidModel

string

Modelo inválido.

InvalidModelUri

string

URI de modelo inválido.

InvalidParameter

string

Parâmetro inválido.

InvalidParameterValue

string

Valor de parâmetro inválido.

InvalidPayload

string

Payload inválido.

InvalidPermissions

string

Permissões inválidas.

InvalidPrerequisite

string

Pré-requisito inválido.

InvalidProductId

string

ID de produto inválido.

InvalidProject

string

Projeto inválido.

InvalidProjectKind

string

Tipo de projeto inválido.

InvalidRecordingsUri

string

URI de gravações inválido.

InvalidRequestBodyFormat

string

Formato do corpo do pedido inválido.

InvalidSasValidityDuration

string

Duração de validade sas inválida.

InvalidSkipTokenForLogs

string

Token de ignorar inválido para registos.

InvalidSourceAzureResourceId

string

ID de recurso do Azure de origem inválido.

InvalidSubscription

string

Subscrição inválida.

InvalidTest

string

Teste inválido.

InvalidTimeToLive

string

Tempo de vida inválido.

InvalidTopForLogs

string

Top inválido para registos.

InvalidTranscription

string

Transcrição inválida.

InvalidWebHookEventKind

string

Tipo de evento de web hook inválido.

MissingInputRecords

string

Registos de Entrada em Falta.

ModelCopyOperationExists

string

A operação de cópia de modelo existe.

ModelDeploymentNotCompleteState

string

A implementação do modelo não está concluída.

ModelDeprecated

string

Modelo preterido.

ModelExists

string

O modelo existe.

ModelMismatch

string

Erro de correspondência do modelo.

ModelNotDeployable

string

Modelo não implementável.

ModelVersionIncorrect

string

Versão do Modelo Incorreta.

NoUtf8WithBom

string

Não utf8 com bom.

OnlyOneOfUrlsOrContainerOrDataset

string

Apenas um dos URLs, contentor ou conjunto de dados.

ProjectGenderMismatch

string

Erro de correspondência de género do projeto.

QuotaViolation

string

Violação de quota.

SingleDefaultEndpoint

string

Ponto final predefinido único.

SkuLimitsExist

string

Existem limites de SKU.

SubscriptionNotFound

string

Subscrição não encontrada.

UnexpectedError

string

Erro inesperado.

UnsupportedClassBasedAdaptation

string

Adaptação baseada em classes não suportada.

UnsupportedDelta

string

Delta não suportado.

UnsupportedDynamicConfiguration

string

Configuração dinâmica não suportada.

UnsupportedFilter

string

Filtro não suportado.

UnsupportedLanguageCode

string

Código de idioma não suportado.

UnsupportedOrderBy

string

Encomenda não suportada por.

UnsupportedPagination

string

Paginação não suportada.

UnsupportedTimeRange

string

Intervalo de tempo não suportado.

Error

Erro

Name Tipo Description
code

ErrorCode

CódigoDoErro
Códigos de erro de alto nível.

details

Error[]

Detalhes de suporte adicionais sobre o erro e/ou as políticas esperadas.

innerError

InnerError

InnerError
Novo formato de Erro Interno que está em conformidade com as Diretrizes da API dos Serviços Cognitivos que estão disponíveis em https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Esta ação contém as propriedades necessárias ErrorCode, destino de mensagens e propriedades opcionais, detalhes (par de valores de chave), erro interno (isto pode ser aninhado).

message

string

Mensagem de erro de alto nível.

target

string

A origem do erro. Por exemplo, seria "documentos" ou "ID do documento" em caso de documento inválido.

ErrorCode

CódigoDoErro

Name Tipo Description
Conflict

string

Representando o código de erro de conflito.

Forbidden

string

Representando o código de erro proibido.

InternalCommunicationFailed

string

A representação do código de erro de comunicação interna falhou.

InternalServerError

string

Representando o código de erro interno do servidor.

InvalidArgument

string

Representando o código de erro de argumento inválido.

InvalidRequest

string

Representando o código de erro de pedido inválido.

NotAllowed

string

Representando o código de erro não permitido.

NotFound

string

Representa o código de erro não encontrado.

PipelineError

string

Representando o código de erro do pipeline.

ServiceUnavailable

string

Representando o código de erro indisponível do serviço.

TooManyRequests

string

Representando o código de erro demasiados pedidos.

Unauthorized

string

Representa o código de erro não autorizado.

UnprocessableEntity

string

Representando o código de erro de entidade não processado.

UnsupportedMediaType

string

Representando o código de erro de tipo de suporte de dados não suportado.

InnerError

InnerError

Name Tipo Description
code

DetailedErrorCode

DetailedErrorCode
Enum de código de erro detalhado.

details

object

Detalhes de suporte adicionais sobre o erro e/ou as políticas esperadas.

innerError

InnerError

InnerError
Novo formato de Erro Interno que está em conformidade com as Diretrizes da API dos Serviços Cognitivos que estão disponíveis em https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Esta ação contém as propriedades necessárias ErrorCode, destino de mensagens e propriedades opcionais, detalhes (par de valores de chave), erro interno (isto pode ser aninhado).

message

string

Mensagem de erro de alto nível.

target

string

A origem do erro. Por exemplo, seria "documentos" ou "ID do documento" em caso de documento inválido.

OutputFormatType

OutputFormatType

Name Tipo Description
Display

string

O modelo suporta a saída ou os pontos finais das transcrições de formatação de apresentação.

Lexical

string

O modelo fornece a saída da transcrição sem formatação.

PaginatedBaseModels

PaginatedBaseModels

Name Tipo Description
@nextLink

string

Uma ligação para o próximo conjunto de resultados paginados se existirem mais entidades disponíveis; caso contrário, nulo.

values

BaseModel[]

Uma lista de entidades limitada pelos parâmetros de consulta transmitidos "ignorar" e "top" ou os respetivos valores predefinidos.

Ao iterar através de uma lista através da paginação e eliminação de entidades em paralelo, algumas entidades serão ignoradas nos resultados. É recomendado criar uma lista no cliente e eliminar após a obtenção da lista completa.

Status

Estado

Name Tipo Description
Failed

string

A operação de execução prolongada falhou.

NotStarted

string

A operação de execução prolongada ainda não foi iniciada.

Running

string

A operação de execução prolongada está atualmente a ser processada.

Succeeded

string

A operação de execução prolongada foi concluída com êxito.