Flutter OpenAI API集成插件openai_api的使用

简介

openai_api 是一个用于Flutter应用中与OpenAI API交互的插件。它支持多种API，包括聊天、图像生成和音频处理等。本文将介绍如何在Flutter项目中使用这个插件。

特性

• ✅ 聊天
• ✅ 图像生成
• ✅ 音频（文本转语音TTS和语音识别STT）
• ✅ 模型管理
• ❌ 编辑（不支持）
• ❌ 补全（不支持）
• ❌ 嵌入（不支持）
• ❌ 文件（不支持）
• ❌ 微调（不支持）
• ❌ 审核（不支持）
• ❌ 引擎（不支持）

使用指南

初始化OpenAI客户端

首先，你需要初始化一个OpenaiClient实例：

final client = OpenaiClient(
  config: OpenaiConfig(
    apiKey: Env.apiKey,   // 从openai.com获取你的API密钥
    baseUrl: Env.baseUrl,  // 如果需要设置反向代理API，请在此处指定
    httpProxy: Env.httpProxy,  // 如果需要通过HTTP代理访问API，请在此处指定
  ),
);

调用API

音频转录

下面是一个如何使用此插件进行音频转录的例子：

final result = await client.createTranscription(
  TranscriptionRequest(
    file: 'assets/ttsmaker-file-2023-3-22-14-57-0.mp3',
  ),
);
print(result.text);

音频翻译

对于音频翻译，你可以这样操作：

final translateResult = await client.createTraslation(
  TranslationRequest(
    file: 'assets/ttsmaker-file-2023-3-22-17-27-30.mp3',
  ),
);
print(translateResult.text);

示例代码

这里提供了一个完整的示例，展示了如何使用openai_api进行聊天、图像生成等功能：

import 'dart:convert';
import 'package:openai_api/openai_api.dart';

void main() async {
  final client = OpenaiClient(
    config: OpenaiConfig(
      apiKey: Env.apiKey,
      baseUrl: Env.baseUrl,
      httpProxy: Env.httpProxy,
    ),
  );

  await runConversation(client);

  client.client.close();
}

Future<void> runConversation(OpenaiClient client) async {
  final messages = [
    ChatMessage.user(content: "What's the weather like in San Francisco, Tokyo, Shanghai and Paris?")
  ];

  final tools = [
    ChatTool(
        function: ChatFunction(
          name: "get_current_weather",
          description: "Get the current weather in a given location",
          parameters: ChatFunctionParameters(
            type: "object",
            properties: {
              "location": {"type": "string", "description": "The city and state, e.g. San Francisco, CA"},
              "unit": {"type": "string", "enum": ["celsius", "fahrenheit"]}
            },
            required: ["location"],
          ),
        ))
  ];

  final result = await client.sendChatCompletion(ChatCompletionRequest(
    model: Models.gpt4_1106Preview,
    messages: messages,
    tools: tools,
    toolChoice: "auto",
  ));

  final msg = result.choices.first.message;
  final toolCalls = msg?.toolCalls;

  if (toolCalls != null) {
    final availableFunctions = {"get_current_weather": getCurrentWeatherOnline};
    messages.add(msg!);

    for (final toolCall in toolCalls) {
      final functionName = toolCall.function.name;
      final toCall = availableFunctions[functionName];
      final args = json.decode(toolCall.function.arguments);
      final res = await toCall!(args["location"]);
      messages.add(
        ChatMessage.tool(content: res, toolCallId: toolCall.id, name: functionName),
      );
    }

    final response = await client.sendChatCompletion(ChatCompletionRequest(
      messages: messages,
      model: Models.gpt4_1106Preview,
    ));
    print(response.choices.first.message?.content);
  }
}