Skip to main content

Référence de l'API DashScope pour les applications

Paramètres d'entrée et de sortie pour l'appel d'applications Model Studio ( Agent , Workflow ) via l'API DashScope, avec des exemples pour les scénarios courants.

Cette rubrique s'applique uniquement à la région Singapour.
Guides associés Invocation d'application.

Prérequis

Effectuez les tâches suivantes :
  1. Créez une application : Accédez à Application Management pour créer une application Model Studio et obtenir son ID d'application.
  2. Obtenez une clé API : Récupérez votre clé API dans Key Management, puis configurez la clé API comme variable d'environnement.
  3. Installez le SDK (facultatif) : Si vous utilisez un SDK pour effectuer vos appels, installez le SDK DashScope correspondant à votre langage de programmation.

Méthodes d'appel

  • Appel via API HTTP URL de la requête : POST https://dashscope-intl.aliyuncs.com/api/v1/apps/APP_ID/completion
    Remplacez APP_ID par l'ID réel de votre application.
  • Appel via SDK SDK Python/Java : L'endpoint approprié est configuré par défaut. Endpoint personnalisé : Configurez-le à l'aide du paramètre base_url.

Corps de la requête

  • Conversation à tour unique
  • Conversation multi-tours
  • Transmission de paramètres
  • Sortie en streaming
  • Récupération de base de connaissances
  • Python
  • Java
  • HTTP
Exemple de requête
import os
import dashscope
from dashscope.v2 import DashScopeError

# Voici la configuration de la région de Singapour. Remplacez {WorkspaceId} par l'ID de votre workspace. La valeur de region varie selon la région.
client = dashscope.Client(
    # Si vous n'utilisez pas de variable d'environnement, configurez votre API key directement (par exemple, api_key="sk-xxx"). Il n'est pas recommandé de coder l'API key en dur dans le code en environnement de production, afin de réduire le risque de fuite de l'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',  # Remplacez par l'ID réel de votre application
        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'Consultez la documentation: https://www.alibabacloud.com/help/model-studio/developer-reference/error-code')