Models - Get Base Model

Referência

Serviço:: Azure AI Services

Versão da API:: v3.2-preview.2

Obtém o modelo base identificado pelo ID especificado.

GET {endpoint}/speechtotext/v3.2-preview.2/models/base/{id}

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).
id	path	True	string uuid	O identificador do modelo base.

Respostas

Name	Tipo	Description
200 OK	BaseModel	OK
Other Status Codes	Error	Ocorreu um erro.

Segurança

Ocp-Apim-Subscription-Key

Forneça a sua chave de 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. Confirme 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 a base model

Pedido de amostra

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/models/base/827712a5-f942-4997-91c3-7c6cde35600b

Resposta da amostra

Código de estado:: 200

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

BaseModel

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", 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 em que o estado atual foi introduzido. O carimbo de data/hora é codificado como formato de data e hora ISO 8601 ("AAAA-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

Name	Tipo	Description
adaptationDateTime	string	A data em que a adaptação é preterida.
transcriptionDateTime	string	A data em que a transcrição é preterida.

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 em lote é 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 a 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 a ser utilizado no contentor no local. Veja a operação "Models_GetCustomModelManifest" para obter mais detalhes.

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

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 linguagem.
LanguageMarkdown	string	Um conjunto de dados de markdown de linguagem.
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

Name	Tipo	Description
DataImportFailed	string	Falha na importação de dados.
DeleteNotAllowed	string	A eliminação não é permitida.
DeployNotAllowed	string	A implementação não é permitida.
DeployingFailedModel	string	A implementar o modelo com falhas.
EmptyRequest	string	Pedido Vazio.
EndpointCannotBeDefault	string	O ponto final não pode ser predefinido.
EndpointNotUpdatable	string	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 inacessível do cliente.
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 Documento inválido.
InvalidLocale	string	Região inválida.
InvalidLogDate	string	Data de registo inválida.
InvalidLogEndTime	string	Hora de fim de registo inválida.
InvalidLogId	string	ID de registo inválido.
InvalidLogStartTime	string	Hora de início de 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 de 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 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. Contém as propriedades necessárias ErrorCode, destino de mensagens e propriedades opcionais, detalhes (par de valores 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	Representa o código de erro de conflito.
Forbidden	string	Representa o código de erro proibido.
InternalCommunicationFailed	string	A representação do código de erro falha na comunicação interna.
InternalServerError	string	Representa o código de erro interno do servidor.
InvalidArgument	string	Representa o código de erro de argumento inválido.
InvalidRequest	string	Representa o código de erro de pedido inválido.
NotAllowed	string	Representa o código de erro não permitido.
NotFound	string	Representa o código de erro não encontrado.
PipelineError	string	Representa o código de erro do pipeline.
ServiceUnavailable	string	Representa o código de erro serviço indisponível.
TooManyRequests	string	Representa o código de erro demasiados pedidos.
Unauthorized	string	Representa o código de erro não autorizado.
UnprocessableEntity	string	Representa o código de erro de entidade não processada.
UnsupportedMediaType	string	Representa o código de erro do tipo de suporte de dados não suportado.

InnerError

Name	Tipo	Description
code	DetailedErrorCode	DetailedErrorCode Enumeração detalhada do código de erro.
details	object	Detalhes de suporte adicionais sobre o erro e/ou as políticas esperadas.
innerError	InnerError	InnerError Novo formato de Erro Interno 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. Contém as propriedades necessárias ErrorCode, destino de mensagens e propriedades opcionais, detalhes (par de valores 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

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 o resultado da transcrição sem formatação.

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.

Partilhar via