1 Commits

20 changed files with 69 additions and 325 deletions
-1
View File
@@ -167,4 +167,3 @@ cython_debug/
src/** src/**
requirements.txt requirements.txt
Pipfile
-9
View File
@@ -1,19 +1,10 @@
Release History Release History
=============== ===============
## 0.1.6 (2024-10-31)
- Add `sm.Plugin` syntax sugar.
- Improvements to Anthropic provider, related to max tokens.
- General improvements.
- Add tests for structured response.
- Add `llm_model` to `structured_response`.
## 0.1.5 (2024-10-31) ## 0.1.5 (2024-10-31)
- Add Gemini provider. - Add Gemini provider.
- Add structured response to Gemini provider. - Add structured response to Gemini provider.
- Support for Python 3.10.
## 0.1.4 (2024-10-30) ## 0.1.4 (2024-10-30)
+5 -4
View File
@@ -6,6 +6,8 @@ Simplemind is AI library designed to simplify your experience with AI APIs in Py
![simplemind](https://github.com/user-attachments/assets/36df2103-2583-4958-ad5e-19cda7740256) ![simplemind](https://github.com/user-attachments/assets/36df2103-2583-4958-ad5e-19cda7740256)
[![Auto Wiki](https://img.shields.io/badge/Auto_Wiki-Mutable.ai-blue)](https://mutable.ai/kennethreitz/simplemind)
## Features ## Features
With Simplemind, tapping into AI is as easy as a friendly conversation. With Simplemind, tapping into AI is as easy as a friendly conversation.
@@ -16,7 +18,7 @@ With Simplemind, tapping into AI is as easy as a friendly conversation.
## Supported APIs ## Supported APIs
To specify a specific provider or model, you can use the `llm_provider` and `llm_model` parameters when calling: `generate_text`, `generate_data`, or `create_conversation`. The APIs remain identital between all supported providers/models. To specify a specific provider or model, you can use the `llm_provider` and `llm_model` parameters when calling: `generate_text`, `generate_data`, or `create_conversation`.
- [**Anthropic's Claude**](https://www.anthropic.com/claude) - [**Anthropic's Claude**](https://www.anthropic.com/claude)
- [**Google's Gemini**](https://gemini.google/) - [**Google's Gemini**](https://gemini.google/)
@@ -25,7 +27,7 @@ To specify a specific provider or model, you can use the `llm_provider` and `llm
- [**OpenAI's GPT**](https://openai.com/gpt) - [**OpenAI's GPT**](https://openai.com/gpt)
- [**xAI's Grok**](https://x.ai/) - [**xAI's Grok**](https://x.ai/)
If you want to see Simplemind support, additional providers or models, please send a pull request! If you want to see Simplemind support, additional providers or models, please request a pull!
## Why SimpleMind? ## Why SimpleMind?
- **Intuitive**: Built with Pythonic simplicity and readability in mind. - **Intuitive**: Built with Pythonic simplicity and readability in mind.
@@ -48,7 +50,7 @@ First, authenticate your API keys by setting them in the environment variables:
$ export OPENAI_API_KEY="sk-..." $ export OPENAI_API_KEY="sk-..."
``` ```
This pattern allows you to keep your API keys private and out of your codebase. Other supported environment variables: `ANTHROPIC_API_KEY`, `XAI_API_KEY`, `GROQ_API_KEY`, and `GEMINI_API_KEY`. This pattern allows you to keep your API keys private and out of your codebase. Other supported environment variables: `ANTHROPIC_API_KEY`, `XAI_API_KEY`, and `GROQ_API_KEY`.
Next, import Simplemind and start using it: Next, import Simplemind and start using it:
@@ -217,4 +219,3 @@ Simplemind is licensed under the Apache 2.0 License.
## Acknowledgements ## Acknowledgements
Simplemind is inspired by the philosophy of "code for humans" and aims to make working with AI models accessible to all. Special thanks to the open-source community for their contributions and inspiration. Simplemind is inspired by the philosophy of "code for humans" and aims to make working with AI models accessible to all. Special thanks to the open-source community for their contributions and inspiration.
+1 -1
View File
@@ -16,7 +16,7 @@ import simplemind
project = "simplemind" project = "simplemind"
copyright = "2024 Kenneth Reitz" copyright = "2024 Kenneth Reitz"
author = "Kenneth Reitz" author = "Kenneth Reitz"
release = "v0.1.6" release = "v0.1.5"
# -- General configuration --------------------------------------------------- # -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+1 -1
View File
@@ -1,6 +1,6 @@
[project] [project]
name = "simplemind" name = "simplemind"
version = "0.1.6" version = "0.1.5"
description = "An experimental client for AI providers that intends to replace LangChain and LangGraph for most common use cases." description = "An experimental client for AI providers that intends to replace LangChain and LangGraph for most common use cases."
readme = "README.md" readme = "README.md"
requires-python = ">=3.10" requires-python = ">=3.10"
+1 -5
View File
@@ -16,7 +16,7 @@ class Session:
self, self,
*, *,
llm_provider: str = settings.DEFAULT_LLM_PROVIDER, llm_provider: str = settings.DEFAULT_LLM_PROVIDER,
llm_model: str | None = None, llm_model: str = settings.DEFAULT_LLM_MODEL,
**kwargs, **kwargs,
): ):
self.llm_provider = llm_provider self.llm_provider = llm_provider
@@ -113,9 +113,6 @@ def generate_text(
return provider.generate_text(prompt=prompt, llm_model=llm_model, **kwargs) return provider.generate_text(prompt=prompt, llm_model=llm_model, **kwargs)
# Syntax sugar.
Plugin = BasePlugin
__all__ = [ __all__ = [
"create_conversation", "create_conversation",
"find_provider", "find_provider",
@@ -124,5 +121,4 @@ __all__ = [
"settings", "settings",
"BasePlugin", "BasePlugin",
"Session", "Session",
"Plugin",
] ]
-27
View File
@@ -1,27 +0,0 @@
import time
from typing import Any, Callable
import logfire
from .settings import settings
def logger(func: Callable[..., Any]) -> Callable[..., Any]:
"""A @logger decorator that logs the function parameters, function returns, and exceptions raised if logging is enabled."""
def wrapper(*args, **kwargs) -> Any:
if not settings.logging.enabled:
return func(*args, **kwargs)
logfire.info(f"Calling {func.__name__} with args: {args}, kwargs: {kwargs}")
t1 = time.perf_counter()
try:
result = func(*args, **kwargs)
t2 = time.perf_counter()
logfire.info(f"{func.__name__} returned: {result} in {t2-t1} seconds")
return result
except Exception as e:
t2 = time.perf_counter()
logfire.error(f"Error in {func.__name__}: {e} in {t2-t1} seconds")
raise e
return wrapper
+1 -1
View File
@@ -1,6 +1,6 @@
from types import TracebackType
import uuid import uuid
from datetime import datetime from datetime import datetime
from types import TracebackType
from typing import Any, Dict, List, Literal, Optional from typing import Any, Dict, List, Literal, Optional
from pydantic import BaseModel, Field from pydantic import BaseModel, Field
+1 -4
View File
@@ -1,13 +1,10 @@
from abc import ABC, abstractmethod from abc import ABC, abstractmethod
from functools import cached_property from functools import cached_property
from typing import TYPE_CHECKING, Any, Type, TypeVar from typing import Any, Type, TypeVar
from instructor import Instructor from instructor import Instructor
from pydantic import BaseModel from pydantic import BaseModel
if TYPE_CHECKING:
from ..models import Conversation, Message
T = TypeVar("T", bound=BaseModel) T = TypeVar("T", bound=BaseModel)
+11 -37
View File
@@ -1,29 +1,24 @@
from functools import cached_property from functools import cached_property
from typing import TYPE_CHECKING, Type, TypeVar from typing import Type, TypeVar
import anthropic
import instructor import instructor
from pydantic import BaseModel from pydantic import BaseModel
from ..logging import logger
from ..settings import settings from ..settings import settings
from ._base import BaseProvider from ._base import BaseProvider
if TYPE_CHECKING:
from ..models import Conversation, Message
T = TypeVar("T", bound=BaseModel) T = TypeVar("T", bound=BaseModel)
PROVIDER_NAME = "anthropic" PROVIDER_NAME = "anthropic"
DEFAULT_MODEL = "claude-3-5-sonnet-20241022" DEFAULT_MODEL = "claude-3-5-sonnet-20241022"
DEFAULT_MAX_TOKENS = 1_000 DEFAULT_MAX_TOKENS = 1000
DEFAULT_KWARGS = {"max_tokens": DEFAULT_MAX_TOKENS}
class Anthropic(BaseProvider): class Anthropic(BaseProvider):
NAME = PROVIDER_NAME NAME = PROVIDER_NAME
DEFAULT_MODEL = DEFAULT_MODEL DEFAULT_MODEL = DEFAULT_MODEL
DEFAULT_KWARGS = DEFAULT_KWARGS
def __init__(self, api_key: str | None = None): def __init__(self, api_key: str | None = None):
self.api_key = api_key or settings.get_api_key(PROVIDER_NAME) self.api_key = api_key or settings.get_api_key(PROVIDER_NAME)
@@ -33,13 +28,6 @@ class Anthropic(BaseProvider):
"""The raw Anthropic client.""" """The raw Anthropic client."""
if not self.api_key: if not self.api_key:
raise ValueError("Anthropic API key is required") raise ValueError("Anthropic API key is required")
try:
import anthropic
except ImportError as exc:
raise ImportError(
"Please install the `anthropic` package: `pip install anthropic`"
) from exc
return anthropic.Anthropic(api_key=self.api_key) return anthropic.Anthropic(api_key=self.api_key)
@cached_property @cached_property
@@ -47,8 +35,7 @@ class Anthropic(BaseProvider):
"""A client patched with Instructor.""" """A client patched with Instructor."""
return instructor.from_anthropic(self.client) return instructor.from_anthropic(self.client)
@logger def send_conversation(self, conversation: "Conversation", **kwargs):
def send_conversation(self, conversation: "Conversation", **kwargs) -> "Message":
"""Send a conversation to the Anthropic API.""" """Send a conversation to the Anthropic API."""
from ..models import Message from ..models import Message
@@ -59,7 +46,8 @@ class Anthropic(BaseProvider):
response = self.client.messages.create( response = self.client.messages.create(
model=conversation.llm_model or self.DEFAULT_MODEL, model=conversation.llm_model or self.DEFAULT_MODEL,
messages=messages, messages=messages,
**{**self.DEFAULT_KWARGS, **kwargs}, max_tokens=DEFAULT_MAX_TOKENS,
**kwargs,
) )
# Get the response content from the Anthropic response # Get the response content from the Anthropic response
@@ -74,27 +62,12 @@ class Anthropic(BaseProvider):
llm_provider=PROVIDER_NAME, llm_provider=PROVIDER_NAME,
) )
@logger def structured_response(self, model: str, response_model: Type[T], **kwargs) -> T:
def structured_response(
self, response_model: Type[T], *, llm_model: str | None = None, **kwargs
) -> T:
model = llm_model or self.DEFAULT_MODEL
# Extract the prompt from kwargs if it exists
prompt = kwargs.pop("prompt", kwargs.pop("messages", ""))
# Format the messages properly
messages = [{"role": "user", "content": prompt}]
response = self.structured_client.messages.create( response = self.structured_client.messages.create(
model=model, model=model or self.DEFAULT_MODEL, response_model=response_model, **kwargs
messages=messages, # Add the messages parameter
response_model=response_model,
**{**self.DEFAULT_KWARGS, **kwargs},
) )
return response_model.model_validate(response) return response
@logger
def generate_text(self, prompt: str, *, llm_model: str, **kwargs): def generate_text(self, prompt: str, *, llm_model: str, **kwargs):
messages = [ messages = [
{"role": "user", "content": prompt}, {"role": "user", "content": prompt},
@@ -103,7 +76,8 @@ class Anthropic(BaseProvider):
response = self.client.messages.create( response = self.client.messages.create(
model=llm_model or self.DEFAULT_MODEL, model=llm_model or self.DEFAULT_MODEL,
messages=messages, messages=messages,
**{**self.DEFAULT_KWARGS, **kwargs}, max_tokens=DEFAULT_MAX_TOKENS,
**kwargs,
) )
return response.content[0].text return response.content[0].text
+10 -26
View File
@@ -2,24 +2,20 @@
# IT is not currently working as desired. # IT is not currently working as desired.
from functools import cached_property from functools import cached_property
from typing import TYPE_CHECKING, Type, TypeVar from typing import Type, TypeVar
import google.generativeai as genai
import instructor import instructor
from pydantic import BaseModel from pydantic import BaseModel
from ..logging import logger
from ..settings import settings from ..settings import settings
from ._base import BaseProvider from ._base import BaseProvider
if TYPE_CHECKING:
from ..models import Conversation, Message
T = TypeVar("T", bound=BaseModel)
PROVIDER_NAME = "gemini" PROVIDER_NAME = "gemini"
DEFAULT_MODEL = "models/gemini-1.5-flash-latest" DEFAULT_MODEL = "models/gemini-1.5-flash-latest"
T = TypeVar("T", bound=BaseModel)
class Gemini(BaseProvider): class Gemini(BaseProvider):
NAME = PROVIDER_NAME NAME = PROVIDER_NAME
@@ -29,21 +25,12 @@ class Gemini(BaseProvider):
self.api_key = api_key or settings.get_api_key(PROVIDER_NAME) self.api_key = api_key or settings.get_api_key(PROVIDER_NAME)
self.model_name = DEFAULT_MODEL self.model_name = DEFAULT_MODEL
def set_model(self, model_name: str):
self.model_name = model_name
@cached_property @cached_property
def client(self): def client(self, model_name: str = DEFAULT_MODEL):
"""The raw Gemini client.""" """The raw Gemini client."""
if not self.api_key: if not self.api_key:
raise ValueError("Gemini API key is required") raise ValueError("Gemini API key is required")
try: self.model_name = model_name
import google.generativeai as genai
except ImportError as exc:
raise ImportError(
"Please install the `google-generativeai` package: `pip install google-generativeai`"
) from exc
genai.configure(api_key=self.api_key)
return genai.GenerativeModel(model_name=self.model_name) return genai.GenerativeModel(model_name=self.model_name)
@cached_property @cached_property
@@ -51,7 +38,6 @@ class Gemini(BaseProvider):
"""A Gemini client patched with Instructor.""" """A Gemini client patched with Instructor."""
return instructor.from_gemini(self.client) return instructor.from_gemini(self.client)
@logger
def send_conversation(self, conversation: "Conversation") -> "Message": def send_conversation(self, conversation: "Conversation") -> "Message":
"""Send a conversation to the Gemini API.""" """Send a conversation to the Gemini API."""
from ..models import Message from ..models import Message
@@ -78,11 +64,9 @@ class Gemini(BaseProvider):
llm_provider=PROVIDER_NAME, llm_provider=PROVIDER_NAME,
) )
@logger
def structured_response(self, prompt: str, response_model: Type[T], **kwargs) -> T: def structured_response(self, prompt: str, response_model: Type[T], **kwargs) -> T:
"""Send a structured response to the Gemini API.""" """Send a structured response to the Gemini API."""
# Only try to pop if the key exists llm_model = kwargs.pop("llm_model", self.model_name)
kwargs.pop("llm_model", None) # Add default value of None
try: try:
response = self.structured_client.chat.completions.create( response = self.structured_client.chat.completions.create(
@@ -95,12 +79,12 @@ class Gemini(BaseProvider):
raise RuntimeError( raise RuntimeError(
f"Failed to send structured response to Gemini API: {e}" f"Failed to send structured response to Gemini API: {e}"
) from e ) from e
return response_model.model_validate(response) return response
@logger
def generate_text(self, prompt: str, **kwargs) -> str: def generate_text(self, prompt: str, **kwargs) -> str:
"""Generate text using the Gemini API.""" """Generate text using the Gemini API."""
kwargs.pop("llm_model") llm_model = kwargs.pop("llm_model", self.model_name)
try: try:
response = self.client.generate_content(prompt, **kwargs) response = self.client.generate_content(prompt, **kwargs)
except Exception as e: except Exception as e:
+10 -27
View File
@@ -1,29 +1,22 @@
from functools import cached_property from functools import cached_property
from typing import TYPE_CHECKING, Type, TypeVar from typing import Type, TypeVar
import groq
import instructor import instructor
from pydantic import BaseModel from pydantic import BaseModel
from ..logging import logger
from ..settings import settings from ..settings import settings
from ._base import BaseProvider from ._base import BaseProvider
if TYPE_CHECKING:
from ..models import Conversation, Message
T = TypeVar("T", bound=BaseModel)
PROVIDER_NAME = "groq" PROVIDER_NAME = "groq"
DEFAULT_MODEL = "llama3-8b-8192" DEFAULT_MODEL = "llama3-8b-8192"
DEFAULT_MAX_TOKENS = 1_000
DEFAULT_KWARGS = {"max_tokens": DEFAULT_MAX_TOKENS} T = TypeVar("T", bound=BaseModel)
class Groq(BaseProvider): class Groq(BaseProvider):
NAME = PROVIDER_NAME NAME = PROVIDER_NAME
DEFAULT_MODEL = DEFAULT_MODEL DEFAULT_MODEL = DEFAULT_MODEL
DEFAULT_KWARGS = DEFAULT_KWARGS
def __init__(self, api_key: str | None = None): def __init__(self, api_key: str | None = None):
self.api_key = api_key or settings.get_api_key(PROVIDER_NAME) self.api_key = api_key or settings.get_api_key(PROVIDER_NAME)
@@ -33,12 +26,6 @@ class Groq(BaseProvider):
"""The raw Groq client.""" """The raw Groq client."""
if not self.api_key: if not self.api_key:
raise ValueError("Groq API key is required") raise ValueError("Groq API key is required")
try:
import groq
except ImportError as exc:
raise ImportError(
"Please install the `groq` package: `pip install groq`"
) from exc
return groq.Groq(api_key=self.api_key) return groq.Groq(api_key=self.api_key)
@cached_property @cached_property
@@ -46,7 +33,6 @@ class Groq(BaseProvider):
"""A client patched with Instructor.""" """A client patched with Instructor."""
return instructor.from_groq(self.client) return instructor.from_groq(self.client)
@logger
def send_conversation( def send_conversation(
self, self,
conversation: "Conversation", conversation: "Conversation",
@@ -62,7 +48,7 @@ class Groq(BaseProvider):
response = self.client.chat.completions.create( response = self.client.chat.completions.create(
model=conversation.llm_model or self.DEFAULT_MODEL, model=conversation.llm_model or self.DEFAULT_MODEL,
messages=messages, messages=messages,
**{**self.DEFAULT_KWARGS, **kwargs}, **kwargs,
) )
# Get the response content from the Groq response # Get the response content from the Groq response
@@ -77,7 +63,6 @@ class Groq(BaseProvider):
llm_provider=PROVIDER_NAME, llm_provider=PROVIDER_NAME,
) )
@logger
def structured_response(self, prompt: str, response_model: Type[T], **kwargs) -> T: def structured_response(self, prompt: str, response_model: Type[T], **kwargs) -> T:
# Ensure messages are provided in kwargs # Ensure messages are provided in kwargs
messages = [ messages = [
@@ -87,19 +72,17 @@ class Groq(BaseProvider):
response = self.structured_client.chat.completions.create( response = self.structured_client.chat.completions.create(
messages=messages, messages=messages,
response_model=response_model, response_model=response_model,
model=kwargs.pop("llm_model", self.DEFAULT_MODEL), **kwargs,
**{**self.DEFAULT_KWARGS, **kwargs},
) )
return response_model.model_validate(response) return response
@logger
def generate_text( def generate_text(
self, self,
prompt: str, prompt: str,
*, *,
llm_model: str, llm_model: str,
**kwargs, **kwargs,
) -> str: ):
messages = [ messages = [
{"role": "user", "content": prompt}, {"role": "user", "content": prompt},
] ]
@@ -107,7 +90,7 @@ class Groq(BaseProvider):
response = self.client.chat.completions.create( response = self.client.chat.completions.create(
messages=messages, messages=messages,
model=llm_model or self.DEFAULT_MODEL, model=llm_model or self.DEFAULT_MODEL,
**{**self.DEFAULT_KWARGS, **kwargs}, **kwargs,
) )
return str(response.choices[0].message.content) return response.choices[0].message.content
+9 -34
View File
@@ -1,30 +1,25 @@
from functools import cached_property from functools import cached_property
from typing import TYPE_CHECKING, Type, TypeVar from typing import Type, TypeVar
import instructor import instructor
import ollama as ol
from openai import OpenAI from openai import OpenAI
from pydantic import BaseModel from pydantic import BaseModel
from ..logging import logger
from ..settings import settings from ..settings import settings
from ._base import BaseProvider from ._base import BaseProvider
if TYPE_CHECKING:
from ..models import Conversation, Message
T = TypeVar("T", bound=BaseModel) T = TypeVar("T", bound=BaseModel)
PROVIDER_NAME = "ollama" PROVIDER_NAME = "ollama"
DEFAULT_MODEL = "llama3.2" DEFAULT_MODEL = "llama3.2"
DEFAULT_TIMEOUT = 60 DEFAULT_TIMEOUT = 60
DEFAULT_KWARGS = {}
class Ollama(BaseProvider): class Ollama(BaseProvider):
NAME = PROVIDER_NAME NAME = PROVIDER_NAME
DEFAULT_MODEL = DEFAULT_MODEL DEFAULT_MODEL = DEFAULT_MODEL
DEFAULT_KWARGS = DEFAULT_KWARGS
TIMEOUT = DEFAULT_TIMEOUT TIMEOUT = DEFAULT_TIMEOUT
def __init__(self, host_url: str | None = None): def __init__(self, host_url: str | None = None):
@@ -35,12 +30,6 @@ class Ollama(BaseProvider):
"""The raw Ollama client.""" """The raw Ollama client."""
if not self.host_url: if not self.host_url:
raise ValueError("No ollama host url provided") raise ValueError("No ollama host url provided")
try:
import ollama as ol
except ImportError as exc:
raise ImportError(
"Please install the `ollama` package: `pip install ollama`"
) from exc
return ol.Client(timeout=self.TIMEOUT, host=self.host_url) return ol.Client(timeout=self.TIMEOUT, host=self.host_url)
@cached_property @cached_property
@@ -54,8 +43,7 @@ class Ollama(BaseProvider):
mode=instructor.Mode.JSON, mode=instructor.Mode.JSON,
) )
@logger def send_conversation(self, conversation: "Conversation") -> "Message":
def send_conversation(self, conversation: "Conversation", **kwargs) -> "Message":
"""Send a conversation to the Ollama API.""" """Send a conversation to the Ollama API."""
from ..models import Message from ..models import Message
@@ -63,9 +51,7 @@ class Ollama(BaseProvider):
{"role": msg.role, "content": msg.text} for msg in conversation.messages {"role": msg.role, "content": msg.text} for msg in conversation.messages
] ]
response = self.client.chat( response = self.client.chat(
model=conversation.llm_model or DEFAULT_MODEL, model=conversation.llm_model or DEFAULT_MODEL, messages=messages
messages=messages,
**{**self.DEFAULT_KWARGS, **kwargs},
) )
assistant_message = response.get("message") assistant_message = response.get("message")
@@ -78,14 +64,8 @@ class Ollama(BaseProvider):
llm_provider=PROVIDER_NAME, llm_provider=PROVIDER_NAME,
) )
@logger
def structured_response( def structured_response(
self, self, prompt: str, response_model: Type[T], *, llm_model: str, **kwargs
prompt: str,
response_model: Type[T],
*,
llm_model: str | None = None,
**kwargs,
) -> T: ) -> T:
"""Get a structured response from the Ollama API.""" """Get a structured response from the Ollama API."""
messages = [ messages = [
@@ -96,23 +76,18 @@ class Ollama(BaseProvider):
messages=messages, messages=messages,
model=llm_model or self.DEFAULT_MODEL, model=llm_model or self.DEFAULT_MODEL,
response_model=response_model, response_model=response_model,
**{**self.DEFAULT_KWARGS, **kwargs}, **kwargs,
) )
return response_model.model_validate(response) return response
@logger def generate_text(self, prompt: str, *, llm_model: str) -> str:
def generate_text(
self, prompt: str, *, llm_model: str | None = None, **kwargs
) -> str:
"""Generate text using the Ollama API.""" """Generate text using the Ollama API."""
messages = [ messages = [
{"role": "user", "content": prompt}, {"role": "user", "content": prompt},
] ]
response = self.client.chat( response = self.client.chat(
messages=messages, messages=messages, model=llm_model or self.DEFAULT_MODEL
model=llm_model or self.DEFAULT_MODEL,
**{**self.DEFAULT_KWARGS, **kwargs},
) )
return response.get("message", {}).get("content", "") return response.get("message", {}).get("content", "")
+7 -26
View File
@@ -1,28 +1,22 @@
from functools import cached_property from functools import cached_property
from typing import TYPE_CHECKING, Type, TypeVar from typing import Type, TypeVar
import instructor import instructor
import openai as oa
from pydantic import BaseModel from pydantic import BaseModel
from ..logging import logger
from ..settings import settings from ..settings import settings
from ._base import BaseProvider from ._base import BaseProvider
if TYPE_CHECKING:
from ..models import Conversation, Message
T = TypeVar("T", bound=BaseModel) T = TypeVar("T", bound=BaseModel)
PROVIDER_NAME = "openai" PROVIDER_NAME = "openai"
DEFAULT_MODEL = "gpt-4o-mini" DEFAULT_MODEL = "gpt-4o-mini"
DEFAULT_MAX_TOKENS = 1_000
DEFAULT_KWARGS = {"max_tokens": DEFAULT_MAX_TOKENS}
class OpenAI(BaseProvider): class OpenAI(BaseProvider):
NAME = PROVIDER_NAME NAME = PROVIDER_NAME
DEFAULT_MODEL = DEFAULT_MODEL DEFAULT_MODEL = DEFAULT_MODEL
DEFAULT_KWARGS = DEFAULT_KWARGS
def __init__(self, api_key: str | None = None): def __init__(self, api_key: str | None = None):
self.api_key = api_key or settings.get_api_key(PROVIDER_NAME) self.api_key = api_key or settings.get_api_key(PROVIDER_NAME)
@@ -32,12 +26,6 @@ class OpenAI(BaseProvider):
"""The raw OpenAI client.""" """The raw OpenAI client."""
if not self.api_key: if not self.api_key:
raise ValueError("OpenAI API key is required") raise ValueError("OpenAI API key is required")
try:
import openai as oa
except ImportError as exc:
raise ImportError(
"Please install the `openai` package: `pip install openai`"
) from exc
return oa.OpenAI(api_key=self.api_key) return oa.OpenAI(api_key=self.api_key)
@cached_property @cached_property
@@ -45,8 +33,7 @@ class OpenAI(BaseProvider):
"""A OpenAI client with Instructor.""" """A OpenAI client with Instructor."""
return instructor.from_openai(self.client) return instructor.from_openai(self.client)
@logger def send_conversation(self, conversation: "Conversation", **kwargs):
def send_conversation(self, conversation: "Conversation", **kwargs) -> "Message":
"""Send a conversation to the OpenAI API.""" """Send a conversation to the OpenAI API."""
from ..models import Message from ..models import Message
@@ -55,9 +42,7 @@ class OpenAI(BaseProvider):
] ]
response = self.client.chat.completions.create( response = self.client.chat.completions.create(
model=conversation.llm_model or DEFAULT_MODEL, model=conversation.llm_model or DEFAULT_MODEL, messages=messages, **kwargs
messages=messages,
**{**self.DEFAULT_KWARGS, **kwargs},
) )
# Get the response content from the OpenAI response # Get the response content from the OpenAI response
@@ -72,7 +57,6 @@ class OpenAI(BaseProvider):
llm_provider=PROVIDER_NAME, llm_provider=PROVIDER_NAME,
) )
@logger
def structured_response( def structured_response(
self, self,
prompt: str, prompt: str,
@@ -90,19 +74,16 @@ class OpenAI(BaseProvider):
messages=messages, messages=messages,
model=llm_model or self.DEFAULT_MODEL, model=llm_model or self.DEFAULT_MODEL,
response_model=response_model, response_model=response_model,
**{**self.DEFAULT_KWARGS, **kwargs}, **kwargs,
) )
return response_model.model_validate(response) return response
@logger
def generate_text(self, prompt: str, *, llm_model: str | None = None, **kwargs): def generate_text(self, prompt: str, *, llm_model: str | None = None, **kwargs):
"""Generate text using the OpenAI API.""" """Generate text using the OpenAI API."""
messages = [ messages = [
{"role": "user", "content": prompt}, {"role": "user", "content": prompt},
] ]
response = self.client.chat.completions.create( response = self.client.chat.completions.create(
messages=messages, messages=messages, model=llm_model or self.DEFAULT_MODEL, **kwargs
model=llm_model or self.DEFAULT_MODEL,
**{**self.DEFAULT_KWARGS, **kwargs},
) )
return response.choices[0].message.content return response.choices[0].message.content
+7 -28
View File
@@ -1,30 +1,20 @@
from functools import cached_property from functools import cached_property
from typing import TYPE_CHECKING, Type, TypeVar
import instructor import instructor
from pydantic import BaseModel import openai as oa
from ..logging import logger
from ..settings import settings from ..settings import settings
from ._base import BaseProvider from ._base import BaseProvider
if TYPE_CHECKING:
from ..models import Conversation, Message
T = TypeVar("T", bound=BaseModel)
PROVIDER_NAME = "xai" PROVIDER_NAME = "xai"
DEFAULT_MODEL = "grok-beta" DEFAULT_MODEL = "grok-beta"
BASE_URL = "https://api.x.ai/v1" BASE_URL = "https://api.x.ai/v1"
DEFAULT_MAX_TOKENS = 1000 DEFAULT_MAX_TOKENS = 1000
DEFAULT_KWARGS = {"max_tokens": DEFAULT_MAX_TOKENS}
class XAI(BaseProvider): class XAI(BaseProvider):
NAME = PROVIDER_NAME NAME = PROVIDER_NAME
DEFAULT_MODEL = DEFAULT_MODEL DEFAULT_MODEL = DEFAULT_MODEL
DEFAULT_KWARGS = DEFAULT_KWARGS
def __init__(self, api_key: str | None = None): def __init__(self, api_key: str | None = None):
self.api_key = api_key or settings.get_api_key(PROVIDER_NAME) self.api_key = api_key or settings.get_api_key(PROVIDER_NAME)
@@ -34,12 +24,6 @@ class XAI(BaseProvider):
"""The raw OpenAI client.""" """The raw OpenAI client."""
if not self.api_key: if not self.api_key:
raise ValueError("XAI API key is required") raise ValueError("XAI API key is required")
try:
import openai as oa
except ImportError as exc:
raise ImportError(
"Please install the `openai` package: `pip install openai`"
) from exc
return oa.OpenAI( return oa.OpenAI(
api_key=self.api_key, api_key=self.api_key,
base_url=BASE_URL, base_url=BASE_URL,
@@ -50,8 +34,7 @@ class XAI(BaseProvider):
"""A client patched with Instructor.""" """A client patched with Instructor."""
return instructor.from_openai(self.client) return instructor.from_openai(self.client)
@logger def send_conversation(self, conversation: "Conversation", **kwargs):
def send_conversation(self, conversation: "Conversation", **kwargs) -> "Message":
"""Send a conversation to the OpenAI API.""" """Send a conversation to the OpenAI API."""
from ..models import Message from ..models import Message
@@ -62,7 +45,7 @@ class XAI(BaseProvider):
response = self.client.chat.completions.create( response = self.client.chat.completions.create(
model=conversation.llm_model or self.DEFAULT_MODEL, model=conversation.llm_model or self.DEFAULT_MODEL,
messages=messages, messages=messages,
**{**self.DEFAULT_KWARGS, **kwargs}, **kwargs,
) )
# Get the response content from the OpenAI response # Get the response content from the OpenAI response
@@ -77,14 +60,10 @@ class XAI(BaseProvider):
llm_provider=PROVIDER_NAME, llm_provider=PROVIDER_NAME,
) )
@logger def structured_response(self, prompt: str, response_model, *, llm_model: str):
def structured_response(
self, prompt: str, response_model: Type[T], *, llm_model: str
) -> T:
raise NotImplementedError("XAI does not support structured responses") raise NotImplementedError("XAI does not support structured responses")
@logger def generate_text(self, prompt: str, *, llm_model: str, **kwargs):
def generate_text(self, prompt: str, *, llm_model: str, **kwargs) -> str:
messages = [ messages = [
{"role": "user", "content": prompt}, {"role": "user", "content": prompt},
] ]
@@ -92,7 +71,7 @@ class XAI(BaseProvider):
response = self.client.chat.completions.create( response = self.client.chat.completions.create(
messages=messages, messages=messages,
model=llm_model or self.DEFAULT_MODEL, model=llm_model or self.DEFAULT_MODEL,
**{**self.DEFAULT_KWARGS, **kwargs}, **kwargs,
) )
return str(response.choices[0].message.content) return response.choices[0].message.content
+5 -27
View File
@@ -1,42 +1,19 @@
from typing import Optional, Union from typing import Literal, Optional, Union
from pydantic import Field, SecretStr, field_validator from pydantic import Field, SecretStr, field_validator
from pydantic_settings import BaseSettings, SettingsConfigDict from pydantic_settings import BaseSettings, SettingsConfigDict
logging_level = Literal["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"]
class LoggingConfig(BaseSettings): class LoggingConfig(BaseSettings):
"""The class that holds all the logging settings for the application.""" """The class that holds all the logging settings for the application."""
enabled: bool = Field(False, description="Enable logging") enabled: bool = Field(False, description="Enable logging")
level: logging_level = Field("INFO", description="The logging level")
model_config = SettingsConfigDict(extra="forbid") model_config = SettingsConfigDict(extra="forbid")
def enable_logfire(self, **kwargs) -> None:
"""Enable logging for the application."""
# adding imports here to avoid forced dependencies
try:
import logfire
from logging import basicConfig
except ImportError as e:
raise ImportError(
"To enable logging, please install logfire: `pip install logfire`"
) from e
self.enabled = True
logfire.configure(**kwargs)
basicConfig(handlers=[logfire.LogfireLoggingHandler()])
try:
logfire.configure(**kwargs)
basicConfig(handlers=[logfire.LogfireLoggingHandler()])
except Exception as e:
self.enabled = False # Reset flag on failure
raise RuntimeError("Failed to configure logging") from e
def disable_logfire(self) -> None:
"""Disable logging for the application."""
self.enabled = False
class Settings(BaseSettings): class Settings(BaseSettings):
"""The class that holds all the API keys for the application.""" """The class that holds all the API keys for the application."""
@@ -52,6 +29,7 @@ class Settings(BaseSettings):
) )
XAI_API_KEY: Optional[SecretStr] = Field(None, description="API key for xAI") XAI_API_KEY: Optional[SecretStr] = Field(None, description="API key for xAI")
DEFAULT_LLM_PROVIDER: str = Field("openai", description="The default LLM provider") DEFAULT_LLM_PROVIDER: str = Field("openai", description="The default LLM provider")
DEFAULT_LLM_MODEL: str = Field("gpt-4o-mini", description="The default LLM model")
model_config = SettingsConfigDict( model_config = SettingsConfigDict(
env_file=".env", env_file_encoding="utf-8", case_sensitive=True, extra="ignore" env_file=".env", env_file_encoding="utf-8", case_sensitive=True, extra="ignore"
-15
View File
@@ -1,15 +0,0 @@
import os
import sys
import pytest
# Add the project root to the Python path.
sys.path.append(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
from simplemind import Session
@pytest.fixture
def sm():
"""Fixture that provides a simplemind Session instance with default settings."""
return Session()
-2
View File
@@ -1,2 +0,0 @@
def test_basic_math():
assert 1 + 1 == 2
-28
View File
@@ -1,28 +0,0 @@
from pydantic import BaseModel
import pytest
from simplemind.providers import Anthropic, Gemini, Groq, Ollama, OpenAI
class ResponseModel(BaseModel):
result: int
@pytest.mark.parametrize(
"provider_cls",
[
Anthropic,
Gemini,
OpenAI,
Groq,
Ollama,
],
)
def test_generate_data(provider_cls):
provider = provider_cls()
prompt = "What is 2+2?"
data = provider.structured_response(prompt=prompt, response_model=ResponseModel)
assert isinstance(data, ResponseModel)
assert isinstance(data.result, int)
-22
View File
@@ -1,22 +0,0 @@
import pytest
from simplemind.providers import Anthropic, Gemini, Groq, Ollama, OpenAI
@pytest.mark.parametrize(
"provider_cls",
[
Anthropic,
Gemini,
OpenAI,
Groq,
Ollama,
],
)
def test_generate_text(provider_cls):
provider = provider_cls()
prompt = "What is 2+2?"
response = provider.generate_text(prompt=prompt, llm_model=provider.DEFAULT_MODEL)
assert isinstance(response, str)
assert len(response) > 0