Compartilhar via


Models - Create

Cria um novo modelo.

POST {endpoint}/speechtotext/v3.2-preview.2/models

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

Corpo da solicitação

Nome Obrigatório Tipo Description
displayName True

string

O nome para exibição do objeto.

locale True

string

A localidade dos dados contidos.

baseModel

EntityReference

EntityReference

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 .

project

EntityReference

EntityReference

properties

CustomModelProperties

CustomModelProperties

text

string

O texto usado para adaptar esse modelo de linguagem.

Respostas

Nome Tipo Description
201 Created

CustomModel

A resposta contém informações sobre a entidade como conteúdo e sua localização como cabeçalho.

Cabeçalhos

Location: string

Other Status Codes

Error

Ocorreu um erro.

Segurança

Ocp-Apim-Subscription-Key

Forneça sua chave de 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

Create a model
Create a model with custom model weight

Create a model

Solicitação de exemplo

POST {endpoint}/speechtotext/v3.2-preview.2/models

{
  "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/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
    }
  ],
  "locale": "en-US",
  "displayName": "Model with acoustic and language datasets"
}

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

Create a model with custom model weight

Solicitação de exemplo

POST {endpoint}/speechtotext/v3.2-preview.2/models

{
  "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/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
    }
  ],
  "properties": {
    "customModelWeightPercent": 42
  },
  "locale": "en-US",
  "displayName": "Model with acoustic and language datasets"
}

Resposta de exemplo

Location: https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b
{
  "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

ErrorCode

InnerError

InnerError

OutputFormatType

OutputFormatType

Status

Status

CustomModel

CustomModel

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

O nome para exibição do objeto.

lastActionDateTime

string

O carimbo de data/hora em que o status atual foi inserido. 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 localidade dos dados contidos.

project

EntityReference

EntityReference

properties

CustomModelProperties

CustomModelProperties

self

string

O local dessa entidade.

status

Status

Status
Descrever o estado atual da API

text

string

O texto usado para adaptar esse modelo de linguagem.

CustomModelDeprecationDates

CustomModelDeprecationDates

Nome Tipo Description
transcriptionDateTime

string

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

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

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

copyTo

string

O local para a ação de cópia de modelo obsoleta. Confira a operação "Models_CopyTo" para obter mais detalhes.

files

string

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

manifest

string

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

CustomModelProperties

CustomModelProperties

Nome Tipo Description
customModelWeightPercent

integer

O peso do modelo personalizado entre 1 (modelo personalizado de 1% e modelo base de 99%) e 100 (modelo personalizado de 100% e modelo base de 0%). Quando essa propriedade não está definida, o serviço escolhe 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

Nome Tipo Description
DataImportFailed

string

Falha na importação de dados.

DeleteNotAllowed

string

Exclusão não permitida.

DeployNotAllowed

string

Implantação não permitida.

DeployingFailedModel

string

Implantando um modelo com falha.

EmptyRequest

string

Solicitação vazia.

EndpointCannotBeDefault

string

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

EndpointNotUpdatable

string

Ponto de extremidade não atualizável.

EndpointWithoutLogging

string

Ponto de extremidade sem registro em log.

ExceededNumberOfRecordingsUris

string

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

FailedDataset

string

Conjunto de dados com falha.

Forbidden

string

Negado.

InUseViolation

string

Violação de uso.

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 retorno de chamada 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

Localidade inválida.

InvalidLogDate

string

Data de log inválida.

InvalidLogEndTime

string

Hora de término do log inválida.

InvalidLogId

string

ID de log inválida.

InvalidLogStartTime

string

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

Conteúdo inválido.

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

URI de gravações inválido.

InvalidRequestBodyFormat

string

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

InvalidSasValidityDuration

string

Duração de validade sas inválida.

InvalidSkipTokenForLogs

string

Token de ignorar inválido para logs.

InvalidSourceAzureResourceId

string

ID de recurso do Azure de origem inválida.

InvalidSubscription

string

Assinatura 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 web hook inválido.

MissingInputRecords

string

Registros de entrada ausentes.

ModelCopyOperationExists

string

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

ModelDeploymentNotCompleteState

string

O estado de implantação do modelo não foi concluído.

ModelDeprecated

string

Modelo preterido.

ModelExists

string

O modelo existe.

ModelMismatch

string

Incompatibilidade de modelo.

ModelNotDeployable

string

Modelo não implantável.

ModelVersionIncorrect

string

Versão do modelo Incorreta.

NoUtf8WithBom

string

Não utf8 com bom.

OnlyOneOfUrlsOrContainerOrDataset

string

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

ProjectGenderMismatch

string

Incompatibilidade de gênero do projeto.

QuotaViolation

string

Violação de cota.

SingleDefaultEndpoint

string

Ponto de extremidade padrão único.

SkuLimitsExist

string

Existem limites de SKU.

SubscriptionNotFound

string

Assinatura não encontrada.

UnexpectedError

string

Erro inesperado.

UnsupportedClassBasedAdaptation

string

Adaptação baseada em classe sem suporte.

UnsupportedDelta

string

Delta sem suporte.

UnsupportedDynamicConfiguration

string

Configuração dinâmica sem suporte.

UnsupportedFilter

string

Filtro sem suporte.

UnsupportedLanguageCode

string

Código de idioma sem suporte.

UnsupportedOrderBy

string

Ordem sem suporte por.

UnsupportedPagination

string

Paginação sem suporte.

UnsupportedTimeRange

string

Intervalo de tempo sem suporte.

EntityError

EntityError

Nome Tipo Description
code

string

O código desse erro.

message

string

A mensagem para esse erro.

EntityReference

EntityReference

Nome Tipo Description
self

string

O local da entidade referenciada.

Error

Erro

Nome Tipo Description
code

ErrorCode

ErrorCode
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. Ele contém as propriedades obrigatórias ErrorCode e message, bem como as propriedades opcionais target, details (par chave-valor) e inner error (pode ser aninhada).

message

string

Mensagem de erro de alto nível.

target

string

A origem do erro. Por exemplo, seria "documents" ou "document id" no caso de um documento inválido.

ErrorCode

ErrorCode

Nome 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álido.

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 de serviço indisponível.

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

InnerError

InnerError

Nome Tipo Description
code

DetailedErrorCode

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

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. Ele contém as propriedades obrigatórias ErrorCode e message, bem como as propriedades opcionais target, details (par chave-valor) e inner error (pode ser aninhada).

message

string

Mensagem de erro de alto nível.

target

string

A origem do erro. Por exemplo, seria "documents" ou "document id" no caso de um documento inválido.

OutputFormatType

OutputFormatType

Nome Tipo Description
Display

string

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

Lexical

string

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

Status

Status

Nome 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á sendo processada no momento.

Succeeded

string

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