AskLuma - EventBridge - Alibaba Cloud Documentation Center

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

eventbridge:AskLuma

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AgentName	string	Yes	The name of the agent.	demo-luma-agent
Question	string	Yes	The natural language question.	Help me collect statistics on recent order data
ConversationId	string	No	The conversation ID. This parameter is required for multi-turn conversations.	conv_1474xxx32_593b9d08-9
MaxRows	integer	No	The maximum number of rows to return.	100

Response elements

Element	Type	Description	Example
	object
Code	string	The error code.	AgentNotFound
Data	AskLumaResult	The response body.
Message	string	The error message. This value is null if the request is successful.	Agent with name 'xxx' not found for account 1186xxx
RequestId	string	The request ID.	97FB3BAE-XXXXXX-36435495B7EB
Success	boolean	Indicates whether the request was successful.	true

Examples

Success response

JSON format

{
  "Code": "AgentNotFound",
  "Data": {
    "MessageId": "msg_xxx",
    "ConversationId": "conv_xxx",
    "Status": "RUNNING, SUCCEEDED, FAILED, TIMEOUT",
    "Content": {
      "TextAttachments": [
        "\"**top 5 城市**: 北京(120)...\""
      ],
      "QueryAttachments": [
        {
          "QueryId": "sqlx-0-a1b2c3d4",
          "Query": "\"SELECT city, COUNT(*) AS cnt FROM events GROUP BY city\"",
          "Result": {
            "IsTruncated": false,
            "RowCount": 2,
            "Rows": "[[\"Beijing\",120],[\"Shanghai\",98]]",
            "Schema": [
              {
                "Name": "name",
                "Type": "VARCHAR"
              }
            ],
            "TotalRows": 2
          }
        }
      ],
      "MessageAttachments": [
        {
          "Id": "msg_123456_a1b2c3d4",
          "Role": "assistant",
          "Content": "根据您的问题，我将查询过去7天的事件量...",
          "Metadata": {
            "Attachments": {
              "Name": "acs:eventbridge:cn-hangzhou:12345:eventhouse/system-rocketmq/namespace/rmq-cn-xxx/table/order",
              "Type": "inner-resource/event-table"
            }
          },
          "ToolCallId": "call_xxx",
          "ToolCalls": [
            {
              "Id": "call_xxx",
              "Type": "function",
              "Function": {
                "Name": "discoverMetadata",
                "Arguments": "{}"
              }
            }
          ],
          "Reasoning": ""
        }
      ]
    },
    "IsError": false,
    "ErrorCode": "ExecutionFailed, Timeout, RateLimited, InternalError, ConversationExpired",
    "ErrorMessage": "Agent with name 'xxx' not found for account 1186xxx",
    "StorageTruncated": true,
    "ClarificationNeeded": false,
    "ClarificationQuestion": "Which database does the employee table you are referring to belong to?",
    "WikiVersion": "eventhouse-multisource-demo-v1",
    "Constraints": {
      "BeginTime": 1717200000000,
      "EndTime": 1717200000000
    }
  },
  "Message": "Agent with name 'xxx' not found for account 1186xxx",
  "RequestId": "97FB3BAE-XXXXXX-36435495B7EB",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
403	ServiceNotEnable	Service not enable

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.