Transcriptions - Transcribe

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

HTTP

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

Objeto

A transcrição completa por canal.

Nome	Tipo	Description
channel	integer (int32)	O índice de canal baseado em 0. Só estará presente se a separação de canal estiver habilitada.
text	string	O texto transcrito.

DetailedErrorCode

Enumeração

DetailedErrorCode

Valor	Description
InvalidParameterValue	Valor de parâmetro inválido.
InvalidRequestBodyFormat	Formato do corpo da solicitação inválido.
EmptyRequest	Solicitação vazia.
MissingInputRecords	Registros de entrada ausentes.
InvalidDocument	Documento inválido.
ModelVersionIncorrect	Versão do modelo incorreta.
InvalidDocumentBatch	Lote de Documentos Inválido.
UnsupportedLanguageCode	Código de idioma sem suporte.
DataImportFailed	Falha na importação de dados.
InUseViolation	Em violação de uso.
InvalidLocale	Localidade inválida.
InvalidBaseModel	Modelo base inválido.
InvalidAdaptationMapping	Mapeamento de adaptação inválido.
InvalidDataset	Conjunto de dados inválido.
InvalidTest	Teste inválido.
FailedDataset	Conjunto de dados com falha.
InvalidModel	Modelo inválido.
InvalidTranscription	Transcrição inválida.
InvalidPayload	Conteúdo inválido.
InvalidParameter	Parâmetro inválido.
EndpointWithoutLogging	Ponto de extremidade sem registro em log.
InvalidPermissions	Permissões inválidas.
InvalidPrerequisite	Pré-requisito inválido.
InvalidProductId	ID do produto inválido.
InvalidSubscription	Assinatura inválida.
InvalidProject	Projeto inválido.
InvalidProjectKind	Tipo de projeto inválido.
InvalidRecordingsUri	URI de gravações inválido.
OnlyOneOfUrlsOrContainerOrDataset	Apenas uma das URLs, contêiner ou conjunto de dados.
ExceededNumberOfRecordingsUris	Número excedido de uris de gravações.
InvalidChannels	Canais inválidos.
ModelMismatch	Incompatibilidade de modelo.
ProjectGenderMismatch	Incompatibilidade de gênero do projeto.
ModelDeprecated	Modelo preterido.
ModelExists	O modelo existe.
ModelNotDeployable	Modelo não implantável.
EndpointNotUpdatable	Ponto de extremidade não atualizável.
SingleDefaultEndpoint	Ponto de extremidade padrão único.
EndpointCannotBeDefault	O ponto de extremidade não pode ser padrão.
InvalidModelUri	URI de modelo inválido.
SubscriptionNotFound	Assinatura não encontrada.
QuotaViolation	Violação de cota.
UnsupportedDelta	Delta sem suporte.
UnsupportedFilter	Filtro sem suporte.
UnsupportedPagination	Paginação sem suporte.
UnsupportedDynamicConfiguration	Configuração dinâmica sem suporte.
UnsupportedOrderBy	Ordem sem suporte por.
NoUtf8WithBom	Não utf8 com bom.
ModelDeploymentNotCompleteState	Implantação de modelo não completa o estado.
SkuLimitsExist	Existem limites de SKU.
DeployingFailedModel	Implantação de modelo com falha.
UnsupportedTimeRange	Intervalo de tempo sem suporte.
InvalidLogDate	Data de log inválida.
InvalidLogId	ID de log inválida.
InvalidLogStartTime	Hora de início do log inválida.
InvalidLogEndTime	Hora de término do log inválida.
InvalidTopForLogs	Parte superior inválida para logs.
InvalidSkipTokenForLogs	Token de ignorar inválido para logs.
DeleteNotAllowed	Exclusão não permitida.
Forbidden	Proibido.
DeployNotAllowed	Implantação não permitida.
UnexpectedError	Erro inesperado.
InvalidCollection	Coleção inválida.
InvalidCallbackUri	URI de retorno de chamada inválido.
InvalidSasValidityDuration	Duração de validade sas inválida.
InaccessibleCustomerStorage	Armazenamento de clientes inacessível.
UnsupportedClassBasedAdaptation	Adaptação baseada em classe sem suporte.
InvalidWebHookEventKind	Tipo de evento de gancho da Web inválido.
InvalidTimeToLive	Tempo de vida inválido.
InvalidSourceAzureResourceId	ID de recurso do Azure de origem inválida.
ModelCopyAuthorizationExpired	ModelCopyAuthorization expirado.
EndpointLoggingNotSupported	Não há suporte para o registro em log do ponto de extremidade.
NoLanguageIdentified	A Identificação de Idiomas não reconheceu nenhum idioma.
MultipleLanguagesIdentified	Identificação de Idiomas reconheceu vários idiomas. Nenhuma linguagem dominante poderia ser determinada.
InvalidAudioFormat	Não há suporte para o formato de áudio de entrada.
BadChannelConfiguration	Há uma incompatibilidade entre canais de áudio nos dados, na configuração ou nos requisitos do aplicativo.
InvalidChannelSpecification	Não há suporte para a seleção de canais na solicitação de transcrição (por exemplo, nem 0 nem 1 foram selecionados).)
AudioLengthLimitExceeded	O arquivo de áudio é maior que a duração máxima permitida.
EmptyAudioFile	O arquivo de áudio está vazio.

Error

Objeto

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

Enumeração

ErrorCode

Valor	Description
InvalidRequest	Representando o código de erro de solicitação inválido.
InvalidArgument	Representando o código de erro de argumento inválido.
InternalServerError	Representando o código de erro interno do servidor.
ServiceUnavailable	Representando o código de erro indisponível do serviço.
NotFound	Representando o código de erro não encontrado.
PipelineError	Representando o código de erro do pipeline.
Conflict	Representando o código de erro de conflito.
InternalCommunicationFailed	Representando o código de erro de falha de comunicação interna.
Forbidden	Representando o código de erro proibido.
NotAllowed	Representando o código de erro não permitido.
Unauthorized	Representando o código de erro não autorizado.
UnsupportedMediaType	Representando o código de erro de tipo de mídia sem suporte.
TooManyRequests	Representando o código de erro de muitas solicitações.
UnprocessableEntity	Representando o código de erro de entidade não processável.

InnerError

Objeto

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

Objeto

Uma frase transcrita.

Nome	Tipo	Description
channel	integer (int32)	O índice de canal baseado em 0. Só estará presente se a separação de canal estiver habilitada.
confidence	number (float)	O valor de confiança da frase.
durationMilliseconds	integer (int32)	A duração da frase em milissegundos.
locale	string	A localidade da frase.
offsetMilliseconds	integer (int32)	O deslocamento inicial da frase em milissegundos.
speaker	integer (int32)	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

Objeto

O resultado da operação de transcrever.

Nome	Tipo	Description
combinedPhrases	ChannelCombinedPhrases[]	A transcrição completa de cada canal.
durationMilliseconds	integer (int32)	A duração do áudio em milissegundos.
phrases	Phrase[]	Os resultados da transcrição segmentados em frases.

Word

Objeto

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

Nome	Tipo	Description
durationMilliseconds	integer (int32)	A duração da palavra em milissegundos.
offsetMilliseconds	integer (int32)	O deslocamento inicial da palavra em milissegundos.
text	string	A palavra reconhecida, incluindo pontuação.

Compartilhar via

Transcriptions - Transcribe

Parâmetros de URI

Cabeçalho da solicitação

Respostas

Segurança

Ocp-Apim-Subscription-Key

Exemplos

Transcribe an audio file

Solicitação de exemplo

Resposta de exemplo

Definições

ChannelCombinedPhrases

DetailedErrorCode

Error

ErrorCode

InnerError

Phrase

TranscribeResult

Word