Custom application parameter pass-through

Obter uma chave de API e exportar a chave de API como variável de ambiente. Se utilizar um SDK para fazer chamadas, instale o DashScope SDK.

​

Parâmetros de plugin personalizado

Este artigo utiliza a ferramenta de consulta de convenções de dormitório para demonstrar como passar parâmetros para um plugin personalizado via API. O exemplo a seguir mostra como passar parâmetros de plugin personalizado para uma Agent Application.

​

Uso

​

Etapa 1: Criar um plugin personalizado

Caso já tenha criado uma ferramenta de plugin ou importado um plugin, pule esta etapa.

1. Crie um plugin personalizado: Acesse a página Plugins no console do Model Studio e clique em Add Custom Plug-in. Insira as informações do plugin. Se for necessária autenticação, ative a opção Enable Authentication e configure as definições.

   Exemplo de descrição do plugin: Consulta convenções de dormitório e localiza entradas específicas por índice numérico.

   Exemplo de URL do plugin: https://domitorgreement-plugin-example-icohrkdjxy.cn-beijing.fcapp.run

   
   Nota: O campo Plug-in Description resume brevemente a finalidade do plugin. Isso auxilia o modelo grande a decidir se deve chamar o plugin para uma determinada tarefa. Descreva-o em linguagem natural.
2. Crie uma ferramenta: Preencha as informações da ferramenta e configure os parâmetros de entrada e saída. Nota:
   1. A Tool Description ajuda o modelo grande a compreender melhor as funções e os casos de uso da ferramenta. Utilize linguagem natural e forneça exemplos sempre que possível.
   2. Um Parameter Name descritivo facilita o entendimento do modelo grande sobre a informação representada.
   3. A Parameter Description explica a função do parâmetro de entrada. Deve ser concisa e precisa para ajudar o modelo grande a determinar o valor correto a ser utilizado.
   4. É obrigatório selecionar Business Pass-through no campo Passing Method do parâmetro de entrada.
   Neste exemplo, o índice de conteúdo da convenção de dormitório, article_index, é definido como um parâmetro de repasse.
   
3. Clique em Test Tool. Após a aprovação do teste, Publish o plugin.

​

Etapa 2: Associar um plugin a um agente

Só é possível associar plugins a uma Agent Application que esteja no mesmo workspace.

1. No cartão de um plugin publicado, clique em Add to Agent e selecione uma aplicação de agente.
2. Alternativamente, clique em + Plugin dentro de uma aplicação para associar um plugin personalizado.
3. Por fim, Publish a aplicação.

​

Etapa 3: Chamada de API

• Quando a autenticação não é necessária: Para chamar um plugin personalizado via API, utilize o parâmetro user_defined_params de biz_params para transmitir as informações do plugin. Substitua your_plugin_code pelo ID real do plugin e passe os pares chave-valor dos parâmetros de entrada configurados no plugin.

  É possível encontrar o ID do plugin no cartão do plugin.

  Neste exemplo, passar o valor 2 para o parâmetro article_index consulta o conteúdo da segunda convenção de dormitório e retorna o resultado correto.
  • Python
  • Java
  • HTTP

  Exemplo de solicitação

  Copy

  import os
  from http import HTTPStatus
  # We recommend using DashScope SDK v1.14.0 or later.
  from dashscope import Application
  biz_params = {
      # Pass the input parameters for the agent application's custom plugin. Replace `your_plugin_code` with your plugin ID.
      "user_defined_params": {
          "your_plugin_code": {
              "article_index": 2}}}
  response = Application.call(
          # If the environment variable is not set, you can use your Model Studio API key by replacing the following line with api_key="sk-xxx". We recommend using an environment variable in production to avoid leaking your API key.
          api_key=os.getenv("DASHSCOPE_API_KEY"),
          app_id='YOUR_APP_ID',
          prompt='Dormitory convention content',
          biz_params=biz_params)
  
  if response.status_code != HTTPStatus.OK:
      print(f'request_id={response.request_id}')
      print(f'code={response.status_code}')
      print(f'message={response.message}')
      print(f'For more information, see: https://www.alibabacloud.com/help/en/model-studio/developer-reference/error-code')
  else:
      print('%s\n' % (response.output.text))  # Process and output only the text.
      # print('%s\n' % (response.usage))
  

  Exemplo de resposta

  Copy

  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!
  

  Exemplo de solicitação

  Copy

  import com.alibaba.dashscope.app.*;
  import com.alibaba.dashscope.exception.ApiException;
  import com.alibaba.dashscope.exception.InputRequiredException;
  import com.alibaba.dashscope.exception.NoApiKeyException;
  import com.alibaba.dashscope.utils.JsonUtils;
  
  public class Main {
      public static void appCall() throws NoApiKeyException, InputRequiredException {
          String bizParams =
                  // Pass the input parameters for the agent application's custom plugin. Replace `{your_plugin_code}` with your plugin ID.
                  "{\"user_defined_params\":{\"{your_plugin_code}\":{\"article_index\":2}}}";
          ApplicationParam param = ApplicationParam.builder()
                  // If the environment variable is not set, you can use your Model Studio API key by replacing the following line with .apiKey("sk-xxx"). We recommend using an environment variable in production to avoid leaking your API key.
                  .apiKey(System.getenv("DASHSCOPE_API_KEY"))
                  .appId("YOUR_APP_ID")
                  .prompt("Dormitory convention content")
                  .bizParams(JsonUtils.parse(bizParams))
                  .build();
  
          Application application = new Application();
          ApplicationResult result = application.call(param);
          System.out.printf("%s\n",
                  result.getOutput().getText());
      }
  
      public static void main(String[] args) {
          try {
              appCall();
          } catch (ApiException | NoApiKeyException | InputRequiredException e) {
              System.out.printf("Exception: %s", e.getMessage());
              System.out.println("For more information, see: https://www.alibabacloud.com/help/en/model-studio/error-code");
          }
          System.exit(0);
      }
  }
  

  Exemplo de resposta

  Copy

  The second article of the dormitory convention is as follows:
  
  Article 2: Roommates must help, care for, and learn from each other to achieve mutual improvement. They must be tolerant, forgiving, respectful, and sincere.
  
  This emphasizes that in a shared living environment, roommates should maintain a positive and supportive relationship to create a harmonious atmosphere for living and learning. If you need to learn about any other specific articles, please let me know.
  

  • curl
  • PHP
  • Node.js
  • C#
  • Go

  Exemplo de solicitação

  Copy

  curl -X POST https://dashscope.aliyuncs.com/api/v1/apps/YOUR_APP_ID/completion \
  --header "Authorization: Bearer $DASHSCOPE_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
      "input": {
          "prompt": "Dormitory convention content",
          "biz_params":
          {
              "user_defined_params":
              {
                  "{your_plugin_code}":
                      {
                      "article_index": 2
                      }
              }
          }
      },
      "parameters":  {},
      "debug":{}
  }'
  

  Substitua YOUR_APP_ID pelo ID da sua aplicação.

  Exemplo de resposta

  Copy

  {"output":
  {"finish_reason":"stop",
  "session_id":"e151267ffded4fbdb13d91439011d31e",
  "text":"The second article of the dormitory convention is: \"Roommates must help, care for, and learn from each other to achieve mutual improvement. They must be tolerant, forgiving, respectful, and sincere.\" This means that in dormitory life, everyone must support each other to create a harmonious and positive living environment."},
  "usage":{"models":[{"output_tokens":94,"model_id":"qwen-max","input_tokens":453}]},
  "request_id":"a39fd2b5-7e2c-983e-84a1-1039f726f18a"}%
  

  Exemplo de solicitação

  Copy

  <?php
  
  # If the environment variable is not set, you can use your Model Studio API key by replacing the following line with $api_key="sk-xxx". We recommend using an environment variable in production to avoid leaking your API key.
  $api_key = getenv("DASHSCOPE_API_KEY");
  $application_id = 'YOUR_APP_ID'; // Replace with your app ID.
  $url = "https://dashscope.aliyuncs.com/api/v1/apps/$application_id/completion";
  // Replace `{your_plugin_code}` with your plugin ID.
  // Construct the request data.
  $data = [
      "input" => [
          'prompt' => 'Dormitory convention content',
          'biz_params' => [
          'user_defined_params' => [
              '{your_plugin_code}' => [
                  'article_index' => 2
                  ]
              ]
          ]
      ],
  ];
  // Encode the data as JSON.
  $dataString = json_encode($data);
  
  // Check if json_encode was successful.
  if (json_last_error() !== JSON_ERROR_NONE) {
      die("JSON encoding failed with error: " . json_last_error_msg());
  }
  
  // Initialize a cURL session.
  $ch = curl_init($url);
  
  // Set the cURL options.
  curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
  curl_setopt($ch, CURLOPT_POSTFIELDS, $dataString);
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  curl_setopt($ch, CURLOPT_HTTPHEADER, [
      'Content-Type: application/json',
      'Authorization: Bearer ' . $api_key
  ]);
  
  // Execute the request.
  $response = curl_exec($ch);
  
  // Check if the cURL execution was successful.
  if ($response === false) {
      die("cURL Error: " . curl_error($ch));
  }
  
  // Get the HTTP status code.
  $status_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
  // Close the cURL session.
  curl_close($ch);
  // Decode the response data.
  $response_data = json_decode($response, true);
  // Process the response.
  if ($status_code == 200) {
      if (isset($response_data['output']['text'])) {
          echo "{$response_data['output']['text']}\n";
      } else {
          echo "No text in response.\n";
      }
  }else {
      if (isset($response_data['request_id'])) {
          echo "request_id={$response_data['request_id']}\n";}
      echo "code={$status_code}\n";
      if (isset($response_data['message'])) {
          echo "message={$response_data['message']}\n";}
      else {
          echo "message=Unknown error\n";}
  }
  ?>
  

  Exemplo de resposta

  Copy

  The second article of the dormitory convention states: Roommates must help, care for, and learn from each other to achieve mutual improvement. They must be tolerant, forgiving, respectful, and sincere. This is to ensure that everyone can live and study in a harmonious and friendly environment. If you want to learn about other specific articles or have other questions, feel free to ask.
  

  Dependências:

  Copy

  npm install axios
  

  Exemplo de solicitação

  Copy

  const axios = require('axios');
  
  async function callDashScope() {
      // If the environment variable is not set, you can use your Model Studio API key by replacing the following line with apiKey='sk-xxx'. We recommend using an environment variable in production to avoid leaking your API key.
      const apiKey = process.env.DASHSCOPE_API_KEY;
      const appId = 'YOUR_APP_ID';// Replace with your app ID.
      const pluginCode = 'YOUR_PLUGIN_CODE';// Replace with your plugin ID.
      const url = `https://dashscope.aliyuncs.com/api/v1/apps/${appId}/completion`;
  
      const data = {
          input: {
              prompt: "Dormitory convention content",
              biz_params: {
                  user_defined_params: {
                      [pluginCode]: {
                          // 'article_index' is an example of a custom plugin parameter.
                          'article_index': 2
                      }
                  }
              }
          },
          parameters: {},
          debug: {}
      };
  
      try {
          console.log("Sending request to DashScope API...");
  
          const response = await axios.post(url, data, {
              headers: {
                  'Authorization': `Bearer ${apiKey}`,
                  'Content-Type': 'application/json'
              }
          });
  
          if (response.status === 200) {
              if (response.data.output && response.data.output.text) {
                  console.log(`${response.data.output.text}`);
              }
          } else {
              console.log("Request failed:");
              if (response.data.request_id) {
                  console.log(`request_id=${response.data.request_id}`);
              }
              console.log(`code=${response.status}`);
              if (response.data.message) {
                  console.log(`message=${response.data.message}`);
              } else {
                  console.log('message=Unknown error');
              }
          }
      } catch (error) {
          console.error(`Error calling DashScope: ${error.message}`);
          if (error.response) {
              console.error(`Response status: ${error.response.status}`);
              console.error(`Response data: ${JSON.stringify(error.response.data, null, 2)}`);
          }
      }
  }
  callDashScope();
  

  Exemplo de resposta

  Copy

  The second article of the dormitory convention states: Roommates must help, care for, and learn from each other to achieve mutual improvement. They must be tolerant, forgiving, respectful, and sincere. This is to ensure that everyone can live and study in a harmonious and friendly environment. If you want to learn about other specific articles or have other questions, feel free to ask.
  

  Exemplo de solicitação

  Copy

  using System.Text;
  
  class Program
  {
      static async Task Main(string[] args)
      {
          // If the environment variable is not set, you can use your Model Studio API key by replacing the following line with apiKey="sk-xxx". We recommend using an environment variable in production to avoid leaking your API key.
          string apiKey = Environment.GetEnvironmentVariable("DASHSCOPE_API_KEY")?? throw new InvalidOperationException("DASHSCOPE_API_KEY environment variable is not set.");;
          string appId = "YOUR_APP_ID";// Replace with your app ID.
  
          if (string.IsNullOrEmpty(apiKey))
          {
              Console.WriteLine("Please ensure that the DASHSCOPE_API_KEY environment variable is set.");
              return;
          }
  
          string url = $"https://dashscope.aliyuncs.com/api/v1/apps/{appId}/completion";
  
          using (HttpClient client = new HttpClient())
          {
              client.DefaultRequestHeaders.Add("Authorization", $"Bearer {apiKey}");
              string pluginCode = "{your_plugin_code}"; // Replace `{your_plugin_code}` with your plugin ID.
              string jsonContent = $@"{{
                  ""input"": {{
                      ""prompt"": ""Dormitory convention content"",
                      ""biz_params"": {{
                          ""user_defined_params"": {{
                              ""{pluginCode}"": {{
                                  ""article_index"": 2
                              }}
                          }}
                      }}
                  }},
                  ""parameters"": {{}},
                  ""debug"": {{}}
              }}";
  
              HttpContent content = new StringContent(jsonContent, Encoding.UTF8, "application/json");
  
              try
              {
                  HttpResponseMessage response = await client.PostAsync(url, content);
  
                  if (response.IsSuccessStatusCode)
                  {
                      string responseBody = await response.Content.ReadAsStringAsync();
                      Console.WriteLine("Request successful:");
                      Console.WriteLine(responseBody);
                  }
                  else
                  {
                      Console.WriteLine($"Request failed with status code: {response.StatusCode}");
                      string responseBody = await response.Content.ReadAsStringAsync();
                      Console.WriteLine(responseBody);
                  }
              }
              catch (Exception ex)
              {
                  Console.WriteLine($"Error calling DashScope: {ex.Message}");
              }
          }
      }
  }
  

  Exemplo de resposta

  Copy

  {
      "output": {
          "finish_reason": "stop",
          "session_id": "237ca6187c814f3b9e7461090a5f8b74",
          "text": "The second article of the dormitory convention is as follows:\n\n\"Roommates must help, care for, and learn from each other to achieve mutual improvement. They must be tolerant, forgiving, respectful, and sincere.\"\n\nThis indicates that in the dormitory, roommates need to establish a positive relationship, creating a harmonious living and learning environment by helping, caring for, and supporting each other. They should also learn to understand and accept differences between roommates and communicate with sincerity. If you want to learn about other articles or specific content, please let me know!"
      },
      "usage": {
          "models": [
              {
                  "output_tokens": 133,
                  "model_id": "qwen-max",
                  "input_tokens": 829
              }
          ]
      },
      "request_id": "64e8c359-d071-9d2e-bb94-187e86cc3a79"
  }
  

  Exemplo de solicitação

  Copy

  package main
  
  import (
    "bytes"
    "encoding/json"
    "fmt"
    "io"
    "net/http"
    "os"
  )
  
  func main() {
    // If the environment variable is not set, you can use your Model Studio API key by replacing the following line with apiKey := "sk-xxx". We recommend using an environment variable in production to avoid leaking your API key.
    apiKey := os.Getenv("DASHSCOPE_API_KEY")
    appId := "YOUR_APP_ID"           // Replace with your app ID.
    pluginCode := "YOUR_PLUGIN_CODE" // Replace with your plugin ID.
  
    if apiKey == "" {
        fmt.Println("Please ensure that the DASHSCOPE_API_KEY environment variable is set.")
        return
    }
  
    url := fmt.Sprintf("https://dashscope.aliyuncs.com/api/v1/apps/%s/completion", appId)
  
    // Create the request body.
    requestBody := map[string]interface{}{
        "input": map[string]interface{}{
            "prompt": "Dormitory convention content",
            "biz_params": map[string]interface{}{
                "user_defined_params": map[string]interface{}{
                    pluginCode: map[string]interface{}{
                        "article_index": 2,
                    },
                },
            },
        },
        "parameters": map[string]interface{}{},
        "debug":      map[string]interface{}{},
    }
  
    jsonData, err := json.Marshal(requestBody)
    if err != nil {
        fmt.Printf("Failed to marshal JSON: %v\n", err)
        return
    }
  
    // Create an HTTP POST request.
    req, err := http.NewRequest("POST", url, bytes.NewBuffer(jsonData))
    if err != nil {
        fmt.Printf("Failed to create request: %v\n", err)
        return
    }
  
    // Set the request headers.
    req.Header.Set("Authorization", "Bearer "+apiKey)
    req.Header.Set("Content-Type", "application/json")
  
    // Send the request.
    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        fmt.Printf("Failed to send request: %v\n", err)
        return
    }
    defer resp.Body.Close()
  
    // Read the response.
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        fmt.Printf("Failed to read response: %v\n", err)
        return
    }
  
    // Process the response.
    if resp.StatusCode == http.StatusOK {
        fmt.Println("Request successful:")
        fmt.Println(string(body))
    } else {
        fmt.Printf("Request failed with status code: %d\n", resp.StatusCode)
        fmt.Println(string(body))
    }
  }
  

  Exemplo de resposta

  Copy

  {
      "output": {
          "finish_reason": "stop",
          "session_id": "860d2a4c1f3649ac880298537993cb51",
          "text": "The second article of the dormitory convention is as follows:\n\nRoommates must help, care for, and learn from each other to achieve mutual improvement. They must be tolerant, forgiving, respectful, and sincere.\n\nThis emphasizes that in dormitory life, roommates should maintain a supportive relationship and respect each other. Would you like to learn about the content of other articles?"
      },
      "usage": {
          "models": [
              {
                  "output_tokens": 84,
                  "model_id": "qwen-max",
                  "input_tokens": 876
              }
          ]
      },
      "request_id": "0a250055-90a4-992d-9276-e268ad35d1ab"
  }
  
  • Python
  • Java
  • HTTP

  Exemplo de solicitação

  Copy

  import os
  from http import HTTPStatus
  # We recommend using DashScope SDK v1.14.0 or later.
  import dashscope
  from dashscope import Application
  
  dashscope.base_http_api_url = 'https://dashscope-intl.aliyuncs.com/api/v1'
  biz_params = {
      # Pass the input parameters for the agent application's custom plugin. Replace `your_plugin_code` with your plugin ID.
      "user_defined_params": {
          "your_plugin_code": {
              "article_index": 2}}}
  response = Application.call(
          # If the environment variable is not set, you can use your Model Studio API key by replacing the following line with api_key="sk-xxx". We recommend using an environment variable in production to avoid leaking your API key.
          api_key=os.getenv("DASHSCOPE_API_KEY"),
          app_id='YOUR_APP_ID',
          prompt='Dormitory convention content',
          biz_params=biz_params)
  
  if response.status_code != HTTPStatus.OK:
      print(f'request_id={response.request_id}')
      print(f'code={response.status_code}')
      print(f'message={response.message}')
      print(f'For more information, see: https://www.alibabacloud.com/help/en/model-studio/developer-reference/error-code')
  else:
      print('%s\n' % (response.output.text))  # Process and output only the text.
      # print('%s\n' % (response.usage))
  

  Exemplo de resposta

  Copy

  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!
  

  Exemplo de solicitação

  Copy

  import com.alibaba.dashscope.app.*;
  import com.alibaba.dashscope.exception.ApiException;
  import com.alibaba.dashscope.exception.InputRequiredException;
  import com.alibaba.dashscope.exception.NoApiKeyException;
  import com.alibaba.dashscope.utils.JsonUtils;
  import com.alibaba.dashscope.utils.Constants;
  
  public class Main {
    static {
          Constants.baseHttpApiUrl="https://dashscope-intl.aliyuncs.com/api/v1";
      }
      public static void appCall() throws NoApiKeyException, InputRequiredException {
          String bizParams =
                  // Pass the input parameters for the agent application's custom plugin. Replace `{your_plugin_code}` with your plugin ID.
                  "{\"user_defined_params\":{\"{your_plugin_code}\":{\"article_index\":2}}}";
          ApplicationParam param = ApplicationParam.builder()
                  // If the environment variable is not set, you can use your Model Studio API key by replacing the following line with .apiKey("sk-xxx"). We recommend using an environment variable in production to avoid leaking your API key.
                  .apiKey(System.getenv("DASHSCOPE_API_KEY"))
                  .appId("YOUR_APP_ID")
                  .prompt("Dormitory convention content")
                  .bizParams(JsonUtils.parse(bizParams))
                  .build();
  
          Application application = new Application();
          ApplicationResult result = application.call(param);
          System.out.printf("%s\n",
                  result.getOutput().getText());
      }
  
      public static void main(String[] args) {
          try {
              appCall();
          } catch (ApiException | NoApiKeyException | InputRequiredException e) {
              System.out.printf("Exception: %s", e.getMessage());
              System.out.println("For more information, see: https://www.alibabacloud.com/help/en/model-studio/developer-reference/error-code");
          }
          System.exit(0);
      }
  }
  

  Exemplo de resposta

  Copy

  The second article of the dormitory convention is as follows:
  
  Article 2: Roommates must help, care for, and learn from each other to achieve mutual improvement. They must be tolerant, forgiving, respectful, and sincere.
  
  This emphasizes that in a shared living environment, roommates should maintain a positive and supportive relationship to create a harmonious atmosphere for living and learning. If you need to learn about any other specific articles, please let me know.
  

  • curl
  • PHP
  • Node.js
  • C#
  • Go

  Exemplo de solicitação

  Copy

  curl -X POST https://dashscope-intl.aliyuncs.com/api/v1/apps/YOUR_APP_ID/completion \
  --header "Authorization: Bearer $DASHSCOPE_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
      "input": {
          "prompt": "Dormitory convention content",
          "biz_params":
          {
              "user_defined_params":
              {
                  "{your_plugin_code}":
                      {
                      "article_index": 2
                      }
              }
          }
      },
      "parameters":  {},
      "debug":{}
  }'
  

  Substitua YOUR_APP_ID pelo ID da sua aplicação.

  Exemplo de resposta

  Copy

  {"output":
  {"finish_reason":"stop",
  "session_id":"e151267ffded4fbdb13d91439011d31e",
  "text":"The second article of the dormitory convention is: \"Roommates must help, care for, and learn from each other to achieve mutual improvement. They must be tolerant, forgiving, respectful, and sincere.\" This means that in dormitory life, everyone must support each other to create a harmonious and positive living environment."},
  "usage":{"models":[{"output_tokens":94,"model_id":"qwen-max","input_tokens":453}]},
  "request_id":"a39fd2b5-7e2c-983e-84a1-1039f726f18a"}%
  

  Exemplo de solicitação

  Copy

  <?php
  
  # If the environment variable is not set, you can use your Model Studio API key by replacing the following line with $api_key="sk-xxx". We recommend using an environment variable in production to avoid leaking your API key.
  $api_key = getenv("DASHSCOPE_API_KEY");
  $application_id = 'YOUR_APP_ID'; // Replace with your app ID.
  $url = "https://dashscope-intl.aliyuncs.com/api/v1/apps/$application_id/completion";
  // Replace `{your_plugin_code}` with your plugin ID.
  // Construct the request data.
  $data = [
      "input" => [
          'prompt' => 'Dormitory convention content',
          'biz_params' => [
          'user_defined_params' => [
              '{your_plugin_code}' => [
                  'article_index' => 2
                  ]
              ]
          ]
      ],
  ];
  // Encode the data as JSON.
  $dataString = json_encode($data);
  
  // Check if json_encode was successful.
  if (json_last_error() !== JSON_ERROR_NONE) {
      die("JSON encoding failed with error: " . json_last_error_msg());
  }
  
  // Initialize a cURL session.
  $ch = curl_init($url);
  
  // Set the cURL options.
  curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
  curl_setopt($ch, CURLOPT_POSTFIELDS, $dataString);
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  curl_setopt($ch, CURLOPT_HTTPHEADER, [
      'Content-Type: application/json',
      'Authorization: Bearer ' . $api_key
  ]);
  
  // Execute the request.
  $response = curl_exec($ch);
  
  // Check if the cURL execution was successful.
  if ($response === false) {
      die("cURL Error: " . curl_error($ch));
  }
  
  // Get the HTTP status code.
  $status_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
  // Close the cURL session.
  curl_close($ch);
  // Decode the response data.
  $response_data = json_decode($response, true);
  // Process the response.
  if ($status_code == 200) {
      if (isset($response_data['output']['text'])) {
          echo "{$response_data['output']['text']}\n";
      } else {
          echo "No text in response.\n";
      }
  }else {
      if (isset($response_data['request_id'])) {
          echo "request_id={$response_data['request_id']}\n";}
      echo "code={$status_code}\n";
      if (isset($response_data['message'])) {
          echo "message={$response_data['message']}\n";}
      else {
          echo "message=Unknown error\n";}
  }
  ?>
  

  Exemplo de resposta

  Copy

  The second article of the dormitory convention states: Roommates must help, care for, and learn from each other to achieve mutual improvement. They must be tolerant, forgiving, respectful, and sincere. This is to ensure that everyone can live and study in a harmonious and friendly environment. If you want to learn about other specific articles or have other questions, feel free to ask.
  

  Dependências:

  Copy

  npm install axios
  

  Exemplo de solicitação

  Copy

  const axios = require('axios');
  
  async function callDashScope() {
      // If the environment variable is not set, you can use your Model Studio API key by replacing the following line with apiKey='sk-xxx'. We recommend using an environment variable in production to avoid leaking your API key.
      const apiKey = process.env.DASHSCOPE_API_KEY;
      const appId = 'YOUR_APP_ID';// Replace with your app ID.
      const pluginCode = 'YOUR_PLUGIN_CODE';// Replace with your plugin ID.
      const url = `https://dashscope-intl.aliyuncs.com/api/v1/apps/${appId}/completion`;
  
      const data = {
          input: {
              prompt: "Dormitory convention content",
              biz_params: {
                  user_defined_params: {
                      [pluginCode]: {
                          // 'article_index' is an example of a custom plugin parameter.
                          'article_index': 2
                      }
                  }
              }
          },
          parameters: {},
          debug: {}
      };
  
      try {
          console.log("Sending request to DashScope API...");
  
          const response = await axios.post(url, data, {
              headers: {
                  'Authorization': `Bearer ${apiKey}`,
                  'Content-Type': 'application/json'
              }
          });
  
          if (response.status === 200) {
              if (response.data.output && response.data.output.text) {
                  console.log(`${response.data.output.text}`);
              }
          } else {
              console.log("Request failed:");
              if (response.data.request_id) {
                  console.log(`request_id=${response.data.request_id}`);
              }
              console.log(`code=${response.status}`);
              if (response.data.message) {
                  console.log(`message=${response.data.message}`);
              } else {
                  console.log('message=Unknown error');
              }
          }
      } catch (error) {
          console.error(`Error calling DashScope: ${error.message}`);
          if (error.response) {
              console.error(`Response status: ${error.response.status}`);
              console.error(`Response data: ${JSON.stringify(error.response.data, null, 2)}`);
          }
      }
  }
  callDashScope();
  

  Exemplo de resposta

  Copy

  The second article of the dormitory convention states: Roommates must help, care for, and learn from each other to achieve mutual improvement. They must be tolerant, forgiving, respectful, and sincere. This is to ensure that everyone can live and study in a harmonious and friendly environment. If you want to learn about other specific articles or have other questions, feel free to ask.
  

  Exemplo de solicitação

  Copy

  using System.Text;
  
  class Program
  {
      static async Task Main(string[] args)
      {
          // If the environment variable is not set, you can use your Model Studio API key by replacing the following line with apiKey="sk-xxx". We recommend using an environment variable in production to avoid leaking your API key.
          string apiKey = Environment.GetEnvironmentVariable("DASHSCOPE_API_KEY")?? throw new InvalidOperationException("DASHSCOPE_API_KEY environment variable is not set.");;
          string appId = "YOUR_APP_ID";// Replace with your app ID.
  
          if (string.IsNullOrEmpty(apiKey))
          {
              Console.WriteLine("Please ensure that the DASHSCOPE_API_KEY environment variable is set.");
              return;
          }
  
          string url = $"https://dashscope-intl.aliyuncs.com/api/v1/apps/{appId}/completion";
  
          using (HttpClient client = new HttpClient())
          {
              client.DefaultRequestHeaders.Add("Authorization", $"Bearer {apiKey}");
              string pluginCode = "{your_plugin_code}"; // Replace `{your_plugin_code}` with your plugin ID.
              string jsonContent = $@"{{
                  ""input"": {{
                      ""prompt"": ""Dormitory convention content"",
                      ""biz_params"": {{
                          ""user_defined_params"": {{
                              ""{pluginCode}"": {{
                                  ""article_index"": 2
                              }}
                          }}
                      }}
                  }},
                  ""parameters"": {{}},
                  ""debug"": {{}}
              }}";
  
              HttpContent content = new StringContent(jsonContent, Encoding.UTF8, "application/json");
  
              try
              {
                  HttpResponseMessage response = await client.PostAsync(url, content);
  
                  if (response.IsSuccessStatusCode)
                  {
                      string responseBody = await response.Content.ReadAsStringAsync();
                      Console.WriteLine("Request successful:");
                      Console.WriteLine(responseBody);
                  }
                  else
                  {
                      Console.WriteLine($"Request failed with status code: {response.StatusCode}");
                      string responseBody = await response.Content.ReadAsStringAsync();
                      Console.WriteLine(responseBody);
                  }
              }
              catch (Exception ex)
              {
                  Console.WriteLine($"Error calling DashScope: {ex.Message}");
              }
          }
      }
  }
  

  Exemplo de resposta

  Copy

  {
      "output": {
          "finish_reason": "stop",
          "session_id": "237ca6187c814f3b9e7461090a5f8b74",
          "text": "The second article of the dormitory convention is as follows:\n\n\"Roommates must help, care for, and learn from each other to achieve mutual improvement. They must be tolerant, forgiving, respectful, and sincere.\"\n\nThis indicates that in the dormitory, roommates need to establish a positive relationship, creating a harmonious living and learning environment by helping, caring for, and supporting each other. They should also learn to understand and accept differences between roommates and communicate with sincerity. If you want to learn about other articles or specific content, please let me know!"
      },
      "usage": {
          "models": [
              {
                  "output_tokens": 133,
                  "model_id": "qwen-max",
                  "input_tokens": 829
              }
          ]
      },
      "request_id": "64e8c359-d071-9d2e-bb94-187e86cc3a79"
  }
  

  Exemplo de solicitação

  Copy

  package main
  
  import (
    "bytes"
    "encoding/json"
    "fmt"
    "io"
    "net/http"
    "os"
  )
  
  func main() {
    // If the environment variable is not set, you can use your Model Studio API key by replacing the following line with apiKey := "sk-xxx". We recommend using an environment variable in production to avoid leaking your API key.
    apiKey := os.Getenv("DASHSCOPE_API_KEY")
    appId := "YOUR_APP_ID"           // Replace with your app ID.
    pluginCode := "YOUR_PLUGIN_CODE" // Replace with your plugin ID.
  
    if apiKey == "" {
        fmt.Println("Please ensure that the DASHSCOPE_API_KEY environment variable is set.")
        return
    }
  
    url := fmt.Sprintf("https://dashscope-intl.aliyuncs.com/api/v1/apps/%s/completion", appId)
  
    // Create the request body.
    requestBody := map[string]interface{}{
        "input": map[string]interface{}{
            "prompt": "Dormitory convention content",
            "biz_params": map[string]interface{}{
                "user_defined_params": map[string]interface{}{
                    pluginCode: map[string]interface{}{
                        "article_index": 2,
                    },
                },
            },
        },
        "parameters": map[string]interface{}{},
        "debug":      map[string]interface{}{},
    }
  
    jsonData, err := json.Marshal(requestBody)
    if err != nil {
        fmt.Printf("Failed to marshal JSON: %v\n", err)
        return
    }
  
    // Create an HTTP POST request.
    req, err := http.NewRequest("POST", url, bytes.NewBuffer(jsonData))
    if err != nil {
        fmt.Printf("Failed to create request: %v\n", err)
        return
    }
  
    // Set the request headers.
    req.Header.Set("Authorization", "Bearer "+apiKey)
    req.Header.Set("Content-Type", "application/json")
  
    // Send the request.
    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        fmt.Printf("Failed to send request: %v\n", err)
        return
    }
    defer resp.Body.Close()
  
    // Read the response.
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        fmt.Printf("Failed to read response: %v\n", err)
        return
    }
  
    // Process the response.
    if resp.StatusCode == http.StatusOK {
        fmt.Println("Request successful:")
        fmt.Println(string(body))
    } else {
        fmt.Printf("Request failed with status code: %d\n", resp.StatusCode)
        fmt.Println(string(body))
    }
  }
  

  Exemplo de resposta

  Copy

  {
      "output": {
          "finish_reason": "stop",
          "session_id": "860d2a4c1f3649ac880298537993cb51",
          "text": "The second article of the dormitory convention is as follows:\n\nRoommates must help, care for, and learn from each other to achieve mutual improvement. They must be tolerant, forgiving, respectful, and sincere.\n\nThis emphasizes that in dormitory life, roommates should maintain a supportive relationship and respect each other. Would you like to learn about the content of other articles?"
      },
      "usage": {
          "models": [
              {
                  "output_tokens": 84,
                  "model_id": "qwen-max",
                  "input_tokens": 876
              }
          ]
      },
      "request_id": "0a250055-90a4-992d-9276-e268ad35d1ab"
  }
  
• Quando a autenticação é necessária: Este cenário descreve como chamar um plugin personalizado que possui Authentication ativada e está configurado com User-level Authentication.

  É possível encontrar o ID do plugin no cartão do plugin.

  • Utilize user_defined_params no campo biz_params para passar as informações do plugin personalizado. Substitua your_plugin_code pelo ID do seu plugin e forneça os parâmetros de entrada como pares chave-valor.
  • Utilize user_defined_tokens no campo biz_params para passar as credenciais de autenticação. Substitua your_plugin_code pelo ID do seu plugin e defina o valor de user_token como seu token de autenticação, como uma chave de API do DashScope.
  • Após a autenticação bem-sucedida, o serviço consulta o item especificado com base no parâmetro de índice fornecido e retorna o resultado correto.
  Neste exemplo, o parâmetro article_index é definido como 2, e o valor de user_token, YOUR_TOKEN, é substituído pela DASHSCOPE_API_KEY real. Após a autenticação bem-sucedida, o conteúdo da segunda regra do dormitório é consultado e o resultado correto é retornado.
  • Python
  • Java
  • HTTP

  Exemplo de solicitação

  Copy

  from http import HTTPStatus
  import os
  # We recommend using DashScope SDK v1.14.0 or later.
  from dashscope import Application
  biz_params = {
      # Pass authentication credentials for the agent application's custom plugin.
      # Replace your_plugin_code with your plugin ID and YOUR_TOKEN with your authentication token, such as an API key.
      "user_defined_params": {
          "your_plugin_code": {
              "article_index": 2}},
      "user_defined_tokens": {
          "your_plugin_code": {
              "user_token": "YOUR_TOKEN"}}}
  response = Application.call(
              # If the environment variable is not configured, you can use a DashScope API key by replacing the next line with: api_key="sk-xxx".
              # However, we do not recommend hardcoding the API key in a production environment to reduce the risk of key leakage.
              api_key=os.getenv("DASHSCOPE_API_KEY"),
              app_id='YOUR_APP_ID',
              prompt='Dormitory convention content',
              biz_params=biz_params)
  
  if response.status_code != HTTPStatus.OK:
      print(f'request_id={response.request_id}')
      print(f'code={response.status_code}')
      print(f'message={response.message}')
      print(f'For more information, refer to: https://www.alibabacloud.com/help/en/model-studio/developer-reference/error-code')
  else:
      print('%s\n' % (response.output.text))  # Process and output only the text.
      # print('%s\n' % (response.usage))
  

  Exemplo de resposta

  Copy

  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.
  

  Exemplo de solicitação

  Copy

  import com.alibaba.dashscope.app.*;
  import com.alibaba.dashscope.exception.ApiException;
  import com.alibaba.dashscope.exception.InputRequiredException;
  import com.alibaba.dashscope.exception.NoApiKeyException;
  import com.alibaba.dashscope.utils.JsonUtils;
  
  public class Main {
      public static void appCall() throws NoApiKeyException, InputRequiredException {
          String bizParams =
                  // Replace {your_plugin_code} with your plugin ID, and YOUR_TOKEN with your token, such as an API key.
                  "{\"user_defined_params\":{\"{your_plugin_code}\":{\"article_index\":2}}," +
                          "\"user_defined_tokens\":{\"{your_plugin_code}\":{\"user_token\":\"YOUR_TOKEN\"}}}";
          ApplicationParam param = ApplicationParam.builder()
                  // If the environment variable is not configured, you can use a DashScope API key by replacing the next line with: .apiKey("sk-xxx").
                  // However, we do not recommend hardcoding the API key in a production environment to reduce the risk of key leakage.
                  .apiKey(System.getenv("DASHSCOPE_API_KEY"))
                  .appId("YOUR_APP_ID")
                  .prompt("Dormitory convention content")
                  .bizParams(JsonUtils.parse(bizParams))
                  .build();
  
          Application application = new Application();
          ApplicationResult result = application.call(param);
          System.out.printf("%s\n",
                  result.getOutput().getText());
      }
      public static void main(String[] args) {
          try {
              appCall();
          } catch (ApiException | NoApiKeyException | InputRequiredException e) {
              System.out.printf("Exception: %s", e.getMessage());
              System.out.println("For more information, refer to: https://www.alibabacloud.com/help/en/model-studio/error-code");
          }
          System.exit(0);
      }
  }
  

  Exemplo de resposta

  Copy

  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 query for more articles, please let me know.
  

  Substitua YOUR_APP_ID pelo ID da sua aplicação, your_plugin_code pelo ID do seu plugin personalizado e YOUR_TOKEN pelo seu token de autenticação.

  • curl
  • PHP
  • Node.js
  • C#
  • Go

  Exemplo de solicitação

  Copy

  curl -X POST https://dashscope.aliyuncs.com/api/v1/apps/YOUR_APP_ID/completion \
  --header "Authorization: Bearer $DASHSCOPE_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
      "input": {
          "prompt": "Dormitory convention content",
          "biz_params":
          {
              "user_defined_params":
              {
                  "{your_plugin_code}":
                      {
                      "article_index": 2
                      }
              },
              "user_defined_tokens":
              {
                  "{your_plugin_code}":
                      {
                      "user_token": "YOUR_TOKEN"
                      }
              }
          }
      },
      "parameters":  {},
      "debug":{}
  }'
  

  Substitua YOUR_APP_ID pelo ID da sua aplicação, {your_plugin_code} pelo ID do seu plugin personalizado e YOUR_TOKEN pelo seu token de autenticação.

  Exemplo de resposta

  Copy

  {"output":{"finish_reason":"stop",
  "session_id":"d3b5c3e269dc40479255a7a02df5c630",
  "text":"The second article of the dormitory convention is: \"Roommates must help, care for, and learn from each other to achieve mutual improvement. They must be tolerant, forgiving, respectful, and sincere.\" This emphasizes the importance of harmonious coexistence and mutual progress among members in dormitory life."},
  "usage":{"models":[{"output_tokens":80,"model_id":"qwen-max","input_tokens":432}]},
  "request_id":"1f77154c-edc3-9003-b622-816fa2f849cf"}%
  

  Exemplo de solicitação

  Copy

  <?php
  
  # If the environment variable is not configured, you can use a DashScope API key by replacing the next line with: $api_key="sk-xxx".
  # However, we do not recommend hardcoding the API key in a production environment to reduce the risk of key leakage.
  $api_key = getenv("DASHSCOPE_API_KEY");
  $application_id = 'YOUR_APP_ID'; // Replace with your application ID.
  $url = "https://dashscope.aliyuncs.com/api/v1/apps/$application_id/completion";
  
  // Construct the request data.
  $data = [
      "input" => [
          'prompt' => 'Dormitory convention content',
          'biz_params' => [
          'user_defined_params' => [
              '{your_plugin_code}' => [//Replace {your_plugin_code} with your plugin ID.
                  'article_index' => 2
                  ]
              ],
          'user_defined_tokens' => [
              '{your_plugin_code}' => [//Replace {your_plugin_code} with your plugin ID.
                  'user_token' => 'YOUR_TOKEN'//Replace with your token, such as an API key.
              ]
          ]
          ]
      ],
  ];
  // Encode the data as JSON.
  $dataString = json_encode($data);
  
  // Check if json_encode was successful.
  if (json_last_error() !== JSON_ERROR_NONE) {
      die("JSON encoding failed with error: " . json_last_error_msg());
  }
  
  // Initialize a cURL session.
  $ch = curl_init($url);
  
  // Set cURL options.
  curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
  curl_setopt($ch, CURLOPT_POSTFIELDS, $dataString);
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  curl_setopt($ch, CURLOPT_HTTPHEADER, [
      'Content-Type: application/json',
      'Authorization: Bearer ' . $api_key
  ]);
  
  // Execute the request.
  $response = curl_exec($ch);
  
  // Check if the cURL execution was successful.
  if ($response === false) {
      die("cURL Error: " . curl_error($ch));
  }
  
  // Get the HTTP status code.
  $status_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
  // Close the cURL session.
  curl_close($ch);
  // Decode the response data.
  $response_data = json_decode($response, true);
  // Process the response.
  if ($status_code == 200) {
      if (isset($response_data['output']['text'])) {
          echo "{$response_data['output']['text']}\n";
      } else {
          echo "No text in response.\n";
      }
  }else {
      if (isset($response_data['request_id'])) {
          echo "request_id={$response_data['request_id']}\n";}
      echo "code={$status_code}\n";
      if (isset($response_data['message'])) {
          echo "message={$response_data['message']}\n";}
      else {
          echo "message=Unknown error\n";}
  }
  ?>
  

  Exemplo de resposta

  Copy

  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 more about the convention or other information, please feel free to ask.
  

  Dependências:

  Copy

  npm install axios
  

  Exemplo de solicitação

  Copy

  const axios = require('axios');
  async function callDashScope() {
      // If the environment variable is not configured, you can use a DashScope API key by replacing the next line with: apiKey='sk-xxx'.
      // However, we do not recommend hardcoding the API key in a production environment to reduce the risk of key leakage.
      const apiKey = process.env.DASHSCOPE_API_KEY;
      const appId = 'YOUR_APP_ID';// Replace with your application ID.
      const pluginCode = 'YOUR_PLUGIN_CODE';// Replace with your plugin ID.
      const url = `https://dashscope.aliyuncs.com/api/v1/apps/${appId}/completion`;
  
      const data = {
          input: {
              prompt: "Dormitory convention content",
              biz_params: {
                  user_defined_params: {
                      [pluginCode]: {
                          // `article_index` is a sample parameter for the custom plugin. Replace it with your parameter.
                          'article_index': 6
                      }
                  },
                  user_defined_tokens: {
                      [pluginCode]: {
                          // Replace YOUR_TOKEN with your authentication token, such as an API key.
                          user_token: 'YOUR_TOKEN'
                      }
                  }
              }
          },
          parameters: {},
          debug: {}
      };
  
      try {
          console.log("Sending request to DashScope API...");
  
          const response = await axios.post(url, data, {
              headers: {
                  'Authorization': `Bearer ${apiKey}`,
                  'Content-Type': 'application/json'
              }
          });
  
          if (response.status === 200) {
              if (response.data.output && response.data.output.text) {
                  console.log(`${response.data.output.text}`);
              }
          } else {
              console.log("Request failed:");
              if (response.data.request_id) {
                  console.log(`request_id=${response.data.request_id}`);
              }
              console.log(`code=${response.status}`);
              if (response.data.message) {
                  console.log(`message=${response.data.message}`);
              } else {
                  console.log('message=Unknown error');
              }
          }
      } catch (error) {
          console.error(`Error calling DashScope: ${error.message}`);
          if (error.response) {
              console.error(`Response status: ${error.response.status}`);
              console.error(`Response data: ${JSON.stringify(error.response.data, null, 2)}`);
          }
      }
  }
  callDashScope();
  

  Exemplo de resposta

  Copy

  The sixth article of the dormitory convention states: Develop good sleep habits. Every roommate has the right to rest and the responsibility to ensure others' right to rest. If you need to know more about the regulations, please provide more details.
  

  Exemplo de solicitação

  Copy

  using System.Text;
  
  class Program
  {
      static async Task Main(string[] args)
      {
          // If the environment variable is not configured, you can use a DashScope API key by replacing the next line with: apiKey="sk-xxx".
          // However, we do not recommend hardcoding the API key in a production environment to reduce the risk of key leakage.
          string apiKey = Environment.GetEnvironmentVariable("DASHSCOPE_API_KEY")?? throw new InvalidOperationException("DASHSCOPE_API_KEY environment variable is not set.");;
          string appId = "YOUR_APP_ID";// Replace with your application ID.
  
          if (string.IsNullOrEmpty(apiKey))
          {
              Console.WriteLine("Please make sure the DASHSCOPE_API_KEY environment variable is set.");
              return;
          }
  
          string url = $"https://dashscope.aliyuncs.com/api/v1/apps/{appId}/completion";
  
          using (HttpClient client = new HttpClient())
          {
              client.DefaultRequestHeaders.Add("Authorization", $"Bearer {apiKey}");
              string pluginCode = "your_plugin_code"; // Replace your_plugin_code with your plugin ID.
              // Replace YOUR_TOKEN with your token, such as an API key.
              string jsonContent = $@"{{
                  ""input"": {{
                      ""prompt"": ""Dormitory convention content"",
                      ""biz_params"": {{
                          ""user_defined_params"": {{
                              ""{pluginCode}"": {{
                                  ""article_index"": 2
                              }}
                          }},
                          ""user_defined_tokens"": {{
                              ""{pluginCode}"": {{
                                  ""user_token"": ""YOUR_TOKEN""
                              }}
                          }}
                      }}
                  }},
                  ""parameters"": {{}},
                  ""debug"": {{}}
              }}";
  
              HttpContent content = new StringContent(jsonContent, Encoding.UTF8, "application/json");
  
              try
              {
                  HttpResponseMessage response = await client.PostAsync(url, content);
  
                  if (response.IsSuccessStatusCode)
                  {
                      string responseBody = await response.Content.ReadAsStringAsync();
                      Console.WriteLine("Request successful:");
                      Console.WriteLine(responseBody);
                  }
                  else
                  {
                      Console.WriteLine($"Request failed with status code: {response.StatusCode}");
                      string responseBody = await response.Content.ReadAsStringAsync();
                      Console.WriteLine(responseBody);
                  }
              }
              catch (Exception ex)
              {
                  Console.WriteLine($"Error calling DashScope: {ex.Message}");
              }
          }
      }
  }
  

  Exemplo de resposta

  Copy

  {
      "output": {
          "finish_reason": "stop",
          "session_id": "1a1913a9922a401f8eba36df8ea1a062",
          "text": "The second article of the dormitory convention is as follows:\n\nRoommates must help, care for, and learn from each other to achieve mutual improvement. They must be tolerant, forgiving, respectful, and sincere.\n\nIf you need more details about the convention, please specify."
      },
      "usage": {
          "models": [
              {
                  "output_tokens": 66,
                  "model_id": "qwen-max",
                  "input_tokens": 802
              }
          ]
      },
      "request_id": "04bac806-c5e6-9fab-a846-a66641862be9"
  }
  

  Exemplo de solicitação

  Copy

  package main
  
  import (
    "bytes"
    "encoding/json"
    "fmt"
    "io"
    "net/http"
    "os"
  )
  
  func main() {
    // If the environment variable is not configured, you can use a DashScope API key by replacing the next line with: apiKey := "sk-xxx".
    // However, we do not recommend hardcoding the API key in a production environment to reduce the risk of key leakage.
    apiKey := os.Getenv("DASHSCOPE_API_KEY")
    appId := "YOUR_APP_ID"           // Replace with your application ID.
    pluginCode := "YOUR_PLUGIN_CODE" // Replace with your plugin ID.
  
    if apiKey == "" {
        fmt.Println("Please make sure the DASHSCOPE_API_KEY environment variable is set.")
        return
    }
  
    url := fmt.Sprintf("https://dashscope.aliyuncs.com/api/v1/apps/%s/completion", appId)
  
    // Create the request body.
    requestBody := map[string]interface{}{
        "input": map[string]interface{}{
            "prompt": "Dormitory convention content",
            "biz_params": map[string]interface{}{
                "user_defined_params": map[string]interface{}{
                    pluginCode: map[string]interface{}{
                        "article_index": 10,
                    },
                },
                "user_defined_tokens": map[string]interface{}{
                    pluginCode: map[string]interface{}{
                        "user_token": "YOUR_TOKEN", // Replace with your authentication token, such as an API key.
                    },
                },
            },
        },
        "parameters": map[string]interface{}{},
        "debug":      map[string]interface{}{},
    }
  
    jsonData, err := json.Marshal(requestBody)
    if err != nil {
        fmt.Printf("Failed to marshal JSON: %v\n", err)
        return
    }
  
    // Create an HTTP POST request.
    req, err := http.NewRequest("POST", url, bytes.NewBuffer(jsonData))
    if err != nil {
        fmt.Printf("Failed to create request: %v\n", err)
        return
    }
  
    // Set request headers.
    req.Header.Set("Authorization", "Bearer "+apiKey)
    req.Header.Set("Content-Type", "application/json")
  
    // Send the request.
    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        fmt.Printf("Failed to send request: %v\n", err)
        return
    }
    defer resp.Body.Close()
  
    // Read the response.
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        fmt.Printf("Failed to read response: %v\n", err)
        return
    }
  
    // Process the response.
    if resp.StatusCode == http.StatusOK {
        fmt.Println("Request successful:")
        fmt.Println(string(body))
    } else {
        fmt.Printf("Request failed with status code: %d\n", resp.StatusCode)
        fmt.Println(string(body))
    }
  }
  

  Exemplo de resposta

  Copy

  {
      "output": {
          "finish_reason": "stop",
          "session_id": "b8e051ba7e954ff8919208e7b84430fa",
          "text": "The tenth article of the dormitory convention states that roommates should work together to create and maintain a clean, tidy, aesthetically pleasing, and culturally rich dormitory environment. To understand the full content of the dormitory convention, you may need to view other articles or directly consult the dormitory management department. Is there any other specific content you would like to know about?"
      },
      "usage": {
          "models": [
              {
                  "output_tokens": 70,
                  "model_id": "qwen-max",
                  "input_tokens": 855
              }
          ]
      },
      "request_id": "0921ee34-2754-9616-a826-cea33a0e0a14"
  }
  
  • Python
  • Java
  • HTTP

  Exemplo de solicitação

  Copy

  from http import HTTPStatus
  import os
  # We recommend using DashScope SDK v1.14.0 or later.
  import dashscope
  from dashscope import Application
  
  dashscope.base_http_api_url = 'https://dashscope-intl.aliyuncs.com/api/v1'
  biz_params = {
      # Pass authentication credentials for the agent application's custom plugin.
      # Replace your_plugin_code with your plugin ID and YOUR_TOKEN with your authentication token, such as an API key.
      "user_defined_params": {
          "your_plugin_code": {
              "article_index": 2}},
      "user_defined_tokens": {
          "your_plugin_code": {
              "user_token": "YOUR_TOKEN"}}}
  response = Application.call(
              # If the environment variable is not configured, you can use a DashScope API key by replacing the next line with: api_key="sk-xxx".
              # However, we do not recommend hardcoding the API key in a production environment to reduce the risk of key leakage.
              api_key=os.getenv("DASHSCOPE_API_KEY"),
              app_id='YOUR_APP_ID',
              prompt='Dormitory convention content',
              biz_params=biz_params)
  
  if response.status_code != HTTPStatus.OK:
      print(f'request_id={response.request_id}')
      print(f'code={response.status_code}')
      print(f'message={response.message}')
      print(f'For more information, refer to: https://www.alibabacloud.com/help/en/model-studio/developer-reference/error-code')
  else:
      print('%s\n' % (response.output.text))  # Process and output only the text.
      # print('%s\n' % (response.usage))
  

  Exemplo de resposta

  Copy

  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.
  

  Exemplo de solicitação

  Copy

  import com.alibaba.dashscope.app.*;
  import com.alibaba.dashscope.exception.ApiException;
  import com.alibaba.dashscope.exception.InputRequiredException;
  import com.alibaba.dashscope.exception.NoApiKeyException;
  import com.alibaba.dashscope.utils.JsonUtils;
  import com.alibaba.dashscope.utils.Constants;
  
  public class Main {
    static {
          Constants.baseHttpApiUrl="https://dashscope-intl.aliyuncs.com/api/v1";
      }
      public static void appCall() throws NoApiKeyException, InputRequiredException {
          String bizParams =
                  // Replace {your_plugin_code} with your plugin ID, and YOUR_TOKEN with your token, such as an API key.
                  "{\"user_defined_params\":{\"{your_plugin_code}\":{\"article_index\":2}}," +
                          "\"user_defined_tokens\":{\"{your_plugin_code}\":{\"user_token\":\"YOUR_TOKEN\"}}}";
          ApplicationParam param = ApplicationParam.builder()
                  // If the environment variable is not configured, you can use a DashScope API key by replacing the next line with: .apiKey("sk-xxx").
                  // However, we do not recommend hardcoding the API key in a production environment to reduce the risk of key leakage.
                  .apiKey(System.getenv("DASHSCOPE_API_KEY"))
                  .appId("YOUR_APP_ID")
                  .prompt("Dormitory convention content")
                  .bizParams(JsonUtils.parse(bizParams))
                  .build();
  
          Application application = new Application();
          ApplicationResult result = application.call(param);
          System.out.printf("%s\n",
                  result.getOutput().getText());
      }
      public static void main(String[] args) {
          try {
              appCall();
          } catch (ApiException | NoApiKeyException | InputRequiredException e) {
              System.out.printf("Exception: %s", e.getMessage());
              System.out.println("For more information, refer to: https://www.alibabacloud.com/help/en/model-studio/developer-reference/error-code");
          }
          System.exit(0);
      }
  }
  

  Exemplo de resposta

  Copy

  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 query for more articles, please let me know.
  

  Substitua YOUR_APP_ID pelo ID da sua aplicação, your_plugin_code pelo ID do seu plugin personalizado e YOUR_TOKEN pelo seu token de autenticação.

  • curl
  • PHP
  • Node.js
  • C#
  • Go

  Exemplo de solicitação

  Copy

  curl -X POST https://dashscope-intl.aliyuncs.com/api/v1/apps/YOUR_APP_ID/completion \
  --header "Authorization: Bearer $DASHSCOPE_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
      "input": {
          "prompt": "Dormitory convention content",
          "biz_params":
          {
              "user_defined_params":
              {
                  "{your_plugin_code}":
                      {
                      "article_index": 2
                      }
              },
              "user_defined_tokens":
              {
                  "{your_plugin_code}":
                      {
                      "user_token": "YOUR_TOKEN"
                      }
              }
          }
      },
      "parameters":  {},
      "debug":{}
  }'
  

  Substitua YOUR_APP_ID pelo ID da sua aplicação, {your_plugin_code} pelo ID do seu plugin personalizado e YOUR_TOKEN pelo seu token de autenticação.

  Exemplo de resposta

  Copy

  {"output":{"finish_reason":"stop",
  "session_id":"d3b5c3e269dc40479255a7a02df5c630",
  "text":"The second article of the dormitory convention is: \"Roommates must help, care for, and learn from each other to achieve mutual improvement. They must be tolerant, forgiving, respectful, and sincere.\" This emphasizes the importance of harmonious coexistence and mutual progress among members in dormitory life."},
  "usage":{"models":[{"output_tokens":80,"model_id":"qwen-max","input_tokens":432}]},
  "request_id":"1f77154c-edc3-9003-b622-816fa2f849cf"}%
  

  Exemplo de solicitação

  Copy

  <?php
  
  # If the environment variable is not configured, you can use a DashScope API key by replacing the next line with: $api_key="sk-xxx".
  # However, we do not recommend hardcoding the API key in a production environment to reduce the risk of key leakage.
  $api_key = getenv("DASHSCOPE_API_KEY");
  $application_id = 'YOUR_APP_ID'; // Replace with your application ID.
  $url = "https://dashscope-intl.aliyuncs.com/api/v1/apps/$application_id/completion";
  
  // Construct the request data.
  $data = [
      "input" => [
          'prompt' => 'Dormitory convention content',
          'biz_params' => [
          'user_defined_params' => [
              '{your_plugin_code}' => [//Replace {your_plugin_code} with your plugin ID.
                  'article_index' => 2
                  ]
              ],
          'user_defined_tokens' => [
              '{your_plugin_code}' => [//Replace {your_plugin_code} with your plugin ID.
                  'user_token' => 'YOUR_TOKEN'//Replace with your token, such as an API key.
              ]
          ]
          ]
      ],
  ];
  // Encode the data as JSON.
  $dataString = json_encode($data);
  
  // Check if json_encode was successful.
  if (json_last_error() !== JSON_ERROR_NONE) {
      die("JSON encoding failed with error: " . json_last_error_msg());
  }
  
  // Initialize a cURL session.
  $ch = curl_init($url);
  
  // Set cURL options.
  curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
  curl_setopt($ch, CURLOPT_POSTFIELDS, $dataString);
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  curl_setopt($ch, CURLOPT_HTTPHEADER, [
      'Content-Type: application/json',
      'Authorization: Bearer ' . $api_key
  ]);
  
  // Execute the request.
  $response = curl_exec($ch);
  
  // Check if the cURL execution was successful.
  if ($response === false) {
      die("cURL Error: " . curl_error($ch));
  }
  
  // Get the HTTP status code.
  $status_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
  // Close the cURL session.
  curl_close($ch);
  // Decode the response data.
  $response_data = json_decode($response, true);
  // Process the response.
  if ($status_code == 200) {
      if (isset($response_data['output']['text'])) {
          echo "{$response_data['output']['text']}\n";
      } else {
          echo "No text in response.\n";
      }
  }else {
      if (isset($response_data['request_id'])) {
          echo "request_id={$response_data['request_id']}\n";}
      echo "code={$status_code}\n";
      if (isset($response_data['message'])) {
          echo "message={$response_data['message']}\n";}
      else {
          echo "message=Unknown error\n";}
  }
  ?>
  

  Exemplo de resposta

  Copy

  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 more about the convention or other information, please feel free to ask.
  

  Dependências:

  Copy

  npm install axios
  

  Exemplo de solicitação

  Copy

  const axios = require('axios');
  async function callDashScope() {
      // If the environment variable is not configured, you can use a DashScope API key by replacing the next line with: apiKey='sk-xxx'.
      // However, we do not recommend hardcoding the API key in a production environment to reduce the risk of key leakage.
      const apiKey = process.env.DASHSCOPE_API_KEY;
      const appId = 'YOUR_APP_ID';// Replace with your application ID.
      const pluginCode = 'YOUR_PLUGIN_CODE';// Replace with your plugin ID.
      const url = `https://dashscope-intl.aliyuncs.com/api/v1/apps/${appId}/completion`;
  
      const data = {
          input: {
              prompt: "Dormitory convention content",
              biz_params: {
                  user_defined_params: {
                      [pluginCode]: {
                          // `article_index` is a sample parameter for the custom plugin. Replace it with your parameter.
                          'article_index': 6
                      }
                  },
                  user_defined_tokens: {
                      [pluginCode]: {
                          // Replace YOUR_TOKEN with your authentication token, such as an API key.
                          user_token: 'YOUR_TOKEN'
                      }
                  }
              }
          },
          parameters: {},
          debug: {}
      };
  
      try {
          console.log("Sending request to DashScope API...");
  
          const response = await axios.post(url, data, {
              headers: {
                  'Authorization': `Bearer ${apiKey}`,
                  'Content-Type': 'application/json'
              }
          });
  
          if (response.status === 200) {
              if (response.data.output && response.data.output.text) {
                  console.log(`${response.data.output.text}`);
              }
          } else {
              console.log("Request failed:");
              if (response.data.request_id) {
                  console.log(`request_id=${response.data.request_id}`);
              }
              console.log(`code=${response.status}`);
              if (response.data.message) {
                  console.log(`message=${response.data.message}`);
              } else {
                  console.log('message=Unknown error');
              }
          }
      } catch (error) {
          console.error(`Error calling DashScope: ${error.message}`);
          if (error.response) {
              console.error(`Response status: ${error.response.status}`);
              console.error(`Response data: ${JSON.stringify(error.response.data, null, 2)}`);
          }
      }
  }
  callDashScope();
  

  Exemplo de resposta

  Copy

  The sixth article of the dormitory convention states: Develop good sleep habits. Every roommate has the right to rest and the responsibility to ensure others' right to rest. If you need to know more about the regulations, please provide more details.
  

  Exemplo de solicitação

  Copy

  using System.Text;
  
  class Program
  {
      static async Task Main(string[] args)
      {
          // If the environment variable is not configured, you can use a DashScope API key by replacing the next line with: apiKey="sk-xxx".
          // However, we do not recommend hardcoding the API key in a production environment to reduce the risk of key leakage.
          string apiKey = Environment.GetEnvironmentVariable("DASHSCOPE_API_KEY")?? throw new InvalidOperationException("DASHSCOPE_API_KEY environment variable is not set.");;
          string appId = "YOUR_APP_ID";// Replace with your application ID.
  
          if (string.IsNullOrEmpty(apiKey))
          {
              Console.WriteLine("Please make sure the DASHSCOPE_API_KEY environment variable is set.");
              return;
          }
  
          string url = $"https://dashscope-intl.aliyuncs.com/api/v1/apps/{appId}/completion";
  
          using (HttpClient client = new HttpClient())
          {
              client.DefaultRequestHeaders.Add("Authorization", $"Bearer {apiKey}");
              string pluginCode = "your_plugin_code"; // Replace your_plugin_code with your plugin ID.
              // Replace YOUR_TOKEN with your token, such as an API key.
              string jsonContent = $@"{{
                  ""input"": {{
                      ""prompt"": ""Dormitory convention content"",
                      ""biz_params"": {{
                          ""user_defined_params"": {{
                              ""{pluginCode}"": {{
                                  ""article_index"": 2
                              }}
                          }},
                          ""user_defined_tokens"": {{
                              ""{pluginCode}"": {{
                                  ""user_token"": ""YOUR_TOKEN""
                              }}
                          }}
                      }}
                  }},
                  ""parameters"": {{}},
                  ""debug"": {{}}
              }}";
  
              HttpContent content = new StringContent(jsonContent, Encoding.UTF8, "application/json");
  
              try
              {
                  HttpResponseMessage response = await client.PostAsync(url, content);
  
                  if (response.IsSuccessStatusCode)
                  {
                      string responseBody = await response.Content.ReadAsStringAsync();
                      Console.WriteLine("Request successful:");
                      Console.WriteLine(responseBody);
                  }
                  else
                  {
                      Console.WriteLine($"Request failed with status code: {response.StatusCode}");
                      string responseBody = await response.Content.ReadAsStringAsync();
                      Console.WriteLine(responseBody);
                  }
              }
              catch (Exception ex)
              {
                  Console.WriteLine($"Error calling DashScope: {ex.Message}");
              }
          }
      }
  }
  

  Exemplo de resposta

  Copy

  {
      "output": {
          "finish_reason": "stop",
          "session_id": "1a1913a9922a401f8eba36df8ea1a062",
          "text": "The second article of the dormitory convention is as follows:\n\nRoommates must help, care for, and learn from each other to achieve mutual improvement. They must be tolerant, forgiving, respectful, and sincere.\n\nIf you need more details about the convention, please specify."
      },
      "usage": {
          "models": [
              {
                  "output_tokens": 66,
                  "model_id": "qwen-max",
                  "input_tokens": 802
              }
          ]
      },
      "request_id": "04bac806-c5e6-9fab-a846-a66641862be9"
  }
  

  Exemplo de solicitação

  Copy

  package main
  
  import (
    "bytes"
    "encoding/json"
    "fmt"
    "io"
    "net/http"
    "os"
  )
  
  func main() {
    // If the environment variable is not configured, you can use a DashScope API key by replacing the next line with: apiKey := "sk-xxx".
    // However, we do not recommend hardcoding the API key in a production environment to reduce the risk of key leakage.
    apiKey := os.Getenv("DASHSCOPE_API_KEY")
    appId := "YOUR_APP_ID"           // Replace with your application ID.
    pluginCode := "YOUR_PLUGIN_CODE" // Replace with your plugin ID.
  
    if apiKey == "" {
        fmt.Println("Please make sure the DASHSCOPE_API_KEY environment variable is set.")
        return
    }
  
    url := fmt.Sprintf("https://dashscope-intl.aliyuncs.com/api/v1/apps/%s/completion", appId)
  
    // Create the request body.
    requestBody := map[string]interface{}{
        "input": map[string]interface{}{
            "prompt": "Dormitory convention content",
            "biz_params": map[string]interface{}{
                "user_defined_params": map[string]interface{}{
                    pluginCode: map[string]interface{}{
                        "article_index": 10,
                    },
                },
                "user_defined_tokens": map[string]interface{}{
                    pluginCode: map[string]interface{}{
                        "user_token": "YOUR_TOKEN", // Replace with your authentication token, such as an API key.
                    },
                },
            },
        },
        "parameters": map[string]interface{}{},
        "debug":      map[string]interface{}{},
    }
  
    jsonData, err := json.Marshal(requestBody)
    if err != nil {
        fmt.Printf("Failed to marshal JSON: %v\n", err)
        return
    }
  
    // Create an HTTP POST request.
    req, err := http.NewRequest("POST", url, bytes.NewBuffer(jsonData))
    if err != nil {
        fmt.Printf("Failed to create request: %v\n", err)
        return
    }
  
    // Set request headers.
    req.Header.Set("Authorization", "Bearer "+apiKey)
    req.Header.Set("Content-Type", "application/json")
  
    // Send the request.
    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        fmt.Printf("Failed to send request: %v\n", err)
        return
    }
    defer resp.Body.Close()
  
    // Read the response.
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        fmt.Printf("Failed to read response: %v\n", err)
        return
    }
  
    // Process the response.
    if resp.StatusCode == http.StatusOK {
        fmt.Println("Request successful:")
        fmt.Println(string(body))
    } else {
        fmt.Printf("Request failed with status code: %d\n", resp.StatusCode)
        fmt.Println(string(body))
    }
  }
  

  Exemplo de resposta

  Copy

  {
      "output": {
          "finish_reason": "stop",
          "session_id": "b8e051ba7e954ff8919208e7b84430fa",
          "text": "The tenth article of the dormitory convention states that roommates should work together to create and maintain a clean, tidy, aesthetically pleasing, and culturally rich dormitory environment. To understand the full content of the dormitory convention, you may need to view other articles or directly consult the dormitory management department. Is there any other specific content you would like to know about?"
      },
      "usage": {
          "models": [
              {
                  "output_tokens": 70,
                  "model_id": "qwen-max",
                  "input_tokens": 855
              }
          ]
      },
      "request_id": "0921ee34-2754-9616-a826-cea33a0e0a14"
  }
  

​

Repasse de parâmetros de nó personalizado

Este tópico utiliza o exemplo de Consulta de divisões administrativas por nome da cidade para demonstrar como passar parâmetros de nó personalizado para uma aplicação através de uma chamada de API. O exemplo a seguir mostra como passar parâmetros personalizados para o nó inicial em uma Workflow Application.

​

Uso

​

Etapa 1: Configurar parâmetros de nó personalizado

Acesse a página My Applications no console do Model Studio. Selecione uma Workflow Application e defina parâmetros personalizados para seu nó inicial. Para este exemplo, crie uma variável String chamada city. Em seguida, insira as variáveis city e query no prompt e Publish a aplicação.

​

Etapa 2: Fazer uma chamada de API

Ao realizar a chamada de API, passe o valor de city no campo biz_params e o valor de query no campo prompt.

​

Documentação relacionada

Plugin personalizado: Saiba como criar um plugin personalizado. Invocação de aplicação: Saiba como invocar aplicações e explorar mais casos de uso. API de invocação de aplicação: Consulte a lista completa de parâmetros e exemplos de invocação.