Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/adrianmejias/laravel-open-ai

Open AI wrapper for the Laravel Framework.
https://github.com/adrianmejias/laravel-open-ai

api laravel laravel-framework open-ai openai php wrapper

Last synced: 1 day ago
JSON representation

Open AI wrapper for the Laravel Framework.

Host: GitHub
URL: https://github.com/adrianmejias/laravel-open-ai
Owner: adrianmejias
License: mit
Archived: true
Created: 2022-01-11T10:14:12.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2023-02-02T15:22:04.000Z (over 1 year ago)
Last Synced: 2024-09-21T14:06:54.544Z (6 days ago)
Topics: api, laravel, laravel-framework, open-ai, openai, php, wrapper
Language: PHP
Homepage:
Size: 79.1 KB
Stars: 4
Watchers: 2
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.yml
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md

Awesome Lists containing this project

README

        # Open AI Package for Laravel

[![security](https://github.com/adrianmejias/laravel-open-ai/actions/workflows/security.yml/badge.svg)](https://github.com/adrianmejias/laravel-open-ai/actions/workflows/security.yml) [![tests](https://github.com/adrianmejias/laravel-open-ai/actions/workflows/tests.yml/badge.svg)](https://github.com/adrianmejias/laravel-open-ai/actions/workflows/tests.yml) [![PHPStan](https://github.com/adrianmejias/laravel-open-ai/actions/workflows/phpstan.yml/badge.svg)](https://github.com/adrianmejias/laravel-open-ai/actions/workflows/phpstan.yml) [![PHP CS Fixer](https://github.com/adrianmejias/laravel-open-ai/actions/workflows/php-cs-fixer.yml/badge.svg)](https://github.com/adrianmejias/laravel-open-ai/actions/workflows/php-cs-fixer.yml) [![StyleCI](https://github.styleci.io/repos/446770602/shield?branch=main)](https://github.styleci.io/repos/446770602?branch=main) [![Build Status](https://travis-ci.com/adrianmejias/laravel-open-ai.svg?branch=main)](https://travis-ci.com/adrianmejias/laravel-open-ai) [![codecov](https://codecov.io/gh/adrianmejias/laravel-open-ai/branch/main/graph/badge.svg?token=7TCWYB1YV6)](https://codecov.io/gh/adrianmejias/laravel-open-ai) ![Downloads](https://img.shields.io/packagist/dt/adrianmejias/laravel-open-ai) ![Packagist](https://img.shields.io/packagist/v/adrianmejias/laravel-open-ai) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) ![Liberapay](https://img.shields.io/liberapay/patrons/adrianmejias.svg?logo=liberapay)

[Open AI](https://openai.com/api/) api wrapper for the [Laravel Framework](https://laravel.com/).

## Installation

This version supports PHP 8.0. You can install the package via composer:

`composer require adrianmejias/laravel-open-ai`

To create the `config/open-ai.php` configuration file:

`php artisan vendor:publish --tag=open-ai`

## Usage

### Example

```php

 'list',

    'data' => [

        [

            'object' => 'engine',

            'id' => 'ada',

            'ready' => 1,

            'owner' => 'openai',

            'created' => '',

            'permissions' => '',

            'replicas' => '',

            'ready_replicas' => '',

            'max_replicas' => '',

        ],

        // ...

    ],

];

```

### Api Requests

- `completions(array $options, string $engine = 'davinci')` - Get a list of completions.

- `search(array $options, string $engine = 'davinci')` - Get a list of search results.

- `answers(array $options)` - Get a list of answers.

- `classifications(array $options)` - Get a list of classifications.

- `files(string $file, string $purpose = 'classifications')` - Publish a training file (jsonl).

- `engines()` - Get a list of engines.

- `engine(string $engine)` - Get information for a specific engine.

## Testing

`composer test`

## Todo

- [x] Add to packagist repo

- [x] Add unit tests

- [x] Add documentation for open source contributations

- [x] Add GitHub Action for unit tests

- [ ] Add more unit test coverages

- [ ] Add more documentation to README.md

- [ ] Add API listing to README.md

## Contributing

Thank you for considering contributing to Laravel Open Ai! You can read the contribution guide [here](.github/CONTRIBUTING.md).

## Code of Conduct

In order to ensure that the community is welcoming to all, please review and abide by the [Code of Conduct](.github/CODE_OF_CONDUCT.md).

## Security Vulnerabilities

Please see the [security file](SECURITY.md) for more information.

## License

The MIT License (MIT). Please see the [license file](LICENSE.md) for more information.