Ai学习之openai api

一、什么是openai api

大家对特斯拉的马斯克应该是不陌生的，openai 就是马斯克投资的一家研究人工智能的公司，它就致力于推动人工智能技术的发展，目标是确保人工智能对人类有益，并实现安全且通用的人工智能。

此后，OpenAI 在技术研发和应用方面不断取得进展，逐渐成为全球瞩目的人工智能研究机构，OpenAI 在自然语言处理方面取得了众多突破性成果，最著名的是 GPT（Generative Pretrained Transformer）系列语言模型。例如 GPT-3，它具有强大的语言理解和生成能力，能够生成连贯、有逻辑的文本，在问答、文本生成、翻译等多个任务中表现出色。GPT-4 更是在 GPT-3 的基础上进一步提升了性能和功能，能够处理更复杂的任务，对语言的理解和生成更加精准和自然。

而chatGpt 就是使用GPT的网页端应用。

但是为了更好的支持开发者使用，openai 公司提供了标准接口的api 供开发者使用GPT大模型。我们可以通过 api 和大模型进行通讯，从而实现使用大模型实现自己的功能。

目前 openapi api 规范已经是国内所有大模型统一的接口规范，基本上国内各大厂商都参考其规范实现自己的模型 API

二、Api 详细说明

可以看看下面的例子：

curl --insecure https://api.openai.com/v1/chat/completions \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $KEY" \
-d '{"model": "gpt-4o","messages": [{"role": "user", "content": "写一首关于AI的诗"}]}'

这是一个 openai 的聊天补全接口，实际上但Open AI API 提供了许多功能，比如：

Text Generation：生成和处理文本
Embeddings：文本转向量
Speech to Text：语音转文本
Image Generation：生成图像
Vision：处理图像输入

这些不同的接口是通过不同的路径进行区分。这里看到的 /v1/chat/completions 就是我们常用的大模型的编程接口。

接口有两个特别重要的参数。分别是访问地址和api key。通过 api key 可以用来区分不同的用户，而访问地址则是一个模型代理地址，不同模型提供的访问地址一般都是不同的。这个地址不一定是模型本身提供的，也可能是代理地址。
https://api-docs.deepseek.com/zh-cn/guides/multi_round_chat
在这里插入图片描述

然后我们来讲讲接口的请求参数说明：

核心参数：

参数名称	参数说明
model	用于指定与哪个模型进行沟通，选择合适的模型来完成相应任务
messages	是一个消息列表，发送给模型的消息，可理解为历史消息列表，为模型提供更多上下文信息，帮助其更准确地理解和生成回复
temperature	设定大模型回复的确定性，取值范围对应不同的随机性。值越小，生成的回复越具确定性；值越大，回复的随机性越强
max_completion_tokens	表示生成应答的最大token数。由于大模型生成内容常按token数计费，合理限制此参数大小可有效控制成本
stream	用于决定是否需要流式应答。流式应答能够提升聊天的响应速度，为用户带来更好的交互体验

工程参数

参数名称	参数说明
终端用户标识	开发者提供给OpenAI，用于监控和检测API的滥用，监控粒度能到个体
n	为每条输入消息生成回复的数量，生成更多内容需计费，若无特别需求，不额外设置此参数
response_format	应答格式，默认接口只生成文本内容，开发中常用JSON格式，既可用提示词要求大模型返回JSON格式，也可通过设置此参数让API直接返回JSON格式

工具参数

参数名称	说明
tools（模型可以调用的工具列表）	每个工具包含 type（类型，目前只有 function 类型）和 function 部分。function 用于告知模型函数的调用方式，包括 description（函数描述）、name（函数名）以及 parameters（函数参数）
tool_choice（选择怎么调用工具）	参数值为 none 表示不调用工具；参数值为 auto 表示模型自行选择生成消息或调用工具；参数值为 required 表示必须调用工具

模型参数

参数名称	说明
seed（种子值）	用于解决可重复输出问题，使用相同种子值和相同参数时，生成的结果相同，类似缓存
stop	停止序列，告知大模型在生成文本时遇到该序列就停止生成
frequency_penalty（频率惩罚）	根据一个 token 在已生成文本中出现的频率进行计算
presence_penalty（存在惩罚）	根据一个 token 是否已经出现来进行计算
logit_bias（logit 偏差）	在 logit 函数计算中调整计算结果，主要目的是修改某些 token 出现的可能性，如不希望某些词出现在最终结果里
logprobs（是否返回对数概率）	返回大模型生成每个 token 的概率
top_logprobs（返回每个位置最可能返回的 token 数量）	让大模型返回排名靠前的 token
top_p（另一种采样方式，与 temperature 相对）	在概率前多少的 token 中进行选择

再看看接口的响应参数：

子项	说明
id	应答的唯一标识
object（对象类型）	通用字段，在聊天补全接口中，值为 chat.comploetion（应为 chat.completion ）
created	Unix 时间戳，表明这个应答生成的时间
model	生成应答的模型，一般是请求时所带的模型，有时会返回具体的版本
system_fingerprint（系统指纹）	代表模型运行时使用的后端配置
choices.index（索引）	顺序编号，如果文本被切分了，可通过索引将内容重新排列以生成正确顺序
choices.finish_reason	停止生成 token 的原因，到了停止点或遇到停止序列，原因是 stop ；到了一定长度，原因是 length
message（回复的消息）	角色和内容
tool_calls.id	函数调用的 ID
tool_calls.type	目前只支持 function
tool_calls.function	函数调用部分，其中包含了 name 和 arguments
logprobs.content	token 与其对应的概率（logprob）。bytes 表示这个 token 对应的 UTF-8 的字节表现形式，而 top_logprobs 则包含了每个 token 对应的备选 token 及其概率