Download the PHP package tallesairan/oobapi-php without Composer
On this page you can find all versions of the php package tallesairan/oobapi-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download tallesairan/oobapi-php
More information about tallesairan/oobapi-php
Files in tallesairan/oobapi-php
Package oobapi-php
Short Description PHP Wrapper for oobabooga's text-generation-webui
License
Informations about the package oobapi-php
oobapi-php Documentation
PHP Wrapper for oobabooga's text-generation-webui
This is a PHP client for interacting with WebSocket and HTTP endpoints of the Text Generation API. The client allows you to send requests to the server and receive responses from the WebSocket and HTTP endpoints.
This documentation provides information about the oobapi-php
library, a PHP wrapper for oobabooga's text-generation-webui. The library consists of two main classes, ApiClient
and StreamClient
, each responsible for interacting with different API endpoints.
Table of Contents
- Installation
- ApiClient
- Constructor
- Methods
- generate
- chat
- stopStream
- StreamClient
- Constructor
- Methods
- stream
- chatStream
Installation
To use the oobapi-php
library, you need to have PHP 7.4 or later installed. Additionally, the library depends on the following packages:
guzzlehttp/guzzle
version 7.0 or latertextalk/websocket
version 1.6.1 or later
You can install the library via Composer. Add the following to your composer.json
file and run composer install
:
Requirements
- PHP 7.4 or higher
- Composer
ApiClient
The ApiClient
class allows you to interact with the oobabooga's text-generation-webui API using HTTP requests.
Constructor
Create a new ApiClient
instance by providing the base URL for the API:
Methods
generate
Generate text based on a given prompt and optional parameters.
chat
Chat with the API to generate interactive text based on user input and history.
stopStream
Stop the text generation stream.
StreamClient
- Take careful this is under development
The StreamClient
class enables you to interact with the oobabooga's text-generation-webui API using WebSocket.
Constructor
Create a new StreamClient
instance by providing the WebSocket base URL:
Methods
stream
Generate text using WebSocket streaming based on a given prompt and optional parameters.
chatStream
Chat using WebSocket streaming to generate interactive text based on user input and history.
Please note that the above documentation provides a general overview of the oobapi-php
library and its main classes. For more specific implementation details and usage examples, refer to the source code and documentation of the library itself.
Contributions
Contributions are welcome! If you find any issues or want to improve the client, feel free to open a pull request.
License
This project is licensed under the MIT License. See the LICENSE file for details.
Please make sure to adjust the WebSocket and HTTP endpoint URLs in the Usage section to match the actual implementation of your WebSocket and HTTP servers. Also, update the WebSocket and HTTP server information in the WebSocket Server and HTTP Server sections accordingly.