php openai sdk
v3.0.0
この PHP ライブラリは、OpenAI API のシンプルなラッパーを提供し、OpenAI API を PHP プロジェクトに簡単に統合できるようにします。
Composer 経由でライブラリをインストールできます。
composer require softcreatr/php-openai-sdkまず、プロジェクトにライブラリを含めます。
<?php
require_once ' vendor/autoload.php ' ;次に、API キー、組織 (オプション)、HTTP クライアント、HTTP リクエスト ファクトリ、および HTTP ストリーム ファクトリを使用してOpenAIクラスのインスタンスを作成します。
use SoftCreatR OpenAI OpenAI ;
$ apiKey = ' your_api_key ' ;
$ organization = ' your_organization_id ' ; // optional
// Replace these lines with your chosen PSR-17 and PSR-18 compatible HTTP client and factories
$ httpClient = new YourChosenHttpClient ();
$ requestFactory = new YourChosenRequestFactory ();
$ streamFactory = new YourChosenStreamFactory ();
$ uriFactory = new YourChosenUriFactory ();
$ openAI = new OpenAI ( $ requestFactory , $ streamFactory , $ uriFactory , $ httpClient , $ apiKey , $ organization );これで、マジック メソッド__callを使用して、サポートされている OpenAI API エンドポイントを呼び出すことができます。
$ response = $ openAI -> createChatCompletion ([
' model ' => ' gpt-4 ' ,
' messages ' => [
[ ' role ' => ' system ' , ' content ' => ' You are a helpful assistant. ' ],
[ ' role ' => ' user ' , ' content ' => ' Hello! ' ],
],
]);
// Process the API response
if ( $ response -> getStatusCode () === 200 ) {
$ responseObj = json_decode ( $ response -> getBody ()-> getContents (), true );
print_r ( $ responseObj );
} else {
echo " Error: " . $ response -> getStatusCode ();
}チャット完了のリアルタイム ストリーミングを有効にできます。
$ streamCallback = static function ( $ data ) {
if ( isset ( $ data [ ' choices ' ][ 0 ][ ' delta ' ][ ' content ' ])) {
echo $ data [ ' choices ' ][ 0 ][ ' delta ' ][ ' content ' ];
}
};
$ openAI -> createChatCompletion (
[
' model ' => ' gpt-4 ' ,
' messages ' => [
[
' role ' => ' user ' ,
' content ' => ' Tell me a story about a brave knight. ' ,
],
],
' stream ' => true ,
],
$ streamCallback
);各エンドポイントの使用方法の詳細については、OpenAI API ドキュメントとリポジトリで提供されている例を参照してください。
以下は、サポートされているメソッドをカテゴリ別にまとめたリストです。各メソッドは、対応する OpenAI API ドキュメントにリンクしており、このリポジトリ内の例へのリンクが含まれています。
createTranscription(array $options = [])createTranslation(array $options = [])createSpeech(array $options = [])createChatCompletion(array $options = [])createEmbedding(array $options = [])createFineTuningJob(array $options = [])listFineTuningJobs()retrieveFineTuningJob(array $parameters)cancelFineTuning(array $parameters)listFineTuningEvents(array $parameters, array $options = [])createBatch(array $options = [])retrieveBatch(array $parameters)cancelBatch(array $parameters)listBatches()listFiles()uploadFile(array $options = [])deleteFile(array $parameters)retrieveFile(array $parameters)retrieveFileContent(array $parameters)createUpload(array $options = [])addUploadPart(array $parameters, array $options = [])completeUpload(array $parameters)cancelUpload(array $parameters)createImage(array $options = [])createImageEdit(array $options = [])createImageVariation(array $options = [])listModels()retrieveModel(array $parameters)deleteModel(array $parameters)createModeration(array $options = [])createAssistant(array $options = [])listAssistants()retrieveAssistant(array $parameters)modifyAssistant(array $parameters, array $options = [])deleteAssistant(array $parameters)createThread(array $options = [])retrieveThread(array $parameters)modifyThread(array $parameters, array $options = [])deleteThread(array $parameters)createMessage(array $parameters, array $options = [])listMessages(array $parameters)retrieveMessage(array $parameters)modifyMessage(array $parameters, array $options = [])deleteMessage(array $parameters)createRun(array $parameters, array $options = [])createThreadAndRun(array $options = [])listRuns(array $parameters)retrieveRun(array $parameters)modifyRun(array $parameters, array $options = [])submitToolOutputsToRun(array $parameters, array $options = [])cancelRun(array $parameters)listRunSteps(array $parameters)retrieveRunStep(array $parameters)createVectorStore(array $options = [])listVectorStores()retrieveVectorStore(array $parameters)modifyVectorStore(array $parameters, array $options = [])deleteVectorStore(array $parameters)createVectorStoreFile(array $parameters, array $options = [])listVectorStoreFiles(array $parameters)retrieveVectorStoreFile(array $parameters)deleteVectorStoreFile(array $parameters)createVectorStoreFileBatch(array $parameters, array $options = [])retrieveVectorStoreFileBatch(array $parameters)cancelVectorStoreFileBatch(array $parameters)listVectorStoreFilesInBatch(array $parameters)listInvites()createInvite(array $options = [])retrieveInvite(array $parameters)deleteInvite(array $parameters)listUsers()modifyUser(array $parameters, array $options = [])retrieveUser(array $parameters)deleteUser(array $parameters)listProjects()createProject(array $options = [])retrieveProject(array $parameters)modifyProject(array $parameters, array $options = [])archiveProject(array $parameters)listProjectUsers(array $parameters)createProjectUser(array $parameters, array $options = [])retrieveProjectUser(array $parameters)modifyProjectUser(array $parameters, array $options = [])deleteProjectUser(array $parameters)listProjectServiceAccounts(array $parameters)createProjectServiceAccount(array $parameters, array $options = [])retrieveProjectServiceAccount(array $parameters)deleteProjectServiceAccount(array $parameters)listProjectApiKeys(array $parameters)retrieveProjectApiKey(array $parameters)deleteProjectApiKey(array $parameters)listAuditLogs(array $options = [])変更と更新の詳細なリストについては、CHANGELOG.md ファイルを参照してください。私たちはセマンティック バージョニングを遵守し、リリースごとに重要な変更を文書化します。
チャット完了時のリアルタイム トークン生成でストリーミングがサポートされるようになりました。例で示されているように、コールバックを使用してストリームを正しく処理していることを確認してください。
このライブラリは、ISC ライセンスに基づいてライセンスされています。詳細については、LICENSE ファイルを参照してください。
サシャ・グリュエル |
