Transcriptions - Transcribe

  • Referência
Serviço:
Azure AI Services
Versão da API:
2024-11-15

Transcrição síncrona de um arquivo de áudio.

POST {endpoint}/speechtotext/transcriptions:transcribe?api-version=2024-11-15

Parâmetros de URI

Nome Em Obrigatório Tipo Description
audio
 formData True

file

binary

O conteúdo do arquivo de áudio a ser transcrito. O arquivo de áudio deve ter menos de 2 horas de duração de áudio e menor que 250 MB de tamanho.
definition
 formData

string

Metadados para uma solicitação de transcrição. Este campo contém um objeto serializado em JSON do tipo TranscribeDefinition.
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).
api-version
 query True

string

A versão da API solicitada.

Cabeçalho da solicitação

Media Types: "multipart/form-data"

Nome Obrigatório Tipo Description
Ocp-Apim-Subscription-Key True

string

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

Respostas

Nome Tipo Description
200 OK

TranscribeResult

OKEY
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

Exemplos

Transcribe an audio file

Solicitação de exemplo

POST {endpoint}/speechtotext/transcriptions:transcribe?api-version=2024-11-15

Resposta de exemplo

Código de status:
200 
{
  "durationMilliseconds": 2000,
  "combinedPhrases": [
    {
      "text": "Weather"
    }
  ],
  "phrases": [
    {
      "offsetMilliseconds": 40,
      "durationMilliseconds": 320,
      "text": "Weather",
      "words": [
        {
          "text": "weather",
          "offsetMilliseconds": 40,
          "durationMilliseconds": 320
        }
      ],
      "locale": "en-US",
      "confidence": 0.78983736
    }
  ]
}

Definições

Nome Description
ChannelCombinedPhrases

A transcrição completa por canal.
DetailedErrorCode

DetailedErrorCode
Error

Erro
ErrorCode

ErrorCode
InnerError

InnerError
Phrase

Uma frase transcrita.
TranscribeResult

O resultado da operação de transcrever.
Word

Palavra com carimbo de data/hora no formulário de exibição.

ChannelCombinedPhrases

A transcrição completa por canal.

Nome Tipo Description
channel

integer

O índice de canal baseado em 0. Só estará presente se a separação de canal estiver habilitada.
text

string

O texto transcrito.

DetailedErrorCode

DetailedErrorCode

Nome Tipo Description
AudioLengthLimitExceeded

string

O arquivo de áudio é maior que a duração máxima permitida.
BadChannelConfiguration

string

Há uma incompatibilidade entre canais de áudio nos dados, na configuração ou nos requisitos do aplicativo.
DataImportFailed

string

Falha na importação de dados.
DeleteNotAllowed

string

Exclusão não permitida.
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

Solicitação vazia.
EndpointCannotBeDefault

string

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

string

Não há suporte para o registro em log do ponto de extremidade.
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

Proibido.
InUseViolation

string

Em violação de uso.
InaccessibleCustomerStorage

string

Armazenamento de clientes inacessível.
InvalidAdaptationMapping

string

Mapeamento de adaptação inválido.
InvalidAudioFormat

string

Não há suporte para o formato de áudio de entrada.
InvalidBaseModel

string

Modelo base inválido.
InvalidCallbackUri

string

URI de retorno de chamada inválido.
InvalidChannelSpecification

string

Não há suporte para a seleção de canais na solicitação de transcrição (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 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álido.
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 gancho da Web inválido.
MissingInputRecords

string

Registros de entrada ausentes.
ModelCopyAuthorizationExpired

string

ModelCopyAuthorization expirado.
ModelDeploymentNotCompleteState

string

Implantação de modelo não completa o estado.
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.
MultipleLanguagesIdentified

string

Identificação de Idiomas reconheceu vários idiomas. Nenhuma linguagem dominante poderia ser determinada.
NoLanguageIdentified

string

A Identificação de Idiomas não reconheceu nenhum idioma.
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.

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

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

Phrase

Uma frase transcrita.

Nome Tipo Description
channel

integer

O índice de canal baseado em 0. Só estará presente se a separação de canal estiver habilitada.
confidence

number

O valor de confiança da frase.
durationMilliseconds

integer

A duração da frase em milissegundos.
locale

string

A localidade da frase.
offsetMilliseconds

integer

O deslocamento inicial da frase em milissegundos.
speaker

integer

Um número inteiro exclusivo atribuído a cada alto-falante detectado no áudio sem uma ordem específica. Só estará presente se a diarização do locutor estiver habilitada.
text

string

O texto transcrito da frase.
words

Word[]

As palavras que compõem a frase. Só estará presente se os carimbos de data/hora de nível de palavra estiverem habilitados.

TranscribeResult

O resultado da operação de transcrever.

Nome Tipo Description
combinedPhrases

ChannelCombinedPhrases[]

A transcrição completa de cada canal.
durationMilliseconds

integer

A duração do áudio em milissegundos.
phrases

Phrase[]

Os resultados da transcrição segmentados em frases.

Word

Palavra com carimbo de data/hora no formulário de exibição.

Nome Tipo Description
durationMilliseconds

integer

A duração da palavra em milissegundos.
offsetMilliseconds

integer

O deslocamento inicial da palavra em milissegundos.
text

string

A palavra reconhecida, incluindo pontuação.