Partilhar via


Models - Get Custom Model

Obtém o modelo identificado pelo ID especificado.

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

Respostas

Name Tipo Description
200 OK

CustomModel

OK

Cabeçalhos

Retry-After: integer

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 a model
Get a model with custom model weight

Get a model

Pedido de amostra

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

Resposta da amostra

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b",
  "baseModel": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
  },
  "datasets": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
    }
  ],
  "links": {
    "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b",
    "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copyto",
    "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copy",
    "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b/files"
  },
  "properties": {
    "deprecationDates": {
      "transcriptionDateTime": "2023-05-04T00:00:00Z"
    },
    "customModelWeightPercent": 30,
    "features": {
      "supportsTranscriptions": true,
      "supportsEndpoints": true,
      "supportsTranscriptionsOnSpeechContainers": false,
      "supportedOutputFormats": [
        "Lexical",
        "Display"
      ]
    }
  },
  "lastActionDateTime": "2019-01-07T11:36:07Z",
  "status": "Running",
  "createdDateTime": "2019-01-07T11:34:12Z",
  "locale": "en-US",
  "displayName": "Language model",
  "description": "This is a language model"
}

Get a model with custom model weight

Pedido de amostra

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

Resposta da amostra

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/827712a5-f942-4997-91c3-7c6cde35600b",
  "baseModel": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
  },
  "datasets": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
    }
  ],
  "links": {
    "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b",
    "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copyto",
    "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copy",
    "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b/files"
  },
  "properties": {
    "deprecationDates": {
      "transcriptionDateTime": "2023-05-04T00:00:00Z"
    },
    "customModelWeightPercent": 42,
    "features": {
      "supportsTranscriptions": true,
      "supportsEndpoints": true,
      "supportsTranscriptionsOnSpeechContainers": false,
      "supportedOutputFormats": [
        "Lexical",
        "Display"
      ]
    }
  },
  "lastActionDateTime": "2019-01-07T11:36:07Z",
  "status": "Running",
  "createdDateTime": "2019-01-07T11:34:12Z",
  "locale": "en-US",
  "displayName": "Language model",
  "description": "This is a language model"
}

Definições

Name Description
CustomModel

CustomModel

CustomModelDeprecationDates

CustomModelDeprecationDates

CustomModelFeatures

CustomModelFeatures

CustomModelLinks

CustomModelLinks

CustomModelProperties

CustomModelProperties

DetailedErrorCode

DetailedErrorCode

EntityError

EntityError

EntityReference

EntityReference

Error

Erro

ErrorCode

CódigoDoErro

InnerError

InnerError

OutputFormatType

OutputFormatType

Status

Estado

CustomModel

CustomModel

Name Tipo Description
baseModel

EntityReference

EntityReference

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

customProperties

object

As propriedades personalizadas desta entidade. O comprimento máximo permitido da chave é de 64 carateres, o comprimento máximo permitido do valor é de 256 carateres e a contagem de entradas permitidas é de 10.

datasets

EntityReference[]

Conjuntos de dados utilizados para adaptação.

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

CustomModelLinks

CustomModelLinks

locale

string

A região dos dados contidos.

project

EntityReference

EntityReference

properties

CustomModelProperties

CustomModelProperties

self

string

A localização desta entidade.

status

Status

Estado
Descrever o estado atual da API

text

string

O texto utilizado para adaptar este modelo de linguagem.

CustomModelDeprecationDates

CustomModelDeprecationDates

Name Tipo Description
transcriptionDateTime

string

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

CustomModelFeatures

CustomModelFeatures

Name Tipo Description
supportedOutputFormats

OutputFormatType[]

Formatos de saída suportados.

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.

CustomModelLinks

Name Tipo Description
copy

string

A localização da ação de cópia do modelo. Veja a operação "Models_Copy" para obter mais detalhes.

copyTo

string

A localização da ação de cópia do modelo obsoleto. Veja a operação "Models_CopyTo" para obter mais detalhes.

files

string

A localização para obter todos os ficheiros desta entidade. Veja a operação "Models_ListFiles" para obter mais detalhes.

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.

CustomModelProperties

CustomModelProperties

Name Tipo Description
customModelWeightPercent

integer

O peso do modelo personalizado entre 1 (modelo personalizado de 1% e modelo base de 99%) e 100 (modelo personalizado a 100% e modelo base de 0%). Quando esta propriedade não está definida, o serviço escolhe um valor adequado (obtenha o modelo para obter a ponderação selecionada). Comece sem utilizar esta propriedade. Se necessário, escolha um peso maior (ou menor) para aumentar (ou diminuir) o impacto do modelo personalizado.

deprecationDates

CustomModelDeprecationDates

CustomModelDeprecationDates

email

string

O endereço de e-mail para o qual enviar notificações por e-mail, caso a operação seja concluída. O valor será removido depois de enviar o e-mail com êxito.

error

EntityError

EntityError

features

CustomModelFeatures

CustomModelFeatures
Funcionalidades suportadas pelo modelo.

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

EntityError

EntityError

Name Tipo Description
code

string

O código deste erro.

message

string

A mensagem para este erro.

EntityReference

EntityReference

Name Tipo Description
self

string

A localização da entidade referenciada.

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

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

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.

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.