ListIntentions-阿里云帮助中心

Query intent for the Annotation Center list.

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

outboundbot:ListIntentions

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
BotId	string	No	Bot ID Note Get this from the DescribeScript API. The corresponding parameter is ChatbotId.	chatbot-cn-n7QmzrUnNe
UserNick	string	No	Intent Name Note Use this for fuzzy queries based on keywords.	知道
PageIndex	integer	No	Page Number	1
PageSize	integer	No	Number.	10
IntentId	integer	No	Intent ID	10717802
Environment	integer	No	Environment 1: Private Cloud 2: Public Cloud	2
AnnotationMissionDataSourceType	integer	Yes	Important This parameter is required. Select based on the scenario. Annotation data source. 1: Outbound Call 2: Navigation	1
ScriptId	string	Yes	Scenario ID	c5c5d8c0-c0f1-48a7-be2b-dc46006d888a
InstanceId	string	Yes	Instance ID	e5035654-1745-484a-8c5b-165f7c7bcd79

Response elements

Element	Type	Description	Example
	object	BaseResponse
Success	boolean	Is Success	true
Code	string	API Status Code	OK
Message	string	API Message	Success
Data	object	Returned Data
IntentList	array<object>	Intent List
	array<object>	Intent Data
BotId	integer	Bot ID (Deprecated)	chatbot-cn-n7QmzrUnNe
DialogId	string	Conversation Flow ID	50099
Name	string	Intent Name	知道了
Alias	array	Intent Alias
	string	Intent Alias	嗯明白了
Id	integer	Intent ID	10717802
BotName	string	Bot Name	111
Language	string	Language English (en-us) Chinese (zh-cn)	zh-cn
Type	integer	Intent Type: 0: Normal intent; 1: UNKNOWN; 2: TableQA intent; 3: Generated from standard intent	0
TableId	integer	Table ID	43258
UserSay	array<object>	User Say List
	array<object>	User Say Data
Id	string	The ID of the user utterance.	17448458
FromId	string	Source ID Important Invalid content	1234567
Strict	boolean	Is Strict Match	true
UserSayData	array<object>	User Say List
	object	User Say Data
SlotId	string	Slot Unique Identifier	9ec31b50-32b8-11eb-9478-19d2d885afdb
Text	string	Expression	知道
RuleCheck	array<object>	LGF Intent Expression
	object	LGF Intent Expression
Strict	boolean	Is Strict Match	true
Text	string	Expression Value	知道
Warning	array	Warning Message
	string	Warning Message	“”
Error	array	Error Message
	string	Error Message	“”
Slot	array<object>	Intent Slot Information
	array<object>	Intent Slot Information
Id	string	Slot Unique Identifier	9ec31b50-32b8-11eb-9478-19d2d885afdb
Name	string	Slot Name	知道
IsArray	boolean	Is Array: true: Yes false: No	false
IsEncrypt	boolean	Is Encrypted Important Invalid content	false
IsInteractive	boolean	Is Interactive Important Invalid content	false
Value	string	Slot Tagging Result	@知道
Tags	array<object>	Slot Tagging Labels
	object	Slot Tagging Labels
UserSayId	string	User Say Unique Identifier for the Label	17448458
Value	string	The value of the tag is the result of tagging an intent expression.	你知道xxxx？
Question	array	Slot Follow-up Question
	string	Slot Follow-up Question	你知道？
IsNecessary	boolean	Is Required Slot: true: Yes false: No	true
LifeSpan	integer	Slot Lifecycle	0
FeedbackType	string	Feedback Type Important Invalid content	test
FeedbackFunctions	array<object>	The follow-up question function. Important This parameter is invalid.
	array<object>	Follow-up question function
Code	string	API Status Code	OK
Description	string	Follow-up Question Description	GA setup for HPC cn4-HPC-EndUserServer-GlobalAccelerator
Function	string	Follow-up Question Function	count
Name	string	Function Name	方欣云呼系统每日拨测_2024年11月
AliyunService	string	Alibaba Cloud Service	test
AliyunFunction	string	Alibaba Cloud Function Name	test
EndPoint	string	Endpoint	cn-hangzhou.log.aliyuncs.com
Type	string	Follow-up Question Type	cluster
Switch	array<object>	Feature Switch. Values: on: Enabled off: Disabled
	object	Branch Type
Id	string	Condition ID	b9932604-08ae-4525-bbe5-c8cce3066070
Label	string	Follow-up Question Label	SQL_SUB_QUERY
Type	string	Type	PASSKEY
Value	string	Condition Value	BASE_VALIDATE_FILTER_SWITCH
Name	string	Condition Name	测试0609_20241021_101018_复制_复制_复制
Params	object	Parameters
	any	Parameter Content	{"type":2}
Success	boolean	Indicates whether the operation was successful.	true
Message	string	API Message	Success
BotId	string	Bot ID	chatbot-cn-n7QmzrUnNe
HttpStatusCode	integer	HTTP Status Code	200
RequestId	string	Request ID	254EB995-DEDF-48A4-9101-9CA5B72FFBCC

Examples

Success response

JSON format

{
  "Success": true,
  "Code": "OK",
  "Message": "Success",
  "Data": {
    "IntentList": [
      {
        "BotId": 0,
        "DialogId": "50099",
        "Name": "知道了",
        "Alias": [
          "嗯明白了"
        ],
        "Id": 10717802,
        "BotName": "111",
        "Language": "zh-cn\n",
        "Type": 0,
        "TableId": 43258,
        "UserSay": [
          {
            "Id": "17448458",
            "FromId": "1234567",
            "Strict": true,
            "UserSayData": [
              {
                "SlotId": "9ec31b50-32b8-11eb-9478-19d2d885afdb\n",
                "Text": "知道"
              }
            ]
          }
        ],
        "RuleCheck": [
          {
            "Strict": true,
            "Text": "知道",
            "Warning": [
              "“”"
            ],
            "Error": [
              "“”"
            ]
          }
        ],
        "Slot": [
          {
            "Id": "9ec31b50-32b8-11eb-9478-19d2d885afdb\n",
            "Name": "知道",
            "IsArray": false,
            "IsEncrypt": false,
            "IsInteractive": false,
            "Value": "@知道",
            "Tags": [
              {
                "UserSayId": "17448458",
                "Value": "你知道xxxx？"
              }
            ],
            "Question": [
              "你知道？"
            ],
            "IsNecessary": true,
            "LifeSpan": 0,
            "FeedbackType": "test",
            "FeedbackFunctions": [
              {
                "Code": "OK",
                "Description": "GA setup for HPC cn4-HPC-EndUserServer-GlobalAccelerator",
                "Function": "count",
                "Name": "方欣云呼系统每日拨测_2024年11月",
                "AliyunService": "test",
                "AliyunFunction": "test",
                "EndPoint": "cn-hangzhou.log.aliyuncs.com",
                "Type": "cluster",
                "Switch": [
                  {
                    "Id": "b9932604-08ae-4525-bbe5-c8cce3066070",
                    "Label": "SQL_SUB_QUERY",
                    "Type": "PASSKEY",
                    "Value": "BASE_VALIDATE_FILTER_SWITCH",
                    "Name": "测试0609_20241021_101018_复制_复制_复制"
                  }
                ],
                "Params": {
                  "key": "{\"type\":2}"
                }
              }
            ]
          }
        ]
      }
    ],
    "Success": true,
    "Message": "Success",
    "BotId": "chatbot-cn-n7QmzrUnNe\n"
  },
  "HttpStatusCode": 200,
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC"
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.