ExecuteAITeacherChineseCompositionTutoringWorkflowRun

更新时间:
复制 MD 格式

Executes a workflow for Chinese composition tutoring.

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

aicontent:ExecuteAITeacherChineseCompositionTutoringWorkflowRun

create

*All Resource

*

None None

Request syntax

POST /pop/api/v1/intelligentAgent/chineseCompositionTutoring/workflowRun HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

body

object

No

The request body.

essayOutline

string

No

The essay outline.

题目: 春天的色彩 开头: 开门见山,点明主题。 中间: 分段描写春天的不同色彩。 结尾: 总结全文,抒发情感。

essayRequirements

string

Yes

The essay requirements.

生动形象,字数不得少于100

essayTopic

string

Yes

The essay topic.

春天的景色

essayType

string

Yes

The essay type.

outline: An outline.

essay: A full essay.

essay

essayWordCount

integer

No

The target word count.

100

grade

integer

Yes

The student's grade level.

3

responseMode

string

Yes

The response mode.

streaming

userId

string

Yes

The user ID.

xxxxxxxxx

System parameters are not required in the request.

Response elements

Element

Type

Description

Example

object

The response body.

requestId

string

The unique ID for the request. This ID is useful for troubleshooting.

xxxx-xxxx-xxxx-xxxxxxxx

event

string

The event type.

message

content

string

The content associated with the event.

春天里常见的景

Example of a streaming response:

data:{"event":"start"}

data:{"event":"message","content":"###"}

data:{"event":"message","content":" "}

data:{"event":"message","content":"Essay"}

data:{"event":"message","content":" analysis \n- **"}

data:{"event":"message","content":"Common spring scenery"}

data:{"event":"message","content":" and the feelings of love for it."}

data:{"event":"end"}

Examples

Success response

JSON format

{
  "requestId": "xxxx-xxxx-xxxx-xxxxxxxx",
  "event": "message",
  "content": "春天里常见的景"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.