阿水AI开放平台API，使用与OpenAI兼容的API格式，这也就意味着，您可以使用OpenAI SDK 来访问阿水AI开放平台API，或使用与OpenAI API相互兼容的软件。

请求URL:

请求地址：https://open.api.ashuiai.cn

完整路由请求：https://open.api.ashuiai.cn/v1/chat/completions

请求方式：

POST

请求头(header)：

参数名	是否必须	类型	说明
Content-Type	是	string	请求类型： application/json
Authorization	是	string	Bearer api_key

请求参数(body):

参数名	是否必须	类型	说明
model	是	string	调用的模型名称
messages	是	[]object	消息主体
stream	是	bool	控制是否开启流式输出
frequency_penalty	否	float64	频率惩罚。为了稍微减少输出中的重复词语，惩罚系数的合理值通常约为0.1至1。如果目标是显著抑制重复，系数可以增加到2，但这可能会对输出的质量产生负面影响。相反，使用负值可以增加重复的可能性。
max_tokens	否	float64	限制单次对话请求中，大模型生成 completion 的最大 token 数，建议为token上限的一半
presence_penalty	否	float64	presence_penalty 参数用于控制生成文本中是否包含新话题。它通过对已经生成的标记施加惩罚，来鼓励模型生成更多新内容。取值范围：-2.0 到 2.0
temperature	否	float64	温度。
top_p	否	float64	介于 0 和 1.0 之间的数字。在温度不为0时，优先提炼top_p比例的token值作为对话依据
file_list	否	array	文件url列表（传递该参数则为文件解析，文件解析与图片解析无法同时存在）
web_search	否	bool	是否联网

参数详细介绍

model

模型的调用名称，一般是英文名称，如果输入错误将无法进行调用。

steam

是否开启流式输出，如果开启，这次返回将会以sse进行返回，请保持长连接

messages

参数名	参数描述	参数类型	是否必填
role	对话的角色	string	是
content	对话内容	object	是

请求示例

普通对话请求（纯文字）：

"messages": [
    {
        "role": "system",
        "content": "对话携带的提示词"
    }, 
    {
        "role": "user",
        "content": "对话内容"
    }
]

多模态对话（带图片）：

"messages": [
    {
        "role": "system",
        "content": "对话携带的提示词"
    }, 
    {
        "role": "user",
        "content": [
            {
                "type": "text",
                "text": "这张图有啥"
            },
            {
                "type": "image_url",
                "image_url": {
                    "url": "https://img1.baidu.com/it/u=1458976551,2839064554\u0026fm=253\u0026fmt=auto\u0026app=138\u0026f=JPEG?w=800\u0026h=1422"
                }
            }
        ]
    }
]

role规则:

对话的角色可以选择的范围有:

system : 系统角色一般用作于为本次对话进行提示词的控制

user: 用户本身对话信息

assistant: AI返回的消息内容

frequency_penalty

介于 -2.0 和 2.0 之间的数字。如果该值为正，那么新 token 会根据其在已有文本中的出现频率受到相应的惩罚，降低模型重复相同内容的可能性。

max_tokens

限制一次请求中模型生成 completion 的最大 token 数。输入 token 和输出 token 的总长度受模型的上下文长度的限制。

presence_penalty

介于 -2.0 和 2.0 之间的数字。如果该值为正，那么新 token 会根据其是否已在已有文本中出现受到相应的惩罚，从而增加模型谈论新主题的可能性。

temperature

采样温度，temperature 是一个控制生成文本的随机性和创造性的参数。它的取值范围通常在0到1之间。具体来说，temperature 参数的作用如下：低温度（接近0）：模型生成的文本更确定和保守，倾向于选择概率最高的词。这种设置适合需要精确和一致性的任务，如回答事实性问题或生成技术文档。高温度（接近1或更高）：模型生成的文本更随机和多样化，可能会选择概率较低的词。这种设置适合需要创造性和多样性的任务，如写作创意内容或生成诗歌。

top_p

作为调节采样温度的替代方案，模型会考虑前 top_p 概率的 token 的结果。所以 0.1 就意味着只有包括在最高 10% 概率中的 token 会被考虑。我们通常建议修改这个值或者更改 temperature，但不建议同时对两者进行修改。

带参请求示例

{
    "frequency_penalty": 0,
    "max_tokens": 4096,
    "messages": [
        {
            "role": "system",
            "content": "测试提示词123"
        },
        {
            "role": "user",
            "content": "你好"
        }
    ],
    "model": "ashuiai-4.0",   
    "presence_penalty": 0,
    "stream": true,
    "temperature": 0
}

返回示例:

正确返回示例

data:
{
    "id": "chat99178712-6398-11ef-9fd7-3cecef9ef2bc",
    "object": "chat.completion.chunk",
    "created": 1724669253,
    "model": "kfzmxmc",
    "system_fingerprint": null,
    "choices":
    [
        {
            "index": 0,
            "delta":
            {
                "content": "hello word"
            },
            "logprobs": null,
            "finish_reason": "stop"
        }
    ]
}

data:[DONE]

失败示例：

data: 
{
    "Type": "string",
    "Data": null,
    "Err": "不存在的模型",
    "Code": 700
}

错误结果:

错误码	错误信息
0	成功
500	内部错误
400	参数异常
401	message结构异常
600	无效的key
601	用户被封禁
700	模型名称错误
701	模型暂不支持该功能
800	您的账户已欠费，请充值后重试。
900	不支持的文件类型（文件解析）

Curl

Golang

Python

Java

阿水AI开放平台API调用文档

请求URL:#

请求方式：#

请求头(header)：#

请求参数(body):#

参数详细介绍#

model#

steam#

messages#

请求示例#

普通对话请求（纯文字）：#

多模态对话（带图片）：#

role规则:#

frequency_penalty#

max_tokens#

presence_penalty#

temperature#

top_p#

带参请求示例#

返回示例:#

错误结果:#