插件-角色描述自动生成

更新时间:

角色描述自动生成

接口

POST /v2/api/character/auto/desc

入参

名称

类型

是否必传

说明

type

String

file或者text

fileUrl

String

外部文件链接

text

String

文本内容

fileName

String

typefile时必填,带有文件类型后缀的文件名

返回

名称

类型

说明

content

string

自动生成的内容

usage

object

token用量

usage.outputTokens

int

token输出用量

usage.inputTokens

int

token输入用量

示例参考

说明

传入内容type分为file、text类型

file类型传入可访问fileUrl地址和fileName

text类型传入文本内容

调用示例

curl --location 'https://nlp.aliyuncs.com/v2/api/character/auto/desc' \
--header 'Expect;' \
--header 'accept: */*' \
--header 'Content-Type: application/json' \
--header 'x-fag-servicename: aca-char-auto-desc' \
--header 'x-fag-appcode: aca' \
--header 'Authorization: Bearer {YOUR_API_KEY}' \
--data '{
  "type": "file",
  "fileUrl":"https://lang.alicdn.com/xingchen/guanyu.txt",
  "fileName":"test.txt"
}'
/**
 * API名称:角色描述自动生成
 * 环境要求:Java 17及以上
 */
public class Example {
    private static final String URL = "https://nlp.aliyuncs.com/v2/api/character/auto/desc";
    private static final String API_KEY = "Bearer {YOUR_API_KEY}";

//    type text 用法
//    private static final String jsonBody = """
//    {
//        "type": "text",
//        "text":"刘备(161年-223年),字玄德,涿郡涿县(今河北涿州)人,三国时期蜀汉开国皇帝。作为汉室后裔,他以仁德宽厚、礼贤下士著称。早年颠沛流离,屡遭挫败,但始终坚韧不拔。他三顾茅庐请出诸葛亮,奠定鼎足之势。于221年在成都称帝,国号“汉”,史称蜀汉。刘备重信义,关爱百姓,其“仁君”形象深入人心。在《三国演义》中,他被塑造为理想化的明主代表,与关羽、张飞的君臣情谊更是千古佳话。"
//    }
//    """;
    
//    type file 用法
    private static final String jsonBody = """
    {
        "type": "file",
        "fileUrl":"https://lang.alicdn.com/xingchen/guanyu.txt",
        "fileName":"test.txt"
    }
    """;

    public static void main(String[] args) throws Exception {
        call();
    }

    private static void call() throws Exception {
        HttpClient client = HttpClient.newHttpClient();

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create(URL))
                .headers(
                        "Authorization", API_KEY,
                        "X-AcA-DataInspection", "enable",
                        "x-fag-servicename", "aca-char-auto-desc",
                        "x-fag-appcode", "aca",
                        "Content-Type", "application/json")
                .POST(HttpRequest.BodyPublishers.ofString(jsonBody))
                .build();

        // 同步调用
        HttpResponse<String> response = client.send(
                request,
                HttpResponse.BodyHandlers.ofString()
        );

        String responseBody = response.body();
        System.out.println("响应数据: " + responseBody);
    }
}
import requests

URL = "https://nlp.aliyuncs.com/v2/api/character/auto/desc"

# API名称:角色描述自动生成
# 环境要求:python3.10及以上
def call(api_key):
    headers = {
        "Content-Type": "application/json",
        "x-fag-servicename": "aca-char-auto-desc",
        "x-fag-appcode": "aca",
        "Authorization": f"Bearer {api_key}",
        "X-AcA-DataInspection": "enable"
    }

    # type file 用法
    payload = {
        "type": "file",
        "fileUrl": "https://lang.alicdn.com/xingchen/guanyu.txt",
        "fileName": "test.txt"
    }
    # type text 用法
    # payload = {
    #      "type": "text",
    #      "text":"刘备(161年-223年),字玄德,涿郡涿县(今河北涿州)人,三国时期蜀汉开国皇帝。作为汉室后裔,他以仁德宽厚、礼贤下士著称。早年颠沛流离,屡遭挫败,但始终坚韧不拔。他三顾茅庐请出诸葛亮,奠定鼎足之势。于221年在成都称帝,国号“汉”,史称蜀汉。刘备重信义,关爱百姓,其“仁君”形象深入人心。在《三国演义》中,他被塑造为理想化的明主代表,与关羽、张飞的君臣情谊更是千古佳话。"
    # }

    response = requests.post(URL, json=payload, headers=headers)
    # 逐行打印原始响应内容
    for line in response.iter_lines():
        if line:
            print(line.decode('utf-8'))
    # 检查响应状态,如有错误则抛出异常
    response.raise_for_status()
    return response


if __name__ == "__main__":
    api_key = "YOUR_API_KEY"

    try:
        response = call(api_key)
    except requests.HTTPError as e:
        print(f"请求出错: {e}")
package main

import (
    "bytes"
    "encoding/json"
    "fmt"
    "io"
    "net/http"
)

// API名称:角色描述自动生成
// 环境要求:go 1.20及以上

const URL = "https://nlp.aliyuncs.com/v2/api/chat/send"

func call(apiKey string) (*http.Response, error) {
    // type file 用法
    payload := map[string]interface{}{
    "type":     "file",
    "fileUrl":  "https://lang.alicdn.com/xingchen/guanyu.txt",
    "fileName": "test.txt",
    }
    // type text 用法
    //payload := map[string]interface{}{
    //	  "type": "text",
    //	  "text":"刘备(161年-223年),字玄德,涿郡涿县(今河北涿州)人,三国时期蜀汉开国皇帝。作为汉室后裔,他以仁德宽厚、礼贤下士著称。早年颠沛流离,屡遭挫败,但始终坚韧不拔。他三顾茅庐请出诸葛亮,奠定鼎足之势。于221年在成都称帝,国号“汉”,史称蜀汉。刘备重信义,关爱百姓,其“仁君”形象深入人心。在《三国演义》中,他被塑造为理想化的明主代表,与关羽、张飞的君臣情谊更是千古佳话。"
    //}

    payloadBytes, err := json.Marshal(payload)
    if err != nil {
        return nil, err
    }

    req, err := http.NewRequest("POST", URL, bytes.NewBuffer(payloadBytes))
    if err != nil {
        return nil, err
    }

    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("x-fag-servicename", "aca-char-auto-desc")
    req.Header.Set("x-fag-appcode", "aca")
    req.Header.Set("Authorization", "Bearer "+apiKey)
    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        return nil, err
    }

    // 逐行打印原始响应内容
    defer resp.Body.Close()
    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))

    if resp.StatusCode != http.StatusOK {
        return nil, fmt.Errorf("请求出错,状态码:%d", resp.StatusCode)
    }

    return resp, nil
}

func main() {

    apiKey := "YOUR_API_KEY"

    _, err := call(apiKey)
    if err != nil {
        fmt.Printf("请求出错: %v\n", err)
    }
}

返回示例

{
    "requestId": "3a42685c-497b-4a54-aeb7-555b68ac410f",
    "code": 200,
    "data": {
        "content": "【关羽基本信息】\n- 原名:长生\n- 后改字:云长\n- 民族:汉族\n- 出生地:并州河东解(今山西运城)\n\n【关羽生平与成就】\n- 中国东汉末年著名将领\n- 自刘备于乡里聚众起兵开始追随刘备,是刘备最为信任的将领之一\n\n【关羽形象神化及后世地位】\n- 关羽去世后,其形象逐渐被后人神化,一直是历来民间祭祀的对象,被尊称为“关公”\n- 经历代朝廷褒封,清代时被奉为“忠义神武灵佑仁勇威显关圣大帝”,崇为“武圣”,与“文圣” 孔子齐名\n- 长篇历史小说《三国演义》对关羽的事迹多有描写和夸大,在《演义》中关羽被描写为“五虎大将”之首\n\n【其他相关】\n- 古代有地名关羽,但其确切位置不明。",
        "usage": {
            "outputTokens": 233,
            "inputTokens": 230,
            "cachedTokens": 0
        },
        "context": {
            "modelName": "xingchen-plus"
        }
    },
    "success": true
}