iteks/laravel-openai

A powerful package that seamlessly integrates OpenAI's advanced AI capabilities into your Laravel applications. This package offers quick setup and intuitive configuration to leverage AI models for chat, embeddings, and more.

Maintainers

Details

github.com/iteks/laravel-openai

Source

Issues

Installs: 808

Dependents: 0

Suggesters: 0

Security: 0

Stars: 6

Watchers: 0

Forks: 2

Open Issues: 0

v1.0.5 2024-10-06 13:34 UTC

Requires

Requires (Dev)

MIT f2495595e6ea302450642aa7dc18b52e26fd3c84

  • Jeramy Hing <iteks.woop@msn.com>

phphttpdataapiclientlaravelaiopenaigpt

This package is auto-updated.

Last update: 2025-03-06 14:32:17 UTC

README

Laravel OpenAI

Total Downloads Latest Stable Version License

Laravel OpenAI is a community-maintained PHP API client, a powerful and user-friendly package designed to seamlessly integrate OpenAI's advanced AI capabilities into your Laravel applications. This package simplifies interaction with the OpenAI API, offering an elegant interface to quickly leverage various AI models for chat, embeddings, and more. With intuitive configuration through environment variables and smooth integration via a dedicated Laravel service provider, Laravel OpenAI ensures you can get started with OpenAI endpoints swiftly and efficiently. Enhance your Laravel applications by harnessing the power of OpenAI's AI models with this versatile and easy-to-use client.

Offered by iteks, Developed by jeramyhing.

Get Started

Requires PHP 8.1+

Install Laravel OpenAI via the Composer package manager:

composer require iteks/laravel-openai

Set your OpenAI API key and base URI in your .env file. These configurations are required:

OPENAI_API_KEY=
OPENAI_BASE_URI=

To explore additional optional configurations, publish the package configuration file using the following command:

php artisan vendor:publish --provider="Iteks\Providers\OpenAiServiceProvider" --tag=config

Usage

Include the OpenAi facade.

use Iteks\Support\Facades\OpenAi;

For API calls, required parameters should be passed directly to the Facade methods without wrapping them in an array. Optional parameters can be included as an associative array at the end. Each method's documentation includes a link to the official API reference for further details.

// Example of a required parameter
$response = OpenAi::chat('Your message here');

// Example with optional parameters
$response = OpenAi::chat('Your message here', ['temperature' => 0.7, 'max_tokens' => 150]);

ENDPOINTS

Audio

Create speech

Generates audio from the input text. See official documentation for all options.

OpenAi::audio()->createSpeech('tts-1', 'The quick brown fox jumped over the lazy dog.', 'alloy');

top

Create transcription

Transcribes audio into the input language. See official documentation for all options.

OpenAi::audio()->createTranscription(fopen('@/path/to/file/audio.mp3', 'r'), 'whisper-1');

top

Create translation

Translates audio into English. See official documentation for all options.

OpenAi::audio()->createTranslation('@/path/to/file/german.m4a', 'whisper-1');

top

Chat

Create chat completion

Creates a model response for the given chat conversation. See official documentation for all options.

OpenAi::chat()->create(
    [
        ['role' => 'system', 'content' => 'You are a helpful assistant.',],
        [ 'role' => 'user', 'content' => 'Hello!', ],
    ],
    'gpt-4o'
);

top

Embeddings

Create embeddings

Creates an embedding vector representing the input text. See official documentation for all options.

OpenAi::embeddings()->create(
    'The food was delicious and the waiter...',
    'text-embedding-ada-002',
    ['encoding_format' => 'float']
);

top

Fine-tuning

Create fine-tuning job

Creates a fine-tuning job which begins the process of creating a new model from a given dataset. See official documentation for all options.

OpenAi::fineTuning()->create('gpt-3.5-turbo', 'file-BK7bzQj3FfZFXr7DbL6xJwfo');

top

List fine-tuning jobs

List your organization's fine-tuning jobs. See official documentation for all options.

OpenAi::fineTuning()->list();

top

List fine-tuning events

Get status updates for a fine-tuning job. See official documentation for all options.

OpenAi::fineTuning()->listEvents('ftjob-abc123');

top

List fine-tuning checkpoints

List checkpoints for a fine-tuning job. See official documentation for all options.

OpenAi::fineTuning()->listCheckpoints('ftjob-abc123');

top

Retrieve fine-tuning job

Get info about a fine-tuning job. See official documentation for all options.

OpenAi::fineTuning()->retrieve('ft-AF1WoRqd3aJAHsqc9NY7iL8F');

top

Cancel fine-tuning

Immediately cancel a fine-tune job. See official documentation for all options.

OpenAi::fineTuning()->cancel('ftjob-abc123');

top

Batch

Create batch

Creates and executes a batch from an uploaded file of requests. See official documentation for all options.

OpenAi::batch()->create('file-abc123', '/v1/chat/completions', '24h');

top

Retrieve batch

Retrieves a batch. See official documentation for all options.

OpenAi::batch()->retrieve('batch_abc123');

top

Cancel batch

Cancels an in-progress batch. See official documentation for all options.

OpenAi::batch()->cancel('batch_abc123');

top

List batch

List your organization's batches. See official documentation for all options.

OpenAi::batch()->list();

top

Files

Upload file

Upload a file that can be used across various endpoints. Individual files can be up to 512 MB, and the size of all files uploaded by one organization can be up to 100 GB. See official documentation for all options.

OpenAi::files()->create(fopen('@mydata.jsonl', 'r'), 'fine-tune');

top

List files

Returns a list of files that belong to the user's organization. See official documentation for all options.

OpenAi::files()->list();

top

Retrieve file

Returns information about a specific file. See official documentation for all options.

OpenAi::files()->retrieve('file-abc123');

top

Delete file

Delete a file. See official documentation for all options.

OpenAi::files()->delete('file-abc123');

top

Retrieve file content

Returns the contents of the specified file. See official documentation for all options.

OpenAi::files()->retrieveContents('file-abc123');

top

Images

Create image

Creates an image given a prompt. See official documentation for all options.

OpenAi::images()->create(
    'A cute baby sea otter',
    [
        'model' => 'dall-e-3',
        'n' => 1,
        'size' => '1024x1024',
    ]
);

top

Create image edit

Creates an edited or extended image given an original image and a prompt. See official documentation for all options.

OpenAi::images()->createEdit(
    'fopen('@otter.png', 'r')',
    'A cute baby sea otter wearing a beret',
    [
        'mask' => '@mask.png',
        'n' => 2,
        'size' => '1024x1024',
    ]
);

top

Create image variation

Creates a variation of a given image. See official documentation for all options.

OpenAi::images()->createVariation(
    'fopen('@otter.png', 'r')',
    [
        'n' => 2,
        'size' => '1024x1024',
    ]
);

top

Models

List models

Lists the currently available models, and provides basic information about each one such as the owner and availability. See official documentation for all options.

OpenAi::models()->list();

top

Retrieve model

Retrieves a model instance, providing basic information about the model such as the owner and permissioning. See official documentation for all options.

OpenAi::models()->retrieve('gpt-3.5-turbo-instruct');

top

Delete a fine-tuned model

Delete a fine-tuned model. You must have the Owner role in your organization to delete a model. See official documentation for all options.

OpenAi::models()->delete('ft:gpt-3.5-turbo:acemeco:suffix:abc123');

top

Moderations

Create moderation

Classifies if text is potentially harmful. See official documentation for all options.

OpenAi::moderations()->create('I want to kill them.');

top

ASSISTANTS

Assistants

Create assistant

Create an assistant with a model and instructions. See official documentation for all options.

OpenAi::assistants()->create(
    'gpt-4-turbo',
    [
        'instructions' => 'You are a personal math tutor. When asked a question, write and run Python code to answer the question.',
        'name' => 'Math Tutor',
        'tools' => [['type' => 'code_interpreter']],
    ]
);

top

List assistants

Returns a list of assistants. See official documentation for all options.

OpenAi::assistants()->list();

top

Retrieve assistant

Retrieves an assistant. See official documentation for all options.

OpenAi::assistants()->retrieve('asst_abc123');

top

Modify assistant

Modifies an assistant. See official documentation for all options.

OpenAi::assistants()->modify(
    'asst_idcmCPkquyQbqOpdJOEb6wCO',
    [
        'instructions' => 'You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.',
        'tools' => [['type' => 'file_search']],
        'model' => 'gpt-4-turbo',
    ]
);

top

Delete assistant

Delete an assistant. See official documentation for all options.

OpenAi::assistants()->delete('asst_abc123');

top

Threads

Create thread

Create a thread. See official documentation for all options.

OpenAi::threads()->create();

top

Retrieve thread

Retrieves a thread. See official documentation for all options.

OpenAi::threads()->retrieve('thread_abc123');

top

Modify thread

Modifies a thread. See official documentation for all options.

OpenAi::threads()->modify(
    'thread_abc123',
    [
        'metadata' => [
            'modified' => 'true',
            'user' => 'abc123',
        ],
    ]
);

top

Delete thread

Delete a thread. See official documentation for all options.

OpenAi::threads()->delete('thread_abc123');

top

Messages

Create message

Create a message. See official documentation for all options.

OpenAi::messages()->create(
    'thread_abc123',
    'user',
    'How does AI work? Explain it in simple terms.'
);

top

List messages

Returns a list of messages for a given thread. See official documentation for all options.

OpenAi::messages()->list('thread_abc123');

top

Retrieve message

Retrieves a message. See official documentation for all options.

OpenAi::messages()->retrieve('thread_abc123', 'msg_abc123');

top

Modify message

Modifies a message. See official documentation for all options.

OpenAi::messages()->modify(
    'thread_abc123',
    'msg_abc123',
    [
        'metadata' => [
            'modified' => 'true',
            'user' => 'abc123',
        ],
    ]
);

top

Delete message

Deletes a message. See official documentation for all options.

OpenAi::messages()->delete('thread_abc123', 'msg_abc123');

top

Runs

Create run

Create a run. See official documentation for all options.

OpenAi::runs()->create('thread_abc123', 'asst_abc123');

top

Create thread and run

Create a thread and run it in one request. See official documentation for all options.

OpenAi::runs()->createThreadAndRun(
    'asst_abc123',
    [
        'messages' => [
            [
                'role' => 'user',
                'content' => 'Explain deep learning to a 5 year old.',
            ],
        ],
    ]
);

top

List runs

Returns a list of runs belonging to a thread. See official documentation for all options.

OpenAi::runs()->list('thread_abc123');

top

Retrieve run

Retrieves a run. See official documentation for all options.

OpenAi::runs()->retrieve('thread_abc123', 'run_abc123');

top

Modify run

Modifies a run. See official documentation for all options.

OpenAi::runs()->modify(
    'thread_abc123',
    'run_abc123',
    [
        'metadata' => [
            'user' => 'user_abc123',
        ],
    ]
);

top

Submit tool outputs to run

When a run has the status: "requires_action" and required_action.type is submit_tool_outputs, this endpoint can be used to submit the outputs from the tool calls once they're all completed. See official documentation for all options.

OpenAi::runs()->submitToolOutputs(
    'thread_abc123',
    'run_abc123',
    [
        0 => [
            'tool_call_id' => 'call_001',
            'output' => '70 degrees and sunny.',
        ],
    ]
);

top

Cancel a run

Cancels a run that is in_progress. See official documentation for all options.

OpenAi::runs()->cancel('thread_abc123', 'run_abc123');

top

Run Steps

List run steps

Returns a list of run steps belonging to a run. See official documentation for all options.

OpenAi::runSteps()->list('thread_abc123', 'run_abc123');

top

Retrieve run step

Retrieves a run step. See official documentation for all options.

OpenAi::runSteps()->retrieve('thread_abc123', 'run_abc123', 'step_abc123');

top

Vector Stores

Create vector store

Create a vector store. See official documentation for all options.

OpenAi::vectorStores()->create(['name' => 'Support FAQ']);

top

List vector stores

Returns a list of vector stores. See official documentation for all options.

OpenAi::vectorStores()->list();

top

Retrieve vector store

Retrieves a vector store. See official documentation for all options.

OpenAi::vectorStores()->retrieve('vs_abc123');

top

Modify vector store

Modifies a vector store. See official documentation for all options.

OpenAi::vectorStores()->modify('vs_abc123', ['name' => 'Support FAQ']);

top

Delete vector store

Delete a vector store. See official documentation for all options.

OpenAi::vectorStores()->delete('vs_abc123');

top

Vector Store Files

Create vector store file

Create a vector store file by attaching a File to a vector store. See official documentation for all options.

OpenAi::vectorStoreFiles()->create('vs_abc123', 'file-abc123');

top

List vector store files

Returns a list of vector store files. See official documentation for all options.

OpenAi::vectorStoreFiles()->list('vs_abc123');

top

Retrieve vector store file

Retrieves a vector store file. See official documentation for all options.

OpenAi::vectorStoreFiles()->retrieve('vs_abc123', 'file-abc123');

top

Delete vector store file

Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the delete file endpoint. See official documentation for all options.

OpenAi::vectorStoreFiles()->delete('vs_abc123', 'file-abc123');

top

Vector Store File Batches

Create vector store file batch

Create a vector store file batch. See official documentation for all options.

OpenAi::vectorStoreFileBatches()->create(
    'vs_abc123',
    [
        'file_ids' => [
            'file-abc123',
            'file-abc456',
        ],
    ]
);

top

Retrieve vector store file batch

Retrieves a vector store file batch. See official documentation for all options.

OpenAi::vectorStoreFileBatches()->retrieve('vs_abc123', 'vsfb_abc123');

top

Cancel vector store file batch

Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible. See official documentation for all options.

OpenAi::vectorStoreFileBatches()->cancel('vs_abc123', 'vsfb_abc123');

top

List vector store files in a batch

Returns a list of vector store files in a batch. See official documentation for all options.

OpenAi::vectorStoreFileBatches()->list('vs_abc123', 'vsfb_abc123');

top

LEGACY

Completions

Create completion

Creates a completion for the provided prompt and parameters. See official documentation for all options.

OpenAi::completions()->create(
    'gpt-3.5-turbo-instruct',
    'Say this is a test',
    [
        'max_tokens' => 7,
        'temperature' => 0,
    ]
);

top