Skip to main content

Chamar aplicativos

Você pode integrar aplicativos do Model Studio, como agentes, fluxos de trabalho ou orquestrações de agentes, aos seus sistemas de negócios usando o DashScope SDK ou HTTP.

Pré-requisitos

Use o DashScope SDK ou uma interface HTTP para chamar um aplicativo do Model Studio.
Independentemente do método de chamada, configure a chave de API como variável de ambiente. Para usar o DashScope SDK, também é necessário instalá-lo.

Uso

Conversa de uma rodada

Exemplos de código para implementar uma conversa de uma rodada usando o DashScope SDK ou HTTP.
  • Python
  • Java
  • HTTP
Exemplo de solicitaçã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='YOUR_APP_ID',  # Substitua pelo ID real do 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')
Exemplo de resposta
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!

Conversa de várias rodadas

Em conversas de várias rodadas, o LLM pode consultar o histórico da conversa, aproximando a interação da comunicação cotidiana.
Atualmente, apenas aplicativos de agente e aplicativos de fluxo de trabalho de diálogo oferecem suporte a conversas de várias rodadas.
  • Ao passar session_id, a solicitação inclui automaticamente o histórico da conversa armazenado na nuvem.
    Ao passar session_id, prompt é obrigatório.
  • Você também pode manter um array messages. Adicione o histórico de cada rodada e as novas instruções ao array messages e transmita o histórico por meio de messages.
    Ao passar messages, prompt é opcional. Se ambos forem passados, prompt será acrescentado ao final de messages como informação complementar.
Se session_id e messages forem passados juntos, messages terá prioridade.
  • Armazenamento em nuvem (session_id)
  • Gerenciamento próprio (messages)
  • Python
  • Java
  • HTTP
Exemplo de solicitaçã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",
)

def call_with_session():
    try:
        response = client.apps.completions.create(
            app_id='YOUR_APP_ID',  # Substitua pelo ID real do aplicativo
            prompt='Who are you?')

        responseNext = client.apps.completions.create(
                    app_id='YOUR_APP_ID',  # Substitua pelo ID real do aplicativo
                    prompt='What skills do you have?',
                    session_id=response.session_id)  # O session_id da resposta anterior

        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'Refer to the documentation: https://www.alibabacloud.com/help/model-studio/developer-reference/error-code')

if __name__ == '__main__':
    call_with_session()
Exemplo de resposta
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

Passar parâmetros personalizados

Para adaptar o mesmo agente ou fluxo de trabalho a diferentes cenários, configure parâmetros personalizados para plug-ins ou nós e passe-os por biz_params ao chamar o aplicativo. Para saber como configurá-los, consulte Passagem de parâmetros de aplicativos. Exemplos:
  1. Parâmetros de plug-ins personalizados: passe-os pelo aplicativo de agente associado ou pelo nó de plug-in do aplicativo de fluxo de trabalho associado. Você pode passar parâmetros e informações de autenticação em nível de usuário para plug-ins personalizados:
    • Parâmetros: user_defined_params.
    • Autenticação em nível de usuário: user_defined_tokens. user_token contém as informações de autenticação exigidas pelo plug-in, como DASHSCOPE_API_KEY.
    O exemplo a seguir usa um aplicativo de agente que exige o parâmetro index e as informações de autenticação em nível de usuário do plug-in associado.
    Ferramentas de plug-in só podem ser associadas a aplicativos de agente do mesmo espaço de trabalho.
    Substitua your_plugin_code pelo ID da ferramenta de plug-in associada, exibido no cartão do plug-in, e passe os pares de chave e valor dos parâmetros de entrada. Neste exemplo, article_index tem o valor 2.
    • Passagem de parâmetros
    • Autenticação em nível de usuário
    • Python
    • Java
    • HTTP
    Exemplo de solicitação
    import os
    # A versão do SDK do DashScope deve ser 2.0.1 ou posterior.
    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",
    )
    biz_params = {
        # Passe os parâmetros de entrada personalizados de plug-in para aplicações de agente. Substitua your_plugin_code pelo ID do seu plug-in personalizado
        "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))  # Processar para obter apenas a saída de texto
        # 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'Refer to the documentation: https://www.alibabacloud.com/help/model-studio/developer-reference/error-code')
    
    Exemplo de resposta
    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. Parâmetros de nós personalizados: passe-os pelo aplicativo de fluxo de trabalho, em seu nó inicial, ou pelo aplicativo de orquestração de agentes, em seu nó de aplicativo. No exemplo a seguir, o aplicativo de fluxo de trabalho define um parâmetro city no nó inicial. Insira as variáveis city e query no Prompt e publique o aplicativo.
    Configuração do aplicativo
    Ao chamar, passe city por biz_params e query por prompt.
    • Python
    • Java
    • HTTP
    Exemplo de solicitaçã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",
    )
    # Passe parâmetros personalizados da aplicação de workflow ou de orquestração de agentes
    biz_params = {"city": "Hangzhou"}
    try:
        response = client.apps.completions.create(
            app_id='YOUR_APP_ID',  # Substitua pelo ID real do aplicativo
            prompt='Query the administrative divisions of this city',
            biz_params=biz_params  # Passe os parâmetros de negócio
        )
        print(f'{response.text}')  # Processar para obter apenas a saída de texto
    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')
    
    Exemplo de resposta
    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.
    

Saída em streaming

No modo de saída em streaming, o modelo gera resultados intermediários cuja concatenação forma o resultado final. Você pode ler o conteúdo à medida que é gerado, reduzindo a espera pela resposta. Conforme o método de chamada, configure os parâmetros abaixo para ativar o streaming:
  • SDK Python: defina stream como True.
  • SDK Java: chame pela interface streamCall.
  • HTTP: especifique X-DashScope-SSE como enable no cabeçalho.
Por padrão, a saída em streaming não é incremental: cada retorno inclui todo o conteúdo gerado até então. Para usar saída incremental em streaming, defina incremental_output (incrementalOutput em Java) como true. Em HTTP, defina incremental_output como true dentro do objeto parameters.
Exemplos:
  • Para aplicativos de agente:
    • Python
    • Java
    • HTTP
    Exemplo de solicitaçã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:
        stream = client.apps.completions.create(
                    app_id='YOUR_APP_ID',
                    prompt='Who are you?',
                    stream=True,  # Habilite a saída em streaming
                    incremental_output=True)  # Habilite a saída incremental
    
        for partial in stream:
            print(f'{partial.text}\n')  # Processar para obter apenas a saída de texto
    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')
    
    Exemplo de resposta
    I am
    
    Alibaba
    
    Cloud
    
    's large-scale language model
    
    , my name is
    
    Qwen.
    
  • O aplicativo de fluxo de trabalho oferece dois modos de saída em streaming, definidos por flow_stream_mode. Valores dos parâmetros e métodos de uso:
    • full_thoughts (valor padrão):
      • Descrição: os resultados em streaming de todos os nós são retornados no campo thoughts.
      • Requisito: também defina has_thoughts como True.
    • agent_format:
      • Descrição: o mesmo modo de saída dos aplicativos de agente.
      • Efeito: na console, ative a opção Resposta para um nó específico. Os resultados em streaming desse nó serão incluídos no campo text de output.
      • Cenário: adequado quando você precisa apenas da saída de determinados nós intermediários.
      A opção Resposta está disponível somente nos nós de Conversão de Texto, LLM e Fim (ativada por padrão nos nós Fim). Nós sem suporte a streaming retornam todo o conteúdo de uma vez.
    Exemplo:
    • full_thoughts
    • agent_format
    Este é um aplicativo de fluxo de trabalho publicado com saída em streaming.
    Configuração do fluxo de trabalho
    • Python
    • Java
    • HTTP
    Exemplo de solicitaçã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",
    )
    biz_params = {
        "city": "Hangzhou"}
    try:
        stream = client.apps.completions.create(
            # Substitua pelo ID real do aplicativo
            app_id='YOUR_APP_ID',
            prompt='Hello',
            biz_params=biz_params,
            # Habilite a saída em streaming
            stream=True,
            # incremental_output=true habilita a saída incremental, false desabilita; se não for especificado, o valor padrão é false
            incremental_output=True,
            # has_thoughts deve ser definido como True
            has_thoughts=True)
    
        for response in stream:
            print(f'{response.thoughts}\n')  # A saída retorna apenas os thoughts; as informações do processo são retornadas no campo thoughts de output
    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')
    
    Exemplo de resposta
    [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)]
    
    • Cada item de thoughts contém os detalhes de execução de um nó. A seguir está um exemplo de resultado de um nó 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"
    }
    
    Para acompanhar os resultados em streaming de um nó LLM (LLM_j45e no exemplo acima), observe a saída do nó com nodeId LLM_j45e em cada envio de thoughts.
    • Se um nó falhar, toda a tarefa também falhará.

Consultar a base de conhecimento

A base de conhecimento fornece a capacidade RAG do Model Studio e complementa os modelos com conhecimentos privados e recentes. Ao chamar aplicativos de agente, especifique o escopo da busca para melhorar a precisão das respostas.

Antes de começar

Na console do Model Studio, ative o Aprimoramento por busca na base de conhecimento no aplicativo de agente. Depois, publique o aplicativo.
Ignore esse pré-requisito para aplicativos RAG.

Especificar o escopo da busca

  1. Para consultar uma base de conhecimento específica, escolha um dos métodos abaixo:
    • Na console, clique em Configurar base de conhecimento no aplicativo e selecione a base desejada. Depois, publique o aplicativo.
    • Não associe a base na console. Passe seu ID por rag_options ao fazer a chamada de API;
    • Associe a base na console e passe seu ID por rag_options ao fazer a chamada de API.
      Nesse caso, apenas a base passada na chamada é consultada. Por exemplo, um aplicativo de agente está associado à base A, mas a chamada de API especifica a base B. Somente B será consultada; A não será.
    Para obter o ID da base de conhecimento (pipeline_ids), acesse a página Base de conhecimento ou use Data.Id retornado pela API CreateIndex. CreateIndex aceita apenas bases não estruturadas. Bailian Phones Specifications.docx é usado nos exemplos a seguir como base de conhecimento não estruturada.
    • Python
    • Java
    • HTTP
    Exemplo de solicitação
    import os
    # A versão do SDK do DashScope deve ser 2.0.1 ou posterior.
    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='YOUR_APP_ID',  # Substitua YOUR_APP_ID pelo ID real do aplicativo
            prompt='Please recommend a mobile phone under 3000 yuan',
            rag_options={
                "pipeline_ids": ["YOUR_PIPELINE_ID1,YOUR_PIPELINE_ID2"],  # Substitua pelos IDs reais das knowledge bases; separe múltiplos IDs com vírgulas
            }
        )
        print('%s\n' % (response.text))  # Processar para obter apenas a saída de texto
        # 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'Refer to the documentation: https://www.alibabacloud.com/help/model-studio/developer-reference/error-code')
    
    Exemplo de resposta
    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. Consulte documentos não estruturados específicos: passe o ID da base, os IDs dos documentos, as tags ou os metadados (pares de chave e valor) em rag_options.
    IDs de documentos, tags e metadados são válidos apenas para documentos não estruturados.
    • Como obtê-los:
    • Você pode especificar vários IDs de documentos, desde que os documentos já estejam incluídos nos índices de conhecimento.
    • Ao especificar IDs de documentos, informe também o ID da base de conhecimento à qual pertencem.
    • Apenas os documentos especificados são consultados. Por exemplo, um aplicativo de agente está associado à base A, mas a chamada de API especifica documentos da base B. Apenas os documentos de B serão consultados, e não os de A. Bailian Phones Specifications.docx é usado nos exemplos a seguir como base de conhecimento não estruturada.
      • Python
      • Java
      • HTTP
      Exemplo de solicitação
      import os
      # A versão do SDK do DashScope deve ser 2.0.1 ou posterior.
      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='YOUR_APP_ID',  # Substitua YOUR_APP_ID pelo ID real do aplicativo
              prompt='Please recommend a mobile phone under 3000 yuan',
              rag_options={
                  "pipeline_ids": ["YOUR_PIPELINE_ID1", "YOUR_PIPELINE_ID2"],  # Substitua pelos IDs reais das knowledge bases; separe múltiplos IDs com vírgulas
                  "file_ids": ["YOUR_FILE_ID1", "YOUR_FILE_ID2"],  # Substitua pelos IDs reais dos documentos não estruturados; separe múltiplos IDs com vírgulas
                  "metadata_filter": {  # Pares chave-valor de metadados dos documentos; separe múltiplos pares com vírgulas
                      "key1": "value1",
                      "key2": "value2"
                  },
                  "tags": ["tag1", "tag2"]  # Tags dos documentos; separe múltiplas tags com vírgulas
              }
          )
          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'Refer to the documentation: https://www.alibabacloud.com/help/model-studio/developer-reference/error-code')
      
      Exemplo de resposta
      {
          "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. Consulte dados específicos de documentos estruturados: passe o ID da base de conhecimento e pares de chave e valor de "cabeçalho de dados estruturados + valor" em rag_options. Obtenha os pares de chave e valor de dados estruturados (structured_filter): na página Base de conhecimento, clique em Exibir para abrir a base e depois em Exibir índice.
    • Python
    • Java
    • HTTP
    Exemplo de solicitação
    import os
    # A versão do SDK do DashScope deve ser 2.0.1 ou posterior.
    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='YOUR_APP_ID',  # Substitua YOUR_APP_ID pelo ID real do aplicativo
            prompt='Please recommend a mobile phone under 3000 yuan',
            rag_options={
                "pipeline_ids": ["YOUR_PIPELINE_ID1", "YOUR_PIPELINE_ID2"],  # Substitua pelos IDs reais das knowledge bases; separe múltiplos IDs com vírgulas
                 "structured_filter": {  # Pares chave-valor de dados estruturados, correspondentes aos dados estruturados; separe múltiplos pares com vírgulas
                    "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'Refer to the documentation: https://www.alibabacloud.com/help/model-studio/developer-reference/error-code')
    
    Exemplo de resposta
    {
        "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
    }
    
Exibir informações

Exibir o processo de busca: ao chamar, adicione has_thoughts ao código e defina-o como True. O processo de busca será retornado no campo thoughts de output.

Exibir a origem da resposta: ative Mostrar origem na Configuração de busca do aplicativo de agente e publique o aplicativo.
Configuração da origem da resposta

Referência da API

Para a lista completa de parâmetros, consulte Referência da API DashScope para aplicativos de fluxo de trabalho e agentes legados.

Códigos de erro

Se uma chamada falhar, consulte Códigos de erro para solucionar o problema.

Referências

FAQ

  1. Verifique se os nomes de classes e pacotes nas instruções de importação estão corretos.
  2. Adicione a dependência: se você usa Maven ou Gradle, verifique se a dependência do DashScope Java SDK está em pom.xml ou build.gradle e usa a versão mais recente. Consulte o número da versão mais recente no Maven.
<!-- 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>
// https://mvnrepository.com/artifact/com.alibaba/dashscope-sdk-java
implementation group: 'com.alibaba', name: 'dashscope-sdk-java', version: 'Enter the latest version, e.g., 2.16.4'
  1. Atualize o SDK: versões antigas do DashScope Java SDK podem não conter os recursos ou classes necessários. Se a versão estiver desatualizada, altere o número da versão em pom.xml ou build.gradle.
<!-- 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>
// https://mvnrepository.com/artifact/com.alibaba/dashscope-sdk-java
implementation group: 'com.alibaba', name: 'dashscope-sdk-java', version: 'Replace this with the latest version number'
  1. Recarregue o projeto para aplicar as alterações.
  2. Execute novamente o exemplo de código. Se o problema persistir, procure casos semelhantes e soluções no fórum de desenvolvedores ou abra um chamado.