Hotwords personalizadas Python SDK

Use o Python SDK para criar, listar, consultar, atualizar e excluir vocabulários personalizados para reconhecimento de fala.

Guia do usuário: Melhorar a precisão do reconhecimento.

Pré-requisitos

• Uma chave de API configurado como o DASHSCOPE_API_KEY variável de ambiente
• O SDK DashScope mais recente

URL do serviço

Defina o URL base antes de criar o serviço:

import dashscope

dashscope.base_http_api_url = 'https://maas.qwencloudapi.com/api/v1'

Classe VocabularyService

Pacote: dashscope.audio.asr.VocabularyService

Gerencia o ciclo de vida de vocabulários personalizados (criar, listar, consultar, atualizar, excluir).

Construtor

VocabularyService(api_key: str = None, workspace: str = None, model: str = None)

Se api_key não for aprovado, o SDK usará o global dashscope.api_key.

criar_vocabulário()

Crie um vocabulário personalizado.

def create_vocabulary(self, target_model: str, prefix: str,
                      vocabulary: List[dict]) -> str

Retornos: str — o ID do vocabulário criado.

import dashscope
from dashscope.audio.asr import VocabularyService
import os

dashscope.api_key = os.environ.get('DASHSCOPE_API_KEY')
dashscope.base_http_api_url = 'https://maas.qwencloudapi.com/api/v1'

prefix = 'testpfx'
target_model = "fun-asr"

my_vocabulary = [
  {"text": "Seediq Bale", "weight": 4}
]

service = VocabularyService()
vocabulary_id = service.create_vocabulary(
  prefix=prefix,
  target_model=target_model,
  vocabulary=my_vocabulary)

print(f"Vocabulary ID: {vocabulary_id}")

lista_vocabulários()

Liste vocabulários personalizados com filtragem e paginação opcionais.

A API HTTP usa o formato singular list_vocabulary, enquanto o nome do método Python usa o plural list_vocabularies.

def list_vocabularies(self, prefix: str = None,
                      page_index: int = 0,
                      page_size: int = 10) -> List[dict]

Retornos: List[dict] — uma lista de objetos de vocabulário, cada um contendo:

import dashscope
from dashscope.audio.asr import VocabularyService
import json
import os

dashscope.api_key = os.environ.get('DASHSCOPE_API_KEY')
dashscope.base_http_api_url = 'https://maas.qwencloudapi.com/api/v1'

service = VocabularyService()
vocabularies = service.list_vocabularies()
print(f"Vocabularies: {json.dumps(vocabularies)}")

consulta_vocabulário()

Consulte detalhes de um vocabulário personalizado específico.

def query_vocabulary(self, vocabulary_id: str) -> dict

Retornos: dict — um objeto de vocabulário contendo:

import dashscope
from dashscope.audio.asr import VocabularyService
import json
import os

dashscope.api_key = os.environ.get('DASHSCOPE_API_KEY')
dashscope.base_http_api_url = 'https://maas.qwencloudapi.com/api/v1'

service = VocabularyService()
vocabulary = service.query_vocabulary("vocab-testpfx-xxx")
print(f"Vocabulary: {json.dumps(vocabulary, ensure_ascii=False)}")

atualização_vocabulário()

Atualize um vocabulário personalizado. Isso substitui completamente as entradas existentes.

def update_vocabulary(self, vocabulary_id: str,
                      vocabulary: List[dict]) -> None

Retornos: None

import dashscope
from dashscope.audio.asr import VocabularyService
import os

dashscope.api_key = os.environ.get('DASHSCOPE_API_KEY')
dashscope.base_http_api_url = 'https://maas.qwencloudapi.com/api/v1'

service = VocabularyService()
my_vocabulary = [
  {"text": "Seediq Bale", "weight": 4, "lang": "en"}
]
service.update_vocabulary("vocab-testpfx-xxx", my_vocabulary)

deletar_vocabulário()

Exclua um vocabulário personalizado.

def delete_vocabulary(self, vocabulary_id: str) -> None

Retornos: None

import dashscope
from dashscope.audio.asr import VocabularyService
import os

dashscope.api_key = os.environ.get('DASHSCOPE_API_KEY')
dashscope.base_http_api_url = 'https://maas.qwencloudapi.com/api/v1'

service = VocabularyService()
service.delete_vocabulary("vocab-testpfx-xxxx")

Estrutura de entrada de hotword

Cada entrada no vocabulary lista possui os seguintes campos: