hrai_python 0.3.0

A decorator for logging OpenAI API requests and responses.

Installation

pip install hrai_python

Configuration

from hrai_python.hrai_logger import hrai_logger

#Initialize the Logger

logger_instance = Logger(
    client_attr_name='client',        # Attribute name of the OpenAI client in your class
    enable_remote=True,               # Enable remote logging
    enable_async=True,                # Use asynchronous remote logging
    return_type=Logger.Return_Type.content_only
)

Basic Usage

import os
from openai import OpenAI
from dotenv import load_dotenv
from hrai_python.hrai_logger import hrai_logger


logger = logger()

class gpt:
    def __init__(self):
        load_dotenv()
        self.model = os.environ.get("OPENAI_MODEL")
        self.client = OpenAI(api_key=os.environ.get("OPENAI_API_KEY"))
            
    @logger.readable
    def basic_completion(self, messages):
        completion = self.client.chat.completions.create(
        model = self.model,
        messages=messages
        )
        return(completion)

Configuration

hrai_python offers several configuration options when initializing the Logger class:

• client_instance (Optional[openai.ChatCompletion]): OpenAI client instance if standalone.
• client_attr_name (Optional[str]): Attribute name of the OpenAI client in your class (default: "client").
• base_url (Optional[str]): Remote server URL for logging (default: "https://api.humanreadable.ai/").
• apikey (Optional[str]): API key for authenticating with the remote logging server.
• log_file (str): Log file name (default: "hrai.log").
• log_level (str): Logging level, e.g., "INFO", "DEBUG", "WARNING".
• log_format (Optional[str]): Log message format (default: '%(asctime)s - %(levelname)s - %(message)s').
• enable_remote (bool): Enable/disable remote logging (default: True).
• enable_async (bool): Use asynchronous remote logging (default: False).
• return_type (Return_Type): Defines the format of the returned response from API calls.

Return Types

The Return_Type enum in hrai_python defines the format of the response from OpenAI API calls:

• content_only (1): Returns only the message content. (default)
• json (2): Returns the response as a JSON object.
• openai_object (3): Returns the full OpenAI response object.