Skip to main content

Application DashScope API reference

Parâmetros de entrada e saída para chamar aplicações do Model Studio ( Agent , Workflow ) por meio da API DashScope, com exemplos para cenários típicos.

Este tópico se aplica apenas à região Singapore.
Guias relacionados Application invocation.

Pré-requisitos

Conclua as seguintes tarefas:
  1. Crie uma aplicação: Acesse o Application Management para criar uma Model Studio application e obter seu ID de aplicação.
  2. Obtenha uma chave de API: Obtenha sua chave de API no Key Management e configure the API key as an environment variable.
  3. Instale o SDK (opcional): Caso utilize um SDK para fazer chamadas, instale o DashScope SDK correspondente à sua linguagem de programação.

Métodos de invocação

  • Chamada de API HTTP URL da requisição: POST https://dashscope-intl.aliyuncs.com/api/v1/apps/APP_ID/completion
    Substitua APP_ID pelo ID real do seu aplicativo.
  • Chamada via SDK SDK Python/Java: O endpoint correto já vem configurado por padrão. Endpoint personalizado: Configure-o utilizando o parâmetro base_url.

Corpo da requisição

  • Conversa de turno único
  • Conversa de múltiplos turnos
  • Passar parâmetros
  • Saída em streaming
  • Recuperação de base de conhecimento
  • Python
  • Java
  • HTTP
Exemplo de requisição
import os
import dashscope
from dashscope.v2 import DashScopeError

# A configuração abaixo refere-se à região Singapura. Substitua {WorkspaceId} pelo ID do seu workspace. O valor de region varia conforme a região.
client = dashscope.Client(
    # Se não estiver usando uma variável de ambiente, defina sua API Key diretamente (por exemplo, api_key="sk-xxx"). Entretanto, não é recomendado codificar a API Key diretamente no código em ambientes de produção, para reduzir o risco de vazamento da API Key.
    api_key=os.getenv("DASHSCOPE_API_KEY"),
    workspace="{WorkspaceId}",
    region="ap-southeast-1",
)
try:
    response = client.apps.completions.create(
        app_id='APP_ID',  # Substitua pelo ID real do seu aplicativo
        prompt='Who are you?')
    print(response.text)
except DashScopeError as e:
    print(f'request_id={e.request_id}')
    print(f'code={e.code}')
    print(f'message={e.message}')
    print(f'Refer to the documentation: https://www.alibabacloud.com/help/model-studio/developer-reference/error-code')