如何获取openai自定义API操作 API 返回值说明

custom-自定义API操作

openai.custom

公共参数

请求地址: https://api-gw-4.cn/openai/custom

名称	类型	必须	描述
key	String	是	调用key（必须以GET方式拼接在URL中）
secret	String	是	调用密钥
api_name	String	是	API接口名称（包括在请求地址中）[item_search,item_get,item_search_shop等]
cache	String	否	[yes,no]默认yes，将调用缓存的数据，速度比较快
result_type	String	否	[json,jsonu,xml,serialize,var_export]返回数据格式，默认为json，jsonu输出的内容中文可以直接阅读
lang	String	否	[cn,en,ru]翻译语言，默认cn简体中文
version	String	否	API版本

请求参数

请求参数：method=&_o_args=
我司的openai专用API域名：https://api-ai.onebound.cn/

参数说明： 文本模式参数：&_o_args={"prompt": "中国队什么时候进世界杯","max_tokens":200} prompt 文本，max_token 词汇最大量
图片模式参数：&_o_args={"prompt":"地球","n":10} prompt 图片描述文本，n 返回图片数
api:openAI开放平台的接口名（如：v1/completions）
其它参数:参考官方平台接口文档，与官方的参数一致
MJ图片生成参数：method=images/submit&_o_args={"prompt":"向日葵"}(生成图片id), method=images/get&_o_args={"imgid":"1987378144113570"}(图片id生成图片)

名称	类型	必须	描述
method	String		接口名,如： v1/models(模型), v1/completions( AI问答 ), v1/chat/completions(对话), v1/edits(编辑文本，优化文本信息), v1/images/generations( 文本生图 ), v1/images/edits(图片编辑), v1/images/variations(图片修改), v1/embeddings(学习模型), v1/audio/transcriptions(声音转换、翻译), v1/files(文件微调、修改), images/submit(文本生成图片id), images/get(图片id生成图片), ……………………
_o_args	String		json数组格式，如{"prompt": "中国队什么时候进世界杯","max_tokens":200}
[其他参数]	String		其它参数:参考OpenAI开放平台接口文档，与官方的参数一致 https://platform.openai.com/

响应参数

Version: Date:

名称	类型	必须	示例值	描述
response	Mix	0	[]	响应内容，不同的接口返回内容不一样，具体参考 https://platform.openai.com/

请求示例

-- 请求示例 url 默认请求参数已经URL编码处理
curl -i "https://api-gw-4.cn/openai/custom/?key=<您自己的apiKey>&secret=<您自己的apiSecret>&method="

响应示例

{
	"response": {
		"id": "cmpl-6qY0bIoPXYs7nCMME3g9buaZcxbf6",
		"object": "text_completion",
		"created": 1677981805,
		"model": "text-davinci-003",
		"choices": [
			{
				"text": "\n\n按中国富豪榜排名，中国最有钱的人是马云。",
				"index": 0,
				"logprobs": null,
				"finish_reason": "stop"
			}
		],
		"usage": {
			"prompt_tokens": 16,
			"completion_tokens": 43,
			"total_tokens": 59
		}
	},
	"error": "",
	"reason": "",
	"error_code": "0000",
	"request_id": "1.6403f86cd67f6",
	"last_id": "1593583206"
}

异常示例

{
	"response": {
		"error": {
			"message": "Rate limit reached for default-text-davinci-003 in organization org-s1mHAqazDVEDzVLaYDlHtn4z on tokens per min. Limit: 150000 / min. Current: 2000000 / min. Contact support@openai.com if you continue to have issues. Please add a payment method to your account to increase your rate limit. Visit https://platform.openai.com/account/billing to add a payment method.",
			"type": "tokens",
			"param": null,
			"code": null
		}
	},
	"error_code": "2000",
	"error": "",
	"reason": "",
	"request_id": "1.6403fb3e09647",
	"last_id": "1593602602"
}

相关资料

ChatGPT、Bard、LLaMa、文心一言、MOSS等人工智能应用聚合平台

错误码解释

状态代码(error_code)	状态信息	详细描述	是否收费
0000	success	接口调用成功并返回相关数据	是
2000	Search success but no result	接口访问成功，但是搜索没有结果	是
4000	Server internal error	服务器内部错误	否
4001	Network error	网络错误	否
4002	Target server error	目标服务器错误	否
4003	Param error	用户输入参数错误	忽略
4004	Account not found	用户帐号不存在	忽略
4005	Invalid authentication credentials	授权失败	忽略
4006	API stopped	您的当前API已停用	忽略
4007	Account stopped	您的账户已停用	忽略
4008	API rate limit exceeded	并发已达上限	忽略
4009	API maintenance	API维护中	忽略
4010	API not found with these values	API不存在	忽略
4012	Please add api first	请先添加api	忽略
4013	Number of calls exceeded	调用次数超限	忽略
4014	Missing url param	参数缺失	忽略
4015	Wrong pageToken	参数pageToken有误	忽略
4016	Insufficient balance	余额不足	忽略
4017	timeout error	请求超时	否
5000	unknown error	未知错误	否

API 工具

OpenAI 提供了一系列 API，允许开发者集成其 AI 技术到各种应用中。对于自定义的 API 操作，具体的返回值会依赖于你正在使用的特定 API 和你请求的操作。但是，我可以为你提供一个通用的 API 返回值说明的框架，以及如何使用 OpenAI 的 API 文档来获取具体的返回值信息。

通用 API 返回值框架

1. 成功响应:

   • 状态码: 通常为 200 OK。
   • 响应体: 包含请求的结果或数据。这可能是一个 JSON 对象，其中包含多个字段，每个字段都提供了关于请求结果的不同信息。

2. 错误响应:

   • 状态码: 非 200 的状态码，如 400 Bad Request、401 Unauthorized、500 Internal Server Error 等。
   • 响应体: 通常包含一个错误消息，描述发生了什么错误。对于 JSON 格式的响应，这通常是一个包含 error 或 message 字段的对象。

使用 OpenAI API 文档

要获取特定 API 操作的详细返回值说明，你应该查阅 OpenAI 的官方 API 文档。以下是一些步骤：

1. 访问 OpenAI 文档: 打开 OpenAI 的官方文档网站。
2. 选择 API: 在文档中找到你正在使用的 API，如 GPT-3、Completion API、Embeddings API 等。
3. 查看端点文档: 对于你感兴趣的 API 端点，查看其文档。这通常会提供关于该端点的详细描述、请求参数、请求示例和响应示例。
4. 注意返回值: 在响应示例部分，你将看到该端点返回的数据结构。仔细阅读这些示例，了解返回值的字段和它们代表的含义。
5. 错误处理: 查看文档中提到的错误代码和消息，了解如何处理可能发生的错误情况。

示例

以 Completion API 为例，当你发送一个请求来获取一段文本的补全时，响应可能如下所示（以 JSON 格式为例）：

json复制代码

	{
	"id": "your-request-id",
	"object": "text_completion",
	"created": 1677836926,
	"model": "text-davinci-003",
	"choices": [
	{
	"text": "这是你的文本补全内容...",
	"index": 0,
	"logprobs": null,
	"finish_reason": "length"
	}
	],
	"usage": {
	"prompt_tokens": 5,
	"completion_tokens": 15,
	"total_tokens": 20
	}
	}

在这个示例中，choices 字段包含了文本补全的内容，而 usage 字段提供了关于请求使用情况的统计信息。具体的字段和它们的含义会在 API 文档中有详细的描述。

总之，要获取关于 OpenAI 自定义 API 操作的详细返回值说明，你应该查阅相关的 API 文档，并仔细阅读其中的描述和示例。