# 大语言模型

目前，LinwitDocEditor 支持 `Openai（ChatGPT）`、`星火大模型`、`文心一言`以及 `自定义后端` 类型的大语言模型。

## Openai（ChatGPT）

```ts
new LinwitDocEditor({
    element: "#aiEditor",
    ai: {
        models: {
            openai: {
                apiKey: "sk-alQ96zbDn*****",
                model:"gpt-4o",
            }
        }
    },
})
```
或者通过 Openai 的接口使用 `月之暗面` 或者其他和 Openai API 兼容的模型。

```ts
new LinwitDocEditor({
    element: "#aiEditor",
    ai: {
        models: {
            openai: {
                endpoint: "https://api.moonshot.cn",
                model: "moonshot-v1-8k",
                apiKey: "sk-alQ96zb******"
            }
        }
    },
})
```

注意，在以上的配置中，AIEditor 会去自动请求 URL 为`https://api.moonshot.cn/v1/chat/completions` 进行 AI 对话，若当前的大模型的地址并不是
`endpoint` + `/v1/chat/completions` 时，我们需要配置 `customUrl`，如下代码所示：

```ts
new LinwitDocEditor({
    element: "#aiEditor",
    ai: {
        models: {
            openai: {
                customUrl: "https://api.moonshot.cn/your/custom/path",
                model: "moonshot-v1-8k",
                apiKey: "sk-alQ96zb******"
            }
        }
    },
})
```




## 星火大模型

```typescript
new LinwitDocEditor({
    element: "#aiEditor",
    ai: {
        models: {
            spark: {
                appId: "****",
                apiKey: "****",
                apiSecret: "****",
                protocol: "ws", //或者 wss
                version: "v3.1", //或者其他
            }
        }
    },
})
```

在 version 配置中，注意一下星火产品和 version 的对应关系：

- Spark Lite ---> v1.1
- Spark V2.0 ---> v2.1
- Spark Pro ---> v3.1 （注意：pro-128k 产品暂不支持）
- Spark Max ---> v3.5
- Spark4.0 Ultra ---> v4.0

## 文心一言

```typescript
new LinwitDocEditor({
    element: "#aiEditor",
    ai: {
        models: {
            wenxin: {
                access_token: "****",
                protocol: "****",
                version: "****"
            }
        }
    },
})
```

## Gitee Ai 

当前是使用 Gitee AI 的 serverless api 来进行支持。

```typescript
new LinwitDocEditor({
    element: "#aiEditor",
    ai: {
        models: {
            gitee:{
                endpoint:"https://ai.gitee.com/api/inference/serverless/KGHCVOPBV7GY/chat/completions",
                apiKey:"***",
            }
        }
    },
})
```

更多的 Gitee AI 配置，例如：

```typescript
new LinwitDocEditor({
    element: "#aiEditor",
    ai: {
        models: {
            gitee:{
                endpoint:"https://ai.gitee.com/api/inference/serverless/KGHCVOPBV7GY/chat/completions",
                apiKey:"***",
                max_tokens: 512,
                temperature: 0.7,
                top_p: 0.7,
                top_k: 50,
            }
        }
    },
})
```


## 自定义大语言模型

```typescript
new LinwitDocEditor({
    element: "#aiEditor",
    ai: {
        models: {
            custom: {
                url: "http://127.0.0.1:8080/api/v1/ai/chat",
                headers: () => {
                    return {
                        "jwt": "xxxx"
                    }
                },
                wrapPayload: (message: string) => {
                    return JSON.stringify({prompt: message})
                },
                parseMessage: (message: string) => {
                    return {
                        role: "assistant",
                        content: message,
                        // index: number,
                        // //0 代表首个文本结果；1 代表中间文本结果；2 代表最后一个文本结果。
                        // status: 0|1|2,
                    }
                },
                // protocol: "sse" | "websocket"
            }
        }
    },
})
```
参数说明：

- `url`: 字符串，或者返回一个字符串的方法
- `headers`: 自定义 sse 请求的 http 头信息
- `wrapPayload`: 把用户的 `prompt` 字符串，转换为 `url` 接口所需要的 `json` 格式（亦或者其他格式）。
- `parseMessage`：把后端响应的 `body` 内容，转换为 `AiMessage` 格式。

`AiMessage` 定义如下：

```ts
declare interface AiMessage {
    role: string;
    content: string;
    index: number;
    status: 0 | 1 | 2;
}
```