openai自定义API操作 API 返回值说明

布满荆棘的人生 2024-02-19 10:55 23阅读 0赞

### custom-自定义API操作 ###

#### openai.custom ####

公共参数

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>类型</th> 
   <th>必须</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>key</td> 
   <td>String</td> 
   <td>是</td> 
   <td>调用key（<a href="https://o0b.cn/jennif" rel="nofollow" title="获取测试key">获取测试key</a>）</td> 
  </tr> 
  <tr> 
   <td>secret</td> 
   <td>String</td> 
   <td>是</td> 
   <td>调用密钥</td> 
  </tr> 
  <tr> 
   <td>api_name</td> 
   <td>String</td> 
   <td>是</td> 
   <td>API接口名称（包括在请求地址中）[item_search,item_get,item_search_shop等]</td> 
  </tr> 
  <tr> 
   <td>cache</td> 
   <td>String</td> 
   <td>否</td> 
   <td>[yes,no]默认yes，将调用缓存的数据，速度比较快</td> 
  </tr> 
  <tr> 
   <td>result_type</td> 
   <td>String</td> 
   <td>否</td> 
   <td>[json,jsonu,xml,serialize,var_export]返回数据格式，默认为json，jsonu输出的内容中文可以直接阅读</td> 
  </tr> 
  <tr> 
   <td>lang</td> 
   <td>String</td> 
   <td>否</td> 
   <td>[cn,en,ru]翻译语言，默认cn简体中文</td> 
  </tr> 
  <tr> 
   <td>version</td> 
   <td>String</td> 
   <td>否</td> 
   <td>API版本</td> 
  </tr> 
 </tbody> 
</table>

请求参数

请求参数：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生成图片)

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

响应参数

Version: Date:

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

![9d2fe617c7a7414b8e16b8d52836e35c.png][]

[9d2fe617c7a7414b8e16b8d52836e35c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/3ad9a6fbf18b45ca92627d7976c180c1.png