README

OpenAi PHP客户端是一个易于使用的PHP库，旨在简化与OpenAI Rest API的交互。

需求

• PHP版本 >= 8.1

安装

您可以使用流行的包管理器 composer 无缝地安装 OpenAi PHP客户端。

composer require thojou/openai-php-client

用法

要开始使用 OpenAi PHP客户端 的功能，您需要一个有效的OpenAI API密钥。如果您还没有，您可以在这里 获取。

<?php

use Thojou\OpenAi\OpenAi;

require_once __DIR__ . '/vendor/autoload.php';

$apiKey = "<YOUR API KEY>";

$openAi = new OpenAi($apiKey);
$result = $openAI->chat()->completion([
    'model' => 'gpt-3.5-turbo',
    'prompt' => 'This is a test',
]);

echo $result['choices'][0]['message']['content']; // Prints the openai chat answer

有关更多实用示例，请参阅 示例 文件夹。

限制

由于OpenAI API中已弃用，某些端点（即Edits、Fine-Tunes 和 Completions）尚未集成。

文档

OpenAi PHP客户端旨在与OpenAI API文档中详细说明的请求和响应格式无缝对齐。这个全面的资源提供了关于请求结构和预期响应的所有必要信息。

OpenAi类

OpenAi类是OpenAI API交互库的核心组件。它提供了访问不同API端点的方法，例如模型、聊天、图像、嵌入、音频、文件、微调和审查。

构造函数

public function __construct(
    string $apiKey,
    string $baseUri = 'https://api.openai.com/v1/'
)

创建OpenAi类的实例。

• 参数
  • $apiKey (字符串)：用于验证OpenAI API的API密钥。
  • $baseUri (字符串，可选)：API请求的基础URI。默认为'https://api.openai.com/v1/'。

方法

models()

public function models(): Models

返回模型端点的实例。

• 返回
  • Models：模型端点的实例。

chat()

public function chat(): Chat

返回聊天端点的实例。

• 返回
  • Chat：聊天端点的实例。

images()

public function images(): Images

返回图像端点的实例。

• 返回
  • Images：图像端点的实例。

embeddings()

public function embeddings(): Embeddings

返回嵌入端点的实例。

• 返回
  • Embeddings：嵌入端点的实例。

audio()

public function audio(): Audio

返回音频端点的实例。

• 返回
  • Audio：音频端点的实例。

files()

public function files(): Files

返回文件端点的实例。

• 返回
  • Files：文件端点的实例。

fineTuning()

public function fineTuning(): FineTuning

返回微调端点的实例。

• 返回
  • FineTuning：微调端点的实例。

moderation()

public function moderation(): Moderations

返回审查端点的实例。

• 返回
  • Moderations：审查端点的实例。

此类提供了以结构化方式与OpenAI API的各种端点交互的方法。每个方法返回相应的端点类实例，使您能够更有效地执行API操作。

许可证

本项目采用慷慨和宽容的MIT许可证。