Skip to main content

Call applications

Vous pouvez intégrer des applications Model Studio (agents, workflows ou orchestrations d'agents) à vos systèmes métier via le SDK DashScope ou HTTP.

Prérequis

Le SDK DashScope ou une interface HTTP permettent d'appeler une application Model Studio.
Quelle que soit la méthode d'appel choisie, il est recommandé de configurer la clé API en tant que variable d'environnement . Si vous utilisez le SDK DashScope, vous devez également installer le SDK DashScope .

Utilisation

Conversation à tour unique

Voici des exemples de code utilisant le SDK DashScope ou la méthode HTTP pour mettre en œuvre une conversation à tour unique.
  • 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 les variables d'environnement ne sont pas configurées, vous pouvez remplacer la ligne suivante par api_key="sk-xxx". Cependant, 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='YOUR_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')
Exemple de réponse
I am a large language model developed by Alibaba Cloud, named Qwen. I am designed to help users generate various types of text, such as articles, stories, poems, stories, etc., and can be adjusted and optimized according to different scenarios and needs. In addition, I can also answer various questions, provide information and explanations, and assist in learning and research. If you have any needs, please feel free to ask me questions at any time!

Conversation multi-tours

Lors de conversations multi-tours, le LLM peut s'appuyer sur l'historique des échanges, ce qui rend l'interaction plus proche d'une communication naturelle.
Actuellement, seules les applications agent et les applications de workflow de dialogue prennent en charge les conversations multi-tours.
  • Si vous transmettez un session_id, la requête inclut automatiquement l'historique de conversation stocké dans le cloud.
    Lors de la transmission d'un session_id , le paramètre prompt est obligatoire.
  • Vous avez également la possibilité de gérer un tableau messages. Ajoutez chaque tour de conversation ainsi que les nouvelles instructions au tableau messages, puis transmettez l'historique via ce même tableau.
    Lors de la transmission du tableau messages , le paramètre prompt est facultatif. Si les deux sont fournis, le contenu de prompt sera ajouté à la fin du tableau messages à titre d'information complémentaire.
Si session_id et messages sont tous deux transmis, le tableau messages sera utilisé en priorité.
  • Cloud storage (session_id)
  • Self-management (messages)
  • 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 les variables d'environnement ne sont pas configurées, vous pouvez remplacer la ligne suivante par api_key="sk-xxx". Cependant, 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",
)

def call_with_session():
    try:
        response = client.apps.completions.create(
            app_id='YOUR_APP_ID',  # Remplacez par l'ID réel de votre application
            prompt='Who are you?')

        responseNext = client.apps.completions.create(
                    app_id='YOUR_APP_ID',  # Remplacez par l'ID réel de votre application
                    prompt='What skills do you have?',
                    session_id=response.session_id)  # session_id de la réponse précédente

        print('%s\n session_id=%s\n' % (responseNext.text, responseNext.session_id))
        # 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')

if __name__ == '__main__':
    call_with_session()
Exemple de réponse
I have multiple skills and can assist you with various tasks. Here are some of my main skills:

1. **Information retrieval**: Providing weather, news, historical facts, scientific knowledge, and various other information.
2. **Language processing**: Translating text, correcting grammar errors, generating articles and stories.
3. **Technical problem solving**: Answering programming questions, software usage, technical troubleshooting, etc.
4. **Educational assistance**: Helping with questions in subjects like mathematics, physics, chemistry, etc.
5. **Life advice**: Providing advice on health, diet, travel, shopping, etc.
6. **Entertainment interaction**: Telling jokes, playing word games, engaging in simple chat interactions.
7. **Schedule management**: Reminding important dates, arranging schedules, setting reminders.
8. **Data analysis**: Explaining data charts, providing data analysis suggestions.
9. **Emotional support**: Listening to your feelings, providing comfort and support.

If you have specific needs or questions, you can tell me directly, and I'll do my best to help you!
 session_id=98ceb3ca0c4e4b05a20a00f913050b42

Transmission de paramètres personnalisés

Pour adapter un même agent ou workflow à différents scénarios métier, vous pouvez configurer des paramètres personnalisés pour les plug-ins ou les nœuds, et transmettre ces paramètres via biz_params lors de l'appel de l'application. Pour savoir comment configurer ces paramètres, reportez-vous à Transmission des paramètres d'application. Exemple de code :
  1. Paramètres des plug-ins personnalisés : transmettez-les via l'Agent Application associée ou via le Plug-in Node de la Workflow Application associée. Vous pouvez transmettre des paramètres ainsi que des informations d'authentification au niveau utilisateur pour les plug-ins personnalisés :
    • Paramètres : user_defined_params.
    • Authentification au niveau utilisateur : user_defined_tokens. user_token correspond aux informations d'authentification requises par le plug-in, telles que la clé DASHSCOPE_API_KEY.
    L'exemple suivant présente une Agent Application qui nécessite le paramètre index ainsi que les informations d'authentification au niveau utilisateur du plug-in associé.
    Les outils de type plug-in ne peuvent être associés qu'à des Agent Applications appartenant au même espace de travail.
    Remplacez your_plugin_code par l'ID de l'outil plug-in associé affiché sur la carte du plug-in, puis transmettez les paires clé-valeur des paramètres d'entrée. Dans cet exemple, article_index prend la valeur 2.
    • Parameter passing
    • User-level authentication
    • Python
    • Java
    • HTTP
    Exemple de requête
    import os
    # La version du SDK Dashscope doit être 2.0.1 ou ultérieure.
    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 les variables d'environnement ne sont pas configurées, vous pouvez remplacer la ligne suivante par api_key="sk-xxx". Cependant, 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",
    )
    biz_params = {
        # Transmettez les paramètres d'entrée personnalisés du plug-in pour les applications agent. Remplacez your_plugin_code par l'ID de votre plug-in personnalisé
        "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))  # Traitement pour n'obtenir que la sortie texte
        # 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 rule of the Dormitory Convention states:
    
    "Dormitory members should help each other, care for each other, learn from each other, and improve together; be tolerant, humble, respect each other, and treat each other with sincerity."
    
    This indicates that within the dormitory, members should cultivate a positive atmosphere for living and studying, support and assist each other, and also learn to understand and respect one another. If you need to know about other clauses of the convention, please let me know!
    
  2. Paramètres de nœud personnalisés : transmettez-les via le Workflow Application (nœud Start Node) ou via l'Agent Orchestration Application (nœud Application Node). Dans l'exemple suivant, le Workflow Application définit un paramètre city dans le Start Node. Insérez les variables city et query dans le Prompt, puis cliquez sur Publish pour publier l'application.
    image
    Lors de l'appel, transmettez city via biz_params et query via 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. Remplacez {WorkspaceId} par l'ID de votre workspace. La valeur de region varie selon la région.
    client = dashscope.Client(
        # Si les variables d'environnement ne sont pas configurées, vous pouvez remplacer la ligne suivante par api_key="sk-xxx". Cependant, 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",
    )
    # Transmettez des paramètres personnalisés pour les applications de workflow et d'orchestration d'agents
    biz_params = {"city": "Hangzhou"}
    try:
        response = client.apps.completions.create(
            app_id='YOUR_APP_ID',  # Remplacez par l'ID réel de votre application
            prompt='Query the administrative divisions of this city',
            biz_params=biz_params  # Transmettez les paramètres métier
        )
        print(f'{response.text}')  # Traitement pour n'obtenir que la sortie texte
    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 city of Hangzhou, as the capital of Zhejiang Province, has an administrative division consisting of 10 districts: Shangcheng District, Gongshu District, Xihu District, Binjiang District, Xiaoshan District, Yuhang District, Linping District, Qiantang District, Fuyang District, and Lin'an District. Each district has its own unique characteristics and development focus.
    
    - Shangcheng District: Located in the central area of Hangzhou, it is one of the political, economic, and cultural centers of the city.
    - Gongshu District: Known for its canal culture, it features numerous historical and cultural heritage sites.
    - Xihu District: Famous for the West Lake scenic area, it is an important destination for tourism.
    - Binjiang District: A hub for high-tech industries, with renowned companies like Alibaba situated here.
    - Xiaoshan District: An administrative district in the southeast, experiencing rapid economic growth, particularly in the manufacturing sector.
    - Yuhang District: Has developed rapidly in recent years, especially in the field of internet economy; Alibaba's headquarters is also located here (Note: Alibaba headquarters is actually in Binjiang District).
    - Linping District: A newly established district aimed at promoting comprehensive economic and social development in the area.
    - Qiantang District: Also a result of recent administrative adjustments, focusing on the integration of innovation and ecological protection.
    - Fuyang District: Located southwest of Hangzhou, known for its rich natural landscapes and long history and culture.
    - Lin'an District: Situated west of Hangzhou, famous for its beautiful ecological environment and profound cultural heritage.
    
    Please note that city planning may change over time, and it is recommended to refer to the latest official information.
    

Sortie en streaming

En mode de sortie en streaming, le modèle génère des résultats intermédiaires qui sont concaténés pour former le résultat final. Ce mécanisme permet de lire les données au fur et à mesure de leur génération, réduisant ainsi le temps d'attente avant la réponse complète du modèle. Selon la méthode d'appel utilisée, configurez les paramètres suivants pour activer la sortie en streaming :
  • SDK Python : définissez stream sur True.
  • SDK Java : utilisez l'interface streamCall.
  • HTTP : spécifiez X-DashScope-SSE avec la valeur enable dans l'en-tête.
Par défaut, la sortie en streaming est non incrémentielle, ce qui signifie que chaque retour contient l'intégralité du contenu généré précédemment. Pour utiliser la sortie en streaming incrémentielle , définissez le paramètre incremental_output (ou incrementalOutput pour Java) sur true . Pour les appels HTTP, positionnez incremental_output à true dans l'objet parameters.
Exemples :
  • Pour une Agent Application :
    • 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 les variables d'environnement ne sont pas configurées, vous pouvez remplacer la ligne suivante par api_key="sk-xxx". Cependant, 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:
        stream = client.apps.completions.create(
            app_id='YOUR_APP_ID',
            prompt='Who are you?',
            stream=True,  # Activez la sortie en streaming
            incremental_output=True)  # Activez la sortie incrémentale
    
        for partial in stream:
            print(f'{partial.text}\n')  # Traitement pour n'obtenir que la sortie texte
    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
    I am
    
    Alibaba
    
    Cloud
    
    's large-scale language model
    
    , my name is
    
    Qwen.
    
  • L'application Workflow Application propose deux modes de sortie en streaming, déterminés par la valeur de flow_stream_mode. Valeurs des paramètres et méthodes d'utilisation :
    • full_thoughts (valeur par défaut) :
      • Description : les résultats en streaming de tous les nœuds sont renvoyés dans le champ thoughts.
      • Prérequis : vous devez également définir has_thoughts sur True.
    • agent_format :
      • Description : mode de sortie identique à celui des applications agent.
      • Effet : dans la console, activez le commutateur Response pour un nœud spécifique afin d'inclure les résultats en streaming de ce nœud dans le champ text de output.
      • Cas d'usage : idéal lorsque seule la sortie de certains nœuds intermédiaires vous intéresse.
      Le commutateur Response est disponible uniquement pour les nœuds Text Conversion, LLM et End (il est activé par défaut pour les nœuds End). Les nœuds ne prenant pas en charge la sortie en streaming renvoient leur contenu en une seule fois.
    Exemple :
    • full_thoughts
    • agent_format
    Il s'agit d'une Workflow Application publiée avec sortie en streaming.
    image
    • 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 les variables d'environnement ne sont pas configurées, vous pouvez remplacer la ligne suivante par api_key="sk-xxx". Cependant, 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",
    )
    biz_params = {
        "city": "Hangzhou"}
    try:
        stream = client.apps.completions.create(
            # Remplacez par l'ID réel de votre application
            app_id='YOUR_APP_ID',
            prompt='Hello',
            biz_params=biz_params,
            # Activez la sortie en streaming
            stream=True,
            # incremental_output à true active la sortie incrémentale, à false la désactive ; la valeur par défaut est false si non spécifié
            incremental_output=True,
            # has_thoughts doit être défini sur True
            has_thoughts=True)
    
        for response in stream:
            print(f'{response.thoughts}\n')  # La sortie ne renvoie que les thoughts ; les informations du processus sont renvoyées dans le champ thoughts
    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
    [ApplicationThought(thought=None, action_type=None, response='{"nodeName":"Start","nodeType":"Start","nodeStatus":"success","nodeId":"Start_bYxoRU","nodeExecTime":"0ms"}', action_name=None, action=None, action_input_stream=None, action_input=None, observation=None), ApplicationThought(thought=None, action_type=None, response='{"nodeName":"LLM_99FA","nodeResult":"{\\"result\\":\\"\\"}","nodeType":"LLM","nodeStatus":"executing","nodeId":"LLM_99FA"}', action_name=None, action=None, action_input_stream=None, action_input=None, observation=None)]
    
    [ApplicationThought(thought=None, action_type=None, response='{"nodeName":"Start","nodeType":"Start","nodeStatus":"success","nodeId":"Start_bYxoRU","nodeExecTime":"0ms"}', action_name=None, action=None, action_input_stream=None, action_input=None, observation=None), ApplicationThought(thought=None, action_type=None, response='{"nodeName":"LLM_1","nodeResult":"{\\"result\\":\\"Dongpo\\"}","nodeType":"LLM","nodeStatus":"executing","nodeId":"LLM_99FA"}', action_name=None, action=None, action_input_stream=None, action_input=None, observation=None)]
    
    [ApplicationThought(thought=None, action_type=None, response='{"nodeName":"Start","nodeType":"Start","nodeStatus":"success","nodeId":"Start_bYxoRU","nodeExecTime":"0ms"}', action_name=None, action=None, action_input_stream=None, action_input=None, observation=None), ApplicationThought(thought=None, action_type=None, response='{"nodeName":"LLM_1","nodeResult":"{\\"result\\":\\" Pork, West Lake Vinegar Fish,\\"}","nodeType":"LLM","nodeStatus":"executing","nodeId":"LLM_99FA"}', action_name=None, action=None, action_input_stream=None, action_input=None, observation=None)]
    
    [ApplicationThought(thought=None, action_type=None, response='{"nodeName":"Start","nodeType":"Start","nodeStatus":"success","nodeId":"Start_bYxoRU","nodeExecTime":"0ms"}', action_name=None, action=None, action_input_stream=None, action_input=None, observation=None), ApplicationThought(thought=None, action_type=None, response='{"nodeName":"LLM_1","nodeResult":"{\\"result\\":\\" Longjing Shrimp, Hangzhou Pa\\"}","nodeType":"LLM","nodeStatus":"executing","nodeId":"LLM_99FA"}', action_name=None, action=None, action_input_stream=None, action_input=None, observation=None)]
    
    [ApplicationThought(thought=None, action_type=None, response='{"nodeName":"Start","nodeType":"Start","nodeStatus":"success","nodeId":"Start_bYxoRU","nodeExecTime":"0ms"}', action_name=None, action=None, action_input_stream=None, action_input=None, observation=None), ApplicationThought(thought=None, action_type=None, response='{"nodeName":"LLM_1","nodeResult":"{\\"result\\":\\"stry, Beggar\'s Chicken\\"}","nodeType":"LLM","nodeStatus":"success","nodeId":"LLM_99FA","nodeExecTime":"1027ms"}', action_name=None, action=None, action_input_stream=None, action_input=None, observation=None), ApplicationThought(thought=None, action_type=None, response='{"nodeName":"LLM_qkYJ","nodeResult":"{\\"result\\":\\"\\"}","nodeType":"LLM","nodeStatus":"executing","nodeId":"LLM_qkYJ"}', action_name=None, action=None, action_input_stream=None, action_input=None, observation=None)]
    
    [ApplicationThought(thought=None, action_type=None, response='{"nodeName":"Start","nodeType":"Start","nodeStatus":"success","nodeId":"Start_bYxoRU","nodeExecTime":"0ms"}', action_name=None, action=None, action_input_stream=None, action_input=None, observation=None), ApplicationThought(thought=None, action_type=None, response='{"nodeName":"LLM_1","nodeResult":"{\\"result\\":\\"\\"}","nodeType":"LLM","nodeStatus":"success","nodeId":"LLM_99FA","nodeExecTime":"1027ms"}', action_name=None, action=None, action_input_stream=None, action_input=None, observation=None), ApplicationThought(thought=None, action_type=None, response='{"nodeName":"LLM_2","nodeResult":"{\\"result\\":\\"West Lake,\\"}","nodeType":"LLM","nodeStatus":"executing","nodeId":"LLM_qkYJ"}', action_name=None, action=None, action_input_stream=None, action_input=None, observation=None)]
    
    [ApplicationThought(thought=None, action_type=None, response='{"nodeName":"Start","nodeType":"Start","nodeStatus":"success","nodeId":"Start_bYxoRU","nodeExecTime":"0ms"}', action_name=None, action=None, action_input_stream=None, action_input=None, observation=None), ApplicationThought(thought=None, action_type=None, response='{"nodeName":"LLM_1","nodeResult":"{\\"result\\":\\"\\"}","nodeType":"LLM","nodeStatus":"success","nodeId":"LLM_99FA","nodeExecTime":"1027ms"}', action_name=None, action=None, action_input_stream=None, action_input=None, observation=None), ApplicationThought(thought=None, action_type=None, response='{"nodeName":"LLM_2","nodeResult":"{\\"result\\":\\" Lingyin Temple, Xixi\\"}","nodeType":"LLM","nodeStatus":"executing","nodeId":"LLM_qkYJ"}', action_name=None, action=None, action_input_stream=None, action_input=None, observation=None)]
    
    [ApplicationThought(thought=None, action_type=None, response='{"nodeName":"Start","nodeType":"Start","nodeStatus":"success","nodeId":"Start_bYxoRU","nodeExecTime":"0ms"}', action_name=None, action=None, action_input_stream=None, action_input=None, observation=None), ApplicationThought(thought=None, action_type=None, response='{"nodeName":"LLM_1","nodeResult":"{\\"result\\":\\"\\"}","nodeType":"LLM","nodeStatus":"success","nodeId":"LLM_99FA","nodeExecTime":"1027ms"}', action_name=None, action=None, action_input_stream=None, action_input=None, observation=None), ApplicationThought(thought=None, action_type=None, response='{"nodeName":"LLM_2","nodeResult":"{\\"result\\":\\" National Wetland Park, Hefang\\"}","nodeType":"LLM","nodeStatus":"executing","nodeId":"LLM_qkYJ"}', action_name=None, action=None, action_input_stream=None, action_input=None, observation=None)]
    
    [ApplicationThought(thought=None, action_type=None, response='{"nodeName":"Start","nodeType":"Start","nodeStatus":"success","nodeId":"Start_bYxoRU","nodeExecTime":"0ms"}', action_name=None, action=None, action_input_stream=None, action_input=None, observation=None), ApplicationThought(thought=None, action_type=None, response='{"nodeName":"LLM_1","nodeResult":"{\\"result\\":\\"\\"}","nodeType":"LLM","nodeStatus":"success","nodeId":"LLM_99FA","nodeExecTime":"1027ms"}', action_name=None, action=None, action_input_stream=None, action_input=None, observation=None), ApplicationThought(thought=None, action_type=None, response='{"nodeName":"LLM_2","nodeResult":"{\\"result\\":\\" Street, Hangzhou Botanical Garden\\"}","nodeType":"LLM","nodeStatus":"executing","nodeId":"LLM_qkYJ"}', action_name=None, action=None, action_input_stream=None, action_input=None, observation=None)]
    
    [ApplicationThought(thought=None, action_type=None, response='{"nodeName":"Start","nodeType":"Start","nodeStatus":"success","nodeId":"Start_bYxoRU","nodeExecTime":"0ms"}', action_name=None, action=None, action_input_stream=None, action_input=None, observation=None), ApplicationThought(thought=None, action_type=None, response='{"nodeName":"LLM_1","nodeResult":"{\\"result\\":\\"\\"}","nodeType":"LLM","nodeStatus":"success","nodeId":"LLM_99FA","nodeExecTime":"1027ms"}', action_name=None, action=None, action_input_stream=None, action_input=None, observation=None), ApplicationThought(thought=None, action_type=None, response='{"nodeName":"LLM_2","nodeResult":"{\\"result\\":\\"\\"}","nodeType":"LLM","nodeStatus":"success","nodeId":"LLM_qkYJ","nodeExecTime":"1048ms"}', action_name=None, action=None, action_input_stream=None, action_input=None, observation=None), ApplicationThought(thought=None, action_type=None, response='{"nodeName":"End","nodeResult":"{\\"result\\":\\"What do you think about our recommendation?\\"}","nodeType":"End","nodeStatus":"success","nodeId":"End_DrQn7F","nodeExecTime":"0ms"}', action_name=None, action=None, action_input_stream=None, action_input=None, observation=None)]
    
    • Chaque élément de thoughts correspond aux détails d'exécution d'un nœud. Voici un exemple de résultat pour un nœud LLM.
      id:7
      event:result
      :HTTP_STATUS/200
      data:
      {
          "output": {
              "thoughts": [
                  {
                      "response": "{\"nodeName\":\"Start\",\"nodeType\":\"Start\",\"nodeStatus\":\"success\",\"nodeId\":\"Start_bYxoRU\",\"nodeExecTime\":\"0ms\"}"
                  },
                  {
                      "response": "{\"nodeName\":\"LLM_1\",\"nodeResult\":\"{\\\"result\\\":\\\"Songcheng Fish Soup\\\"}\",\"nodeType\":\"LLM\",\"nodeStatus\":\"success\",\"nodeId\":\"LLM_j45e\",\"nodeExecTime\":\"1167ms\"}"
                  },
                  {
                      "response": "{\"nodeName\":\"LLM_2Km9\",\"nodeResult\":\"{\\\"result\\\":\\\"\\\"}\",\"nodeType\":\"LLM\",\"nodeStatus\":\"executing\",\"nodeId\":\"LLM_2Km9\"}"
                  }
              ],
              "session_id": "6035ee0814b64a9fb88346ecaf8b44bf",
              "finish_reason": "null"
          },
          "usage": {
              "models": [
                  {
                      "input_tokens": 25,
                      "output_tokens": 21,
                      "model_id": "qwen-max"
                  }
              ]
          },
          "request_id": "64825069-b3aa-93a7-bcf1-c66fe57111fd"
      }
      
      Pour suivre les résultats en streaming d'un nœud LLM (LLM_j45e dans l'exemple ci-dessus), surveillez la sortie du nœud portant le nodeId LLM_j45e lors de chaque push de thoughts .
    • L'échec d'un nœud entraîne l'échec de l'ensemble de la tâche.

Récupération de base de connaissances

La base de connaissances constitue la fonctionnalité RAG de Model Studio. Elle permet d'enrichir efficacement les modèles avec des connaissances privées et actualisées. Lors de l'appel aux Agent Applications, vous pouvez définir le périmètre de récupération afin d'améliorer la précision des réponses.

Prérequis

Dans la console Model Studio, activez l'option Knowledge Base Retrieval Augmentation pour votre Agent Application. Ensuite, cliquez sur Publish pour publier l'application.
Ignorez cette condition préalable pour les RAG Applications .

Définir le périmètre de récupération

  1. Pour récupérer une base de connaissances spécifique, adoptez l'une des méthodes suivantes :
    • Dans la console, cliquez sur Configure Knowledge Base dans l'application et sélectionnez la base de connaissances souhaitée. Cliquez ensuite sur Publish pour publier l'application.
    • Ne configurez aucune association de base de connaissances dans la console. Transmettez plutôt l'ID de la base de connaissances via rag_options lors de l'appel API ;
    • Associez la base de connaissances dans la console, puis transmettez son ID via rag_options lors de l'appel API.
      Dans ce cas, seule la base de connaissances transmise lors de l'appel sera interrogée. Par exemple, si une Agent Application est associée à la base de connaissances A, mais que vous spécifiez la base de connaissances B dans l'appel API, alors la base A sera ignorée et seule la base B sera récupérée.
    Pour obtenir l'ID de la base de connaissances (pipeline_ids) : consultez la page Knowledge Base, ou utilisez la valeur Data.Id retournée par l'API CreateIndex. Notez que CreateIndex prend uniquement en charge les bases de connaissances non structurées. Le fichier Bailian Phones Specifications.docx sert de base de connaissances non structurée dans les exemples suivants.
    • Python
    • Java
    • HTTP
    Exemple de requête
    import os
    # La version du SDK Dashscope doit être 2.0.1 ou ultérieure.
    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 les variables d'environnement ne sont pas configurées, vous pouvez remplacer la ligne suivante par api_key="sk-xxx". Cependant, 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='YOUR_APP_ID',  # Remplacez YOUR_APP_ID par l'ID réel de votre application
            prompt='Please recommend a mobile phone under 3000 yuan',
            rag_options={
                "pipeline_ids": ["YOUR_PIPELINE_ID1,YOUR_PIPELINE_ID2"],  # Remplacez par les ID réels de vos knowledge bases ; séparez-en plusieurs par des virgules
            }
        )
        print('%s\n' % (response.text))  # Traitement pour n'obtenir que la sortie texte
        # 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
    Based on your budget, I recommend the **Bailian Zephyr Z9**. This phone is priced between 2499-2799 yuan, which fits your budget. It features a lightweight 6.4-inch 1080 x 2340 pixel screen design, paired with 128GB storage and 6GB RAM, suitable for daily use. Additionally, it has a 4000mAh battery and a lens that supports 30× digital zoom, which can meet your photography and battery life needs. If you're looking for a slim, portable phone with comprehensive features, the Bailian Zephyr Z9 would be a good choice.
    
  2. Récupération de documents non structurés spécifiques : transmettez l'ID de la base de connaissances, l'ID du document, les tags ou les métadonnées (paires clé-valeur) dans rag_options.
    L'ID du document, les tags et les métadonnées ne s'appliquent qu'aux documents non structurés.
    • Méthodes d'obtention :
      • ID du document (file_ids) : consultez la page Application Data, ou utilisez l'ID renvoyé par l'API AddFile lors de l'importation des documents.
      • Tags du document : ces informations sont disponibles sur la page Application Data, ou via l'API DescribeFile.
      • Métadonnées du document : sur la page Knowledge Base, cliquez sur View pour accéder à une base de connaissances, puis cliquez sur Metadata Information.
    • Il est possible de spécifier plusieurs ID de documents, à condition que ces documents soient déjà inclus dans des index de connaissances.
    • Lorsque vous indiquez des ID de documents, vous devez également préciser l'ID de la base de connaissances à laquelle ils appartiennent.
    • Seuls les documents spécifiés seront récupérés. Par exemple, si une Agent Application est associée à la base de connaissances A, mais que l'appel API cible des documents de la base B, alors seuls les documents de B seront récupérés, et non ceux de A. Le fichier Bailian Phones Specifications.docx sert de base de connaissances non structurées dans les exemples suivants.
      • Python
      • Java
      • HTTP
      Exemple de requête
      import os
      # La version du SDK Dashscope doit être 2.0.1 ou ultérieure.
      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 les variables d'environnement ne sont pas configurées, vous pouvez remplacer la ligne suivante par api_key="sk-xxx". Cependant, 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='YOUR_APP_ID',  # Remplacez YOUR_APP_ID par l'ID réel de votre application
              prompt='Please recommend a mobile phone under 3000 yuan',
              rag_options={
                  "pipeline_ids": ["YOUR_PIPELINE_ID1", "YOUR_PIPELINE_ID2"],  # Remplacez par les ID réels de vos knowledge bases ; séparez-en plusieurs par des virgules
                  "file_ids": ["YOUR_FILE_ID1", "YOUR_FILE_ID2"],  # Remplacez par les ID réels de vos documents non structurés ; séparez-en plusieurs par des virgules
                  "metadata_filter": {  # Paires clé-valeur des métadonnées des documents ; séparez-en plusieurs par des virgules
                      "key1": "value1",
                      "key2": "value2"
                  },
                  "tags": ["tag1", "tag2"]  # Étiquettes des documents ; séparez-en plusieurs par des virgules
              }
          )
          print('%s\n' % (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')
      
      Exemple de réponse
      {
          "text": "Within a budget of under 3000 yuan, I recommend you consider the **Bailian Zephyr Z9**. This phone has the following features:
      
      - **Screen**: 6.4-inch 1080 x 2340 pixels, suitable for daily use and entertainment.
      - **Memory and storage**: 6GB RAM + 128GB storage space, which can meet most users' needs for smoothness and storage.
      - **Battery capacity**: 4000mAh, providing all-day usage guarantee.
      - **Camera function**: Equipped with a lens supporting 30× digital zoom, capable of capturing details from greater distances.
      - **Other features**: Lightweight and portable design, easy to carry.
      
      The reference price is between 2499 and 2799 yuan, which perfectly fits your budget requirements and offers good value for money. Hope these suggestions are helpful!",
          "finish_reason": "stop",
          "session_id": "10bdea3d1435406aad8750538b701bee",
          "thoughts": null,
          "doc_references": null
      }
      
  3. Récupération de données spécifiques issues de documents structurés : transmettez l'ID de la base de connaissances ainsi que des paires clé-valeur au format « en-tête de données structurées + valeur » dans rag_options. Pour obtenir les paires clé-valeur des données structurées (structured_filter), rendez-vous sur la page Knowledge Base, cliquez sur View pour ouvrir une base de connaissances, puis sélectionnez View Index.
    • Python
    • Java
    • HTTP
    Exemple de requête
    import os
    # La version du SDK Dashscope doit être 2.0.1 ou ultérieure.
    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 les variables d'environnement ne sont pas configurées, vous pouvez remplacer la ligne suivante par api_key="sk-xxx". Cependant, 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='YOUR_APP_ID',  # Remplacez YOUR_APP_ID par l'ID réel de votre application
            prompt='Please recommend a mobile phone under 3000 yuan',
            rag_options={
                "pipeline_ids": ["YOUR_PIPELINE_ID1", "YOUR_PIPELINE_ID2"],  # Remplacez par les ID réels de vos knowledge bases ; séparez-en plusieurs par des virgules
                 "structured_filter": {  # Paires clé-valeur de données structurées, correspondant aux données structurées ; séparez-en plusieurs par des virgules
                    "key1": "value1",
                    "key2": "value2"
                 }
            }
        )
        print('%s\n' % (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')
    
    Exemple de réponse
    {
        "text": "I recommend the \"Bailian\" phone, which is priced at 2999 yuan, fitting your budget requirement. If you need to know more information, such as performance, appearance, etc., please let me know.",
        "finish_reason": "stop",
        "session_id": "80a3b868b5ce42c8a12f01dccf8651e2",
        "thoughts": null,
        "doc_references": null
    }
    

Consulter les informations

Visualiser le processus de récupération : Lors de l'appel, ajoutez has_thoughts au code et définissez sa valeur sur True. Le processus de récupération est alors retourné dans le champ thoughts de output.

Afficher la source de la réponse : Activez l'option Show Source dans la section Retrieval Configuration de votre Agent Application, puis publiez l'application.
image

Référence d'API

Pour consulter la liste complète des paramètres, reportez-vous à la Référence d'API pour les applications d'agent workflow et héritées de DashScope.

Codes d'erreur

En cas d'échec d'un appel, consultez les Codes d'erreur pour résoudre le problème.

Références

  • Pour appeler une application RAG à l'aide d'une API ou d'un SDK avec peu de code, consultez Créer rapidement une application RAG avec peu de code.
  • Pour savoir comment sélectionner des modèles dans une application, consultez la Liste des modèles.
  • Pour obtenir des informations sur la création et l'utilisation des applications, consultez la rubrique Types d'applications.
  • Pour savoir comment utiliser l'outil d'ingénierie de prompt dans une application, consultez la rubrique Ingénierie de prompt.

FAQ

  1. Assurez-vous que les noms de classe et de package dans vos instructions d'importation sont corrects.
  2. Ajoutez la dépendance : si vous utilisez Maven ou Gradle, vérifiez que la dépendance du SDK Java DashScope figure bien dans votre fichier pom.xml ou build.gradle et qu'elle correspond à la dernière version. Vous trouverez le numéro de la dernière version du SDK Java DashScope sur Maven.
    xml
    <!-- https://mvnrepository.com/artifact/com.alibaba/dashscope-sdk-java -->
    <dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>dashscope-sdk-java</artifactId>
        <version>Enter the latest version, e.g., 2.16.4</version>
    </dependency>
    
  3. Mettez à niveau le SDK : une ancienne version du SDK Java DashScope peut ne pas inclure les fonctionnalités ou classes dont vous avez besoin. Si votre version est obsolète, mettez-la à niveau en modifiant le numéro de version dans votre fichier pom.xml ou build.gradle.
    xml
    <!-- https://mvnrepository.com/artifact/com.alibaba/dashscope-sdk-java -->
    <dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>dashscope-sdk-java</artifactId>
        <version>Replace this with the latest version number</version>
    </dependency>
    
  4. Rechargez le projet pour appliquer les modifications.
  5. Exécutez à nouveau l'exemple de code. Si le problème persiste, recherchez des problèmes similaires et leurs solutions sur le forum des développeurs, ou soumettez un ticket.