Skip to main content

Qwen-Audio-ASR-Streaming Python SDK

Este tópico descreve os parâmetros e as interfaces do Python SDK para o modelo de reconhecimento de fala em tempo real Qwen-Audio-ASR-Streaming.

Pré-requisitos

Ative o service e Obtain an API key. Para evitar riscos de segurança causados por vazamento de código, Configure API key as an environment variable em vez de codificá-la diretamente no código.

Início rápido

O recurso principal (client.audio.asr) fornece interfaces para chamadas sem streaming e com streaming bidirecional. Escolha o método de chamada adequado às suas necessidades:
  • Chamada sem streaming (recognize_file): reconhece um arquivo local; o SDK envia o áudio automaticamente em blocos e conduz a tarefa até o fim. Ideal para processar áudio pré-gravado.
  • Chamada com streaming bidirecional (sessão recognize): reconhece um fluxo de áudio diretamente e gera resultados em tempo real. O fluxo pode vir de um dispositivo externo, como microfone, ou ser lido de um arquivo local. Recomendado para cenários que exigem feedback imediato.
  • Chamada sem streaming
  • Chamada com streaming bidirecional
Envie uma única tarefa de reconhecimento de fala em tempo real e obtenha o resultado de forma síncrona e bloqueante ao passar um arquivo local.Chame o método recognize_file do recurso principal (client.audio.asr) para vincular os parâmetros da solicitação e passar o caminho do arquivo local, e itere os eventos do servidor para obter os resultados do reconhecimento.
import os
import dashscope

# A API Key da região Singapura é diferente da da região Pequim. Obtenha uma API Key: https://www.alibabacloud.com/help/zh/model-studio/get-api-key
# Se a variável de ambiente não estiver configurada, substitua a linha abaixo pela sua API Key do Model Studio: api_key="sk-xxx"
client = dashscope.Client(
    api_key=os.environ.get('DASHSCOPE_API_KEY'),
    # A configuração abaixo refere-se à região Singapura. Substitua {WorkspaceId} pelo ID real do seu workspace. O valor de region varia conforme a região.
    workspace="{WorkspaceId}",
    region="ap-southeast-1",
)

# Reconhece um arquivo de áudio local: recognize_file envia o áudio automaticamente em blocos e conduz a tarefa até o fim
for event in client.audio.asr.recognize_file(
        '{YOUR_AUDIO_FILE}',
        model='qwen-audio-3.0-asr-flash-streaming',
        format='wav',
        sample_rate=16000):
    payload = event.get('payload') or {}
    sentence = (payload.get('output') or {}).get('sentence') or {}
    if sentence.get('text') and not sentence.get('heartbeat'):
        print('Resultado do reconhecimento:', sentence['text'])

Parâmetros da solicitação

Defina os parâmetros da solicitação por meio dos métodos recognize/recognize_file do recurso principal (client.audio.asr): model, format, sample_rate e vocabulary_id são parâmetros nomeados, e os demais parâmetros (como language_hints) são passados por meio do dicionário parameters.
ParâmetroTipoObrigatórioDescrição
modelstrSimO nome do modelo.
sample_rateintSimA taxa de amostragem em Hz. Qualquer taxa é compatível.
formatstrSimFormato do áudio.Valores válidos:
  • pcm
  • wav
  • mp3
  • opus
  • speex
  • aac
  • amr
opus/speex: devem usar encapsulamento Ogg.wav: deve usar codificação PCM.amr: apenas o tipo AMR-NB é aceito.
keep_dialectboolNão
Aplica-se apenas a qwen-audio-3.1-asr-flash-streaming.
Padrão: false, que transcreve dialetos em chinês padrão. Defina como true para preservar expressões dialetais. Passe como argumento nomeado com o mesmo nome.
vad_modelstrNão
Aplica-se apenas a qwen-audio-3.1-asr-flash-streaming.
Modelo VAD: near_meeting_16k (campo próximo) ou far_field_meeting_16k (campo distante, padrão). Passe como argumento nomeado com o mesmo nome.
vocabulary_idstrNãoID de uma lista de palavras-chave pré-compilada.Gere esse ID antecipadamente chamando a API de criação de lista de palavras-chave. Passe o ID durante o reconhecimento para usar as palavras-chave da lista.Indicado para cenários em que o vocabulário é conhecido e relativamente estável e quando você precisa reutilizar a mesma lista de palavras entre solicitações.Para detalhes de uso, consulte Precompiled hotwords.
vocabularydictNãoPalavras-chave instantâneas.Passadas como pares chave-valor, em que a chave é o texto da palavra-chave (string) e o valor é o peso da palavra-chave (integer). Não é necessário criar uma lista de palavras-chave antecipadamente. O peso varia de [1, 5] ou é definido como 50: um valor em [1, 5] aumenta a probabilidade de o modelo gerar a palavra conforme o valor cresce; um valor de 50 designa uma super palavra-chave, que melhora significativamente o recall, mas o número de super palavras-chave não pode exceder 50.Adequado para otimização temporária de palavras-chave no nível da sessão.Quando configurado junto com palavras-chave pré-compiladas, apenas as palavras-chave instantâneas têm efeito. Para detalhes de uso, consulte Instant hotwords.Exemplo:
import os
import dashscope

client = dashscope.Client(api_key=os.getenv("DASHSCOPE_API_KEY"))

# As palavras-chave instantâneas são passadas por meio de parameters
vocab = {"John Smith": 5, "Jane Doe": 5}
recognition = client.audio.asr.recognize(
    model='qwen-audio-3.0-asr-flash-streaming',
    format='wav',
    sample_rate=16000,
    parameters={"vocabulary": vocab},
)
max_sentence_silenceintNãoLimiar de silêncio VAD para segmentação, em ms. Quando o silêncio após um segmento de fala excede esse limiar, o sistema determina que a frase terminou.Valor padrão: 800.Valores válidos: [200, 6000].
multi_threshold_mode_enabledboolNãoDefine se o modo de múltiplos limiares deve ser ativado. Quando ativado, impede que a segmentação VAD produza segmentos excessivamente longos.Padrão: False.
punctuation_prediction_enabledboolNãoDefine se a pontuação deve ser adicionada automaticamente aos resultados de reconhecimento:
  • True (padrão): sim. Este valor não pode ser alterado.
heartbeatboolNãoDefine se os pacotes de heartbeat devem ser ativados.Padrão: False.
  • True: mantém a conexão com o servidor ativa enquanto áudio silencioso é enviado continuamente.
  • False (padrão): mesmo quando áudio silencioso é enviado continuamente, a conexão expira e fecha após um período de tempo.
Áudio silencioso refere-se a conteúdo em um arquivo de áudio ou fluxo de dados que não contém sinal sonoro. Você pode gerar áudio silencioso de várias formas, como usando software de edição de áudio como Audacity ou Adobe Audition, ou ferramentas de linha de comando como FFmpeg.O uso deste campo requer o SDK 2.0.1 ou posterior.
language_hintslist[str]NãoIdioma do áudio a ser reconhecido. Não há valor padrão; se não definido, o modelo detecta o idioma automaticamente.Você pode definir até 4 valores. Se definir mais, somente os 4 primeiros terão efeito.
  • zh: Chinês
  • en: Inglês
  • ja: Japonês
  • ko: Coreano
  • vi: Vietnamita
  • th: Tailandês
  • id: Indonésio
  • ms: Malaio
  • tl: Filipino
  • hi: Hindi
  • ar: Árabe
  • fr: Francês
  • de: Alemão
  • es: Espanhol
  • pt: Português
  • ru: Russo
  • it: Italiano
  • nl: Holandês
  • sv: Sueco
  • da: Dinamarquês
  • fi: Finlandês
  • no: Norueguês
  • el: Grego
  • pl: Polonês
  • cs: Tcheco
  • hu: Húngaro
  • ro: Romeno
  • bg: Búlgaro
  • hr: Croata
  • sk: Eslovaco
speech_noise_thresholdfloatNãoLimiar para distinguir fala de ruído, usado para ajustar a sensibilidade da Detecção de Atividade de Voz (VAD).Valores válidos: [-1.0, 1.0].Descrições dos valores:
  • Quanto mais próximo de -1: o limiar de ruído diminui, tornando mais provável que ruído seja reconhecido como fala, o que pode causar a transcrição de mais ruído.
  • Quanto mais próximo de +1: o limiar de ruído aumenta, tornando mais provável que fala seja erroneamente julgada como ruído, o que pode filtrar parte da fala.
Este é um parâmetro de configuração avançada. Ajustá-lo pode afetar significativamente os resultados de reconhecimento. Recomendações:
  • Teste e verifique minuciosamente os resultados antes de ajustar.
  • Ajuste em pequenos incrementos com base no ambiente de áudio real (recomenda-se um passo de 0.1).
special_word_filterstrNãoEspecifica as palavras sensíveis a serem processadas durante o reconhecimento de fala e permite definir diferentes métodos de processamento para cada uma. Para detalhes, consulte Sensitive word filtering.
Os parâmetros a seguir são passados por meio do argumento nomeado input dos métodos recognize/recognize_file.
ParâmetroTipoObrigatórioDescrição
inputdictNãoObjeto de entrada usado para passar o contexto da conversa. O aprimoramento de contexto melhora a precisão do reconhecimento para termos específicos de domínio. Para uso, consulte Quick start.O dict deve incluir uma chave context cujo valor é uma lista de mensagens (list[dict]). Cada mensagem contém os seguintes campos:
  • role (str, obrigatório): a função da mensagem. user representa os resultados de reconhecimento de turnos anteriores do usuário ou uma lista de palavras específicas de domínio. assistant representa as respostas do modelo de linguagem grande de turnos anteriores.
  • content (list[dict], obrigatório): a lista de conteúdo da mensagem. Cada elemento contém type (str; definido como input_text quando role é user, e text quando role é assistant) e text (str, o conteúdo de texto).
Limites: mensagens de contexto dos tipos input_text e text são limitadas a 5 mensagens cada. Quando o limite é excedido, apenas as 5 mensagens mais recentes são retidas. O comprimento total do texto por turno de contexto não pode exceder 400 caracteres, e qualquer excesso é truncado a partir do final.
Ao passar o contexto, as mensagens em context devem seguir uma ordem específica: as mensagens de contexto devem ser organizadas por turno de conversa e, dentro de cada turno, a mensagem user (tipo input_text) deve preceder sua mensagem assistant correspondente (tipo text).
O uso deste campo requer o SDK 2.0.1 ou posterior.
Passe input para o método recognize/recognize_file do recurso principal (client.audio.asr):
# Constrói a entrada a ser passada
input_context = {
    "context": [
        {
            "role": "user",
            "content": [
                {
                    "type": "input_text",
                    "text": "Hello there"
                }
            ]
        },
        {
            "role": "assistant",
            "content": [
                {
                    "type": "text",
                    "text": "Hello, I am Qwen. How can I help you?"
                }
            ]
        }
    ]
}

# Passa por meio do argumento input ao criar a sessão de reconhecimento
recognition = client.audio.asr.recognize(
    model='qwen-audio-3.0-asr-flash-streaming',
    format='wav',
    sample_rate=16000,
    input=input_context,
)

Interfaces principais

Recurso principal (client.audio.asr)

A capacidade de reconhecimento de fala em tempo real está montada no recurso client.audio.asr: recognize cria a sessão de reconhecimento com streaming bidirecional (Recognition) e recognize_file realiza o reconhecimento único de um arquivo local.
Método membroAssinatura do métodoDescrição
recognize
def recognize(self,
              *,
              model: str,
              format: str = "pcm",
              sample_rate: int = 16000,
              vocabulary_id: str = None,
              disfluency_removal_enabled: bool = None,
              diarization_enabled: bool = None,
              parameters: Dict = None,
              input: Dict = None,
              phrase_id: str = None,
              ...) -> Recognition
Cria a sessão de reconhecimento com streaming bidirecional; ao entrar no contexto with, o método start é chamado automaticamente para estabelecer a conexão e enviar a tarefa.O envio de áudio e o consumo de eventos devem ocorrer de forma concorrente (use em conjunto com send_audio_frame, events()/results() e stop).
recognize_file
def recognize_file(self,
                   path: str,
                   *,
                   model: str,
                   format: str = "pcm",
                   sample_rate: int = 16000,
                   ...) -> Iterator[Dict]
Chamada sem streaming baseada em arquivo local: envia o áudio automaticamente em blocos, conduz a tarefa até o fim e produz os eventos do servidor um a um. Este método requer permissão de leitura no arquivo reconhecido.
start
def start(self)
Inicia o reconhecimento de fala: estabelece a conexão, envia a tarefa e aguarda task-started. É chamado automaticamente ao entrar no contexto with; o áudio só pode ser enviado após o sucesso da inicialização.
send_audio_frame
def send_audio_frame(self, buffer: bytes)
Envia áudio. Mantenha cada quadro de áudio enviado nem muito grande nem muito pequeno: cerca de 100 ms por quadro, entre 1 KB e 16 KB.Os resultados de reconhecimento são obtidos por meio da iteração de eventos (events()/results()).
stop
def stop(self)
Interrompe o reconhecimento de fala: apenas notifica o servidor de que a entrada terminou; a thread de recepção deve continuar consumindo events() até o evento task-finished.
events / results
def events(self) -> Iterator[Dict]
def results(self) -> Iterator[RecognitionResult]
Itera os eventos do servidor: events() produz eventos dict brutos (o texto reconhecido está em payload.output.sentence); results() produz apenas frames de resultado de reconhecimento, retornando objetos tipados Resultado de reconhecimento (RecognitionResult) (frames de heartbeat já filtrados).
close
def close(self)
Fecha a sessão de reconhecimento. Chamado automaticamente ao sair do contexto with.
request_id / first_package_delay / last_package_delay / last_response
rec.request_id
rec.first_package_delay
rec.last_package_delay
rec.last_response
Obtém o request_id, o atraso do primeiro pacote (latência desde o envio do primeiro pacote de áudio até o recebimento do primeiro resultado de reconhecimento) e o atraso do último pacote (tempo desde o envio do comando stop até o recebimento do último resultado de reconhecimento); use após a conclusão da tarefa. last_response é a última mensagem bruta lida com sucesso e pode ser usada para recuperar erros de task-failed. Ainda podem ser lidos após o fechamento da sessão.

Iteração de eventos (events()/results())

Durante uma chamada com streaming bidirecional, o servidor retorna informações-chave de processo e dados ao cliente por meio de eventos. Você precisa iterar, na thread de recepção, os events() da sessão (eventos dict brutos) ou os results() (frames tipados de resultado de reconhecimento) para processar as informações ou os dados retornados pelo servidor.
# Itera os eventos brutos: o texto reconhecido está em payload.output.sentence
def receive_events(rec):
    for event in rec.events():
        payload = event.get('payload') or {}
        sentence = (payload.get('output') or {}).get('sentence') or {}
        if sentence.get('text') and not sentence.get('heartbeat'):
            print('Texto reconhecido:', sentence['text'])


# Ou itera apenas os frames de resultado de reconhecimento (retorna RecognitionResult, frames de heartbeat já filtrados)
def receive_results(rec):
    for result in rec.results():
        sentence = result.get_sentence()
        if sentence and 'text' in sentence:
            print('Texto reconhecido:', sentence['text'])
Método/eventoConteúdo produzidoValor de retornoDescrição
event["header"]["event"] == "task-started"
Evento task-startedNenhumLido internamente por start(); a resposta de inicialização é salva em last_response e não é produzida novamente por events().
def events(self) -> Iterator[Dict]
event: evento dict do servidorIteradorProduz um evento quando o servidor responde. O resultado do reconhecimento está em payload.output.sentence; pode haver eventos de heartbeat ou de texto vazio, que podem ser ignorados conforme necessário. Deve ser consumido continuamente por uma única thread de recepção; não crie vários leitores em paralelo.
def results(self) -> Iterator[RecognitionResult]
result: Resultado de reconhecimento (RecognitionResult)IteradorProduz apenas frames de resultado de reconhecimento (frames de heartbeat já filtrados); a iteração termina após o retorno de todos os resultados.
try:
    ...
except DashScopeError as e:
    print(e.code, e.message, e.request_id)
Exceção DashScopeErrorNenhumLançada na thread de envio/recepção quando ocorre um erro; pode ser capturada com try/except.
event["header"]["event"] == "task-finished"
Evento task-finishedNenhumProduzido por events() quando o servidor conclui todo o reconhecimento; a iteração termina em seguida. Esse evento ainda deve ser lido após o envio de stop().

Resposta

Resultado de reconhecimento (RecognitionResult)

RecognitionResult representa um frame de resultado de reconhecimento produzido pela iteração results() da sessão (utilizável tanto na chamada com streaming bidirecional quanto na chamada sem streaming; events() produz eventos dict brutos — use results() caso precise dessa visualização tipada).
Método membroAssinatura do métodoDescrição
get_sentence
def get_sentence(self) -> Union[Dict[str, Any], List[Any]]
Obtém a frase reconhecida atual e suas informações de timestamp; retorna Dict[str, Any] (informação de uma única frase).Para detalhes, consulte Informações da frase (Sentence).
request_id
result.request_id
O request_id da solicitação correspondente ao evento atual.
is_sentence_end
def is_sentence_end(self) -> bool
Determina se a frase atual terminou. Este método verifica se o campo end_time na informação de frase única retornada por get_sentence() é None: um end_time diferente de None indica que a frase terminou.

Informações da frase (Sentence)

Os membros da classe Sentence são os seguintes:
ParâmetroTipoDescrição
begin_timeintTempo de início da frase, em ms.
end_timeintTempo de término da frase, em ms.
textstrTexto reconhecido.
wordsUma lista de Word-level timestamp information (Word)Informações de timestamp no nível da palavra.

Informações de timestamp no nível da palavra (Word)

Os membros da classe Word são os seguintes:
ParâmetroTipoDescrição
begin_timeintTempo de início da palavra, em ms.
end_timeintTempo de término da palavra, em ms.
textstrA palavra.
punctuationstrA pontuação.

Códigos de erro

Se encontrar erros, consulte Error codes para solução de problemas. Se o problema persistir, junte-se à comunidade de desenvolvedores para relatar seu problema e forneça o Request ID para investigação adicional.

FAQ

Recursos

P: Como mantenho a conexão ativa durante longos períodos de silêncio?

Defina o parâmetro de solicitação heartbeat como true e continue enviando áudio silencioso para o servidor. Áudio silencioso é o conteúdo em um arquivo de áudio ou fluxo que não contém sinal sonoro. Você pode gerar áudio silencioso de várias maneiras, como usando software de edição de áudio como Audacity ou Adobe Audition, ou ferramentas de linha de comando como FFmpeg.

P: Como converto áudio para um formato aceito?

Use o FFmpeg. Para mais usos, consulte o site oficial do FFmpeg.
# Basic conversion command (all-purpose template)
# -i, purpose: input file path, example value: audio.wav
# -c:a, purpose: audio codec, example values: aac, libmp3lame, pcm_s16le
# -b:a, purpose: bitrate (audio quality control), example values: 192k, 320k
# -ar, purpose: sample rate, example values: 44100 (CD), 48000, 16000
# -ac, purpose: number of channels, example values: 1 (mono), 2 (stereo)
# -y, purpose: overwrite an existing file (no value needed)
ffmpeg -i input_audio.ext -c:a codec_name -b:a bitrate -ar sample_rate -ac channels output.ext

# For example: WAV to MP3 (keep the original quality)
ffmpeg -i input.wav -c:a libmp3lame -q:a 0 output.mp3
# For example: MP3 to WAV (16-bit PCM standard format)
ffmpeg -i input.mp3 -c:a pcm_s16le -ar 44100 -ac 2 output.wav
# For example: M4A to AAC (extract or convert Apple audio)
ffmpeg -i input.m4a -c:a copy output.aac  # Extract directly without re-encoding
ffmpeg -i input.m4a -c:a aac -b:a 256k output.aac  # Re-encode to improve quality
# For example: FLAC lossless to Opus (high compression)
ffmpeg -i input.flac -c:a libopus -b:a 128k -vbr on output.opus

P: Como reconheço um arquivo local (gravação)?

Existem duas maneiras de reconhecer um arquivo local:
  • Passe o caminho do arquivo local diretamente: esta forma retorna o resultado completo somente após o término do reconhecimento, portanto não é adequada para cenários que precisam de feedback imediato. Consulte Chamada sem streaming e passe o caminho do arquivo para o método recognize_file do recurso principal (client.audio.asr) para reconhecer a gravação diretamente.
  • Converta o arquivo local em um fluxo binário para reconhecimento: esta forma reconhece o arquivo enquanto transmite os resultados em fluxo, sendo adequada para cenários que precisam de feedback imediato. Consulte Chamada com streaming bidirecional e envie o fluxo binário para o servidor para reconhecimento através do método send_audio_frame da sessão de reconhecimento.

Solução de problemas

P: Por que a fala não é reconhecida (nenhum resultado de reconhecimento)?

  1. Verifique se o formato de áudio (format) e a taxa de amostragem (sampleRate/sample_rate) nos parâmetros da solicitação estão corretos e atendem às restrições de parâmetros. Erros comuns incluem:
    • O arquivo de áudio tem extensão .wav, mas na verdade está no formato MP3, enquanto o parâmetro de solicitação format está definido como mp3 (configuração incorreta de parâmetro).
    • A taxa de amostragem do áudio é 3600 Hz, mas o parâmetro de solicitação sampleRate/sample_rate está definido como 48000 (configuração incorreta de parâmetro).
    Use a ferramenta ffprobe para obter o container, codec, taxa de amostragem, canais e outras informações do áudio:
ffprobe -v error -show_entries format=format_name -show_entries stream=codec_name,sample_rate,channels -of default=noprint_wrappers=1 input.xxx
  1. Se nenhuma das verificações acima revelar um problema, adicione palavras-chave personalizadas para melhorar o reconhecimento de termos específicos.