Partilhar via


Models - Get Base Model

Obtém o modelo base identificado pelo ID fornecido.

GET {endpoint}/speechtotext/models/base/{id}?api-version=2024-11-15

Parâmetros do URI

Name Em Necessário Tipo Description
endpoint
path True

string

Pontos de extremidade de Serviços Cognitivos suportados (protocolo e nome do host, por exemplo: https://westus.api.cognitive.microsoft.com).

id
path True

string

uuid

O identificador do modelo base.

api-version
query True

string

A versão da api solicitada.

Cabeçalho do Pedido

Name Necessário Tipo Description
Ocp-Apim-Subscription-Key True

string

Forneça a chave da sua conta de serviços cognitivos aqui.

Respostas

Name Tipo Description
200 OK

BaseModel

OK

Other Status Codes

Error

Ocorreu um erro.

Segurança

Ocp-Apim-Subscription-Key

Forneça a chave da sua conta de serviços cognitivos aqui.

Tipo: apiKey
Em: header

Exemplos

Get a base model

Pedido de amostra

GET {endpoint}/speechtotext/models/base/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-11-15

Resposta da amostra

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

Definições

Name Description
BaseModel

Modelo Base

BaseModelDeprecationDates

BaseModelDeprecationDates

BaseModelFeatures

BaseModelFeatures

BaseModelLinks

BaseModelLinks

BaseModelProperties

BaseModelProperties

DatasetKind

DatasetKind

DetailedErrorCode

DetailedErrorCode

Error

Erro

ErrorCode

Código de erro

InnerError

InnerError

OutputFormatType

OutputFormatType

Status

Situação

BaseModel

Modelo Base

Name Tipo Description
createdDateTime

string

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

description

string

A descrição do objeto.

displayName

string

O nome para exibição do objeto.

lastActionDateTime

string

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

links

BaseModelLinks

BaseModelLinks

locale

string

A localidade dos dados contidos.

properties

BaseModelProperties

BaseModelProperties

self

string

A localização desta entidade.

status

Status

Situação
Descreva o estado atual da API.

BaseModelDeprecationDates

BaseModelDeprecationDates

Name Tipo Description
adaptationDateTime

string

A data em que a adaptação se torna obsoleta.

transcriptionDateTime

string

A data em que a transcrição se torna obsoleta.

BaseModelFeatures

BaseModelFeatures

Name Tipo Description
supportedOutputFormats

OutputFormatType[]

Formatos de saída suportados.

supportsAdaptationsWith

DatasetKind[]

Tipos de conjunto de dados suportados para adaptar o modelo.

supportsEndpoints

boolean

Um valor que indica se a criação de pontos de extremidade para transcrição ao vivo é suportada.

supportsTranscriptionsOnSpeechContainers

boolean

Um valor que indica se este modelo pode ser usado para transcrição no recipiente de fala. Esse recurso pode ser adicionado em modelos existentes quando se torna utilizável no contêiner de fala.

supportsTranscriptionsSubmit

boolean

Um valor que indica se o envio de trabalhos de transcrição é suportado (POST /transcriptions:submit).

supportsTranscriptionsTranscribe

boolean

Um valor que indica se a ação de transcrição é suportada (POST /transcrições:transcrição).

BaseModelLinks

Name Tipo Description
manifest

string

O local para obter um manifesto para este modelo a ser usado no contêiner local. Consulte 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
Recursos suportados pelo modelo.

DatasetKind

DatasetKind

Name Tipo Description
Acoustic

string

Um conjunto de dados acústicos.

AudioFiles

string

Um conjunto de dados de arquivos de áudio.

Language

string

Um conjunto de dados de idioma.

LanguageMarkdown

string

Um conjunto de dados de marcação de idioma.

OutputFormatting

string

Conjunto de dados que contém regras para personalizar a normalização de texto inverso, capitalização, reformulação, palavrões e também define testes para validação de conjunto de dados

Pronunciation

string

Um conjunto de dados de pronúncia.

DetailedErrorCode

DetailedErrorCode

Name Tipo Description
AudioLengthLimitExceeded

string

O arquivo de áudio é maior do que a duração máxima permitida.

BadChannelConfiguration

string

Há uma incompatibilidade entre os canais de áudio nos dados, na configuração ou nos requisitos do aplicativo.

DataImportFailed

string

Falha na importação de dados.

DeleteNotAllowed

string

Excluir não permitido.

DeployNotAllowed

string

Implantação não permitida.

DeployingFailedModel

string

Implantação de modelo com falha.

EmptyAudioFile

string

O arquivo de áudio está vazio.

EmptyRequest

string

Pedido vazio.

EndpointCannotBeDefault

string

O ponto de extremidade não pode ser padrão.

EndpointLoggingNotSupported

string

Não há suporte para registro de ponto final.

EndpointNotUpdatable

string

Ponto final não atualizável.

EndpointWithoutLogging

string

Ponto de extremidade sem registro.

ExceededNumberOfRecordingsUris

string

Excedeu o número de gravações uris.

FailedDataset

string

Conjunto de dados com falha.

Forbidden

string

Proibido.

InUseViolation

string

Violação em uso.

InaccessibleCustomerStorage

string

Armazenamento inacessível do cliente.

InvalidAdaptationMapping

string

Mapeamento de adaptação inválido.

InvalidAudioFormat

string

O formato de entrada de áudio não é suportado.

InvalidBaseModel

string

Modelo base inválido.

InvalidCallbackUri

string

Uri de retorno de chamada inválido.

InvalidChannelSpecification

string

A seleção de canais na solicitação de transcrição não é suportada (por exemplo, nem 0 nem 1 foram selecionados).

InvalidChannels

string

Canais inválidos.

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

Localidade inválida.

InvalidLogDate

string

Data de registo inválida.

InvalidLogEndTime

string

Hora de fim de log inválida.

InvalidLogId

string

ID de log inválido.

InvalidLogStartTime

string

Hora de início de log 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

Carga útil inválida.

InvalidPermissions

string

Permissões inválidas.

InvalidPrerequisite

string

Pré-requisito inválido.

InvalidProductId

string

ID do produto inválida.

InvalidProject

string

Projeto inválido.

InvalidProjectKind

string

Tipo de projeto inválido.

InvalidRecordingsUri

string

Gravações inválidas uri.

InvalidRequestBodyFormat

string

Formato de corpo de solicitação inválido.

InvalidSasValidityDuration

string

Duração de validade sas inválida.

InvalidSkipTokenForLogs

string

Token de pulo inválido para logs.

InvalidSourceAzureResourceId

string

ID de recurso do Azure de origem inválida.

InvalidSubscription

string

Subscrição inválida.

InvalidTest

string

Teste inválido.

InvalidTimeToLive

string

Tempo de vida inválido.

InvalidTopForLogs

string

Parte superior inválida para logs.

InvalidTranscription

string

Transcrição inválida.

InvalidWebHookEventKind

string

Tipo de evento de gancho da Web inválido.

MissingInputRecords

string

Registros de entrada ausentes.

ModelCopyAuthorizationExpired

string

ModelCopyAuthorization expirado.

ModelDeploymentNotCompleteState

string

Implantação do modelo não concluída estado.

ModelDeprecated

string

Modelo preterido.

ModelExists

string

Modelo existe.

ModelMismatch

string

Incompatibilidade de modelos.

ModelNotDeployable

string

Modelo não implantável.

ModelVersionIncorrect

string

Versão do modelo incorreta.

MultipleLanguagesIdentified

string

A Identificação Linguística reconheceu vários idiomas. Nenhuma língua dominante pôde ser determinada.

NoLanguageIdentified

string

A Identificação Linguística não reconhecia nenhuma língua.

NoUtf8WithBom

string

Não utf8 com bom.

OnlyOneOfUrlsOrContainerOrDataset

string

Apenas um dos urls ou contêiner ou conjunto de dados.

ProjectGenderMismatch

string

Desfasamento entre homens e mulheres no projeto.

QuotaViolation

string

Violação de quotas.

SingleDefaultEndpoint

string

Ponto de extremidade padrão único.

SkuLimitsExist

string

Existem limites de Sku.

SubscriptionNotFound

string

Subscrição não encontrada.

UnexpectedError

string

Erro inesperado.

UnsupportedClassBasedAdaptation

string

Adaptação baseada em classe sem suporte.

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

Ordem 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ódigo de erro
Códigos de erro de alto nível.

details

Error[]

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

innerError

InnerError

InnerError
Novo formato de Erro Interno que está em conformidade com as Diretrizes da API de Serviços Cognitivos que está disponível em https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Isso contém as propriedades necessárias ErrorCode, mensagem e destino de propriedades opcionais, detalhes (par de valores de chave), erro interno (isso 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" no caso de documento inválido.

ErrorCode

Código de erro

Name Tipo Description
Conflict

string

Representando o código de erro de conflito.

Forbidden

string

Representando o código de erro proibido.

InternalCommunicationFailed

string

Representando o código de erro de falha de comunicação interna.

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 solicitação inválida.

NotAllowed

string

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

NotFound

string

Representando 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 de muitas solicitações.

Unauthorized

string

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

UnprocessableEntity

string

Representando o código de erro de entidade não processável.

UnsupportedMediaType

string

Representando o código de erro de tipo de mídia não suportado.

InnerError

InnerError

Name Tipo Description
code

DetailedErrorCode

DetailedErrorCode
Código de erro detalhado enum.

details

object

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

innerError

InnerError

InnerError
Novo formato de Erro Interno que está em conformidade com as Diretrizes da API de Serviços Cognitivos que está disponível em https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Isso contém as propriedades necessárias ErrorCode, mensagem e destino de propriedades opcionais, detalhes (par de valores de chave), erro interno (isso 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" no caso de documento inválido.

OutputFormatType

OutputFormatType

Name Tipo Description
Display

string

O modelo suporta formatação de exibição, transcrições, saída ou pontos de extremidade.

Lexical

string

Modelo fornece a saída de transcrição sem formatação.

Status

Situação

Name Tipo Description
Failed

string

A operação de longa duração falhou.

NotStarted

string

A operação de longa duração ainda não começou.

Running

string

A operação de longa duração está atualmente em processamento.

Succeeded

string

A operação de longa duração foi concluída com êxito.