Generates a sample output format for Tag Mining in LightApp.
Debug
You can run this API directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After a successful run, OpenAPI Explorer can automatically generate SDK code examples.
Debug
Authorization information
The following table describes the authorization information for this API. You can use it in the Action element of a RAM policy statement to grant RAM users or RAM roles the permission to call this API. Details are as follows:
- Action: the specific permission point.
- Access level: the access level of each action. Valid values: Write, Read, or List.
-
Resource type: the resource types that support authorization for the action. Details are as follows:
- For required resource types, an asterisk (*) is added as a prefix.
- For actions that do not support resource-level authorization,
All resourcesis used.
- Condition key: the condition keys defined by the cloud service itself.
- Related action: other permissions required to successfully perform the action. The caller must also have the permissions of the related actions for the operation to succeed.
| Action | Access level | Resource type | Condition key | Related action |
|---|---|---|---|---|
| quanmiaolightapp:GenerateOutputFormat | none | *All resources * |
| None |
Request syntax
Request parameters
| Name | Type | Required | Description | Example value |
|---|---|---|---|---|
| workspaceId | string | Yes | Unique identifier of the workspace. | llm-xxxxxxx |
| businessType | string | No | Business type. | clueMining |
| taskDescription | string | No | Task description. | Here is a text data to be analyzed. Please tag the data according to the tag system. |
| content | string | No | Text to be analyzed. | Text to be analyzed |
| tags | array<object> | Yes | Tag system list. | |
| object | Yes | Tag system object. | ||
| tagName | string | No | Tag name. | xxxx |
| tagDefinePrompt | string | No | Tag definition prompt. | xxxx |
| extraInfo | string | No | Extra information. | Extra information |
Response parameters
| Name | Type | Description | Example value |
|---|---|---|---|
| object | Schema of Response | ||
| code | string | Status code. | successful |
| data | object | Example format object. | |
| outputFormat | string | Output format. | Please output directly in the following JSON format, without any other content: { "whetherToBuyHouseRecently": "", "housePurchasePaymentMethod": "", "householdPopulation": "", "numberOfRoomsRequired": "", "housePurchaseInvestmentGoal": "", "customerHousePurchaseType": "", "customerHousePurchaseBudget": "", "customerResidence": "", "userCoreNeeds": [ "" ], "age": "", "gender": "", "occupation":"" } |
| httpStatusCode | integer | HTTP status code. | 200 |
| message | string | Error description. | ok |
| requestId | string | Id of the request | 117F5ABE-CF02-5502-9A3F-E56BC9081A64 |
| success | boolean | Is successful: true for success, false for failure. | True |
Examples
Success response example
JSON format
Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 403 | NoPermission | You are not authorized to perform this action , Please check the assignment of the workspaceId. | Check the assignment of the workspaceId. |