freeplay 0.2.14__py3-none-any.whl → 0.2.15__py3-none-any.whl

freeplay/errors.py

@@ -2,6 +2,18 @@ class FreeplayError(Exception):
     pass
 
 
+class APITypeMissingError(Exception):
+    pass
+
+
+class APIVersionMissingError(Exception):
+    pass
+
+
+class APIEngineMissingError(Exception):
+    pass
+
+
 class APIKeyMissingError(Exception):
     pass
 

freeplay/flavors.py

@@ -1,7 +1,8 @@
 import json
 from abc import abstractmethod, ABC
 from copy import copy
-from typing import Optional, Generator, Any
+from typing import Optional, Generator, Any, Union
+from dataclasses import dataclass, asdict
 
 import anthropic  # type: ignore
 import openai
@@ -24,6 +25,8 @@ class Flavor(ABC):
                 return OpenAIChat()
             case AnthropicClaudeText.record_format_type:
                 return AnthropicClaudeText()
+            case AzureOpenAIChat.record_format_type:
+                return AzureOpenAIChat()
             case _:
                 raise FreeplayError(
                     'Configured flavor not found in SDK. Please update your SDK version or configure a different model in the Freeplay UI.')
@@ -89,15 +92,28 @@ class ChatFlavor(Flavor, ABC):
 
 
 class OpenAI(Flavor, ABC):
-    def configure_openai(self, openai_config: Optional[OpenAIConfig]) -> None:
+    def configure_openai(self,
+        openai_config: Optional[OpenAIConfig],
+        api_base: Optional[str] = None,
+        api_version: Optional[str] = None,
+        api_type: Optional[str] = None,
+    ) -> None:
         super().__init__()
         if not openai_config:
             raise APIKeyMissingError(
                 "Missing OpenAI key. Use a ProviderConfig to specify keys prior to getting completion.")
 
-        if openai_config.api_base:
+        if api_base:
+            openai.api_base = api_base
+        elif openai_config.api_base:
             openai.api_base = openai_config.api_base
 
+        if api_type:
+            openai.api_type = api_type
+
+        if api_version:
+            openai.api_version = api_version
+
         if not openai_config.api_key or not openai_config.api_key.strip():
             raise APIKeyMissingError("OpenAI API key is not set. It must be set to make calls to the service.")
 
@@ -123,7 +139,7 @@ class OpenAIText(OpenAI):
             provider_config: ProviderConfig,
             llm_parameters: LLMParameters
     ) -> CompletionResponse:
-        completion = self.__call_openai(formatted_prompt, provider_config, llm_parameters, stream=False)
+        completion = self._call_openai(formatted_prompt, provider_config, llm_parameters, stream=False)
         return CompletionResponse(
             content=completion.choices[0].text,
             is_complete=completion.choices[0].finish_reason == "stop"
@@ -135,7 +151,7 @@ class OpenAIText(OpenAI):
             provider_config: ProviderConfig,
             llm_parameters: LLMParameters
     ) -> Generator[CompletionChunk, None, None]:
-        completion = self.__call_openai(formatted_prompt, provider_config, llm_parameters, stream=True)
+        completion = self._call_openai(formatted_prompt, provider_config, llm_parameters, stream=True)
 
         for chunk in completion:
             yield CompletionChunk(
@@ -143,7 +159,7 @@ class OpenAIText(OpenAI):
                 is_complete=chunk.choices[0].finish_reason == "stop"
             )
 
-    def __call_openai(
+    def _call_openai(
             self,
             prompt: str,
             provider_config: ProviderConfig,
@@ -181,7 +197,7 @@ class OpenAIChat(OpenAI, ChatFlavor):
             llm_parameters: LLMParameters
     ) -> CompletionResponse:
         messages = json.loads(formatted_prompt)
-        completion = self.__call_openai(messages, provider_config, llm_parameters, stream=False)
+        completion = self._call_openai(messages, provider_config, llm_parameters, stream=False)
         return CompletionResponse(
             content=completion.choices[0].message.content or '',
             is_complete=completion.choices[0].finish_reason == 'stop',
@@ -195,7 +211,7 @@ class OpenAIChat(OpenAI, ChatFlavor):
             llm_parameters: LLMParameters
     ) -> Generator[CompletionChunk, None, None]:
         messages = json.loads(formatted_prompt)
-        completion_stream = self.__call_openai(messages, provider_config, llm_parameters, stream=True)
+        completion_stream = self._call_openai(messages, provider_config, llm_parameters, stream=True)
         for chunk in completion_stream:
             yield CompletionChunk(
                 text=chunk.choices[0].delta.get('content') or '',
@@ -209,7 +225,7 @@ class OpenAIChat(OpenAI, ChatFlavor):
             provider_config: ProviderConfig,
             llm_parameters: LLMParameters
     ) -> ChatCompletionResponse:
-        completion = self.__call_openai(messages, provider_config, llm_parameters, stream=False)
+        completion = self._call_openai(messages, provider_config, llm_parameters, stream=False)
 
         message_history = copy(messages)
         message_history.append(completion.choices[0].message.to_dict())
@@ -225,14 +241,14 @@ class OpenAIChat(OpenAI, ChatFlavor):
             provider_config: ProviderConfig,
             llm_parameters: LLMParameters
     ) -> Generator[CompletionChunk, None, None]:
-        completion_stream = self.__call_openai(messages, provider_config, llm_parameters, stream=True)
+        completion_stream = self._call_openai(messages, provider_config, llm_parameters, stream=True)
         for chunk in completion_stream:
             yield CompletionChunk(
                 text=chunk.choices[0].delta.get('content', ''),
                 is_complete=chunk.choices[0].finish_reason == "stop"
             )
 
-    def __call_openai(
+    def _call_openai(
             self,
             messages: list[ChatMessage],
             provider_config: ProviderConfig,
@@ -240,13 +256,47 @@ class OpenAIChat(OpenAI, ChatFlavor):
             stream: bool
     ) -> Any:
         self.configure_openai(provider_config.openai)
+        llm_parameters.pop('endpoint')
         return openai.ChatCompletion.create(
             messages=messages,
             **self.get_model_params(llm_parameters),
-            stream=stream
+            stream=stream,
         )  # type: ignore
 
 
+class AzureOpenAIChat(OpenAIChat):
+    record_format_type = "azure_openai_chat"
+
+    def _call_openai(
+            self,
+            messages: list[ChatMessage],
+            provider_config: ProviderConfig,
+            llm_parameters: LLMParameters,
+            stream: bool
+    ) -> Any:
+        api_version = llm_parameters.get('api_version')
+        deployment_id = llm_parameters.get('deployment_id')
+        resource_name = llm_parameters.get('resource_name')
+        endpoint = f'https://{resource_name}.openai.azure.com'
+        self.configure_openai(
+            provider_config.azure,
+            api_base=endpoint,
+            api_type='azure',
+            api_version=api_version
+        )
+        llm_parameters.pop('resource_name')
+        return openai.ChatCompletion.create(
+            messages=messages,
+            **self.get_model_params(llm_parameters),
+            engine=deployment_id,
+            stream=stream,
+        )  # type: ignore
+
+    @property
+    def provider(self) -> str:
+        return "azure"
+
+
 class AnthropicClaudeText(Flavor):
     record_format_type = "anthropic_text"
     _model_params_with_defaults = LLMParameters({

freeplay/llm_parameters.py

@@ -24,3 +24,6 @@ class LLMParameters(dict[str, Any]):
                 updated_params[model_param_key] = value
 
         return updated_params
+
+    def pop(self, key: str, default: Optional[Any] = None) -> Any:
+        return super().pop(key, default)

freeplay/provider_config.py

@@ -1,7 +1,12 @@
 from dataclasses import dataclass
 from typing import Optional
 
-from .errors import APIKeyMissingError
+from .errors import (
+    APIEngineMissingError,
+    APIKeyMissingError,
+    APITypeMissingError,
+    APIVersionMissingError,
+)
 
 
 @dataclass
@@ -9,7 +14,10 @@ class OpenAIConfig:
     api_key: str
     api_base: Optional[str]
 
-    def __init__(self, api_key: str, api_base: Optional[str] = None) -> None:
+    def __init__(self,
+        api_key: str,
+        api_base: Optional[str] = None,
+    ) -> None:
         self.api_key = api_key
         self.api_base = api_base
 
@@ -17,6 +25,31 @@ class OpenAIConfig:
         if not self.api_key or not self.api_key.strip():
             raise APIKeyMissingError("OpenAI API key not set. It must be set to make calls to the service.")
 
+@dataclass
+class AzureConfig(OpenAIConfig):
+    engine: Optional[str]
+    api_version: Optional[str]
+
+    def __init__(self,
+        api_key: str,
+        api_base: Optional[str] = None,
+        engine: Optional[str] = None,
+        api_version: Optional[str] = None
+    ):
+        super().__init__(api_key, api_base)
+        self.api_version = api_version
+        self.engine = engine
+
+    def validate(self) -> None:
+        super().validate()
+
+        if self.api_version is None:
+            raise APIVersionMissingError(
+                "OpenAI API version not set. It must be set to make calls to the service.")
+
+        if self.engine is None:
+            raise APIEngineMissingError("Azure engine is not set. It must be set to make calls to the service.")
+
 
 @dataclass
 class AnthropicConfig:
@@ -27,10 +60,11 @@ class AnthropicConfig:
 class ProviderConfig:
     anthropic: Optional[AnthropicConfig] = None
     openai: Optional[OpenAIConfig] = None
+    azure: Optional[AzureConfig] = None
 
     def validate(self) -> None:
         if self.anthropic is None and self.openai is None:
             APIKeyMissingError("At least one provider key must be set in ProviderConfig.")
+
         if self.openai is not None:
             self.openai.validate()
-

{freeplay-0.2.14.dist-info → freeplay-0.2.15.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: freeplay
-Version: 0.2.14
+Version: 0.2.15
 Summary: 
 License: MIT
 Author: FreePlay Engineering

freeplay-0.2.15.dist-info/RECORD

@@ -0,0 +1,12 @@
+freeplay/__init__.py,sha256=74A9S9hmLq9BNHsdx0-37yDxlSukudNl9bJ0TE60Z30,61
+freeplay/api_support.py,sha256=mWauXzpZx9DwIzuqlnfEAXX2LsILE3an4G_6OVMHopI,1834
+freeplay/completions.py,sha256=M1vlziRTIfmO-TGdqNI_eHHq4zYpMj0n8dzH-boz7bY,992
+freeplay/errors.py,sha256=RFJtcgVvNsrVOeojnnh4TGvj3wYKglVshLEFpUHzafM,340
+freeplay/flavors.py,sha256=nxnZnRAv4P_RBzvikg50KKlT4XN-B1V8GgT1XBqwQ5Q,13261
+freeplay/freeplay.py,sha256=Rkv2V1ED4dyqgNnr5Pi5sxQL1WHz__sDkuyuzvKIYDY,27763
+freeplay/llm_parameters.py,sha256=ANlau8qbFc5OTtvcnYzItZOicyiejS3VHfh8wnJYSmU,937
+freeplay/provider_config.py,sha256=EkRHDV4zehqS0Vo5ZQHZHRgqdiw63PRN7rLwvm3Wiig,1871
+freeplay/utils.py,sha256=n7iZGvgSJcDYL31QpYxpJyPzRpYhhqEi_r7g6t6L04I,369
+freeplay-0.2.15.dist-info/METADATA,sha256=Nfk3PHXrcJyRUzSZiTUoe5w-fUU6PKbT1SsJlVdsIYc,680
+freeplay-0.2.15.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+freeplay-0.2.15.dist-info/RECORD,,

freeplay-0.2.14.dist-info/RECORD

@@ -1,12 +0,0 @@
-freeplay/__init__.py,sha256=74A9S9hmLq9BNHsdx0-37yDxlSukudNl9bJ0TE60Z30,61
-freeplay/api_support.py,sha256=mWauXzpZx9DwIzuqlnfEAXX2LsILE3an4G_6OVMHopI,1834
-freeplay/completions.py,sha256=M1vlziRTIfmO-TGdqNI_eHHq4zYpMj0n8dzH-boz7bY,992
-freeplay/errors.py,sha256=SEkQ72gamIRMyJt2g_YHqk3mqVJAxl-SF84ODHN6vdw,188
-freeplay/flavors.py,sha256=bq4wNOyCzOgsS7o2ofGImDMbAMCVmhmXFSQno7mssoE,11724
-freeplay/freeplay.py,sha256=Rkv2V1ED4dyqgNnr5Pi5sxQL1WHz__sDkuyuzvKIYDY,27763
-freeplay/llm_parameters.py,sha256=ODAVTVj6dGsMlAux8NSQPPqeVREMo7-IEP2VIjihR54,828
-freeplay/provider_config.py,sha256=tsMmhV3BAJCfX1I0BmGgDjZjWHT8fJ78l1-BV2LEtmM,955
-freeplay/utils.py,sha256=n7iZGvgSJcDYL31QpYxpJyPzRpYhhqEi_r7g6t6L04I,369
-freeplay-0.2.14.dist-info/METADATA,sha256=lRBXXQGYY12KuOGtTwo0fJuTvq67ha1Msba_6nvSNWQ,680
-freeplay-0.2.14.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-freeplay-0.2.14.dist-info/RECORD,,