Metadata-Version: 2.1
Name: llama_cpp_openai
Version: 0.1.1
Summary: Lightweight OpenAI API server on top of Llama local models. Suitable for combined use with Microsoft AutoGen.
License: Apache-2.0
Author: blav
Author-email: blav@actar.us
Requires-Python: >=3.8,<3.12
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: OS Independent
Classifier: Operating System :: POSIX
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: fastapi (>=0.105.0,<0.106.0)
Requires-Dist: llama-cpp-python (>=0.2.22,<0.3.0)
Requires-Dist: pydantic (>=2.5.2,<3.0.0)
Requires-Dist: uvicorn (>=0.24.0.post1,<0.25.0)
Description-Content-Type: text/markdown

# Llama_CPP OpenAI API Server Project Overview

## Introduction
The `llama_cpp_openai` module provides a lightweight implementation of an OpenAI API server on top of
Llama CPP models. This implementation is particularly designed for use with Microsoft AutoGen and includes support for function calls. The project is structured around the `llama_cpp_python` module and is aimed at facilitating the integration of AI models in applications using OpenAI clients or API.

## Project Structure
The project is organized into several key directories and files:

- **llama_cpp_openai**: Contains the core implementation of the API server.
    - `__init__.py`: Initialization file for the module.
    - `_api_server.py`: Defines the OpenAPI server, using FastAPI for handling requests.
    - `_llama_cpp_functions_chat_handler.py`: Implements the `llama-2-functionary` chat handler that supports function calling.

- **examples**: Provides example scripts demonstrating the usage of the API server.
    - `README.md`: Overview and description of example scripts.
    - `autogen_basic.py`: Basic integration of AutoGen with Llama_CPP using the OpenAI API server.
    - `autogen_functions.py`: Sets up an AutoGen chatbot with function calls capabilities.
    - `basic.py`: Demonstrates the setup and start of an API server using the Llama library.

## Key Features
- **FastAPI Integration**: Utilizes FastAPI for efficient and easy-to-use API endpoints.
- **Llama Library Usage**: Leverages the Llama library for handling AI model interactions.
- **Function Call Support**: Includes capabilities for function calls in chatbot environments.
- **Examples for Quick Start**: Provides example scripts for easy understanding and implementation.

