Alibaba Cloud Model Studio:RESTful API

Envia uma tarefa de reconhecimento de fala.

https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/services/audio/asr/transcription

POST

Authorization: Bearer {api-key} // Substitua {api-key} pela sua chave de API.
Content-Type: application/json
X-DashScope-Async: enable // Não omita este cabeçalho de solicitação. Caso contrário, a tarefa não poderá ser enviada.

O código a seguir mostra um corpo de mensagem contendo todos os parâmetros de solicitação. Omita campos opcionais conforme necessário.

{
    "model":"paraformer-v2", // O nome do modelo. Este parâmetro é obrigatório.
    "input":{
        "file_urls":[
            "https://dashscope.oss-cn-beijing.aliyuncs.com/samples/audio/paraformer/hello_world_female2.wav"
        ] // O arquivo a ser reconhecido. Este parâmetro é obrigatório.
    },
    "parameters":{
        "channel_id":[
            0
        ], // O índice da faixa de áudio. Este parâmetro é opcional.
        "disfluency_removal_enabled":false, // A opção para filtrar palavras de preenchimento. Este parâmetro é opcional.
        "timestamp_alignment_enabled": false, // Especifica se deve ativar o recurso de calibração de timestamp. Este parâmetro é opcional.
        "special_word_filter": "xxx", // As palavras sensíveis. Este parâmetro é opcional.
        "language_hints":[ // Este parâmetro aplica-se apenas ao modelo paraformer-v2. Não use este campo para outros modelos.
            "zh",
            "en"
        ],
        "diarization_enabled":false, // Especifica se deve ativar a diarização automática de falantes. Este parâmetro é opcional.
        "speaker_count": 2 // O número de referência de falantes. Este parâmetro é opcional.
    }
}

model

string

Sim

Nome do modelo Paraformer usado para transcrição de arquivos de áudio e vídeo. Para mais informações, consulte modelos.

file_urls

array[string]

Sim

Lista de URLs para transcrição de arquivos de áudio e vídeo (HTTP/HTTPS). Uma única solicitação suporta apenas 1 URL.

Se seus arquivos de áudio estiverem armazenados no OSS, a API RESTful suporta URLs temporárias que começam com o prefixo oss://.

vocabulary_id

string

Não

ID do vocabulário personalizado. Suportado por modelos v2+ com configurações de idioma. As palavras-chave deste ID aplicam-se ao reconhecimento de fala atual. Desativado por padrão. Para uso, consulte Palavras-chave personalizadas.

channel_id

array[integer]

[0]

Não

Especifica os índices das faixas de áudio a serem reconhecidas em um arquivo multifaixa. Os índices começam em 0. Por exemplo, [0] significa reconhecer a primeira faixa, e [0, 1] significa reconhecer simultaneamente a primeira e a segunda faixas. Se este parâmetro for omitido, apenas a primeira faixa será processada por padrão.

disfluency_removal_enabled

boolean

false

Não

Filtra palavras de preenchimento. Desativado por padrão.

timestamp_alignment_enabled

boolean

false

Não

Ativa o recurso de alinhamento de timestamp. Desativado por padrão.

special_word_filter

string

Não

Especifica palavras sensíveis a serem processadas durante o reconhecimento de fala e permite definir diferentes métodos de processamento para cada palavra.

Se este parâmetro não for fornecido, o sistema utiliza a lógica interna de filtragem de palavras sensíveis, e as palavras correspondentes à lista de palavras sensíveis do Alibaba Cloud Model Studio nos resultados de reconhecimento serão substituídas por * de igual comprimento.

Se este parâmetro for fornecido, as seguintes estratégias de processamento de palavras sensíveis podem ser implementadas:

• Substituir por : Substitui palavras sensíveis correspondentes por de igual comprimento.
• Filtrar diretamente: Remove completamente as palavras sensíveis correspondentes dos resultados de reconhecimento.

O valor deste parâmetro deve ser uma string JSON com a seguinte estrutura:

{
      "filter_with_signed": {
        "word_list": ["test"]
      },
      "filter_with_empty": {
        "word_list": ["start", "happen"]
      },
      "system_reserved_filter": true
    }

Descrições dos campos JSON:

• filter_with_signed

  • Tipo: Object.

  • Obrigatório: Não.

  • Descrição: Configura a lista de palavras sensíveis a serem substituídas por . Palavras correspondentes nos resultados de reconhecimento serão substituídas por de igual comprimento.

  • Exemplo: Usando o JSON acima, o resultado de reconhecimento de fala para "Help me test this code" seria "Help me **** this code".

  • Campos internos:

    • word_list: Um array de strings listando as palavras sensíveis a serem substituídas.

• filter_with_empty

  • Tipo: Object.

  • Obrigatório: Não.

  • Descrição: Configura a lista de palavras sensíveis a serem removidas (filtradas) dos resultados de reconhecimento. Palavras correspondentes serão completamente excluídas.

  • Exemplo: Usando o JSON acima, o resultado de reconhecimento de fala para "The game is about to start, right?" seria "The game is about to, right?".

  • Campos internos:

    • word_list: Um array de strings listando as palavras sensíveis a serem completamente removidas (filtradas).

• system_reserved_filter

  • Tipo: Boolean.
  • Obrigatório: Não.
  • Padrão: true.
  • Descrição: Se deve ativar as regras internas de palavras sensíveis do sistema. Quando definido como true, a lógica interna de filtragem de palavras sensíveis também é ativada, e palavras correspondentes à lista de palavras sensíveis do Alibaba Cloud Model Studio nos resultados de reconhecimento serão substituídas por * de igual comprimento.

language_hints

array[string]

["zh", "en"]

Não

Especifica os códigos de idioma da fala a ser reconhecida.

Este parâmetro aplica-se apenas ao modelo paraformer-v2.

Códigos de idioma suportados:

• zh: Chinês
• en: Inglês
• ja: Japonês
• yue: Cantonês
• ko: Coreano
• de: Alemão
• fr: Francês
• ru: Russo

diarization_enabled

boolean

false

Não

Diarização automática de falantes. Desativada por padrão.

Aplicável apenas a áudio mono. Áudio multicanal não suporta diarização de falantes.

Quando este recurso está ativado, os resultados de reconhecimento incluirão um campo speaker_id para distinguir diferentes falantes.

Para um exemplo de speaker_id, consulte Descrição do resultado de reconhecimento.

speaker_count

integer

Não

Valor de referência para contagem de falantes (inteiro de 2 a 100, inclusive).

Entra em vigor quando diarization_enabled é true.

A contagem de falantes é determinada automaticamente por padrão. Configurar este parâmetro auxilia o algoritmo a focar na contagem especificada, mas não garante uma saída exata.

task_status

string

O status da tarefa.

task_id

string

O ID da tarefa. Este ID é passado como um parâmetro de solicitação na interface de consulta de tarefas.

Consulta o status e o resultado de uma tarefa de reconhecimento de fala.

https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/tasks/{task_id}

GET

Authorization: Bearer {api-key} // Substitua {api-key} pela sua chave de API.

Nenhum.

task_id

string

-

Sim

ID da tarefa necessário para consulta. Retornado pela interface de envio de tarefas.

task_id

string

O ID da tarefa consultada.

task_status

string

O status da tarefa consultada.

subtask_status

string

O status da subtarefa.

file_url

string

A URL do arquivo processado na tarefa de transcrição de arquivos.

transcription_url

string

Link para obter o resultado de reconhecimento (válido por 24 horas). Após a expiração, consultas de tarefas e downloads de resultados falharão.

O resultado de reconhecimento é salvo como JSON. Baixe-o através deste link ou leia diretamente via solicitação HTTP.

Para detalhes sobre os campos JSON, consulte Descrição do resultado de reconhecimento.

audio_format

string

O formato de áudio do arquivo de source.

channels

array[integer]

As informações de índice de faixa de áudio do arquivo de source. Retorna [0] para áudio mono, [0, 1] para áudio de duas faixas, e assim por diante.

original_sampling_rate

integer

A taxa de amostragem (Hz) do áudio no arquivo de source.

original_duration

integer

A duração original do áudio (ms) do arquivo de source.

channel_id

integer

O índice da faixa de áudio do resultado de transcrição, começando em 0.

content_duration

integer

A duração (ms) do conteúdo identificado como fala na faixa de áudio.

transcript

string

O resultado de transcrição de fala no nível de parágrafo.

sentences

array

O resultado de transcrição de fala no nível de sentença.

words

array

O resultado de transcrição de fala no nível de palavra.

begin_time

integer

O timestamp inicial (ms).

end_time

integer

O timestamp final (ms).

text

string

O resultado da transcrição de fala.

speaker_id

integer

O índice do falante atual, começando em 0, usado para distinguir diferentes falantes.

Este campo só é exibido nos resultados de reconhecimento quando a diarização de falantes está ativada.

punctuation

string

A pontuação prevista após a palavra (se houver).