openai.ex

Openai.ex项目介绍

概述

Openai.ex是一个由社区维护的、非官方的OpenAI REST API封装库。这一库为开发者提供了一个简化的途径来与OpenAI的REST接口进行交互。需要注意的是，该项目并不总是与OpenAI的最新API规范保持一致，因为项目维护者可能会因其他项目的优先级而导致对本库问题或请求的处理有所滞后。因此，使用者在选择这一库的同时也可以考虑其他类似项目。

安装指南

要在项目中使用Openai.ex，首先需要在mix.exs文件中添加:openai作为依赖项：

def deps do
  [
    {:openai, "~> 0.6.2"}
  ]
end

之后，可以通过在项目根目录的config/config.exs中配置API密钥等信息来完成设置。

配置

在配置文件中，用户需要设置诸如API密钥和组织ID之类的参数，以下是一个示例配置：

import Config

config :openai,
  api_key: "your-api-key",
  organization_key: "your-organization-key",
  beta: "assistants=v1",
  http_options: [recv_timeout: 30_000],
  api_url: "http://localhost/"

功能与使用方法

Openai.ex封装了多种API功能，以下是几个主要接口的简要说明：

• 模型列表：通过OpenAI.models()可以检索所有可用模型的信息。

• 完成请求：OpenAI.completions()函数用于根据给定的提示生成预测内容。

• 聊天完成：通过OpenAI.chat_completion()函数，可以针对聊天信息创建回复。

• 图片生成：OpenAI.images_generations()根据提供的提示生成图片。

• 音频生成与翻译：支持音频的合成与转录，例如OpenAI.audio_speech()用于将文本转换为语音。

• 文件管理：包括上传、检索和删除文件等操作。

• 微调：可以通过OpenAI.finetunes_create()为模型创建微调任务以改进模型性能。

注意事项

使用该库时，请注意某些API可能仍在测试阶段。用户需在配置中设置相应的参数以启用它们。此外，由于某些文件处理和微调任务可能会消耗较长的时间，用户也可以通过配置选项来调节请求的超时时间。

通过以上这些接口，Openai.ex为开发者提供了一个强大且灵活的工具，使得与OpenAI的功能集成更加便捷。在使用过程中，用户应根据自身需求采用合适的配置与参数设置。