marxolity/open-ai

1.2.2 2023-11-22 10:33 UTC

This package is auto-updated.

Last update: 2024-12-24 05:01:40 UTC


README

uptime License Total Downloads

A Laravel Package that facilitates effortless integration of the OpenAI API into PHP applications, ensuring seamless connectivity and interaction with OpenAI's services within the Laravel Framework.

Installation

Install the package via Composer Reference:

composer require marxolity/open-ai

Configuration

Publish the package configuration: (config/open-ai.php)

php artisan vendor:publish --provider="Marxolity\OpenAi\OpenAIServiceProvider" --tag="config"

Set up your environment variables:

OPENAI_API_KEY="<<YOUR_API_KEY>>"

Usage

   use \Marxolity\OpenAi\Facades\OpenAi;

Changing Model then Retrieve responseMessage (Ex: Change model to gpt-4)

   $responseMessage = OpenAi::query("What is Laravel?")
        ->setModel('gpt-4')
        ->send()->responseMessage;

Retrieve Response Message

   $responseMessage = OpenAi::query("What is Laravel?")->send()->responseMessage;

Response Message:

   Laravel is a free, open-source PHP web framework used for developing web applications. It fol...

Format Output

Retrieve as Array

   $responseArray = OpenAi::query("What is Laravel?")->send()->toArray();

Retrieve as JSON

   $responseJson = OpenAi::query("What is Laravel?")->send()->toJson();

Retrieve as XML

   $responseXml = OpenAi::query("What is Laravel?")->send()->toXml();

Tested Models (Limited to GPT Models)

Note: Please be advised that other GPT models may be utilized at your discretion, acknowledging associated risks.