PHPOpenAI下载 - PHPOpenAI源代码下载

phpopenai

PHPOpenAI是一个社区维护的图书馆，可在PHP中使用OpenAI API。

该项目用PHP编写，可用于轻松将OpenAI API集成到您现有的PHP项目中。

系统要求

该项目基于PHP版本8.1，以使用枚举等功能。该项目不需要任何外部依赖项。但是，您必须安装卷曲扩展名才能正常工作。

PHP版本> = 8.1
卷曲扩展

安装

该项目使用作曲家来管理依赖项。如果您尚未安装作曲家，则可以按照官方作曲家网站上的说明进行操作。

Packagist安装

要安装项目，您可以使用以下命令从packagist.org安装软件包：

composer require easygithdev/php-openai

写第一个示例

要使用OpenAI API ，您需要在其网站上注册并获取API密钥。拥有API密钥后，您可以在PHP代码中使用它将请求发送到OpenAI API。

要了解如何获取钥匙，请转到以下地址：

https://help.openai.com/en/articles/4936850-where-do-i-i-find-my-secret-api-key。

这是一个示例代码，向您展示了如何在PHP中使用OpenAI API：

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

use EasyGithDev  PHPOpenAI  Helpers  ModelEnum ;
use EasyGithDev  PHPOpenAI  OpenAIClient ;

$ apiKey = getenv ( ' OPENAI_API_KEY ' );

$ response = ( new OpenAIClient ( $ apiKey ))-> Completion ()-> create (
    ModelEnum:: TEXT_DAVINCI_003 ,
    " Say this is a test " ,
)-> toObject ();

// Response as stClass object
echo ' <pre> ' , print_r ( $ response , true ), ' </pre> ' ;

该代码使用API键实例化一个新的OpenAIApi对象，然后创建一个新的Completion对象，以使用OpenAI提供的GPT-3 AI语言模型执行文本完成。

在Completion对象上调用create()方法以生成新的文本完成。它需要两个参数：

第一个参数是用于完成的GPT-3模型的ID。在这种情况下，它使用text_davinci_003型号。
第二个参数是将生成完成的提示或输入文本。在这种情况下，提示是“说这是一个测试”。

完成的结果在$response变量中返回。然后可以将结果用于进一步处理，例如显示完整的文本或将其馈入程序的另一部分以进行其他处理。

管理API密钥

您可以使用环境变量存储密钥。然后，您可以如下示例中使用此变量：

 export OPENAI_API_KEY= " sk-xxxxxxxxxxx "

您可以将变量放入Apache配置文件中：

 <VirtualHost hostname:80>
   ...
   SetEnv OPENAI_API_KEY sk-xxxxxxxxxxx
   ...
</VirtualHost>

然后重新启动服务。

现在，您可以通过调用PHP的getenv()函数来使用环境变量。

 <?php
$ response = ( new OpenAIApi ( getenv ( ' OPENAI_API_KEY ' )))-> Completion ()-> create (
    ModelEnum:: TEXT_DAVINCI_003 ,
    " Say this is a test " ,
);

管理组织

如果您希望提供有关组织的信息，则必须按以下方式进行。

 <?php
$ apiKey = getenv ( ' OPENAI_API_KEY ' );
$ org = getenv ( ' OPENAI_API_ORG ' );

// Passing the organization to the client
$ response = ( new OpenAIClient ( $ apiKey , $ org ))

管理API的URL

如果您需要修改API的URL，则可以按以下方式进行：

 <?php
$ apiKey = getenv ( ' OPENAI_API_KEY ' );

// Create a new router, with origine url and version
$ route = new OpenAIRoute (
    ' https://api.openai.com ' ,
    ' v1 '
);

// Get a specific Url
echo $ route -> completionCreate () , ' <br> ' ;

// Passing the router to the client
$ response = ( new OpenAIClient ( $ apiKey ))
    -> setRoute ( $ route );

要重新定义路由，您需要扩展OpenAIRoute类或实现Route接口。

管理记录

API以JSON格式返回响应。为了促进访问不同信息，您可以调用处理程序对象的toObject()或toArray()方法访问数据。

 <?php

$ response = ( new OpenAIClient ( $ apiKey ))-> Completion ()-> create (
    ModelEnum:: TEXT_DAVINCI_003 ,
    " Say this is a test " ,
)-> toObject ();

// Response as a stClass object
echo ' <pre> ' , print_r ( $ response , true ), ' </pre> ' ;

$ response = ( new OpenAIClient ( $ apiKey ))-> Completion ()-> create (
    ModelEnum:: TEXT_DAVINCI_003 ,
    " Say this is a test " ,
)-> toArray ();

// Response as an associative array
echo ' <pre> ' , print_r ( $ response , true ), ' </pre> ' ;

管理错误

有时，API返回错误。因此，有必要能够确定是什么原因引起了问题。为了解决这个困难，您有很多选择。

如果您使用的是带有toObject()或toArray()方法的处理程序对象，则只需使用try-catch结构即可。

 try {
    $ response = ( new OpenAIClient ( ' BAD KEY ' ))
        -> Completion ()
        -> create (
            ModelEnum:: TEXT_DAVINCI_003 ,
            " Say this is a test " ,
        )
        -> toObject ();
} catch ( Throwable $ t ) {
    echo nl2br ( $ t -> getMessage ());
    die;
}

如果您使用的是CurlResponse对象，则可以检查使用验证器发生错误。

 $ handler = ( new OpenAIClient ( ' BAD KEY ' ))-> Completion ()-> create (
    ModelEnum:: TEXT_DAVINCI_003 ,
    " Say this is a test " ,
);

$ response = $ handler -> getResponse ();
$ contentTypeValidator = $ handler -> getContentTypeValidator ();

if (!( new StatusValidator ( $ response ))-> validate () or 
    !( new $ contentTypeValidator ( $ response ))-> validate ()) {
    echo $ response -> getBody ();
}

了解有关错误的更多信息。

应用程序的示例

这是一个视频，显示了一个应用程序，该应用程序允许您使用用户定义的绘画样式创建图像。此应用程序是使用Phpopenai项目创建的。

playground.mp4

您可以在此处找到代码：

https://github.com/easygithdev/phpopenai-playground.git。

代码样本

现在将OpenAI集成到您的应用程序中，就像几行代码一样简单。

您可以在此处找到所有代码：

https://github.com/easygithdev/phpopenai-examples。

使用chatgpt完成文本

 $ response = ( new OpenAIClient ( $ apiKey ))-> Chat ()-> create (
    ModelEnum:: GPT_3_5_TURBO ,
    [
        new ChatMessage (ChatMessage:: ROLE_SYSTEM , " You are a helpful assistant. " ),
        new ChatMessage (ChatMessage:: ROLE_USER , " Who won the world series in 2020? " ),
        new ChatMessage (ChatMessage:: ROLE_ASSISTANT , " The Los Angeles Dodgers won the World Series in 2020. " ),
        new ChatMessage (ChatMessage:: ROLE_USER , " Where was it played? " ),
    ]
)-> toObject ();

了解有关聊天完成的更多信息。

使用GPT-3完成文本完成

 $ response = ( new OpenAIClient ( $ apiKey ))-> Completion ()-> create (
    ModelEnum:: TEXT_DAVINCI_003 ,
    " Say this is a test " ,
)-> toObject ();

了解有关文本完成的更多信息。

使用流的文本完成

OpenAI API中的流属性是一个可选参数，您可以使用该参数来控制API返回的数据流。如果将此选项设置为true，则API将返回响应作为流数据，而不是单个响应。

这意味着您可以在API的可用时检索API的结果，而不是在处理它们之前等待完整的响应。此选项对于需要实时处理大量数据的应用程序很有用。

OpenAi-Completion-stream.mp4

 <?php
header ( ' Content-Type: text/event-stream ' );
header ( ' Cache-Control: no-cache ' );

. . .

( new OpenAIClient ( $ apiKey ))-> Completion ()-> create (
    model: " text-davinci-003 " ,
    prompt: " Translate this into 1. French, 2. Spanish and 3. Japanese: nn What rooms do you have available? nn 1. " ,
    temperature: 0.3 ,
    max_tokens: 100 ,
    top_p: 1.0 ,
    frequency_penalty: 0.0 ,
    presence_penalty: 0.0 ,
    stream: true
)-> getResponse ();

 < html >

< body >
    < div id =" result " > </ div >
    < script >
        function nl2br ( str , replaceMode , isXhtml ) {
            var breakTag = ( isXhtml ) ? '<br />' : '<br>' ;
            var replaceStr = ( replaceMode ) ? '$1' + breakTag : '$1' + breakTag + '$2' ;
            return ( str + '' ) . replace ( / ([^>rn]?)(rn|nr|r|n) / g , replaceStr ) ;
        }

        if ( typeof ( EventSource ) !== 'undefined' ) {
            console . info ( 'Starting connection...' ) ;
            var source = new EventSource ( 'stream.php' ) ;
            source . addEventListener ( 'open' , function ( e ) {
                console . info ( 'Connection was opened.' ) ;
            } , false ) ;

            source . addEventListener ( 'error' , function ( e ) {
                var txt ;
                switch ( event . target . readyState ) {
                    // if reconnecting
                    case EventSource . CONNECTING :
                        txt = 'Reconnecting...' ;
                        break ;
                    // if error was fatal
                    case EventSource . CLOSED :
                        txt = 'Connection failed. Will not retry.' ;
                        break ;
                }
                console . error ( 'Connection error: ' + txt ) ;
            } , false ) ;

            source . addEventListener ( 'message' , function ( e ) {
                if ( e . data == "[DONE]" ) {
                    source . close ( ) ;
                    return ;
                }
                document . getElementById ( 'result' ) . innerHTML += nl2br ( JSON . parse ( e . data ) . choices [ 0 ] . text ) ;

            } , false ) ;
        } else {
            alert ( 'Your browser does not support Server-sent events! Please upgrade it!' ) ;
            console . error ( 'Connection aborted' ) ;
        }
    </ script >
</ body >

</ html >

文本编辑

 $ response = ( new OpenAIClient ( $ apiKey ))-> Edit ()-> create (
    " What day of the wek is it? " ,
    ModelEnum:: TEXT_DAVINCI_EDIT_001 ,
    " Fix the spelling mistakes " ,
)-> toObject ();

了解有关文本编辑的更多信息。

使用dall·e生成图像

 function displayUrl ( $ url )
{
    return ' <img src=" ' . $ url . ' " /> ' ;
}

$ response = ( new OpenAIClient ( $ apiKey ))-> Image ()-> create (
    " a rabbit inside a beautiful garden, 32 bit isometric " ,
    n: 2 ,
    size: ImageSizeEnum::is256,
)-> toObject ();

 < ?php foreach ($response- > data as $image) : ? >
    < div > < ?= displayUrl($image- > url) ? > </ div >
< ?php endforeach; ? >

Rabit-32bits

了解有关图像生成的更多信息。

使用dall·e的图像变化

 $ response = ( new OpenAIClient ( $ apiKey ))-> Image ()-> createVariation (
        __DIR__ . ' /../../assets/image_variation_original.png ' ,
        n: 2 ,
        size: ImageSizeEnum::is256
    )-> toObject ();

变异1

了解有关图像变化的更多信息。

使用dall·e编辑图像编辑

 $ response = ( new OpenAIClient ( $ apiKey ))-> Image ()-> createEdit (
        image: __DIR__ . ' /../../assets/image_edit_original.png ' ,
        mask: __DIR__ . ' /../../assets/image_edit_mask2.png ' ,
        prompt: ' a sunlit indoor lounge area with a pool containing a flamingo ' ,
        size: ImageSizeEnum::is512,
    )-> toObject ();

img-edit

了解有关图像编辑的更多信息。

嵌入

 $ response = ( new OpenAIClient ( $ apiKey ))-> Embedding ()-> create (
    ModelEnum:: TEXT_EMBEDDING_ADA_002 ,
    " The food was delicious and the waiter... " ,
)-> toObject ();

了解有关嵌入的更多信息。

音频转录（文本语音）使用耳语

 $ response = ( new OpenAIClient ( $ apiKey ))-> Audio ()
    -> addCurlParam ( ' timeout ' , 30 )
    -> transcription (
        __DIR__ . ' /../../assets/openai.mp3 ' ,
        ModelEnum:: WHISPER_1 ,
        response_format: AudioResponseEnum:: SRT
    )-> toObject ();

了解有关音频转录的更多信息。

音频翻译（文本语音）使用耳语

 $ response = ( new OpenAIClient ( $ apiKey ))-> Audio ()
    -> addCurlParam ( ' timeout ' , 30 )
    -> translation (
        __DIR__ . ' /../../assets/openai_fr.mp3 ' ,
        ' whisper-1 ' ,
        response_format: AudioResponseEnum:: TEXT
    )-> toObject ();

了解有关音频翻译的更多信息。

模型列表

 $ response = ( new OpenAIClient ( $ apiKey ))
    -> Model ()
    -> list ()
    -> toObject ();

了解有关模型的更多信息。

模型检索

 $ response = ( new OpenAIClient ( $ apiKey ))
    -> Model ()
    -> retrieve ( ' text-davinci-001 ' )
    -> toObject ();

了解有关模型的更多信息。

模型删除

 $ response = ( new OpenAIClient ( $ apiKey ))
    -> Model ()
    -> delete (
        $ _POST [ ' model ' ]
    )-> toObject ();

了解有关模型的更多信息。

文件列表

 $ response = ( new OpenAIApi ( $ apiKey ))
    -> File ()
    -> list ()
    -> toObject ();

了解有关文件的更多信息。

文件上传

 $ response = ( new OpenAIApi ( $ apiKey ))
    -> File ()
    -> create (
        __DIR__ . ' /../../assets/mydata.jsonl ' ,
        ' fine-tune ' ,
    )
    -> toObject ();

了解有关文件的更多信息。

文件删除

 $ response = ( new OpenAIApi ( $ apiKey ))
    -> File ()
    -> delete ( ' file-xxxx ' )
    -> toObject ();

了解有关文件的更多信息。

文件检索

 $ response = ( new OpenAIApi ( $ apiKey ))
    -> File ()
    -> retrieve ( ' file-xxxx ' )
    -> toObject ();

了解有关模型的更多信息。

文件检索内容

 $ response = ( new OpenAIApi ( $ apiKey ))
    -> File ()
    -> download ( ' file-xxxx ' )
    -> toObject ();

了解有关模型的更多信息。

微调列表

 $ response = ( new OpenAIApi ( $ apiKey ))
    -> FineTune ()
    -> list ()
    -> toObject ();

了解有关微调的更多信息。

微调创建

 $ response = ( new OpenAIApi ( $ apiKey ))
        -> FineTune ()
        -> create (
            ' file-xxxx '
        )
        -> toObject ();

了解有关微调的更多信息。

微调检索

 $ response = ( new OpenAIApi ( $ apiKey ))
    -> FineTune ()
    -> retrieve ( ' ft-xxx ' )
    -> toObject ();

了解有关微调的更多信息。

微调清单事件

 $ response = ( new OpenAIApi ( $ apiKey ))
    -> FineTune ()
    -> listEvents ( ' ft-xxx ' )
    -> toObject ();

了解有关微调的更多信息。

微调取消

 $ response = ( new OpenAIApi ( $ apiKey ))
    -> FineTune ()
    -> Cancel ( ' ft-xxx ' )
    -> toObject ();

了解有关微调的更多信息。

适度

 $ response = ( new OpenAIClient ( $ apiKey ))
    -> Moderation ()
    -> create ( ' I want to kill them. ' )
    -> toObject ();

了解有关节制的更多信息。

测试

进行所有测试：

composer test tests

仅运行一个测试：

composer test tests/[NAME]Test.php

概括

PhpoPopenai是一个有用的项目，对于希望轻松将OpenAI API集成到其项目中的PHP开发人员。通过简单的安装以及在PHP应用程序中使用作曲家，文本分类，图像生成和命名实体识别。

展开