Models - Create

Referência

Serviço:: Azure AI Services

Versão da API:: 2024-11-15

Cria um novo modelo.

POST {endpoint}/speechtotext/models?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).
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.

Corpo do Pedido

Name	Necessário	Tipo	Description
displayName	True	string	O nome para exibição do objeto.
locale	True	string	A localidade dos dados contidos.
baseModel		EntityReference	EntidadeReferência
customProperties		object	As propriedades personalizadas desta entidade. O comprimento máximo permitido da chave é de 64 caracteres, o comprimento máximo do valor permitido é de 256 caracteres e a contagem de entradas permitidas é de 10.
datasets		EntityReference[]	Conjuntos de dados utilizados para adaptação.
description		string	A descrição do objeto.
properties		CustomModelProperties	CustomModelProperties

Respostas

Name	Tipo	Description
201 Created	CustomModel	A resposta contém informações sobre a entidade como carga útil e sua localização como cabeçalho. Cabeçalhos Location: string
Other Status Codes	Error	Ocorreu um erro.

Name

Tipo

Description

201 Created

CustomModel

A resposta contém informações sobre a entidade como carga útil 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 a chave da sua conta de serviços cognitivos aqui.

Tipo: apiKey
Em: header

Exemplos

Create a model

Create a model with custom model weight

Create a model

Pedido de amostra

HTTP

POST {endpoint}/speechtotext/models?api-version=2024-11-15


{
  "baseModel": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-11-15"
  },
  "datasets": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-11-15"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c?api-version=2024-11-15"
    }
  ],
  "displayName": "Model with acoustic and language datasets",
  "locale": "en-US"
}

Resposta da amostra

Código de estado:: 201

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

Create a model with custom model weight

Pedido de amostra

HTTP

POST {endpoint}/speechtotext/models?api-version=2024-11-15


{
  "baseModel": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-11-15"
  },
  "datasets": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-11-15"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c?api-version=2024-11-15"
    }
  ],
  "properties": {
    "customModelWeightPercent": 42
  },
  "displayName": "Model with acoustic and language datasets",
  "locale": "en-US"
}

Resposta da amostra

Código de estado:: 201

Location: https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-11-15

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

Definições

Name	Description
CustomModel	Modelo Personalizado
CustomModelDeprecationDates	CustomModelDeprecationDates
CustomModelFeatures	CustomModelFeatures
CustomModelLinks	CustomModelLinks
CustomModelProperties	CustomModelProperties
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
EntityReference	EntidadeReferência
Error	Erro
ErrorCode	Código de erro
InnerError	InnerError
OutputFormatType	OutputFormatType
Status	Situação

CustomModel

Modelo Personalizado

Name	Tipo	Description
baseModel	EntityReference	EntidadeReferência
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).
customProperties	object	As propriedades personalizadas desta entidade. O comprimento máximo permitido da chave é de 64 caracteres, o comprimento máximo do valor permitido é de 256 caracteres 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 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	CustomModelLinks	CustomModelLinks
locale	string	A localidade dos dados contidos.
properties	CustomModelProperties	CustomModelProperties
self	string	A localização desta entidade.
status	Status	Situação Descreva o estado atual da API.

CustomModelDeprecationDates

Name	Tipo	Description
transcriptionDateTime	string	A data em que a transcrição se torna obsoleta.

CustomModelFeatures

Name	Tipo	Description
supportedOutputFormats	OutputFormatType[]	Formatos de saída suportados.
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).

CustomModelLinks

Name	Tipo	Description
copy	string	O local para a ação de cópia do modelo. Consulte a operação "Models_Copy" para obter mais detalhes.
files	string	O local para obter todos os arquivos desta entidade. Consulte a operação "Models_ListFiles" para obter mais detalhes.
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.

CustomModelProperties

Name	Tipo	Description
customModelWeightPercent	integer	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 é definida, o serviço escolhe um valor adequado (obter o modelo para recuperar o peso selecionado). Comece sem usar esta propriedade. Se necessário, escolha um peso maior (ou menor) para aumentar (ou diminuir) o impacto do modelo personalizado.
deprecationDates	CustomModelDeprecationDates	CustomModelDeprecationDates
error	EntityError	EntityError
features	CustomModelFeatures	CustomModelFeatures Recursos suportados pelo modelo.

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.

EntityError

Name	Tipo	Description
code	string	O código deste erro.
message	string	A mensagem para este erro.

EntityReference

EntidadeReferência

Name	Tipo	Description
self	string	A localização da entidade referenciada.

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

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

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.

Partilhar via

Models - Create

Parâmetros do URI

Cabeçalho do Pedido

Corpo do Pedido

Respostas

Segurança

Ocp-Apim-Subscription-Key

Exemplos

Create a model

Pedido de amostra

Resposta da amostra

Create a model with custom model weight

Pedido de amostra

Resposta da amostra

Definições

CustomModel

CustomModelDeprecationDates

CustomModelFeatures

CustomModelLinks

CustomModelProperties

DetailedErrorCode

EntityError

EntityReference

Error

ErrorCode

InnerError

OutputFormatType

Status

Recursos adicionais