ListWritingStyles - 获取写作文体列表

获取文体列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
aimiaobi:ListWritingStyleslist
*全部资源
*

请求参数

名称类型必填描述示例值
WorkspaceIdstring

业务空间 ID

llm-xxxxx
Scenestring

写作场景筛选

枚举值:
  • market营销写作
  • government法定公文
  • custom自定义写作
  • media传媒类
  • office事务公文
media
MaxResultsinteger

返回的最大结果数

100
NextTokenstring

写一页 Token

下一页token

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

1813ceee-7fe5-41b4-87e5-982a4d18cca5
TotalCountinteger

总记录数

58
MaxResultsinteger

最大返回结果数

100
NextTokenstring

下一个 token

下一页token
Codestring

错误码

successful
Messagestring

错误消息

数据不存在
Successstring

此次请求是否成功

true
Dataarray<object>

文体列表

dataobject

文体对象

StyleNamestring

文体名称

文体名称
StyleKeystring

文体唯一标识 KEY

文体唯一标识
StyleDescriptionstring

文体描述

文体描述
DistributeWritingboolean

是否支持分步骤写作

false
StyleImagestring

文体图片

文体图片
Emojistring

文体小图标(字符符号表示)

小图标
TemplateDefineWritingStyleTemplateDefine

文体模板定义

DistributeStepTemplateDefineWritingStyleTemplateDefine

分步骤模板定义

示例

正常返回示例

JSON格式

{
  "RequestId": "1813ceee-7fe5-41b4-87e5-982a4d18cca5",
  "TotalCount": 58,
  "MaxResults": 100,
  "NextToken": "下一页token",
  "Code": "successful",
  "Message": "数据不存在",
  "Success": true,
  "Data": [
    {
      "StyleName": "文体名称",
      "StyleKey": "文体唯一标识",
      "StyleDescription": "文体描述",
      "DistributeWriting": false,
      "StyleImage": "文体图片\n\n",
      "Emoji": "小图标",
      "TemplateDefine": {
        "Fields": [
          {
            "MinItemLength": 1000,
            "Max": 2000,
            "MinLength": 20,
            "MaxLength": 2000,
            "MaxItemLength": 4000,
            "Name": "字段名称",
            "BuildIn": true,
            "Enums": [
              {
                "CascadingFields": [
                  "级联字段"
                ],
                "Key": "枚举KEY",
                "Name": "枚举名称"
              }
            ],
            "Min": 1,
            "Required": false,
            "MaxItem": 10,
            "InitialValue": "初始值",
            "CascadingFields": [
              {
                "MinItemLength": 1000,
                "Max": 2000,
                "MinLength": 20,
                "MaxLength": 2000,
                "MaxItemLength": 4000,
                "Name": "字段名称",
                "BuildIn": true,
                "Enums": [
                  {
                    "CascadingFields": [
                      "级联字段"
                    ],
                    "Key": "枚举KEY",
                    "Name": "枚举名称"
                  }
                ],
                "Min": 1,
                "Required": false,
                "MaxItem": 10,
                "InitialValue": "初始值",
                "CascadingFields": [
                  {
                    "MinItemLength": 1000,
                    "Max": 2000,
                    "MinLength": 20,
                    "MaxLength": 2000,
                    "MaxItemLength": 4000,
                    "Name": "字段名称",
                    "BuildIn": true,
                    "Enums": [
                      {
                        "CascadingFields": [
                          "级联字段"
                        ],
                        "Key": "枚举KEY",
                        "Name": "枚举名称"
                      }
                    ],
                    "Min": 1,
                    "Required": false,
                    "MaxItem": 10,
                    "InitialValue": "初始值",
                    "CascadingFields": [],
                    "Style": {
                      "Placeholder": "清输入Prompt",
                      "Type": "media",
                      "ShowTime": true,
                      "Suffix": "后缀",
                      "Description": "输入框提示文案",
                      "Format": "yyyy-mm-dd"
                    },
                    "Key": "topic"
                  }
                ],
                "Style": {
                  "Placeholder": "清输入Prompt",
                  "Type": "media",
                  "ShowTime": true,
                  "Suffix": "后缀",
                  "Description": "输入框提示文案",
                  "Format": "yyyy-mm-dd"
                },
                "Key": "topic"
              }
            ],
            "Style": {
              "Placeholder": "清输入Prompt",
              "Type": "media",
              "ShowTime": true,
              "Suffix": "后缀",
              "Description": "输入框提示文案",
              "Format": "yyyy-mm-dd"
            },
            "Key": "topic"
          }
        ],
        "Example": [
          {
            "Value": 123,
            "Key": "topic"
          }
        ]
      },
      "DistributeStepTemplateDefine": {
        "Fields": [],
        "Example": [
          {
            "Value": 123,
            "Key": "topic"
          }
        ]
      }
    }
  ]
}

错误码

访问错误中心查看更多错误码。