Skip to main content
Uso da API

DashScope SDK Expert

O assistente inteligente de SDK integrado ao DashScope Python SDK — descreva o que você precisa para receber código executável com a versão verificada, ou cole um erro ou caminho de arquivo para diagnosticar, corrigir e validar automaticamente.

O DashScope SDK Expert (a seguir, "SDK Expert") é uma CLI de assistente inteligente de SDK integrada ao dashscope Python SDK (>=1.27.3). Esta página é o guia de uso geral: como usar o SDK Expert para desenvolver e resolver problemas. Para os parâmetros completos de cada interface, consulte a página de referência correspondente na barra lateral; os domínios de recursos estão listados em "Visão geral da cobertura", abaixo.

Início rápido

  1. Prepare a API key e a base_url: crie uma key (com o prefixo sk-) no console do Model Studio, em "API Key Management"; as keys são específicas por região. Configure por variável de ambiente ou com /setup na sessão:
    export DASHSCOPE_API_KEY=sk-xxxxxxxx
    export DASHSCOPE_HTTP_BASE_URL=https://{workspace-id}.{region}.maas.aliyuncs.com/api/v1
    
    A base_url varia por região; para o mapeamento de domínios, consulte Base URL overview.
  2. Instale ou atualize o SDK: o SDK Expert foi introduzido no dashscope Python SDK 1.27.3.
    # se falhar, substitua pip por pip3
    pip install -U dashscope
    
  3. Inicie a CLI: execute dashscope (sem subcomando) para entrar na sessão interativa do SDK Expert; ou python -m dashscope.acli (acli é o módulo de entrada da CLI do SDK Expert). Na primeira execução, será solicitado o download do pacote de conhecimento do SDK Expert (que inclui as skills api-doc/diagnose, entre outras); também é possível instalá-lo manualmente:
    dashscope
    # ou instale manualmente o pacote de conhecimento do SDK Expert
    python -m dashscope.acli example download dashscope-sdk-expert
    
  4. Consulte a ajuda: digite /help para ver todos os commands e skills. Commands são operações da sessão (por exemplo, /clear /help /exit); skills são chaves de recursos por domínio (/skill <nome>). Em caso de dúvida, basta perguntar em linguagem natural e o SDK Expert seleciona a skill automaticamente.
  5. Pergunte conforme a necessidade: descreva o que você precisa em linguagem natural, por exemplo:
    • "Gere saída em streaming com qwen-plus e conte o consumo de tokens"
    • "O que significa o erro Throttling.RateQuota e como corrigi-lo?"
    • "Leia gen.py e diagnostique a causa raiz do erro InvalidParameter"
    Também é possível usar Ctrl+T para entrada por voz, @caminho-do-arquivo para anexar um arquivo que o SDK Expert vai ler e ↑ para o histórico de comandos.
O SDK Expert confere a versão local do dashscope e lembra você de executar pip install -U dashscope se ela estiver muito antiga.
Para modelos multimodais ou modelos além do Tongyi: pip install -U 'dashscope[acli-all]'.

Visão geral da cobertura

Depois de instalar o pacote de conhecimento do SDK Expert, as seguintes skills ficam disponíveis (use /skill para ver todas):
skillUsoExemplo
api-docConsultar a documentação da API do SDK/skill api-doc Generation
sdk-exampleGerar código de exemplo/skill sdk-example TextEmbedding
error-codeSignificado do código de erro + correções/skill error-code InvalidApiKey
diagnoseLer um arquivo de código e localizar a causa raiz/skill diagnose ./my_code.py
explain-codeExplicar a lógica do código/skill explain-code <código>
translateTradução multilíngue/skill translate en hello world
update-sdkAtualizar o índice de conhecimento/skill update-sdk <caminho-do-sdk>
O SDK Expert cobre todos os domínios de recursos do DashScope SDK — geração de texto, multimodal, voz, retrieval, fine-tuning e implantação, Agent etc. Para consultar a documentação ou exemplos de uma interface específica, use api-doc/sdk-example; para gerar código ou resolver problemas, basta perguntar em linguagem natural.
O SDK Expert é uma CLI agentic completa e também oferece suporte a colaboração multiagente, servidor MCP (Model Context Protocol, um padrão para integração de ferramentas externas), tarefas agendadas (/cron), auditoria (/audit), compactação e histórico de sessão (/compress, /history), entre outros. Os comandos / mais usados na sessão, por categoria:
  • Gerenciamento de sessão: /help /clear /info /stats /setup /exit /feedback
  • Recursos e ferramentas: /skill /mcp /voice /tts /copy
  • Histórico e auditoria: /history /compress /cron /audit /dev /example
A lista completa é a exibida pela saída de /help.

Prática recomendada 1: apenas informe o que precisa — sem ler documentação, receba código executável

Dor: as interfaces do SDK são numerosas e as versões evoluem rápido; com frequência os desenvolvedores precisam abrir a documentação para confirmar nomes de parâmetros, formatos de entrada e listas de modelos. Abordagem: descreva a necessidade ao SDK Expert; ele fará automaticamente:
  1. Comparar com a base de conhecimento interna do SDK (lista de modelos/parâmetros/estrutura de entrada e saída/códigos de erro)
  2. Verificar a versão local do SDK (avisando para atualizar em caso de divergência)
  3. Gerar código executável e realmente executá-lo, mostrando a saída
Exemplo de diálogo:
> Gere um parágrafo em streaming com qwen-plus e conte o consumo de tokens

SDK Expert:
1. Seleciona a skill api-doc/sdk-example e confere a versão local do dashscope
2. Gera um script e o executa, mostrando a saída em streaming e as estatísticas de tokens (veja abaixo)
import os, dashscope
dashscope.api_key = os.getenv("DASHSCOPE_API_KEY")
for chunk in dashscope.Generation.call(
    model="qwen-plus",
    messages=[{"role": "user", "content": "Escreva um poema sobre o outono"}],
    result_format="message", stream=True, incremental_output=True,
):
    if chunk.status_code == 200:
        print(chunk.output.choices[0].message.content, end="", flush=True)
# o último chunk contém usage (input/output tokens)
As folhas de outono caem... (streaming caractere por caractere)
usage: input=10 output=52
Dicas:
  • Especifique linguagem/framework: por exemplo, "Encapsule como um endpoint FastAPI", "Chame com async/await"
  • Especifique a versão: "Usamos o dashscope 1.20.x — esse parâmetro é suportado?" — o SDK Expert verifica a versão instalada antes de responder
  • Pergunte detalhes: "Qual é a faixa de valores do parâmetro?" "Quais outros modelos estão disponíveis?"

Prática recomendada 2: solução de problemas — deixe o SDK Expert localizar e corrigir bugs

Dor: quando uma chamada falha, o significado do código de erro não é claro e o stack trace aponta para o interior do SDK — fica difícil saber se o problema está no código ou nos parâmetros. Abordagem (três caminhos, escolha conforme o cenário):
  1. Cole o código/mensagem de erro/skill error-code <código> (por exemplo, /skill error-code Throttling.RateQuota) → o SDK Expert informa o significado do código de erro + sugestões de correção aplicáveis (ajustar a concorrência/alterar parâmetros/solicitar cota) + um trecho de código opcional.
  2. Informe o caminho do arquivo de código com problema/skill diagnose <caminho do arquivo> (por exemplo, /skill diagnose gen.py) → o SDK Expert lê o código-fonte, compara com causas raiz comuns (mistura do formato antigo de prompt, estrutura de messages incorreta, api_key/workspace não configurados, tarefa assíncrona sem polling correto) e apresenta a causa raiz suspeita + pontos de correção sugeridos.
  3. Ciclo de correção automática/skill diagnose localiza a causa raiz → gera uma prévia de diff para você confirmar → após a confirmação, o SDK Expert aplica a correção e reexecuta o script para validar → formando o fluxo "ler → diagnosticar → corrigir → validar". O SDK Expert pede confirmação antes de alterar arquivos e permite rollback.
Exemplo de diálogo:
> Ao executar gen.py aparece InvalidParameter: url error, me ajude a corrigir

SDK Expert:
1. /skill diagnose gen.py → identifica que um caminho local foi passado em image_url
2. Gera um diff para confirmação (veja abaixo)
3. Aplica após a confirmação, reexecuta o script e retorna 200
- image_url="/tmp/photo.jpg"
+ image_url="https://example.com/photo.jpg"
Dicas:
  • Inclua o request_id junto com o erro para correlacionar com os logs do servidor (o request_id está no campo response.request_id do corpo da resposta ou nos atributos do objeto de erro)
  • Em problemas complexos, primeiro peça ao SDK Expert para "explicar a lógica deste código" (/skill explain-code) e confirmar o entendimento antes de corrigir
  • Se o próprio SDK tiver defeitos ou não atender à sua necessidade, abra uma Issue no GitHub

Perguntas frequentes

O SDK Expert altera meu código-fonte sem avisar? Não. Antes de alterar arquivos, o SDK Expert gera uma prévia de diff para sua confirmação; as mudanças só são aplicadas depois que você confirma, e há suporte a rollback. Funciona offline? Não. O SDK Expert chama a inferência de modelos (consumindo tokens, cobrados pelo Model Studio); é necessário acesso à rede e uma API key válida. O código gerado pode ir direto para produção? O SDK Expert gera código executável com a versão verificada, mas antes de ir para produção revise por conta própria cota, concorrência, tratamento de erros e informações sensíveis. Ele pode gerar código que não seja em Python? Pode gerar texto de código em outras linguagens, mas não verifica versões de SDKs fora do Python (os esquemas de versão são diferentes — revise por conta própria). Meu código é enviado para algum lugar? Ao diagnosticar (/skill diagnose) ou anexar código, o conteúdo do código é enviado ao modelo para inferência; atenção a dados sensíveis.
Referência da API de Geração de Texto
Geração de Imagens
  • FAQ
Geração de Vídeo
Áudio
API em tempo real
Incorporação de Texto
Produção de Modelos