Receive task completion notifications via HTTP callback or MQ

Typically, deploy the HTTP callback endpoint in your business system to receive asynchronous event notifications. It must meet these requirements:

• Request URL: An HTTP URL accessible over the public network or an Alibaba Cloud VPC.
• Request method: POST.
• Request body: JSON format containing the asynchronous task completion event data. You can view the exact event structure in the EventBridge console. Example:

{
    "datacontenttype": "application/json;charset=utf-8",
    "aliyunaccountid": "xxxxx",
    "aliyunpublishtime": "2023-10-25T01:45:16.993Z",
    "data": {
        "start_time": "2023-10-25 09:45:09",
        "user_api_unique_key": "apikey:v1:audio:asr:transcription:paraformer-8k-v2",
        "task_status": "SUCCEEDED",
        "contain_result": false,
        "end_time": "2023-10-25 09:45:16",
        "task_id": "a154c328-xxxx-xxxx-xxxx-e52a9a7e9a35",
        "region": "cn-beijing",
        "request_id": "108f38f5-xxxx-xxxx-xxxx-6504db9080b3",
        "api_key_id": "1250"
    },
    "aliyunoriginalaccountid": "xxxxxxxx",
    "specversion": "1.0",
    "aliyuneventbusname": "default",
    "id": "81765e5b-xxxx-xxxx-xxxx-bbad8dde2bd9",
    "source": "acs.dashscope",
    "time": "2023-1-25T01:45:16.969Z",
    "aliyunregionid": "cn-beijing",
    "type": "dashscope:System:AsyncTaskFinish"
}

The EventBridge console lets you query events delivered by Alibaba Cloud Model Studio.

1. Log on to your Alibaba Cloud primary account and go to the EventBridge console. Switch to the China (Beijing) region. In the navigation pane on the left, select Event buses and click default to enter the default event bus for cloud services.

   Alibaba Cloud Model Studio uses the default event bus by default.

2. Click Event tracking and enter query conditions to find asynchronous task completion events from Alibaba Cloud Model Studio.

   • Event source: Search for and select acs.dashscope, indicating the event originates from DashScope (also known as Lingji Model Service, an underlying service of Alibaba Cloud Model Studio).
   • Event type: Search for and select dashscope:System:AsyncTaskFinish, indicating an asynchronous task completion event.

3. Click Details to view the details of the asynchronous task completion events reported by Alibaba Cloud Model Studio.

{
    "datacontenttype": "application/json;charset=utf-8",
    "aliyunaccountid": "xxxxx",
    "aliyunpublishtime": "2023-10-25T01:45:16.993Z",
    "data": {
        "start_time": "2023-10-25 09:45:09",
        "user_api_unique_key": "apikey:v1:audio:asr:transcription:paraformer-8k-v2",
        "task_status": "SUCCEEDED",
        "contain_result": false,
        "end_time": "2023-10-25 09:45:16",
        "task_id": "a154c328-xxxx-xxxx-xxxx-e52a9a7e9a35",
        "region": "cn-beijing",
        "request_id": "108f38f5-xxxx-xxxx-xxxx-6504db9080b3",
        "api_key_id": "1250"
    },
    "aliyunoriginalaccountid": "xxxxxxxx",
    "specversion": "1.0",
    "aliyuneventbusname": "default",
    "id": "81765e5b-xxxx-xxxx-xxxx-bbad8dde2bd9",
    "source": "acs.dashscope",
    "time": "2023-1-25T01:45:16.969Z",
    "aliyunregionid": "cn-beijing",
    "type": "dashscope:System:AsyncTaskFinish"
}

1. In the navigation pane on the left, select Event rules and click Create rule.

2. Configure basic information: Enter a custom rule name and description.

3. Configure event pattern: Specify which events to forward.

   • Event source: Search for and select acs.dashscope, indicating the event originates from Alibaba Cloud Model Studio.

   • Event type: Search for and select dashscope:System:AsyncTaskFinish, indicating an asynchronous task completion event.

   • Pattern content: Configure filter conditions to match specific events. Use fields from the event details queried in Step 2. For pattern syntax, see Event patterns. Examples:

     • Default: After selecting the event source and type, the pattern defaults to the following, forwarding all dashscope:System:AsyncTaskFinish events.

{
  "source": ["acs.dashscope"],
  "type": ["dashscope:System:AsyncTaskFinish"]
}

• Filter by field: Forward only events where the user_api_unique_key field ends with :paraformer-8k-v2—that is, only events for the paraformer-8k-v2 model. Event type is dashscope:System:AsyncTaskFinish.

{
  "source": ["acs.dashscope"],
  "type": ["dashscope:System:AsyncTaskFinish"],
  "data": {
    "user_api_unique_key": [
      {"suffix": ":paraformer-8k-v2"}
    ]
  }
}

4. Configure event targets: Supports multiple event target types, including HTTP callback URLs and RocketMQ message queues. See Step 4 for details.

1. Configure event target: Forward events to an HTTP callback URL.

   • Service type: Select “HTTP”.

   • URL: Enter the HTTP service endpoint.

   • Body: Select “Complete event”.

   • Network type: Choose based on your service endpoint.

     • HTTP supports both public and private networks. If you select private network, configure VPC, vSwitch, and SecurityGroup.

2. Click Confirm to save the rule. If the event target shows an HTTP style, the configuration succeeded.

   The rule’s Event target column now displays HTTP (1).

To receive events via a RocketMQ message queue, first prepare a RocketMQ queue and then receive messages.

1. Go to the RocketMQ console. In the navigation pane on the left, select Instances and click Create Instance.

   Instance ID example: rmq-cn-nwy*******.

2. Create a Topic for the instance and enter a custom topic name.

3. Create a Group for the instance and enter a custom group name.

The EventBridge console lets you query events delivered by Alibaba Cloud Model Studio.

1. Log on to your Alibaba Cloud primary account and go to the EventBridge console. Switch to the China (Beijing) region. In the navigation pane on the left, select Event buses and click default to enter the default event bus for cloud services.

   Alibaba Cloud Model Studio uses the default event bus by default.

2. Click Event tracking and enter query conditions to find asynchronous task completion events from Alibaba Cloud Model Studio.

   • Event source: Search for and select acs.dashscope, indicating the event originates from DashScope (also known as Lingji Model Service, an underlying service of Alibaba Cloud Model Studio).
   • Event type: Search for and select dashscope:System:AsyncTaskFinish, indicating an asynchronous task completion event.

3. Click Details to view the details of the asynchronous task completion events reported by Alibaba Cloud Model Studio.

{
    "datacontenttype": "application/json;charset=utf-8",
    "aliyunaccountid": "xxxxx",
    "aliyunpublishtime": "2023-10-25T01:45:16.993Z",
    "data": {
        "start_time": "2023-10-25 09:45:09",
        "user_api_unique_key": "apikey:v1:audio:asr:transcription:paraformer-8k-v2",
        "task_status": "SUCCEEDED",
        "contain_result": false,
        "end_time": "2023-10-25 09:45:16",
        "task_id": "a154c328-xxxx-xxxx-xxxx-e52a9a7e9a35",
        "region": "cn-beijing",
        "request_id": "108f38f5-xxxx-xxxx-xxxx-6504db9080b3",
        "api_key_id": "1250"
    },
    "aliyunoriginalaccountid": "xxxxxxxx",
    "specversion": "1.0",
    "aliyuneventbusname": "default",
    "id": "81765e5b-xxxx-xxxx-xxxx-bbad8dde2bd9",
    "source": "acs.dashscope",
    "time": "2023-1-25T01:45:16.969Z",
    "aliyunregionid": "cn-beijing",
    "type": "dashscope:System:AsyncTaskFinish"
}

1. In the navigation pane on the left, select Event rules and click Create rule.

2. Configure basic information: Enter a custom rule name and description.

3. Configure event pattern: Specify which events to forward.

   • Event source: Search for and select acs.dashscope, indicating the event originates from Alibaba Cloud Model Studio.

   • Event type: Search for and select dashscope:System:AsyncTaskFinish, indicating an asynchronous task completion event.

   • Pattern content: Configure filter conditions to match specific events. Use fields from the event details queried in Step 2. For pattern syntax, see Event patterns. Examples:

     • Default: After selecting the event source and type, the pattern defaults to the following, forwarding all dashscope:System:AsyncTaskFinish events.

{
  "source": ["acs.dashscope"],
  "type": ["dashscope:System:AsyncTaskFinish"]
}

• Filter by field: Forward only events where the user_api_unique_key field ends with :paraformer-8k-v2—that is, only events for the paraformer-8k-v2 model. Event type is dashscope:System:AsyncTaskFinish.

{
  "source": ["acs.dashscope"],
  "type": ["dashscope:System:AsyncTaskFinish"],
  "data": {
    "user_api_unique_key": [
      {"suffix": ":paraformer-8k-v2"}
    ]
  }
}

4. Configure event targets: Supports multiple event target types, including HTTP callback URLs and RocketMQ message queues. See Step 4 for details.

After creating RocketMQ, open the event target configuration interface and select your RocketMQ instance.

• Service type: Select “Message Queue for RocketMQ”.
• Version: The RocketMQ version you created, such as RocketMQ 5.x.
• Instance ID: The instance ID of your RocketMQ instance. See Step 1.
• Topic: The topic name you created. See Step 1.

After configuration, submit an asynchronous task. Once complete, view the message in your configured RocketMQ topic.

• Viewing messages online in RocketMQ requires enabling the one-click send/receive experience feature.
• The one-click send/receive experience feature is implemented based on Function Compute. If you exceed the free trial quota, a small fee will be charged. See Function Compute billing rules.

On the Topic Management page, find the topic you created and click Details in the Actions column on the right.

On the topic details page, switch to the One-click send/receive experience tab. In the Basic Features section, select a consumption method, such as PushConsumer consumption.

After configuring parameters like Topic Name and Group ID, click Run to start receiving messages. The Run Results tab displays a list of received messages, including message ID and receipt time.

Use the RocketMQ Java SDK to implement the following logic: subscribe to the relevant topic and implement a message listener. Process the message upon receipt.

The following example shows Java client code for RocketMQ 5.0.

• In a Maven project, add this dependency:

<dependency>
  <groupId>org.apache.rocketmq</groupId>
  <artifactId>rocketmq-client-java</artifactId>
  <version>5.0.4</version>
</dependency>

• Example code for consuming MQ messages:

import com.alibaba.fastjson2.JSON;
import org.apache.rocketmq.client.apis.*;
import org.apache.rocketmq.client.apis.consumer.ConsumeResult;
import org.apache.rocketmq.client.apis.consumer.FilterExpression;
import org.apache.rocketmq.client.apis.consumer.FilterExpressionType;
import org.apache.rocketmq.client.apis.consumer.PushConsumer;
import org.apache.rocketmq.shaded.org.slf4j.Logger;
import org.apache.rocketmq.shaded.org.slf4j.LoggerFactory;
import java.io.IOException;
import java.nio.ByteBuffer;
import java.util.Collections;

public class ConsumerExample {
    private static final Logger LOGGER = LoggerFactory.getLogger(ConsumerExample.class);

    private ConsumerExample() {
    }

    public static void main(String[] args) throws ClientException, IOException, InterruptedException {
        /*
          Endpoint obtained from the Endpoints tab on the instance details page in the console.
          If accessing from an Alibaba Cloud ECS instance over the internal network, use the VPC endpoint.
          If accessing from a local public network or on-premises IDC, use the public endpoint. Public endpoint access requires enabling public network access for the instance.
         */
        String endpoints = "xxxx";
        // Specify the target topic to subscribe to. The topic must be created in the console beforehand; otherwise, an error occurs.
        String topic = "xxxx";
        // Specify the consumer group for the consumer. The group must be created in the console beforehand; otherwise, an error occurs.
        String consumerGroup = "xxxx";
        final ClientServiceProvider provider = ClientServiceProvider.loadService();
        ClientConfigurationBuilder builder = ClientConfiguration.newBuilder().setEndpoints(endpoints);
        /*
          If using a public endpoint, configure the instance username and password, available on the instance details page in the console.
          If accessing from an Alibaba Cloud ECS instance over the internal network, skip this configuration—the server intelligently retrieves VPC info.
         */
        builder.setCredentialProvider(new StaticSessionCredentialsProvider("xxxx", "xxxx"));
        ClientConfiguration clientConfiguration = builder.build();
        // Subscription filter rule—subscribe to messages with any tag.
        String tag = "*";
        FilterExpression filterExpression = new FilterExpression(tag, FilterExpressionType.TAG);
        // Initialize PushConsumer with consumer group, communication parameters, and subscription relationship.
        PushConsumer pushConsumer = provider.newPushConsumerBuilder()
        .setClientConfiguration(clientConfiguration)
        // Set consumer group.
        .setConsumerGroup(consumerGroup)
        // Set pre-bound subscription relationships.
        .setSubscriptionExpressions(Collections.singletonMap(topic, filterExpression))
        // Set message listener.
        .setMessageListener(messageView -> {
            try {
                // Process message and return consumption result.
                ByteBuffer buffer = messageView.getBody();
                ByteBuffer newBuffer = ByteBuffer.allocate(buffer.capacity());
                for (int i = 0; i < buffer.capacity(); i++) {
                    newBuffer.put(buffer.get(i));
                }
                String result = new String(newBuffer.array());
                LOGGER.info("Consume message={}", JSON.toJSONString(result));
                System.out.println(result);
                return ConsumeResult.SUCCESS;
            } catch (Exception e) {
                LOGGER.error("deal message has error", e);
                return ConsumeResult.FAILURE;
            }
        })
        .build();
        Thread.sleep(Long.MAX_VALUE);

        // Close PushConsumer when no longer needed.
        pushConsumer.close();
    }
}