from typing import Any
from typing import Dict
from typing import List
from openCHA.llms import BaseLLM
from openCHA.utils import get_from_dict_or_env
from pydantic import model_validator
[docs]
class OpenAILLM(BaseLLM):
"""
**Description:**
An implementation of the OpenAI APIs. `OpenAI API <https://platform.openai.com/docs/libraries>`_
"""
models: Dict = {
"gpt-4": 8192,
"gpt-4-0314": 8192,
"gpt-4-0613": 8192,
"gpt-4-32k": 32768,
"gpt-4-32k-0314": 32768,
"gpt-4-32k-0613": 32768,
"gpt-3.5-turbo": 4096,
"gpt-3.5-turbo-0301": 4096,
"gpt-3.5-turbo-0613": 4096,
"gpt-3.5-turbo-16k": 16385,
"gpt-3.5-turbo-1106": 16385,
"gpt-3.5-turbo-16k-0613": 16385,
"text-ada-001": 2049,
"ada": 2049,
"text-babbage-001": 2040,
"babbage": 2049,
"text-curie-001": 2049,
"curie": 2049,
"davinci": 2049,
"text-davinci-003": 4097,
"text-davinci-002": 4097,
"code-davinci-002": 8001,
"code-davinci-001": 8001,
"code-cushman-002": 2048,
"code-cushman-001": 2048,
}
api_key: str = ""
llm_model: Any = None
max_tokens: int = 150
[docs]
@model_validator(mode="before")
def validate_environment(cls, values: Dict) -> Dict:
"""
Validate that api key and python package exists in environment.
This method is defined as a validation model for the class and checks the required environment values for using OpenAILLM.
If the "openai_api_key" key exists in the input, its value is assigned to the "api_key" variable.
Additionally, it checksthe existence of the openai library, and if it's not found, it raises an error.
Args:
cls (type): The class itself.
values (Dict): The dictionary containing the values for validation.
Return:
Dict: The validated dictionary with updated values.
Raise:
ValueError: If the anthropic python package cannot be imported.
"""
openai_api_key = get_from_dict_or_env(
values, "openai_api_key", "OPENAI_API_KEY"
)
values["api_key"] = openai_api_key
try:
from openai import OpenAI
values["llm_model"] = OpenAI()
except ImportError:
raise ValueError(
"Could not import openai python package. "
"Please install it with `pip install openai`."
)
return values
[docs]
def get_model_names(self) -> List[str]:
"""
Get a list of available model names.
Return:
List[str]: A list of available model names.
"""
return self.models.keys()
[docs]
def is_max_token(self, model_name, query) -> bool:
"""
Check if the token count of the query exceeds the maximum token count for the specified model.
It calculates the number of tokens from tokenizing the input query and compares it with the maximum allowed tokens for the model.
If the number of tokens is greater than the maximum, it returns True.
Args:
model_name (str): The name of the model.
query (str): The query to check.
Return:
bool: True if the token count exceeds the maximum, False otherwise.
"""
model_max_token = self.models[model_name]
try:
import tiktoken
except ImportError:
raise ValueError(
"Could not import tiktoken python package. "
"This is needed in order to calculate get_num_tokens. "
"Please install it with `pip install tiktoken`."
)
encoder = "gpt2"
if model_name in (
"text-davinci-003",
"text-davinci-002",
):
encoder = "p50k_base"
if model_name.startswith("code"):
encoder = "p50k_base"
enc = tiktoken.get_encoding(encoder)
tokenized_text = enc.encode(query)
return model_max_token < len(tokenized_text)
[docs]
def _parse_response(self, response) -> str:
"""
Parse the response object and return the generated completion text.
Args:
response (object): The response object.
Return:
str: The generated completion text.
"""
return response.choices[0].message.content
[docs]
def _prepare_prompt(self, prompt) -> Any:
"""
Prepare the prompt by combining the human and AI prompts with the input prompt.
Args:
prompt (str): The input prompt.
Return:
Any: The prepared prompt.
"""
return [{"role": "system", "content": prompt}]
[docs]
def generate(self, query: str, **kwargs: Any) -> str:
"""
Generate a response based on the provided query.
Args:
query (str): The query to generate a response for.
**kwargs (Any): Additional keyword arguments.
Return:
str: The generated response.
Raise:
ValueError: If the model name is not specified or is not supported.
"""
model_name = "gpt-3.5-turbo-1106"
if "model_name" in kwargs:
model_name = kwargs["model_name"]
if model_name not in self.get_model_names():
raise ValueError(
"model_name is not specified or OpenAI does not support provided model_name"
)
stop = kwargs["stop"] if "stop" in kwargs else None
max_tokens = (
kwargs["max_tokens"]
if "max_tokens" in kwargs
else self.max_tokens
)
print("here", max_tokens, model_name)
self.llm_model.api_key = self.api_key
query = self._prepare_prompt(query)
response = self.llm_model.chat.completions.create(
model=model_name,
messages=query,
max_tokens=max_tokens,
stop=stop,
)
return self._parse_response(response)