semantic-kernel 0.2.3.dev0__py3-none-any.whl → 0.2.5.dev0__py3-none-any.whl

semantic_kernel/{ai → connectors/ai}/chat_completion_client_base.py

@@ -5,7 +5,7 @@ from logging import Logger
 from typing import TYPE_CHECKING, List, Tuple
 
 if TYPE_CHECKING:
-    from semantic_kernel.ai.chat_request_settings import ChatRequestSettings
+    from semantic_kernel.connectors.ai.chat_request_settings import ChatRequestSettings
 
 
 class ChatCompletionClientBase(ABC):

semantic_kernel/connectors/ai/hugging_face/__init__.py

@@ -0,0 +1,10 @@
+# Copyright (c) Microsoft. All rights reserved.
+
+from semantic_kernel.connectors.ai.hugging_face.services.hf_text_completion import (
+    HuggingFaceTextCompletion,
+)
+from semantic_kernel.connectors.ai.hugging_face.services.hf_text_embedding import (
+    HuggingFaceTextEmbedding,
+)
+
+__all__ = ["HuggingFaceTextCompletion", "HuggingFaceTextEmbedding"]

semantic_kernel/connectors/ai/hugging_face/services/hf_text_completion.py

@@ -0,0 +1,95 @@
+# Copyright (c) Microsoft. All rights reserved.
+
+from logging import Logger
+from typing import Optional
+
+import torch
+from transformers import pipeline
+
+from semantic_kernel.connectors.ai.ai_exception import AIException
+from semantic_kernel.connectors.ai.complete_request_settings import (
+    CompleteRequestSettings,
+)
+from semantic_kernel.connectors.ai.text_completion_client_base import (
+    TextCompletionClientBase,
+)
+from semantic_kernel.utils.null_logger import NullLogger
+
+
+class HuggingFaceTextCompletion(TextCompletionClientBase):
+    _model_id: str
+    _task: str
+    _device: int
+    _log: Logger
+
+    def __init__(
+        self,
+        model_id: str,
+        device: Optional[int] = -1,
+        task: Optional[str] = None,
+        log: Optional[Logger] = None,
+    ) -> None:
+        """
+        Initializes a new instance of the HuggingFaceTextCompletion class.
+
+        Arguments:
+            model_id {str} -- Hugging Face model card string, see
+                https://huggingface.co/models
+            device {Optional[int]} -- Device to run the model on, -1 for CPU, 0+ for GPU.
+            task {Optional[str]} -- Model completion task type, options are:
+                - summarization: takes a long text and returns a shorter summary.
+                - text-generation: takes incomplete text and returns a set of completion candidates.
+                - text2text-generation (default): takes an input prompt and returns a completion.
+                text2text-generation is the default as it behaves more like GPT-3+.
+            log {Optional[Logger]} -- Logger instance.
+
+        Note that this model will be downloaded from the Hugging Face model hub.
+        """
+        self._model_id = model_id
+        self._task = "text2text-generation" if task is None else task
+        self._log = log if log is not None else NullLogger()
+        self.device = (
+            "cuda:" + device if device >= 0 and torch.cuda.is_available() else "cpu"
+        )
+        self.generator = pipeline(
+            task=self._task, model=self._model_id, device=self.device
+        )
+
+    async def complete_async(
+        self, prompt: str, request_settings: CompleteRequestSettings
+    ) -> str:
+        """
+        Completes a prompt using the Hugging Face model.
+
+        Arguments:
+            prompt {str} -- Prompt to complete.
+            request_settings {CompleteRequestSettings} -- Request settings.
+
+        Returns:
+            str -- Completion result.
+        """
+        try:
+            result = self.generator(
+                prompt,
+                num_return_sequences=1,
+                temperature=request_settings.temperature,
+                top_p=request_settings.top_p,
+                max_length=request_settings.max_tokens,
+                pad_token_id=50256,  # EOS token
+            )
+
+            if self._task == "text-generation" or self._task == "text2text-generation":
+                return result[0]["generated_text"]
+
+            elif self._task == "summarization":
+                return result[0]["summary_text"]
+
+            else:
+                raise AIException(
+                    AIException.ErrorCodes.InvalidConfiguration,
+                    "Unsupported hugging face pipeline task: only \
+                        text-generation, text2text-generation, and summarization are supported.",
+                )
+
+        except Exception as e:
+            raise AIException("Hugging Face completion failed", e)

semantic_kernel/connectors/ai/hugging_face/services/hf_text_embedding.py

@@ -0,0 +1,63 @@
+# Copyright (c) Microsoft. All rights reserved.
+
+from logging import Logger
+from typing import List, Optional
+
+import torch
+from numpy import array, ndarray
+from sentence_transformers import SentenceTransformer
+
+from semantic_kernel.connectors.ai.ai_exception import AIException
+from semantic_kernel.connectors.ai.embeddings.embedding_generator_base import (
+    EmbeddingGeneratorBase,
+)
+from semantic_kernel.utils.null_logger import NullLogger
+
+
+class HuggingFaceTextEmbedding(EmbeddingGeneratorBase):
+    _model_id: str
+    _device: int
+    _log: Logger
+
+    def __init__(
+        self,
+        model_id: str,
+        device: Optional[int] = -1,
+        log: Optional[Logger] = None,
+    ) -> None:
+        """
+        Initializes a new instance of the HuggingFaceTextEmbedding class.
+
+        Arguments:
+            model_id {str} -- Hugging Face model card string, see
+                https://huggingface.co/sentence-transformers
+            device {Optional[int]} -- Device to run the model on, -1 for CPU, 0+ for GPU.
+            log {Optional[Logger]} -- Logger instance.
+
+        Note that this model will be downloaded from the Hugging Face model hub.
+        """
+        self._model_id = model_id
+        self._log = log if log is not None else NullLogger()
+        self.device = (
+            "cuda:" + device if device >= 0 and torch.cuda.is_available() else "cpu"
+        )
+        self.generator = SentenceTransformer(
+            model_name_or_path=self._model_id, device=self.device
+        )
+
+    async def generate_embeddings_async(self, texts: List[str]) -> ndarray:
+        """
+        Generates embeddings for a list of texts.
+
+        Arguments:
+            texts {List[str]} -- Texts to generate embeddings for.
+
+        Returns:
+            ndarray -- Embeddings for the texts.
+        """
+        try:
+            self._log.info(f"Generating embeddings for {len(texts)} texts")
+            embeddings = self.generator.encode(texts)
+            return array(embeddings)
+        except Exception as e:
+            raise AIException("Hugging Face embeddings failed", e)

semantic_kernel/connectors/ai/open_ai/__init__.py

@@ -0,0 +1,29 @@
+# Copyright (c) Microsoft. All rights reserved.
+
+from semantic_kernel.connectors.ai.open_ai.services.azure_chat_completion import (
+    AzureChatCompletion,
+)
+from semantic_kernel.connectors.ai.open_ai.services.azure_text_completion import (
+    AzureTextCompletion,
+)
+from semantic_kernel.connectors.ai.open_ai.services.azure_text_embedding import (
+    AzureTextEmbedding,
+)
+from semantic_kernel.connectors.ai.open_ai.services.open_ai_chat_completion import (
+    OpenAIChatCompletion,
+)
+from semantic_kernel.connectors.ai.open_ai.services.open_ai_text_completion import (
+    OpenAITextCompletion,
+)
+from semantic_kernel.connectors.ai.open_ai.services.open_ai_text_embedding import (
+    OpenAITextEmbedding,
+)
+
+__all__ = [
+    "OpenAITextCompletion",
+    "OpenAIChatCompletion",
+    "OpenAITextEmbedding",
+    "AzureTextCompletion",
+    "AzureChatCompletion",
+    "AzureTextEmbedding",
+]

semantic_kernel/{ai → connectors/ai}/open_ai/services/azure_chat_completion.py

@@ -4,7 +4,7 @@
 from logging import Logger
 from typing import Any, Optional
 
-from semantic_kernel.ai.open_ai.services.open_ai_chat_completion import (
+from semantic_kernel.connectors.ai.open_ai.services.open_ai_chat_completion import (
     OpenAIChatCompletion,
 )
 
@@ -24,7 +24,7 @@ class AzureChatCompletion(OpenAIChatCompletion):
         ad_auth=False,
     ) -> None:
         """
-        Initialize an AzureChatCompletion backend.
+        Initialize an AzureChatCompletion service.
 
         You must provide:
         - A deployment_name, endpoint, and api_key (plus, optionally: ad_auth)

semantic_kernel/{ai → connectors/ai}/open_ai/services/azure_text_completion.py

@@ -4,7 +4,7 @@
 from logging import Logger
 from typing import Any, Optional
 
-from semantic_kernel.ai.open_ai.services.open_ai_text_completion import (
+from semantic_kernel.connectors.ai.open_ai.services.open_ai_text_completion import (
     OpenAITextCompletion,
 )
 
@@ -24,7 +24,7 @@ class AzureTextCompletion(OpenAITextCompletion):
         ad_auth=False,
     ) -> None:
         """
-        Initialize an AzureTextCompletion backend.
+        Initialize an AzureTextCompletion service.
 
         You must provide:
         - A deployment_name, endpoint, and api_key (plus, optionally: ad_auth)

semantic_kernel/{ai → connectors/ai}/open_ai/services/azure_text_embedding.py

@@ -4,7 +4,7 @@
 from logging import Logger
 from typing import Any, Optional
 
-from semantic_kernel.ai.open_ai.services.open_ai_text_embedding import (
+from semantic_kernel.connectors.ai.open_ai.services.open_ai_text_embedding import (
     OpenAITextEmbedding,
 )
 
@@ -24,7 +24,7 @@ class AzureTextEmbedding(OpenAITextEmbedding):
         ad_auth=False,
     ) -> None:
         """
-        Initialize an AzureTextEmbedding backend.
+        Initialize an AzureTextEmbedding service.
 
         You must provide:
         - A deployment_name, endpoint, and api_key (plus, optionally: ad_auth)

semantic_kernel/{ai → connectors/ai}/open_ai/services/open_ai_chat_completion.py

@@ -3,13 +3,21 @@
 from logging import Logger
 from typing import Any, List, Optional, Tuple
 
-from semantic_kernel.ai.ai_exception import AIException
-from semantic_kernel.ai.chat_completion_client_base import ChatCompletionClientBase
-from semantic_kernel.ai.chat_request_settings import ChatRequestSettings
+from semantic_kernel.connectors.ai.ai_exception import AIException
+from semantic_kernel.connectors.ai.chat_completion_client_base import (
+    ChatCompletionClientBase,
+)
+from semantic_kernel.connectors.ai.chat_request_settings import ChatRequestSettings
+from semantic_kernel.connectors.ai.complete_request_settings import (
+    CompleteRequestSettings,
+)
+from semantic_kernel.connectors.ai.text_completion_client_base import (
+    TextCompletionClientBase,
+)
 from semantic_kernel.utils.null_logger import NullLogger
 
 
-class OpenAIChatCompletion(ChatCompletionClientBase):
+class OpenAIChatCompletion(ChatCompletionClientBase, TextCompletionClientBase):
     _model_id: str
     _api_key: str
     _org_id: Optional[str] = None
@@ -116,3 +124,27 @@ class OpenAIChatCompletion(ChatCompletionClientBase):
         # TODO: tracking on token counts/etc.
 
         return response.choices[0].message.content
+
+    async def complete_async(
+        self, prompt: str, request_settings: CompleteRequestSettings
+    ) -> str:
+        """
+        Completes the given prompt. Returns a single string completion.
+        Cannot return multiple completions. Cannot return logprobs.
+
+        Arguments:
+            prompt {str} -- The prompt to complete.
+            request_settings {CompleteRequestSettings} -- The request settings.
+
+        Returns:
+            str -- The completed text.
+        """
+        prompt_to_message = [("user", prompt)]
+        chat_settings = ChatRequestSettings(
+            temperature=request_settings.temperature,
+            top_p=request_settings.top_p,
+            presence_penalty=request_settings.presence_penalty,
+            frequency_penalty=request_settings.frequency_penalty,
+            max_tokens=request_settings.max_tokens,
+        )
+        return await self.complete_chat_async(prompt_to_message, chat_settings)

semantic_kernel/{ai → connectors/ai}/open_ai/services/open_ai_text_completion.py

@@ -3,9 +3,13 @@
 from logging import Logger
 from typing import Any, Optional
 
-from semantic_kernel.ai.ai_exception import AIException
-from semantic_kernel.ai.complete_request_settings import CompleteRequestSettings
-from semantic_kernel.ai.text_completion_client_base import TextCompletionClientBase
+from semantic_kernel.connectors.ai.ai_exception import AIException
+from semantic_kernel.connectors.ai.complete_request_settings import (
+    CompleteRequestSettings,
+)
+from semantic_kernel.connectors.ai.text_completion_client_base import (
+    TextCompletionClientBase,
+)
 from semantic_kernel.utils.null_logger import NullLogger
 
 
@@ -50,7 +54,7 @@ class OpenAITextCompletion(TextCompletionClientBase):
 
         return openai
 
-    async def complete_simple_async(
+    async def complete_async(
         self, prompt: str, request_settings: CompleteRequestSettings
     ) -> str:
         """
@@ -79,14 +83,14 @@ class OpenAITextCompletion(TextCompletionClientBase):
         if request_settings.number_of_responses != 1:
             raise AIException(
                 AIException.ErrorCodes.InvalidRequest,
-                "complete_simple_async only supports a single completion, "
+                "complete_async only supports a single completion, "
                 f"but {request_settings.number_of_responses} were requested",
             )
 
         if request_settings.logprobs != 0:
             raise AIException(
                 AIException.ErrorCodes.InvalidRequest,
-                "complete_simple_async does not support logprobs, "
+                "complete_async does not support logprobs, "
                 f"but logprobs={request_settings.logprobs} was requested",
             )
 

semantic_kernel/{ai → connectors/ai}/open_ai/services/open_ai_text_embedding.py

@@ -5,8 +5,8 @@ from typing import Any, List, Optional
 
 from numpy import array, ndarray
 
-from semantic_kernel.ai.ai_exception import AIException
-from semantic_kernel.ai.embeddings.embedding_generator_base import (
+from semantic_kernel.connectors.ai.ai_exception import AIException
+from semantic_kernel.connectors.ai.embeddings.embedding_generator_base import (
     EmbeddingGeneratorBase,
 )
 from semantic_kernel.utils.null_logger import NullLogger

semantic_kernel/{ai → connectors/ai}/text_completion_client_base.py

@@ -5,12 +5,14 @@ from logging import Logger
 from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
-    from semantic_kernel.ai.complete_request_settings import CompleteRequestSettings
+    from semantic_kernel.connectors.ai.complete_request_settings import (
+        CompleteRequestSettings,
+    )
 
 
 class TextCompletionClientBase(ABC):
     @abstractmethod
-    async def complete_simple_async(
+    async def complete_async(
         self,
         prompt: str,
         settings: "CompleteRequestSettings",

semantic_kernel/core_skills/__init__.py

@@ -1,8 +1,9 @@
 # Copyright (c) Microsoft. All rights reserved.
 
 from semantic_kernel.core_skills.file_io_skill import FileIOSkill
+from semantic_kernel.core_skills.http_skill import HttpSkill
 from semantic_kernel.core_skills.text_memory_skill import TextMemorySkill
 from semantic_kernel.core_skills.text_skill import TextSkill
 from semantic_kernel.core_skills.time_skill import TimeSkill
 
-__all__ = ["TextMemorySkill", "TextSkill", "FileIOSkill", "TimeSkill"]
+__all__ = ["TextMemorySkill", "TextSkill", "FileIOSkill", "TimeSkill", "HttpSkill"]

semantic_kernel/core_skills/http_skill.py

@@ -0,0 +1,106 @@
+# Copyright (c) Microsoft. All rights reserved.
+
+import json
+
+import aiohttp
+
+from semantic_kernel.orchestration.sk_context import SKContext
+from semantic_kernel.skill_definition import sk_function, sk_function_context_parameter
+
+
+class HttpSkill:
+    """
+    A skill that provides HTTP functionality.
+
+    Usage:
+        kernel.import_skill(HttpSkill(), "http")
+
+    Examples:
+
+        {{http.getAsync $url}}
+        {{http.postAsync $url}}
+        {{http.putAsync $url}}
+        {{http.deleteAsync $url}}
+    """
+
+    @sk_function(description="Makes a GET request to a uri", name="getAsync")
+    async def get_async(self, url: str) -> str:
+        """
+        Sends an HTTP GET request to the specified URI and returns
+        the response body as a string.
+        params:
+            uri: The URI to send the request to.
+        returns:
+            The response body as a string.
+        """
+        if not url:
+            raise ValueError("url cannot be `None` or empty")
+
+        async with aiohttp.ClientSession() as session:
+            async with session.get(url, raise_for_status=True) as response:
+                return await response.text()
+
+    @sk_function(description="Makes a POST request to a uri", name="postAsync")
+    @sk_function_context_parameter(name="body", description="The body of the request")
+    async def post_async(self, url: str, context: SKContext) -> str:
+        """
+        Sends an HTTP POST request to the specified URI and returns
+        the response body as a string.
+        params:
+            url: The URI to send the request to.
+            context: Contains the body of the request
+        returns:
+            The response body as a string.
+        """
+        if not url:
+            raise ValueError("url cannot be `None` or empty")
+
+        _, body = context.variables.get("body")
+
+        headers = {"Content-Type": "application/json"}
+        data = json.dumps(body)
+        async with aiohttp.ClientSession() as session:
+            async with session.post(
+                url, headers=headers, data=data, raise_for_status=True
+            ) as response:
+                return await response.text()
+
+    @sk_function(description="Makes a PUT request to a uri", name="putAsync")
+    @sk_function_context_parameter(name="body", description="The body of the request")
+    async def put_async(self, url: str, context: SKContext) -> str:
+        """
+        Sends an HTTP PUT request to the specified URI and returns
+        the response body as a string.
+        params:
+            url: The URI to send the request to.
+        returns:
+            The response body as a string.
+        """
+        if not url:
+            raise ValueError("url cannot be `None` or empty")
+
+        _, body = context.variables.get("body")
+
+        headers = {"Content-Type": "application/json"}
+        data = json.dumps(body)
+        async with aiohttp.ClientSession() as session:
+            async with session.put(
+                url, headers=headers, data=data, raise_for_status=True
+            ) as response:
+                return await response.text()
+
+    @sk_function(description="Makes a DELETE request to a uri", name="deleteAsync")
+    async def delete_async(self, url: str) -> str:
+        """
+        Sends an HTTP DELETE request to the specified URI and returns
+        the response body as a string.
+        params:
+            uri: The URI to send the request to.
+        returns:
+            The response body as a string.
+        """
+        if not url:
+            raise ValueError("url cannot be `None` or empty")
+        async with aiohttp.ClientSession() as session:
+            async with session.delete(url, raise_for_status=True) as response:
+                return await response.text()

semantic_kernel/core_skills/time_skill.py

@@ -32,7 +32,7 @@ class TimeSkill:
         {{time.timeZoneName}}    => PST
     """
 
-    @sk_function(description="Get the current time.")
+    @sk_function(description="Get the current date.")
     def date(self) -> str:
         """
         Get the current date
@@ -43,6 +43,16 @@ class TimeSkill:
         now = datetime.datetime.now()
         return now.strftime("%A, %d %B, %Y")
 
+    @sk_function(description="Get the current date.")
+    def today(self) -> str:
+        """
+        Get the current date
+
+        Example:
+            {{time.today}} => Sunday, 12 January, 2031
+        """
+        return self.date()
+
     @sk_function(description="Get the current date and time in the local time zone")
     def now(self) -> str:
         """