openai-delphi - Delphi和Lazarus/FPC专用的OpenAI API非官方客户端库

OpenAI-Delphi 项目介绍

OpenAI-Delphi 是一个用于在 Delphi 和 Lazarus/FPC（自由 Pascal 编译器）中连接 OpenAI API 的客户端库。通过这一库，用户可以在 Delphi 或 Lazarus 应用程序中直接使用诸如 ChatGPT 等热门的 OpenAI 服务。

值得注意的是，这并不是一个官方库，OpenAI 并未提供任何针对 Delphi 的官方库。

安装

要使用该库，用户只需将 Source 文件夹添加到 IDE 的库路径或项目的源代码路径中即可。

使用方法

在使用客户端时，首先需要在代码中引用 OpenAIClient 和 OpenAIDtos 单元。

uses 
  OpenAIClient, OpenAIDtos;

创建客户端

使用此库需配置用户账户的秘密 API 密钥，该密钥可以从 OpenAI 网站获取。建议将其设置为名为 OPENAI_API_KEY 的环境变量。一旦有了 API 密钥，用户可以创建客户端并设置密钥，代码如下：

var
  Client: IOpenAIClient;
{...}
  Client := TOpenAIClient.Create;
  Client.Config.AccessToken := GetEnvironmentVariable('OPENAI_API_KEY');

执行方法

OpenAI 客户端中大多数 API 端点都可以通过 OpenAI 属性接口调用。以下示例展示如何使用 CreateCompletion 端点来提问并获取回答：

function AskQuestion(const Question: string): string;
var
  Request: TCreateCompletionRequest;
  Response: TCreateCompletionResponse;
begin
  Response := nil;
  Request := TCreateCompletionRequest.Create;
  try
    Request.Prompt := Question;
    Request.Model := 'text-davinci-003';
    Request.MaxTokens := 2048; // 注意：这可能迅速耗尽 API 配额。
    Response := Client.OpenAI.CreateCompletion(Request);
    if Assigned(Response.Choices) and (Response.Choices.Count > 0) then
      Result := Response.Choices[0].Text
    else
      Result := '';
  finally
    Request.Free;
    Response.Free;
  end;
end;

用户在创建并作为输入参数传递的对象，以及客户端创建并作为函数结果提供的对象，必须自行销毁，否则将导致内存泄漏。

用户可以利用 Delphi 的代码补全功能来检查可用的方法、参数、类型和阅读文档注释。

系统要求

该库不需要任何第三方库，适用于所有提供 System.Net.HttpClient 单元的最新 Delphi 版本和 Lazarus/FPC。尽管未经过充分测试，但它应该能在所有支持的平台（Windows、Linux、macOS 等）上正常工作。

由于需要使用用户的秘密 API 密钥，因此不建议在客户端应用程序中使用，除非用户确定安全风险可控。

请求自定义

用户可以通过自定义请求工厂来根据需要自定义请求。只需实现接口 IRestRequestFactory 并在属性 Config.RequestFactory 中进行设置即可。

例如，如果用户想要设置一个自定义组织（通过 HTTP 头提供），可以参考以下代码：

uses {...}, OpenApiRest;

type
  TMyRequestFactory = class(TInterfacedObject, IRestRequestFactory)
  strict private
    FFactory: IRestRequestFactory;
  public
    constructor Create(AFactory: IRestRequestFactory);
    function CreateRequest: IRestRequest;
  end;

constructor TMyRequestFactory.Create(AFactory: IRestRequestFactory);
begin
  FFactory := AFactory;
end;

function TMyRequestFactory.CreateRequest: IRestRequest;
begin
  Result := FFactory.CreateRequest;
  Result.AddHeader('OpenAI-Organization', 'org-nUilalMOTvqGjGeAopTDIsSB');
end;

// 设置后创建客户端
    FClient := TOpenAIClient.Create;
    FClient.Config.RequestFactory := TMyRequestFactory.Create(FClient.Config.RequestFactory);

在 Delphi 中集成 WhatsApp

OpenAI-Delphi 能够在 Delphi 中通过与 WPP4Delphi（由 WPPConnect-Team 开发）结合，集成到 WhatsApp 网络应用中以发送消息。以下示例代码展示了如何在 Delphi 中实现此功能：

if SwtChatGPT.IsOn then
begin
if Question <> '' then
begin
	//Credits --> https://github.com/landgraf-dev/openai-delphi
	Answer      := AskQuestion(Question, AChat.id);
	phoneNumber := Copy(Answer, 1, pos('#', Answer)-1);
	Answer      := StringReplace(Answer, phoneNumber + '#', '',[]);

	if Trim(Answer) <> '' then
	frDemo.TWPPConnect1.SendTextMessageEx(phoneNumber, '🤖' + ' *ChatGPT* ' + Answer, 'createChat: true', '123')
	else
	frDemo.TWPPConnect1.SendTextMessageEx(phoneNumber, '🤖' + ' *ChatGPT* ' + 'Could not retrieve an answer.', 'createChat: true', '123');

end;
end;

完整代码参见 WPP4Delphi 项目的 GitHub 页面。