Skip to main content

Transmission de paramètres d'application personnalisés

Transmettez des paramètres personnalisés, principalement à des plugins et nœuds personnalisés, lors de l'appel des applications Agent Application et Workflow Application d'Alibaba Cloud Model Studio (qui remplacent les applications d'orchestration d'agent).

Obtenir une clé API et exporter la clé API en tant que variable d'environnement. Si vous utilisez un SDK pour effectuer des appels, installez le SDK DashScope.

Paramètres de plugin personnalisé

Cette rubrique utilise l'outil de requête de règlement intérieur de dortoir pour illustrer la transmission de paramètres à un plugin personnalisé via une API.
Les paramètres des plugins personnalisés sont transmis via une Agent Application associée ou via le nœud de plugin d'une Workflow Application.
L'exemple suivant montre comment transmettre des paramètres de plugin personnalisé pour une Agent Application.

Utilisation

Étape 1 : Créer un plugin personnalisé

Si vous avez déjà créé un outil de plugin ou importé un plugin, ignorez cette étape.
  1. Créez un plugin personnalisé : accédez à la page Plugins dans la console Model Studio et cliquez sur Add Custom Plug-in. Saisissez les informations du plugin. Si une authentification est requise, activez le commutateur Enable Authentication et configurez les paramètres.
    Exemple de description de plugin : Interroge le règlement intérieur du dortoir et recherche des entrées spécifiques par index numérique.
    Exemple d'URL de plugin : https://domitorgreement-plugin-example-icohrkdjxy.cn-beijing.fcapp.run
    image
    Remarque : Le champ Plug-in Description résume brièvement l'objectif du plugin. Cela aide le grand modèle à décider s'il doit appeler le plugin pour une tâche donnée. Décrivez-le en langage naturel.
  2. Créez un outil : renseignez les informations de l'outil et configurez les paramètres d'entrée et de sortie. Remarque :
    1. Le champ Tool Description aide le grand modèle à mieux comprendre les fonctions et les cas d'utilisation de l'outil. Utilisez un langage naturel et fournissez des exemples si possible.
    2. Un Parameter Name descriptif aide le grand modèle à comprendre l'information représentée.
    3. Le champ Parameter Description explique la fonction du paramètre d'entrée. Il doit être concis et précis pour aider le grand modèle à déterminer la valeur correcte à utiliser.
    4. Vous devez sélectionner Business Pass-through pour le Passing Method du paramètre d'entrée.
    Dans cet exemple, l'index de contenu du règlement intérieur du dortoir, article_index, est défini comme paramètre de transmission.
    image
  3. Cliquez sur Test Tool. Une fois le test réussi, Publish le plugin.

Étape 2 : Associer un plugin à un agent

Vous pouvez uniquement associer des plugins à une Agent Application située dans le même espace de travail.
  1. Sur la carte d'un plugin publié, cliquez sur Add to Agent et sélectionnez une application agent.
  2. Vous pouvez également cliquer sur + Plugin au sein d'une application pour associer un plugin personnalisé.
  3. Enfin, Publish l'application.

Étape 3 : Appel API

  • Sans authentification : Pour appeler un plugin personnalisé via une API, utilisez le paramètre user_defined_params de biz_params afin de transmettre les informations du plugin personnalisé. Remplacez your_plugin_code par l'ID réel du plugin et transmettez les paires clé-valeur des paramètres d'entrée configurés dans le plugin.
    Vous trouverez l'ID du plugin sur la carte du plugin.
    Dans cet exemple, le passage d'une valeur de 2 au paramètre article_index permet d'interroger le contenu du deuxième article du règlement intérieur du dortoir et retourne le résultat correct.
    • Python
    • Java
    • HTTP
    Exemple de requête
    import os
    import dashscope
    # La version du SDK Dashscope doit être 2.0.1 ou ultérieure.
    from dashscope.v2 import DashScopeError
    
    # Voici la configuration de la région de Singapour (ap-southeast-1). La valeur de region varie selon la région.
    client = dashscope.Client(
            # Si la variable d'environnement n'est pas définie, vous pouvez utiliser votre API Key de Model Studio en remplaçant la ligne suivante par : api_key="sk-xxx". L'utilisation d'une variable d'environnement est recommandée en production afin d'éviter toute fuite d'API Key.
            api_key=os.getenv("DASHSCOPE_API_KEY"),
            region="ap-southeast-1")
    biz_params = {
        # Transmet les paramètres d'entrée du plugin personnalisé de l'application d'agents. Remplacez `your_plugin_code` par l'ID de votre plugin.
        "user_defined_params": {
            "your_plugin_code": {
                "article_index": 2}}}
    try:
        response = client.apps.completions.create(
                app_id='YOUR_APP_ID',
                prompt='Dormitory convention content',
                biz_params=biz_params)
        print('%s\n' % (response.text))  # Process and output only the text.
        # print('%s\n' % (response.usage))
    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')
    
    Exemple de réponse
    The second article of the dormitory convention is as follows:
    
    "Roommates must help, care for, and learn from each other to achieve mutual improvement. They must be tolerant, forgiving, respectful, and sincere."
    
    This suggests that roommates should foster a positive living and learning environment by supporting and helping each other, while also learning to understand and respect others. If you want to learn about other articles of the convention, just ask!
    
    • Python
    • Java
    • HTTP
    Exemple de requête
    import os
    import dashscope
    # La version du SDK Dashscope doit être 2.0.1 ou ultérieure.
    from dashscope.v2 import DashScopeError
    
    # Voici la configuration de la région de Singapour (ap-southeast-1). La valeur de region varie selon la région.
    client = dashscope.Client(
            # Si la variable d'environnement n'est pas définie, vous pouvez utiliser votre API Key de Model Studio en remplaçant la ligne suivante par : api_key="sk-xxx". L'utilisation d'une variable d'environnement est recommandée en production afin d'éviter toute fuite d'API Key.
            api_key=os.getenv("DASHSCOPE_API_KEY"),
            region="ap-southeast-1")
    biz_params = {
        # Transmet les paramètres d'entrée du plugin personnalisé de l'application d'agents. Remplacez `your_plugin_code` par l'ID de votre plugin.
        "user_defined_params": {
            "your_plugin_code": {
                "article_index": 2}}}
    try:
        response = client.apps.completions.create(
                app_id='YOUR_APP_ID',
                prompt='Dormitory convention content',
                biz_params=biz_params)
        print('%s\n' % (response.text))  # Process and output only the text.
        # print('%s\n' % (response.usage))
    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')
    
    Exemple de réponse
    The second article of the dormitory convention is as follows:
    
    "Roommates must help, care for, and learn from each other to achieve mutual improvement. They must be tolerant, forgiving, respectful, and sincere."
    
    This suggests that roommates should foster a positive living and learning environment by supporting and helping each other, while also learning to understand and respect others. If you want to learn about other articles of the convention, just ask!
    
  • Avec authentification : Ce scénario décrit comment appeler un plugin personnalisé pour lequel l'Authentication est activée et qui est configuré avec une User-level Authentication.
    Vous trouverez l'ID du plugin sur la carte du plugin.
    • Utilisez user_defined_params dans le champ biz_params pour transmettre les informations du plugin personnalisé. Remplacez your_plugin_code par votre ID de plugin et fournissez les paramètres d'entrée sous forme de paires clé-valeur.
    • Utilisez user_defined_tokens dans le champ biz_params pour transmettre les identifiants d'authentification. Remplacez your_plugin_code par votre ID de plugin et définissez la valeur user_token sur votre jeton d'authentification, tel qu'une clé API DashScope.
    • Après une authentification réussie, le service interroge l'élément spécifié en fonction du paramètre d'index fourni et retourne le résultat correct.
    Dans cet exemple, le paramètre article_index est défini sur 2, et la valeur de user_token, YOUR_TOKEN, est remplacée par la véritable DASHSCOPE_API_KEY. Une fois l'authentification réussie, le contenu de la deuxième règle du dortoir est interrogé et le résultat correct est retourné.
    • Python
    • Java
    • HTTP
    Exemple de requête
    import os
    import dashscope
    # La version du SDK Dashscope doit être 2.0.1 ou ultérieure.
    from dashscope.v2 import DashScopeError
    
    # Voici la configuration de la région de Singapour (ap-southeast-1). La valeur de region varie selon la région.
    client = dashscope.Client(
                # Si la variable d'environnement n'est pas configurée, vous pouvez utiliser une API Key DashScope en remplaçant la ligne suivante par : api_key="sk-xxx".
                # Cependant, il n'est pas recommandé de coder l'API Key en dur dans un environnement de production, afin de réduire le risque de fuite.
                api_key=os.getenv("DASHSCOPE_API_KEY"),
                region="ap-southeast-1")
    biz_params = {
        # Transmet les identifiants d'authentification du plugin personnalisé de l'application d'agents.
        # Remplacez your_plugin_code par l'ID de votre plugin et YOUR_TOKEN par votre jeton d'authentification, tel qu'une API key.
        "user_defined_params": {
            "your_plugin_code": {
                "article_index": 2}},
        "user_defined_tokens": {
            "your_plugin_code": {
                "user_token": "YOUR_TOKEN"}}}
    try:
        response = client.apps.completions.create(
                app_id='YOUR_APP_ID',
                prompt='Dormitory convention content',
                biz_params=biz_params)
        print('%s\n' % (response.text))  # Process and output only the text.
        # print('%s\n' % (response.usage))
    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')
    
    Exemple de réponse
    The second article of the dormitory convention is as follows:
    
    Roommates must help, care for, and learn from each other to achieve mutual improvement. They must be tolerant, forgiving, respectful, and sincere.
    
    If you need to know about other articles of the convention, please let me know.
    
    • Python
    • Java
    • HTTP
    Exemple de requête
    import os
    import dashscope
    # La version du SDK Dashscope doit être 2.0.1 ou ultérieure.
    from dashscope.v2 import DashScopeError
    
    # Voici la configuration de la région de Singapour (ap-southeast-1). La valeur de region varie selon la région.
    client = dashscope.Client(
                # Si la variable d'environnement n'est pas configurée, vous pouvez utiliser une API Key DashScope en remplaçant la ligne suivante par : api_key="sk-xxx".
                # Cependant, il n'est pas recommandé de coder l'API Key en dur dans un environnement de production, afin de réduire le risque de fuite.
                api_key=os.getenv("DASHSCOPE_API_KEY"),
                region="ap-southeast-1")
    biz_params = {
        # Transmet les identifiants d'authentification du plugin personnalisé de l'application d'agents.
        # Remplacez your_plugin_code par l'ID de votre plugin et YOUR_TOKEN par votre jeton d'authentification, tel qu'une API key.
        "user_defined_params": {
            "your_plugin_code": {
                "article_index": 2}},
        "user_defined_tokens": {
            "your_plugin_code": {
                "user_token": "YOUR_TOKEN"}}}
    try:
        response = client.apps.completions.create(
                app_id='YOUR_APP_ID',
                prompt='Dormitory convention content',
                biz_params=biz_params)
        print('%s\n' % (response.text))  # Process and output only the text.
        # print('%s\n' % (response.usage))
    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')
    
    Exemple de réponse
    The second article of the dormitory convention is as follows:
    
    Roommates must help, care for, and learn from each other to achieve mutual improvement. They must be tolerant, forgiving, respectful, and sincere.
    
    If you need to know about other articles of the convention, please let me know.
    

Transmission de paramètres de nœud personnalisé

Cette rubrique utilise l'exemple Requête de divisions administratives par nom de ville pour illustrer la transmission de paramètres de nœud personnalisé à une application via un appel API.
Les paramètres de nœud personnalisé d'une application sont transmis via le nœud de départ d'une Workflow Application.
L'exemple suivant montre comment transmettre des paramètres personnalisés au nœud de départ d'une Workflow Application.

Utilisation

Étape 1 : Configurer les paramètres de nœud personnalisé

Accédez à la page My Applications dans la console Model Studio. Sélectionnez une Workflow Application et définissez des paramètres personnalisés pour son nœud de départ. Pour cet exemple, créez une variable String nommée city. Ensuite, insérez les variables city et query dans l'invite et Publish l'application.

Étape 2 : Effectuer un appel API

Lors de l'appel API, transmettez la valeur city dans le champ biz_params et la valeur query dans le champ prompt.
  • 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 (ap-southeast-1). La valeur de region varie selon la région.
client = dashscope.Client(
    # Si la variable d'environnement n'est pas configurée, vous pouvez utiliser votre API Key de Model Studio en remplaçant la ligne suivante par : 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.
    api_key=os.getenv("DASHSCOPE_API_KEY"),
    region="ap-southeast-1")
# Transmet des paramètres personnalisés pour une application de workflow.
biz_params = {"city": "Hangzhou"}
try:
    response = client.apps.completions.create(
        app_id='YOUR_APP_ID',  # Replace with your actual application ID.
        prompt='Query the administrative divisions of this city',
        biz_params=biz_params  # Pass business parameters.
    )
    print(f'{response.text}')  # Process and output only the 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')
Exemple de réponse
Hangzhou, the capital city of Zhejiang Province, is divided into 10 municipal districts: Shangcheng, Gongshu, Xihu, Binjiang, Xiaoshan, Yuhang, Linping, Qiantang, Fuyang, and Lin'an. Each district has its own unique features and development priorities.

- Shangcheng District: Located in the center of Hangzhou, it is one of the city's political, economic, and cultural hubs.
- Gongshu District: Known for its canal culture and numerous historical and cultural heritage sites.
- Xihu District: Home to the famous West Lake scenic area, a major tourist destination.
- Binjiang District: A hub for high-tech industries, where well-known companies such as Alibaba are located.
- Xiaoshan District: An administrative district in the southeast known for its rapid economic development, especially in manufacturing.
- Yuhang District: Has developed rapidly in recent years, especially in the internet economy. Alibaba's headquarters is also located here (Note: Alibaba's headquarters is actually in Binjiang District).
- Linping District: A newly established administrative district aimed at promoting comprehensive economic and social development in the area.
- Qiantang District: Also a result of recent administrative division adjustments, it emphasizes both innovative development and ecological protection.
- Fuyang District: Located to the southwest of Hangzhou, it is known for its rich natural landscapes and long history and culture.
- Lin'an District: Situated in the western part of Hangzhou, it is famous for its beautiful ecology and profound cultural heritage.

Note that specific urban planning may change over time. Refer to the latest official information.

Documentation connexe

Plugin personnalisé : Découvrez comment créer un plugin personnalisé. Appel d'application : Apprenez à appeler des applications et explorez d'autres cas d'utilisation. API d'appel d'application : Consultez la liste complète des paramètres et des exemples d'appel.