mirror of
https://github.com/microsoft/semantic-kernel.git
synced 2026-10-12 02:19:06 +00:00
### Motivation and Context To better align with SK dotnet v1, Python skills have been renamed to plugins. This removes the root samples skills directory as dotnet supports the plugins and their configs. This the beginning of more work to consolidate other files/names, per the backlog. I've run several greps for files or file names containing "skill" (case insensitive), and no results appear. Do alert if you find anything else that includes "skill." Fixes #3319 <!-- Thank you for your contribution to the semantic-kernel repo! Please help reviewers and future users, providing the following information: 1. Why is this change required? 2. What problem does it solve? 3. What scenario does it contribute to? 4. If it fixes an open issue, please link to the issue here. --> ### Description This is a large, breaking change PR as the replacement of "skills" to "plugins" affects many files. It was difficult to break this up into smaller chunks without leaving the SK Python repo in a bad state for some time. Other updates include: - Prompt template has been updated to use `execution_settings`, which aligns with dotnet, from the previous `completion` that Python used. - AzureOpenAI/OpenAI function calling has been updated to match the current versions of tools/tool_choice. Parsing messages in the open_ai utils respects this as it now looks for tool_calls and it configures the function_call with the id (new), name, and argument). - File renames, where the filename used to contain "skill" will look like new code, but it's the same code, just with "plugin" in the name. - Kernel examples and notebooks have been tested and are working. Unit tests and integration tests are passing. <!-- Describe your changes, the overall approach, the underlying design. These notes will help understanding how your code works. Thanks! --> ### Contribution Checklist <!-- Before submitting this PR, please make sure: --> - [X] The code builds clean without any errors or warnings - [X] The PR follows the [SK Contribution Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md) and the [pre-submission formatting script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts) raises no violations - [X] All unit tests pass, and I have added new tests where possible - [X] I didn't break anyone 😄 --------- Co-authored-by: Evan Mattson <[email protected]>
809 lines
34 KiB
Python
809 lines
34 KiB
Python
# Copyright (c) Microsoft. All rights reserved.
|
|
|
|
import glob
|
|
import importlib
|
|
import inspect
|
|
import logging
|
|
import os
|
|
from typing import Any, Callable, Dict, List, Optional, Type, TypeVar, Union
|
|
from uuid import uuid4
|
|
|
|
from semantic_kernel.connectors.ai.ai_exception import AIException
|
|
from semantic_kernel.connectors.ai.ai_request_settings import AIRequestSettings
|
|
from semantic_kernel.connectors.ai.chat_completion_client_base import (
|
|
ChatCompletionClientBase,
|
|
)
|
|
from semantic_kernel.connectors.ai.embeddings.embedding_generator_base import (
|
|
EmbeddingGeneratorBase,
|
|
)
|
|
from semantic_kernel.connectors.ai.text_completion_client_base import (
|
|
TextCompletionClientBase,
|
|
)
|
|
from semantic_kernel.events import FunctionInvokedEventArgs, FunctionInvokingEventArgs
|
|
from semantic_kernel.kernel_exception import KernelException
|
|
from semantic_kernel.memory.memory_store_base import MemoryStoreBase
|
|
from semantic_kernel.memory.null_memory import NullMemory
|
|
from semantic_kernel.memory.semantic_text_memory import SemanticTextMemory
|
|
from semantic_kernel.memory.semantic_text_memory_base import SemanticTextMemoryBase
|
|
from semantic_kernel.orchestration.context_variables import ContextVariables
|
|
from semantic_kernel.orchestration.sk_context import SKContext
|
|
from semantic_kernel.orchestration.sk_function import SKFunction
|
|
from semantic_kernel.orchestration.sk_function_base import SKFunctionBase
|
|
from semantic_kernel.plugin_definition.function_view import FunctionView
|
|
from semantic_kernel.plugin_definition.plugin_collection import PluginCollection
|
|
from semantic_kernel.plugin_definition.plugin_collection_base import (
|
|
PluginCollectionBase,
|
|
)
|
|
from semantic_kernel.plugin_definition.read_only_plugin_collection_base import (
|
|
ReadOnlyPluginCollectionBase,
|
|
)
|
|
from semantic_kernel.reliability.pass_through_without_retry import (
|
|
PassThroughWithoutRetry,
|
|
)
|
|
from semantic_kernel.reliability.retry_mechanism_base import RetryMechanismBase
|
|
from semantic_kernel.semantic_functions.prompt_template import PromptTemplate
|
|
from semantic_kernel.semantic_functions.prompt_template_config import (
|
|
PromptTemplateConfig,
|
|
)
|
|
from semantic_kernel.semantic_functions.semantic_function_config import (
|
|
SemanticFunctionConfig,
|
|
)
|
|
from semantic_kernel.template_engine.prompt_template_engine import PromptTemplateEngine
|
|
from semantic_kernel.template_engine.protocols.prompt_templating_engine import (
|
|
PromptTemplatingEngine,
|
|
)
|
|
from semantic_kernel.utils.validation import (
|
|
validate_function_name,
|
|
validate_plugin_name,
|
|
)
|
|
|
|
T = TypeVar("T")
|
|
|
|
logger: logging.Logger = logging.getLogger(__name__)
|
|
|
|
|
|
class Kernel:
|
|
_plugin_collection: PluginCollectionBase
|
|
_prompt_template_engine: PromptTemplatingEngine
|
|
_memory: SemanticTextMemoryBase
|
|
|
|
def __init__(
|
|
self,
|
|
plugin_collection: Optional[PluginCollectionBase] = None,
|
|
prompt_template_engine: Optional[PromptTemplatingEngine] = None,
|
|
memory: Optional[SemanticTextMemoryBase] = None,
|
|
log: Optional[Any] = None,
|
|
) -> None:
|
|
if log:
|
|
logger.warning("The `log` parameter is deprecated. Please use the `logging` module instead.")
|
|
self._plugin_collection = plugin_collection if plugin_collection else PluginCollection()
|
|
self._prompt_template_engine = prompt_template_engine if prompt_template_engine else PromptTemplateEngine()
|
|
self._memory = memory if memory else NullMemory()
|
|
|
|
self._text_completion_services: Dict[str, Callable[["Kernel"], TextCompletionClientBase]] = {}
|
|
self._chat_services: Dict[str, Callable[["Kernel"], ChatCompletionClientBase]] = {}
|
|
self._text_embedding_generation_services: Dict[str, Callable[["Kernel"], EmbeddingGeneratorBase]] = {}
|
|
|
|
self._default_text_completion_service: Optional[str] = None
|
|
self._default_chat_service: Optional[str] = None
|
|
self._default_text_embedding_generation_service: Optional[str] = None
|
|
|
|
self._retry_mechanism: RetryMechanismBase = PassThroughWithoutRetry()
|
|
|
|
self._function_invoking_handlers = {}
|
|
self._function_invoked_handlers = {}
|
|
|
|
@property
|
|
def memory(self) -> SemanticTextMemoryBase:
|
|
return self._memory
|
|
|
|
@property
|
|
def prompt_template_engine(self) -> PromptTemplatingEngine:
|
|
return self._prompt_template_engine
|
|
|
|
@property
|
|
def plugins(self) -> ReadOnlyPluginCollectionBase:
|
|
return self._plugin_collection.read_only_plugin_collection
|
|
|
|
def register_semantic_function(
|
|
self,
|
|
plugin_name: Optional[str],
|
|
function_name: str,
|
|
function_config: SemanticFunctionConfig,
|
|
) -> SKFunctionBase:
|
|
if plugin_name is None or plugin_name == "":
|
|
plugin_name = PluginCollection.GLOBAL_PLUGIN
|
|
assert plugin_name is not None # for type checker
|
|
|
|
validate_plugin_name(plugin_name)
|
|
validate_function_name(function_name)
|
|
|
|
function = self._create_semantic_function(plugin_name, function_name, function_config)
|
|
self._plugin_collection.add_semantic_function(function)
|
|
|
|
return function
|
|
|
|
def register_native_function(
|
|
self,
|
|
plugin_name: Optional[str],
|
|
sk_function: Callable,
|
|
) -> SKFunctionBase:
|
|
if not hasattr(sk_function, "__sk_function__"):
|
|
raise KernelException(
|
|
KernelException.ErrorCodes.InvalidFunctionType,
|
|
"sk_function argument must be decorated with @sk_function",
|
|
)
|
|
function_name = sk_function.__sk_function_name__
|
|
|
|
if plugin_name is None or plugin_name == "":
|
|
plugin_name = PluginCollection.GLOBAL_PLUGIN
|
|
assert plugin_name is not None # for type checker
|
|
|
|
validate_plugin_name(plugin_name)
|
|
validate_function_name(function_name)
|
|
|
|
function = SKFunction.from_native_method(sk_function, plugin_name)
|
|
|
|
if self.plugins.has_function(plugin_name, function_name):
|
|
raise KernelException(
|
|
KernelException.ErrorCodes.FunctionOverloadNotSupported,
|
|
"Overloaded functions are not supported, " "please differentiate function names.",
|
|
)
|
|
|
|
function.set_default_plugin_collection(self.plugins)
|
|
self._plugin_collection.add_native_function(function)
|
|
|
|
return function
|
|
|
|
async def run_stream_async(
|
|
self,
|
|
*functions: Any,
|
|
input_context: Optional[SKContext] = None,
|
|
input_vars: Optional[ContextVariables] = None,
|
|
input_str: Optional[str] = None,
|
|
):
|
|
if len(functions) > 1:
|
|
pipeline_functions = functions[:-1]
|
|
stream_function = functions[-1]
|
|
|
|
# run pipeline functions
|
|
context = await self.run_async(pipeline_functions, input_context, input_vars, input_str)
|
|
|
|
elif len(functions) == 1:
|
|
stream_function = functions[0]
|
|
|
|
# TODO: Preparing context for function invoke can be refactored as code below are same as run_async
|
|
# if the user passed in a context, prioritize it, but merge with any other inputs
|
|
if input_context is not None:
|
|
context = input_context
|
|
if input_vars is not None:
|
|
context.variables = input_vars.merge_or_overwrite(new_vars=context.variables, overwrite=False)
|
|
|
|
if input_str is not None:
|
|
context.variables = ContextVariables(input_str).merge_or_overwrite(
|
|
new_vars=context.variables, overwrite=False
|
|
)
|
|
|
|
# if the user did not pass in a context, prioritize an input string,
|
|
# and merge that with input context variables
|
|
else:
|
|
if input_str is not None and input_vars is None:
|
|
variables = ContextVariables(input_str)
|
|
elif input_str is None and input_vars is not None:
|
|
variables = input_vars
|
|
elif input_str is not None and input_vars is not None:
|
|
variables = ContextVariables(input_str)
|
|
variables = variables.merge_or_overwrite(new_vars=input_vars, overwrite=False)
|
|
else:
|
|
variables = ContextVariables()
|
|
context = SKContext(
|
|
variables,
|
|
self._memory,
|
|
self._plugin_collection.read_only_plugin_collection,
|
|
)
|
|
else:
|
|
raise ValueError("No functions passed to run")
|
|
|
|
try:
|
|
async for stream_message in stream_function.invoke_stream_async(input=None, context=context):
|
|
yield stream_message
|
|
|
|
except Exception as ex:
|
|
# TODO: "critical exceptions"
|
|
logger.error(
|
|
"Something went wrong in stream function. During function invocation:"
|
|
f" '{stream_function.plugin_name}.{stream_function.name}'. Error"
|
|
f" description: '{str(ex)}'"
|
|
)
|
|
raise KernelException(
|
|
KernelException.ErrorCodes.FunctionInvokeError,
|
|
"Error occurred while invoking stream function",
|
|
)
|
|
|
|
async def run_async(
|
|
self,
|
|
*functions: Any,
|
|
input_context: Optional[SKContext] = None,
|
|
input_vars: Optional[ContextVariables] = None,
|
|
input_str: Optional[str] = None,
|
|
**kwargs: Dict[str, Any],
|
|
) -> SKContext:
|
|
# if the user passed in a context, prioritize it, but merge with any other inputs
|
|
if input_context is not None:
|
|
context = input_context
|
|
if input_vars is not None:
|
|
context.variables = input_vars.merge_or_overwrite(new_vars=context.variables, overwrite=False)
|
|
|
|
if input_str is not None:
|
|
context.variables = ContextVariables(input_str).merge_or_overwrite(
|
|
new_vars=context.variables, overwrite=False
|
|
)
|
|
|
|
# if the user did not pass in a context, prioritize an input string,
|
|
# and merge that with input context variables
|
|
else:
|
|
if input_str is not None and input_vars is None:
|
|
variables = ContextVariables(input_str)
|
|
elif input_str is None and input_vars is not None:
|
|
variables = input_vars
|
|
elif input_str is not None and input_vars is not None:
|
|
variables = ContextVariables(input_str)
|
|
variables = variables.merge_or_overwrite(new_vars=input_vars, overwrite=False)
|
|
else:
|
|
variables = ContextVariables()
|
|
context = SKContext(
|
|
variables,
|
|
self._memory,
|
|
self._plugin_collection.read_only_plugin_collection,
|
|
)
|
|
|
|
pipeline_step = 0
|
|
for func in functions:
|
|
while True:
|
|
assert isinstance(func, SKFunctionBase), (
|
|
"All func arguments to Kernel.run*(inputs, func1, func2, ...) " "must be SKFunctionBase instances"
|
|
)
|
|
|
|
if context.error_occurred:
|
|
logger.error(
|
|
f"Something went wrong in pipeline step {pipeline_step}. "
|
|
f"Error description: '{context.last_error_description}'"
|
|
)
|
|
return context
|
|
|
|
try:
|
|
function_details = func.describe()
|
|
|
|
function_invoking_args = self.on_function_invoking(function_details, context)
|
|
if (
|
|
isinstance(function_invoking_args, FunctionInvokingEventArgs)
|
|
and function_invoking_args.is_cancel_requested
|
|
):
|
|
cancel_message = "Execution was cancelled on function invoking event of pipeline step"
|
|
logger.info(f"{cancel_message} {pipeline_step}: {func.plugin_name}.{func.name}.")
|
|
return context
|
|
|
|
if (
|
|
isinstance(function_invoking_args, FunctionInvokingEventArgs)
|
|
and function_invoking_args.is_skip_requested
|
|
):
|
|
skip_message = "Execution was skipped on function invoking event of pipeline step"
|
|
logger.info(f"{skip_message} {pipeline_step}: {func.plugin_name}.{func.name}.")
|
|
break
|
|
|
|
context = await func.invoke_async(input=None, context=context, **kwargs)
|
|
|
|
if context.error_occurred:
|
|
logger.error(
|
|
f"Something went wrong in pipeline step {pipeline_step}. "
|
|
f"During function invocation: '{func.plugin_name}.{func.name}'. "
|
|
f"Error description: '{context.last_error_description}'"
|
|
)
|
|
return context
|
|
|
|
function_invoked_args = self.on_function_invoked(function_details, context)
|
|
|
|
if (
|
|
isinstance(function_invoked_args, FunctionInvokedEventArgs)
|
|
and function_invoked_args.is_cancel_requested
|
|
):
|
|
cancel_message = "Execution was cancelled on function invoked event of pipeline step"
|
|
logger.info(f"{cancel_message} {pipeline_step}: {func.plugin_name}.{func.name}.")
|
|
return context
|
|
if (
|
|
isinstance(function_invoked_args, FunctionInvokedEventArgs)
|
|
and function_invoked_args.is_repeat_requested
|
|
):
|
|
repeat_message = "Execution was repeated on function invoked event of pipeline step"
|
|
logger.info(f"{repeat_message} {pipeline_step}: {func.plugin_name}.{func.name}.")
|
|
continue
|
|
else:
|
|
break
|
|
|
|
except Exception as ex:
|
|
logger.error(
|
|
f"Something went wrong in pipeline step {pipeline_step}. "
|
|
f"During function invocation: '{func.plugin_name}.{func.name}'. "
|
|
f"Error description: '{str(ex)}'"
|
|
)
|
|
context.fail(str(ex), ex)
|
|
return context
|
|
|
|
pipeline_step += 1
|
|
|
|
return context
|
|
|
|
def func(self, plugin_name: str, function_name: str) -> SKFunctionBase:
|
|
if self.plugins.has_native_function(plugin_name, function_name):
|
|
return self.plugins.get_native_function(plugin_name, function_name)
|
|
|
|
return self.plugins.get_semantic_function(plugin_name, function_name)
|
|
|
|
def use_memory(
|
|
self,
|
|
storage: MemoryStoreBase,
|
|
embeddings_generator: Optional[EmbeddingGeneratorBase] = None,
|
|
) -> None:
|
|
if embeddings_generator is None:
|
|
service_id = self.get_text_embedding_generation_service_id()
|
|
if not service_id:
|
|
raise ValueError("The embedding service id cannot be `None` or empty")
|
|
|
|
embeddings_service = self.get_ai_service(EmbeddingGeneratorBase, service_id)
|
|
if not embeddings_service:
|
|
raise ValueError(f"AI configuration is missing for: {service_id}")
|
|
|
|
embeddings_generator = embeddings_service(self)
|
|
|
|
if storage is None:
|
|
raise ValueError("The storage instance provided cannot be `None`")
|
|
if embeddings_generator is None:
|
|
raise ValueError("The embedding generator cannot be `None`")
|
|
|
|
self.register_memory(SemanticTextMemory(storage, embeddings_generator))
|
|
|
|
def register_memory(self, memory: SemanticTextMemoryBase) -> None:
|
|
self._memory = memory
|
|
|
|
def register_memory_store(self, memory_store: MemoryStoreBase) -> None:
|
|
self.use_memory(memory_store)
|
|
|
|
def create_new_context(self, variables: Optional[ContextVariables] = None) -> SKContext:
|
|
return SKContext(
|
|
ContextVariables() if not variables else variables,
|
|
self._memory,
|
|
self.plugins,
|
|
)
|
|
|
|
def on_function_invoking(self, function_view: FunctionView, context: SKContext) -> FunctionInvokingEventArgs:
|
|
if self._function_invoking_handlers:
|
|
args = FunctionInvokingEventArgs(function_view, context)
|
|
for handler in self._function_invoking_handlers.values():
|
|
handler(self, args)
|
|
return args
|
|
return None
|
|
|
|
def on_function_invoked(self, function_view: FunctionView, context: SKContext) -> FunctionInvokedEventArgs:
|
|
if self._function_invoked_handlers:
|
|
args = FunctionInvokedEventArgs(function_view, context)
|
|
for handler in self._function_invoked_handlers.values():
|
|
handler(self, args)
|
|
return args
|
|
return None
|
|
|
|
def import_plugin(self, plugin_instance: Any, plugin_name: str = "") -> Dict[str, SKFunctionBase]:
|
|
if plugin_name.strip() == "":
|
|
plugin_name = PluginCollection.GLOBAL_PLUGIN
|
|
logger.debug(f"Importing plugin {plugin_name} into the global namespace")
|
|
else:
|
|
logger.debug(f"Importing plugin {plugin_name}")
|
|
|
|
functions = []
|
|
|
|
if isinstance(plugin_instance, dict):
|
|
candidates = plugin_instance.items()
|
|
else:
|
|
candidates = inspect.getmembers(plugin_instance, inspect.ismethod)
|
|
# Read every method from the plugin instance
|
|
for _, candidate in candidates:
|
|
# If the method is a semantic function, register it
|
|
if not hasattr(candidate, "__sk_function__"):
|
|
continue
|
|
|
|
functions.append(SKFunction.from_native_method(candidate, plugin_name))
|
|
|
|
logger.debug(f"Methods imported: {len(functions)}")
|
|
|
|
# Uniqueness check on function names
|
|
function_names = [f.name for f in functions]
|
|
if len(function_names) != len(set(function_names)):
|
|
raise KernelException(
|
|
KernelException.ErrorCodes.FunctionOverloadNotSupported,
|
|
("Overloaded functions are not supported, " "please differentiate function names."),
|
|
)
|
|
|
|
plugin = {}
|
|
for function in functions:
|
|
function.set_default_plugin_collection(self.plugins)
|
|
self._plugin_collection.add_native_function(function)
|
|
plugin[function.name] = function
|
|
|
|
return plugin
|
|
|
|
def get_request_settings_from_service(self, type: Type[T], service_id: Optional[str] = None) -> AIRequestSettings:
|
|
"""Get the specific request settings from the service, instantiated with the service_id and ai_model_id."""
|
|
service = self.get_ai_service(type, service_id)
|
|
service_instance = service.__closure__[0].cell_contents
|
|
req_settings_type = service_instance.get_request_settings_class()
|
|
return req_settings_type(
|
|
service_id=service_id,
|
|
extension_data={"ai_model_id": service_instance.ai_model_id},
|
|
)
|
|
|
|
def get_ai_service(self, type: Type[T], service_id: Optional[str] = None) -> Callable[["Kernel"], T]:
|
|
matching_type = {}
|
|
if type == TextCompletionClientBase:
|
|
service_id = service_id or self._default_text_completion_service
|
|
matching_type = self._text_completion_services
|
|
elif type == ChatCompletionClientBase:
|
|
service_id = service_id or self._default_chat_service
|
|
matching_type = self._chat_services
|
|
elif type == EmbeddingGeneratorBase:
|
|
service_id = service_id or self._default_text_embedding_generation_service
|
|
matching_type = self._text_embedding_generation_services
|
|
else:
|
|
raise ValueError(f"Unknown AI service type: {type.__name__}")
|
|
|
|
if service_id not in matching_type:
|
|
raise ValueError(f"{type.__name__} service with service_id '{service_id}' not found")
|
|
|
|
return matching_type[service_id]
|
|
|
|
def all_text_completion_services(self) -> List[str]:
|
|
return list(self._text_completion_services.keys())
|
|
|
|
def all_chat_services(self) -> List[str]:
|
|
return list(self._chat_services.keys())
|
|
|
|
def all_text_embedding_generation_services(self) -> List[str]:
|
|
return list(self._text_embedding_generation_services.keys())
|
|
|
|
def add_text_completion_service(
|
|
self,
|
|
service_id: str,
|
|
service: Union[TextCompletionClientBase, Callable[["Kernel"], TextCompletionClientBase]],
|
|
overwrite: bool = True,
|
|
) -> "Kernel":
|
|
if not service_id:
|
|
raise ValueError("service_id must be a non-empty string")
|
|
if not overwrite and service_id in self._text_completion_services:
|
|
raise ValueError(f"Text service with service_id '{service_id}' already exists")
|
|
|
|
self._text_completion_services[service_id] = service if isinstance(service, Callable) else lambda _: service
|
|
if self._default_text_completion_service is None:
|
|
self._default_text_completion_service = service_id
|
|
|
|
return self
|
|
|
|
def add_chat_service(
|
|
self,
|
|
service_id: str,
|
|
service: Union[ChatCompletionClientBase, Callable[["Kernel"], ChatCompletionClientBase]],
|
|
overwrite: bool = True,
|
|
) -> "Kernel":
|
|
if not service_id:
|
|
raise ValueError("service_id must be a non-empty string")
|
|
if not overwrite and service_id in self._chat_services:
|
|
raise ValueError(f"Chat service with service_id '{service_id}' already exists")
|
|
|
|
self._chat_services[service_id] = service if isinstance(service, Callable) else lambda _: service
|
|
if self._default_chat_service is None:
|
|
self._default_chat_service = service_id
|
|
|
|
if isinstance(service, TextCompletionClientBase):
|
|
self.add_text_completion_service(service_id, service)
|
|
|
|
return self
|
|
|
|
def add_text_embedding_generation_service(
|
|
self,
|
|
service_id: str,
|
|
service: Union[EmbeddingGeneratorBase, Callable[["Kernel"], EmbeddingGeneratorBase]],
|
|
overwrite: bool = False,
|
|
) -> "Kernel":
|
|
if not service_id:
|
|
raise ValueError("service_id must be a non-empty string")
|
|
if not overwrite and service_id in self._text_embedding_generation_services:
|
|
raise ValueError(f"Embedding service with service_id '{service_id}' already exists")
|
|
|
|
self._text_embedding_generation_services[service_id] = (
|
|
service if isinstance(service, Callable) else lambda _: service
|
|
)
|
|
if self._default_text_embedding_generation_service is None:
|
|
self._default_text_embedding_generation_service = service_id
|
|
|
|
return self
|
|
|
|
def set_default_text_completion_service(self, service_id: str) -> "Kernel":
|
|
if service_id not in self._text_completion_services:
|
|
raise ValueError(f"AI service with service_id '{service_id}' does not exist")
|
|
|
|
self._default_text_completion_service = service_id
|
|
return self
|
|
|
|
def set_default_chat_service(self, service_id: str) -> "Kernel":
|
|
if service_id not in self._chat_services:
|
|
raise ValueError(f"AI service with service_id '{service_id}' does not exist")
|
|
|
|
self._default_chat_service = service_id
|
|
return self
|
|
|
|
def set_default_text_embedding_generation_service(self, service_id: str) -> "Kernel":
|
|
if service_id not in self._text_embedding_generation_services:
|
|
raise ValueError(f"AI service with service_id '{service_id}' does not exist")
|
|
|
|
self._default_text_embedding_generation_service = service_id
|
|
return self
|
|
|
|
def get_text_completion_service_service_id(self, service_id: Optional[str] = None) -> str:
|
|
if service_id is None or service_id not in self._text_completion_services:
|
|
if self._default_text_completion_service is None:
|
|
raise ValueError("No default text service is set")
|
|
return self._default_text_completion_service
|
|
|
|
return service_id
|
|
|
|
def get_chat_service_service_id(self, service_id: Optional[str] = None) -> str:
|
|
if service_id is None or service_id not in self._chat_services:
|
|
if self._default_chat_service is None:
|
|
raise ValueError("No default chat service is set")
|
|
return self._default_chat_service
|
|
|
|
return service_id
|
|
|
|
def get_text_embedding_generation_service_id(self, service_id: Optional[str] = None) -> str:
|
|
if service_id is None or service_id not in self._text_embedding_generation_services:
|
|
if self._default_text_embedding_generation_service is None:
|
|
raise ValueError("No default embedding service is set")
|
|
return self._default_text_embedding_generation_service
|
|
|
|
return service_id
|
|
|
|
def remove_text_completion_service(self, service_id: str) -> "Kernel":
|
|
if service_id not in self._text_completion_services:
|
|
raise ValueError(f"AI service with service_id '{service_id}' does not exist")
|
|
|
|
del self._text_completion_services[service_id]
|
|
if self._default_text_completion_service == service_id:
|
|
self._default_text_completion_service = next(iter(self._text_completion_services), None)
|
|
return self
|
|
|
|
def remove_chat_service(self, service_id: str) -> "Kernel":
|
|
if service_id not in self._chat_services:
|
|
raise ValueError(f"AI service with service_id '{service_id}' does not exist")
|
|
|
|
del self._chat_services[service_id]
|
|
if self._default_chat_service == service_id:
|
|
self._default_chat_service = next(iter(self._chat_services), None)
|
|
return self
|
|
|
|
def remove_text_embedding_generation_service(self, service_id: str) -> "Kernel":
|
|
if service_id not in self._text_embedding_generation_services:
|
|
raise ValueError(f"AI service with service_id '{service_id}' does not exist")
|
|
|
|
del self._text_embedding_generation_services[service_id]
|
|
if self._default_text_embedding_generation_service == service_id:
|
|
self._default_text_embedding_generation_service = next(iter(self._text_embedding_generation_services), None)
|
|
return self
|
|
|
|
def clear_all_text_completion_services(self) -> "Kernel":
|
|
self._text_completion_services = {}
|
|
self._default_text_completion_service = None
|
|
return self
|
|
|
|
def clear_all_chat_services(self) -> "Kernel":
|
|
self._chat_services = {}
|
|
self._default_chat_service = None
|
|
return self
|
|
|
|
def clear_all_text_embedding_generation_services(self) -> "Kernel":
|
|
self._text_embedding_generation_services = {}
|
|
self._default_text_embedding_generation_service = None
|
|
return self
|
|
|
|
def clear_all_services(self) -> "Kernel":
|
|
self._text_completion_services = {}
|
|
self._chat_services = {}
|
|
self._text_embedding_generation_services = {}
|
|
|
|
self._default_text_completion_service = None
|
|
self._default_chat_service = None
|
|
self._default_text_embedding_generation_service = None
|
|
|
|
return self
|
|
|
|
def _create_semantic_function(
|
|
self,
|
|
plugin_name: str,
|
|
function_name: str,
|
|
function_config: SemanticFunctionConfig,
|
|
) -> SKFunctionBase:
|
|
function_type = function_config.prompt_template_config.type
|
|
if not function_type == "completion":
|
|
raise AIException(
|
|
AIException.ErrorCodes.FunctionTypeNotSupported,
|
|
f"Function type not supported: {function_type}",
|
|
)
|
|
|
|
function = SKFunction.from_semantic_config(plugin_name, function_name, function_config)
|
|
function.request_settings.update_from_ai_request_settings(
|
|
function_config.prompt_template_config.execution_settings
|
|
)
|
|
|
|
# Connect the function to the current kernel plugin
|
|
# collection, in case the function is invoked manually
|
|
# without a context and without a way to find other functions.
|
|
function.set_default_plugin_collection(self.plugins)
|
|
|
|
if function_config.has_chat_prompt:
|
|
service = self.get_ai_service(
|
|
ChatCompletionClientBase,
|
|
function_config.prompt_template_config.default_services[0]
|
|
if len(function_config.prompt_template_config.default_services) > 0
|
|
else None,
|
|
)
|
|
req_settings_type = service.__closure__[0].cell_contents.get_request_settings_class()
|
|
|
|
function.set_chat_configuration(
|
|
req_settings_type.from_ai_request_settings(function_config.prompt_template_config.execution_settings)
|
|
)
|
|
|
|
if service is None:
|
|
raise AIException(
|
|
AIException.ErrorCodes.InvalidConfiguration,
|
|
(
|
|
"Could not load chat service, unable to prepare semantic"
|
|
" function. Function description:"
|
|
" {function_config.prompt_template_config.description}"
|
|
),
|
|
)
|
|
|
|
function.set_chat_service(lambda: service(self))
|
|
else:
|
|
service = self.get_ai_service(
|
|
TextCompletionClientBase,
|
|
function_config.prompt_template_config.default_services[0]
|
|
if len(function_config.prompt_template_config.default_services) > 0
|
|
else None,
|
|
)
|
|
req_settings_type = service.__closure__[0].cell_contents.get_request_settings_class()
|
|
|
|
function.set_ai_configuration(
|
|
req_settings_type.from_ai_request_settings(function_config.prompt_template_config.execution_settings)
|
|
)
|
|
|
|
if service is None:
|
|
raise AIException(
|
|
AIException.ErrorCodes.InvalidConfiguration,
|
|
(
|
|
"Could not load text service, unable to prepare semantic"
|
|
" function. Function description:"
|
|
" {function_config.prompt_template_config.description}"
|
|
),
|
|
)
|
|
|
|
function.set_ai_service(lambda: service(self))
|
|
|
|
return function
|
|
|
|
def import_native_plugin_from_directory(
|
|
self, parent_directory: str, plugin_directory_name: str
|
|
) -> Dict[str, SKFunctionBase]:
|
|
MODULE_NAME = "native_function"
|
|
|
|
validate_plugin_name(plugin_directory_name)
|
|
|
|
plugin_directory = os.path.abspath(os.path.join(parent_directory, plugin_directory_name))
|
|
native_py_file_path = os.path.join(plugin_directory, f"{MODULE_NAME}.py")
|
|
|
|
if not os.path.exists(native_py_file_path):
|
|
raise ValueError(f"Native Plugin Python File does not exist: {native_py_file_path}")
|
|
|
|
plugin_name = os.path.basename(plugin_directory)
|
|
|
|
spec = importlib.util.spec_from_file_location(MODULE_NAME, native_py_file_path)
|
|
module = importlib.util.module_from_spec(spec)
|
|
spec.loader.exec_module(module)
|
|
|
|
class_name = next(
|
|
(name for name, cls in inspect.getmembers(module, inspect.isclass) if cls.__module__ == MODULE_NAME),
|
|
None,
|
|
)
|
|
if class_name:
|
|
plugin_obj = getattr(module, class_name)()
|
|
return self.import_plugin(plugin_obj, plugin_name)
|
|
|
|
return {}
|
|
|
|
def import_semantic_plugin_from_directory(
|
|
self, parent_directory: str, plugin_directory_name: str
|
|
) -> Dict[str, SKFunctionBase]:
|
|
CONFIG_FILE = "config.json"
|
|
PROMPT_FILE = "skprompt.txt"
|
|
|
|
validate_plugin_name(plugin_directory_name)
|
|
|
|
plugin_directory = os.path.join(parent_directory, plugin_directory_name)
|
|
plugin_directory = os.path.abspath(plugin_directory)
|
|
|
|
if not os.path.exists(plugin_directory):
|
|
raise ValueError(f"Plugin directory does not exist: {plugin_directory_name}")
|
|
|
|
plugin = {}
|
|
|
|
directories = glob.glob(plugin_directory + "/*/")
|
|
for directory in directories:
|
|
dir_name = os.path.dirname(directory)
|
|
function_name = os.path.basename(dir_name)
|
|
prompt_path = os.path.join(directory, PROMPT_FILE)
|
|
|
|
# Continue only if the prompt template exists
|
|
if not os.path.exists(prompt_path):
|
|
continue
|
|
|
|
config_path = os.path.join(directory, CONFIG_FILE)
|
|
with open(config_path, "r") as config_file:
|
|
config = PromptTemplateConfig.from_json(config_file.read())
|
|
|
|
# Load Prompt Template
|
|
with open(prompt_path, "r") as prompt_file:
|
|
template = PromptTemplate(prompt_file.read(), self.prompt_template_engine, config)
|
|
|
|
# Prepare lambda wrapping AI logic
|
|
function_config = SemanticFunctionConfig(config, template)
|
|
|
|
plugin[function_name] = self.register_semantic_function(
|
|
plugin_directory_name, function_name, function_config
|
|
)
|
|
|
|
return plugin
|
|
|
|
def create_semantic_function(
|
|
self,
|
|
prompt_template: str,
|
|
function_name: Optional[str] = None,
|
|
plugin_name: Optional[str] = None,
|
|
description: Optional[str] = None,
|
|
**kwargs: Any,
|
|
) -> "SKFunctionBase":
|
|
function_name = function_name if function_name is not None else f"f_{str(uuid4()).replace('-', '_')}"
|
|
|
|
config = PromptTemplateConfig(
|
|
description=(description if description is not None else "Generic function, unknown purpose"),
|
|
type="completion",
|
|
execution_settings=AIRequestSettings(extension_data=kwargs),
|
|
)
|
|
|
|
validate_function_name(function_name)
|
|
if plugin_name is not None:
|
|
validate_plugin_name(plugin_name)
|
|
|
|
template = PromptTemplate(prompt_template, self.prompt_template_engine, config)
|
|
function_config = SemanticFunctionConfig(config, template)
|
|
|
|
return self.register_semantic_function(plugin_name, function_name, function_config)
|
|
|
|
def add_function_invoking_handler(self, handler: Callable) -> None:
|
|
self._function_invoking_handlers[id(handler)] = handler
|
|
|
|
def add_function_invoked_handler(self, handler: Callable) -> None:
|
|
self._function_invoked_handlers[id(handler)] = handler
|
|
|
|
def remove_function_invoking_handler(self, handler: Callable) -> None:
|
|
if id(handler) in self._function_invoking_handlers:
|
|
del self._function_invoking_handlers[id(handler)]
|
|
|
|
def remove_function_invoked_handler(self, handler: Callable) -> None:
|
|
if id(handler) in self._function_invoked_handlers:
|
|
del self._function_invoked_handlers[id(handler)]
|