OpenAI Scala Client: 功能强大的 Scala 语言 OpenAI API 客户端库

openai-scala-client

OpenAI Scala Client: 功能强大的 Scala 语言 OpenAI API 客户端库

OpenAI Scala Client 是一个专为 Scala 开发者设计的 OpenAI API 客户端库。它提供了一种简洁而强大的方式来与 OpenAI 的人工智能模型进行交互。这个库支持 OpenAI 的所有 API 端点和参数,包括流式传输、最新的聊天补全、视觉和语音功能等。

主要特性

全面的 API 支持: OpenAI Scala Client 支持 OpenAI 的所有 API 端点,包括模型、补全、聊天补全、编辑、图像、嵌入、音频、文件、微调、审核等功能。
异步操作: 所有 API 调用都是异步的,返回包装在 Future 中的响应,这使得库能够高效地处理并发请求。
流式传输支持: 库支持流式传输功能,允许实时接收 API 响应。
多提供商支持: 除了 OpenAI,该库还支持其他 API 兼容的提供商,如 Azure OpenAI、Azure AI、Anthropic、Google Vertex AI 等。
可定制配置: 提供灵活的配置选项,包括 API 密钥、组织 ID、超时设置等。
依赖注入支持: 可以通过依赖注入使用该库,方便集成到现有项目中。
适配器功能: 提供了多种适配器,用于负载分配、错误重试、路由等高级功能。
token 计数: 支持在调用 API 前计算预期使用的 token 数量,有助于选择合适的模型和控制成本。

安装和配置

OpenAI Scala Client 支持 Scala 2.12、2.13 和 3 版本。要安装该库,只需在你的 build.sbt 文件中添加以下依赖:

"io.cequence" %% "openai-scala-client" % "1.1.0.RC.1"

如果需要流式传输支持,可以使用:

"io.cequence" %% "openai-scala-client-stream" % "1.1.0.RC.1"

配置方面,你可以通过环境变量设置 API 密钥和组织 ID:

OPENAI_SCALA_CLIENT_API_KEY: OpenAI API 密钥
OPENAI_SCALA_CLIENT_ORG_ID: 组织 ID (可选)

也可以通过配置文件或代码直接设置这些参数。

使用示例

以下是一些使用 OpenAI Scala Client 的基本示例:

列出可用模型:

service.listModels.map(models =>
  models.foreach(println)
)

创建文本补全:

val text = """Extract the name and mailing address from this email:
             |Dear Kelly,
             |It was great to talk to you at the seminar. I thought Jane's talk was quite good.
             |Thank you for the book. Here's my address 2111 Ash Lane, Crestview CA 92002
             |Best,
             |Maya
           """.stripMargin

service.createCompletion(text).map(completion =>
  println(completion.choices.head.text)
)

创建聊天补全:

val messages = Seq(
  SystemMessage("You are a helpful assistant."),
  UserMessage("Who won the world series in 2020?"),
  AssistantMessage("The Los Angeles Dodgers won the World Series in 2020."),
  UserMessage("Where was it played?"),
)

service.createChatCompletion(
  messages = messages,
  settings = CreateChatCompletionSettings(ModelId.gpt_3_5_turbo)
).map { chatCompletion =>
  println(chatCompletion.choices.head.message.content)
}