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應用程序中使用作曲家，文本分類，圖像生成和命名實體識別。

展開