AskLuma-阿里云帮助中心

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
AgentName	string	Yes	Agent Name	demo-luma-agent
Question	string	Yes	Natural language question	帮我统计一下最近的订单数据。
ConversationId	string	No	Conversation ID, required for multi-turn conversations	conv_1474xxx32_593b9d08-9
MaxRows	integer	No	Maximum number of rows to return	100

Response elements

Element	Type	Description	Example
	object
Message	string	Error message (null on success)	Agent with name 'xxx' not found for account 1186xxx
RequestId	string	The returned RequestId	97FB3BAE-XXXXXX-36435495B7EB
Data	AskLumaResult	Business response body
Code	string	Error code	AgentNotFound
Success	boolean	Whether the request was successful	true

Examples

Success response

JSON format

{
  "Message": "Agent with name 'xxx' not found for account 1186xxx",
  "RequestId": "97FB3BAE-XXXXXX-36435495B7EB",
  "Data": {
    "MessageId": "msg_xxx",
    "ConversationId": "conv_xxx",
    "Status": "RUNNING, SUCCEEDED, FAILED, TIMEOUT",
    "Content": {
      "TextAttachments": [
        "\"**top 5 城市**: 北京(120)...\""
      ],
      "QueryAttachments": [
        {
          "Query": "\"SELECT city, COUNT(*) AS cnt FROM events GROUP BY city\"",
          "Result": {
            "Schema": [
              {
                "Name": "name",
                "Type": "VARCHAR"
              }
            ],
            "Rows": "[[\"北京\",120],[\"上海\",98]] ",
            "RowCount": 2,
            "TotalRows": 2,
            "IsTruncated": false
          }
        }
      ],
      "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": "{}"
              }
            }
          ]
        }
      ]
    },
    "IsError": false,
    "ErrorCode": "ExecutionFailed, Timeout, RateLimited, InternalError, ConversationExpired",
    "ErrorMessage": "Agent with name 'xxx' not found for account 1186xxx",
    "StorageTruncated": true,
    "ClarificationNeeded": false,
    "ClarificationQuestion": "您指的是哪个数据库中的员工表？",
    "Constraints": {
      "BeginTime": 1717200000000,
      "EndTime": 1717200000000
    }
  },
  "Code": "AgentNotFound",
  "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.