Compartilhar via


Models - Get Custom Model

Obtém o modelo identificado pela ID fornecida.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
endpoint
path True

string

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

id
path True

string (uuid)

O identificador do modelo.

Respostas

Nome Tipo Description
200 OK

CustomModel

OKEY

Cabeçalhos

Retry-After: integer

Other Status Codes

Error

Ocorreu um erro.

Segurança

Ocp-Apim-Subscription-Key

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

Tipo: apiKey
Em: header

Authorization

Forneça um token de acesso do JWT retornado pelo STS desta região. Adicione o escopo de gerenciamento ao token adicionando a seguinte cadeia de caracteres de consulta à URL do STS: ?scope=speechservicesmanagement

Tipo: apiKey
Em: header

Exemplos

Get a model
Get a model with custom model weight

Get a model

Solicitação de exemplo

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

Resposta de exemplo

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

Solicitação de exemplo

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

Resposta de exemplo

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

Nome Description
CustomModel

CustomModel

CustomModelDeprecationDates

CustomModelDeprecationDates

CustomModelFeatures

CustomModelFeatures

CustomModelLinks

CustomModelLinks

CustomModelProperties

CustomModelProperties

DetailedErrorCode

DetailedErrorCode

EntityError

EntityError

EntityReference

EntityReference

Error

Erro

ErrorCode

Código de Erro

InnerError

InnerError

OutputFormatType

OutputFormatType

Status

Situação

CustomModel

CustomModel

Nome Tipo Description
baseModel

EntityReference

EntityReference

createdDateTime

string (date-time)

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

customProperties

object

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

datasets

EntityReference[]

Conjuntos de dados usados para adaptação.

description

string

A descrição do objeto.

displayName

string

minLength: 1

O nome de exibição do objeto.

lastActionDateTime

string (date-time)

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 ("YYYY-MM-DDThh:mm:ssZ", consulte https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).

links

CustomModelLinks

CustomModelLinks

locale

string

minLength: 1

A localidade dos dados contidos.

project

EntityReference

EntityReference

properties

CustomModelProperties

CustomModelProperties

self

string (uri)

O local dessa entidade.

status

Status

Situação
Descrever o estado atual da API

text

string

O texto usado para adaptar esse modelo de linguagem.

CustomModelDeprecationDates

CustomModelDeprecationDates

Nome Tipo Description
transcriptionDateTime

string (date-time)

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

CustomModelFeatures

CustomModelFeatures

Nome Tipo Description
supportedOutputFormats

OutputFormatType[]

Formatos de saída com suporte.

supportsEndpoints

boolean

Um valor que indica se há suporte para a criação de pontos de extremidade para transcrição dinâmica.

supportsTranscriptions

boolean

Um valor que indica se a transcrição em lote tem suporte.

supportsTranscriptionsOnSpeechContainers

boolean

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

CustomModelLinks

Nome Tipo Description
copy

string (uri)

O local para a ação de cópia do modelo. Consulte a operação "Models_Copy" para obter mais detalhes.

copyTo

string (uri)

O local para a ação de cópia do modelo obsoleto. Consulte a operação "Models_CopyTo" para obter mais detalhes.

files

string (uri)

O local para obter todos os arquivos dessa entidade. Consulte a operação "Models_ListFiles" para obter mais detalhes.

manifest

string (uri)

O local para obter um manifesto para esse modelo a ser usado no contêiner local. Consulte a operação "Models_GetCustomModelManifest" para obter mais detalhes.

CustomModelProperties

CustomModelProperties

Nome Tipo Description
customModelWeightPercent

integer (int32)

minimum: 1
maximum: 100

O peso do modelo personalizado entre 1 (1% modelo personalizado e 99% modelo base) e 100 (100% modelo personalizado e 0% modelo base). Quando essa propriedade não estiver definida, o serviço escolherá um valor adequado (obtenha o modelo para recuperar o peso selecionado). Comece sem usar essa 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 email para o qual enviar notificações por email caso a operação seja concluída. O valor será removido depois de enviar o email com êxito.

error

EntityError

EntityError

features

CustomModelFeatures

CustomModelFeatures
Recursos compatíveis com o modelo.

DetailedErrorCode

DetailedErrorCode

Valor Description
DataImportFailed

Falha na importação de dados.

DeleteNotAllowed

Exclusão não permitida.

DeployNotAllowed

Implantação não permitida.

DeployingFailedModel

Implantação de modelo com falha.

EmptyRequest

Solicitação vazia.

EndpointCannotBeDefault

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

EndpointNotUpdatable

Ponto de extremidade não atualizável.

EndpointWithoutLogging

Ponto de extremidade sem registro em log.

ExceededNumberOfRecordingsUris

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

FailedDataset

Conjunto de dados com falha.

Forbidden

Proibido.

InUseViolation

Em violação de uso.

InaccessibleCustomerStorage

Armazenamento de clientes inacessível.

InvalidAdaptationMapping

Mapeamento de adaptação inválido.

InvalidBaseModel

Modelo base inválido.

InvalidCallbackUri

URI de retorno de chamada inválido.

InvalidCollection

Coleção inválida.

InvalidDataset

Conjunto de dados inválido.

InvalidDocument

Documento inválido.

InvalidDocumentBatch

Lote de Documentos Inválido.

InvalidLocale

Localidade inválida.

InvalidLogDate

Data de log inválida.

InvalidLogEndTime

Hora de término do log inválida.

InvalidLogId

ID de log inválida.

InvalidLogStartTime

Hora de início do log inválida.

InvalidModel

Modelo inválido.

InvalidModelUri

URI de modelo inválido.

InvalidParameter

Parâmetro inválido.

InvalidParameterValue

Valor de parâmetro inválido.

InvalidPayload

Conteúdo inválido.

InvalidPermissions

Permissões inválidas.

InvalidPrerequisite

Pré-requisito inválido.

InvalidProductId

ID do produto inválido.

InvalidProject

Projeto inválido.

InvalidProjectKind

Tipo de projeto inválido.

InvalidRecordingsUri

URI de gravações inválido.

InvalidRequestBodyFormat

Formato do corpo da solicitação inválido.

InvalidSasValidityDuration

Duração de validade sas inválida.

InvalidSkipTokenForLogs

Token de ignorar inválido para logs.

InvalidSourceAzureResourceId

ID de recurso do Azure de origem inválida.

InvalidSubscription

Assinatura inválida.

InvalidTest

Teste inválido.

InvalidTimeToLive

Tempo de vida inválido.

InvalidTopForLogs

Parte superior inválida para logs.

InvalidTranscription

Transcrição inválida.

InvalidWebHookEventKind

Tipo de evento de gancho da Web inválido.

MissingInputRecords

Registros de entrada ausentes.

ModelCopyOperationExists

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

ModelDeploymentNotCompleteState

Implantação de modelo não completa o estado.

ModelDeprecated

Modelo preterido.

ModelExists

O modelo existe.

ModelMismatch

Incompatibilidade de modelo.

ModelNotDeployable

Modelo não implantável.

ModelVersionIncorrect

Versão do modelo incorreta.

NoUtf8WithBom

Não utf8 com bom.

OnlyOneOfUrlsOrContainerOrDataset

Apenas uma das URLs, contêiner ou conjunto de dados.

ProjectGenderMismatch

Incompatibilidade de gênero do projeto.

QuotaViolation

Violação de cota.

SingleDefaultEndpoint

Ponto de extremidade padrão único.

SkuLimitsExist

Existem limites de SKU.

SubscriptionNotFound

Assinatura não encontrada.

UnexpectedError

Erro inesperado.

UnsupportedClassBasedAdaptation

Adaptação baseada em classe sem suporte.

UnsupportedDelta

Delta sem suporte.

UnsupportedDynamicConfiguration

Configuração dinâmica sem suporte.

UnsupportedFilter

Filtro sem suporte.

UnsupportedLanguageCode

Código de idioma sem suporte.

UnsupportedOrderBy

Ordem sem suporte por.

UnsupportedPagination

Paginação sem suporte.

UnsupportedTimeRange

Intervalo de tempo sem suporte.

EntityError

EntityError

Nome Tipo Description
code

string

O código desse erro.

message

string

A mensagem para este erro.

EntityReference

EntityReference

Nome Tipo Description
self

string (uri)

O local da entidade referenciada.

Error

Erro

Nome 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 as políticas esperadas.

innerError

InnerError

InnerError
Novo formato de Erro Interno que está em conformidade com as Diretrizes de API dos 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, destino de mensagens e propriedades opcionais, detalhes (par de valor 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, seriam "documentos" ou "id de documento" em caso de documento inválido.

ErrorCode

Código de Erro

Valor Description
Conflict

Representando o código de erro de conflito.

Forbidden

Representando o código de erro proibido.

InternalCommunicationFailed

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

InternalServerError

Representando o código de erro interno do servidor.

InvalidArgument

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

InvalidRequest

Representando o código de erro de solicitação inválido.

NotAllowed

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

NotFound

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

PipelineError

Representando o código de erro do pipeline.

ServiceUnavailable

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

TooManyRequests

Representando o código de erro de muitas solicitações.

Unauthorized

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

UnprocessableEntity

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

UnsupportedMediaType

Representando o código de erro de tipo de mídia sem suporte.

InnerError

InnerError

Nome Tipo Description
code

DetailedErrorCode

DetailedErrorCode
Enumeração detalhada do código de erro.

details

object

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

innerError

InnerError

InnerError
Novo formato de Erro Interno que está em conformidade com as Diretrizes de API dos 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, destino de mensagens e propriedades opcionais, detalhes (par de valor 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, seriam "documentos" ou "id de documento" em caso de documento inválido.

OutputFormatType

OutputFormatType

Valor Description
Display

O modelo dá suporte à exibição de saída ou pontos de extremidade de transcrições de formatação.

Lexical

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

Status

Situação

Valor Description
Failed

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

NotStarted

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

Running

A operação de execução longa está sendo processada no momento.

Succeeded

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