azure-ai-evaluation 1.0.0b2__py3-none-any.whl → 1.0.0b4__py3-none-any.whl

azure/ai/evaluation/simulator/_simulator.py

@@ -1,25 +1,24 @@
 # flake8: noqa
-# pylint: disable=W0102,W0613,R0914,C0301,E0401,E0611
+# pylint: disable=W0102,W0613,R0914,C0301,E0401,E0611,C0114,R0913,E0702,R0903,C0411
 # ---------------------------------------------------------
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # ---------------------------------------------------------
 import asyncio
 import importlib.resources as pkg_resources
+from tqdm import tqdm
 import json
 import os
 import re
 import warnings
 from typing import Any, Callable, Dict, List, Optional, Union
+from promptflow.core import AsyncPrompty
+from azure.ai.evaluation._model_configurations import AzureOpenAIModelConfiguration, OpenAIModelConfiguration
+from azure.ai.evaluation._common.utils import construct_prompty_model_config
 
-from promptflow.client import load_flow
-from promptflow.core import AzureOpenAIModelConfiguration, Flow
-from tqdm import tqdm
-
+from .._exceptions import ErrorBlame, ErrorCategory, EvaluationException
 from .._user_agent import USER_AGENT
 from ._conversation.constants import ConversationRole
 from ._helpers import ConversationHistory, Turn, experimental
-
-# from ._tracing import monitor_task_simulator
 from ._utils import JsonLineChatProtocol
 
 
@@ -29,43 +28,60 @@ class Simulator:
     Simulator for generating synthetic conversations.
     """
 
-    def __init__(self, azure_ai_project: Dict[str, Any], credential: Optional[Any] = None):
+    def __init__(self, model_config: Union[AzureOpenAIModelConfiguration, OpenAIModelConfiguration]):
         """
-        Initializes the task simulator with a project scope.
+        Initializes the task simulator with the model configuration.
 
-        :param azure_ai_project: A dictionary defining the scope of the project, including keys such as
-                                "subscription_id", "resource_group_name", and "project_name".
-        :param credential: Azure credentials to authenticate the user. If None, the default credentials are used.
-        :paramtype credential: Optional[Any]
-        :raises ValueError: If the azure_ai_project does not contain the required keys or any value is None.
+        :param model_config: A dictionary defining the configuration for the model. Acceptable types are AzureOpenAIModelConfiguration and OpenAIModelConfiguration.
+        :type model_config: Union[~azure.ai.evaluation.AzureOpenAIModelConfiguration, ~azure.ai.evaluation.OpenAIModelConfiguration]
+        :raises ValueError: If the model_config does not contain the required keys or any value is None.
         """
-        self._validate_project_config(azure_ai_project)
-        self.azure_ai_project = azure_ai_project
-        self.azure_ai_project["api_version"] = "2024-02-15-preview"
-        self.credential = credential
+        self._validate_model_config(model_config)
+        self.model_config = model_config
+        if "api_version" not in self.model_config:
+            self.model_config["api_version"] = "2024-06-01"  # type: ignore
 
     @staticmethod
-    def _validate_project_config(azure_ai_project: Dict[str, Any]):
+    def _validate_model_config(model_config: Any):
         """
-        Validates the azure_ai_project configuration to ensure all required keys are present and have non-None values.
+        Validates the model_config to ensure all required keys are present and have non-None values.
+        If 'type' is not specified, it will attempt to infer the type based on the keys present.
 
-        :param azure_ai_project: The Azure AI project configuration dictionary.
-        :type azure_ai_project: Dict[str, Any]
+        :param model_config: The model configuration dictionary.
+        :type model_config: Dict[str, Any]
         :raises ValueError: If required keys are missing or any of the values are None.
         """
-        required_keys = ["subscription_id", "resource_group_name", "project_name"]
-        if not all(key in azure_ai_project for key in required_keys):
-            raise ValueError(f"azure_ai_project must contain keys: {', '.join(required_keys)}")
-        if not all(azure_ai_project[key] for key in required_keys):
-            raise ValueError("subscription_id, resource_group_name, and project_name must not be None")
+        # Attempt to infer 'type' if not provided
+        if "type" not in model_config:
+            if "azure_deployment" in model_config and "azure_endpoint" in model_config:
+                model_config["type"] = "azure_openai"
+            elif "model" in model_config:
+                model_config["type"] = "openai"
+            else:
+                raise ValueError(
+                    "Unable to infer 'type' from model_config. Please specify 'type' as 'azure_openai' or 'openai'."
+                )
+
+        if model_config["type"] == "azure_openai":
+            required_keys = ["azure_deployment", "azure_endpoint"]
+        elif model_config["type"] == "openai":
+            required_keys = ["api_key", "model"]
+        else:
+            raise ValueError("model_config 'type' must be 'azure_openai' or 'openai'.")
+
+        missing_keys = [key for key in required_keys if key not in model_config]
+        if missing_keys:
+            raise ValueError(f"model_config is missing required keys: {', '.join(missing_keys)}")
+        none_keys = [key for key in required_keys if model_config.get(key) is None]
+        if none_keys:
+            raise ValueError(f"The following keys in model_config must not be None: {', '.join(none_keys)}")
 
-    # @monitor_task_simulator
     async def __call__(
         self,
         *,
         target: Callable,
         max_conversation_turns: int = 5,
-        tasks: List[Dict] = [],
+        tasks: List[str] = [],
         text: str = "",
         num_queries: int = 5,
         query_response_generating_prompty: Optional[str] = None,
@@ -109,7 +125,7 @@ class Simulator:
 
         Modes:
         - Task-Free Mode: When only num_queries is specified and tasks is not, the method generates num_queries x max_conversation_turns lines of simulated data grounded in the context of the text.
-        - Task-Specific Mode: When both num_queries and tasks are specified, the method generates lines of simulated data based on the tasks. If num_queries > len(tasks), the remaining lines are simulated in task-free mode. If num_queries < len(tasks), only the first num_queries tasks are used.
+        - Task-Specific Mode: When both num_queries and tasks are specified, the method generates lines of simulated data based on the tasks. If num_queries > len(tasks), the remaining lines will be simulated in task-free mode. If num_queries < len(tasks), only the first num_queries tasks are used.
         - Conversation Starter Mode: When conversation_turns are specified, the method starts each conversation with the user-specified queries and then follows the conversation history for the remaining turns.
         """
         if conversation_turns and (text or tasks):
@@ -128,8 +144,7 @@ class Simulator:
         num_queries = min(num_queries, len(tasks))
         max_conversation_turns *= 2  # account for both user and assistant turns
 
-        prompty_model_config = self._build_prompty_model_config()
-
+        prompty_model_config = self.model_config
         if conversation_turns:
             return await self._simulate_with_predefined_turns(
                 target=target,
@@ -149,7 +164,6 @@ class Simulator:
             prompty_model_config=prompty_model_config,
             **kwargs,
         )
-
         return await self._create_conversations_from_query_responses(
             query_responses=query_responses,
             max_conversation_turns=max_conversation_turns,
@@ -160,18 +174,6 @@ class Simulator:
             api_call_delay_sec=api_call_delay_sec,
         )
 
-    def _build_prompty_model_config(self) -> Dict[str, Any]:
-        """
-        Constructs the configuration for the prompty model.
-
-        :return: A dictionary containing the prompty model configuration, including API version and user agent headers if applicable.
-        :rtype: Dict[str, Any]
-        """
-        config = {"configuration": self.azure_ai_project}
-        if USER_AGENT and isinstance(self.azure_ai_project, AzureOpenAIModelConfiguration):
-            config.update({"parameters": {"extra_headers": {"x-ms-useragent": USER_AGENT}}})
-        return config
-
     async def _simulate_with_predefined_turns(
         self,
         *,
@@ -181,7 +183,7 @@ class Simulator:
         user_simulator_prompty: Optional[str],
         user_simulator_prompty_kwargs: Dict[str, Any],
         api_call_delay_sec: float,
-        prompty_model_config: Dict[str, Any],
+        prompty_model_config: Any,
     ) -> List[JsonLineChatProtocol]:
         """
         Simulates conversations using predefined conversation turns.
@@ -199,7 +201,7 @@ class Simulator:
         :keyword api_call_delay_sec: Delay in seconds between API calls.
         :paramtype api_call_delay_sec: float
         :keyword prompty_model_config: The configuration for the prompty model.
-        :paramtype prompty_model_config: Dict[str, Any]
+        :paramtype prompty_model_config: Any
         :return: A list of simulated conversations represented as JsonLineChatProtocol objects.
         :rtype: List[JsonLineChatProtocol]
         """
@@ -234,8 +236,16 @@ class Simulator:
                     target=target,
                     progress_bar=progress_bar,
                 )
-
-            simulated_conversations.append(current_simulation.to_list())
+            simulated_conversations.append(
+                JsonLineChatProtocol(
+                    {
+                        "messages": current_simulation.to_list(),
+                        "finish_reason": ["stop"],
+                        "context": {},
+                        "$schema": "http://azureml/sdk-2-0/ChatConversation.json",
+                    }
+                )
+            )
 
         progress_bar.close()
         return simulated_conversations
@@ -273,14 +283,16 @@ class Simulator:
         :paramtype progress_bar: tqdm,
         """
         user_flow = self._load_user_simulation_flow(
-            user_simulator_prompty=user_simulator_prompty,
+            user_simulator_prompty=user_simulator_prompty,  # type: ignore
             prompty_model_config=prompty_model_config,
             user_simulator_prompty_kwargs=user_simulator_prompty_kwargs,
         )
 
         while len(current_simulation) < max_conversation_turns:
-            user_response_content = user_flow(
-                task="Continue the conversation", conversation_history=current_simulation.to_list()
+            user_response_content = await user_flow(
+                task="Continue the conversation",
+                conversation_history=current_simulation.to_list(),
+                **user_simulator_prompty_kwargs,
             )
             user_response = self._parse_prompty_response(response=user_response_content)
             user_turn = Turn(role=ConversationRole.USER, content=user_response["content"])
@@ -296,43 +308,60 @@ class Simulator:
     def _load_user_simulation_flow(
         self,
         *,
-        user_simulator_prompty: Union[str, os.PathLike],
+        user_simulator_prompty: Optional[Union[str, os.PathLike]],
         prompty_model_config: Dict[str, Any],
         user_simulator_prompty_kwargs: Dict[str, Any],
-    ) -> Flow:
+    ) -> "AsyncPrompty":  # type: ignore
         """
         Loads the flow for simulating user interactions.
 
         :keyword user_simulator_prompty: Path to the user simulator prompty file.
-        :paramtype user_simulator_prompty: Union[str, os.PathLike]
+        :paramtype user_simulator_prompty: Optional[Union[str, os.PathLike]]
         :keyword prompty_model_config: The configuration for the prompty model.
         :paramtype prompty_model_config: Dict[str, Any]
         :keyword user_simulator_prompty_kwargs: Additional keyword arguments for the user simulator prompty.
         :paramtype user_simulator_prompty_kwargs: Dict[str, Any]
         :return: The loaded flow for simulating user interactions.
-        :rtype: Flow
+        :rtype: AsyncPrompty
         """
         if not user_simulator_prompty:
             package = "azure.ai.evaluation.simulator._prompty"
             resource_name = "task_simulate.prompty"
             try:
                 # Access the resource as a file path
+                # pylint: disable=deprecated-method
                 with pkg_resources.path(package, resource_name) as prompty_path:
-                    return load_flow(source=str(prompty_path), model=prompty_model_config)
+                    prompty_model_config = construct_prompty_model_config(
+                        model_config=prompty_model_config,  # type: ignore
+                        default_api_version="2024-06-01",
+                        user_agent=USER_AGENT,
+                    )
+                    return AsyncPrompty.load(source=prompty_path, model=prompty_model_config)  # type: ignore
             except FileNotFoundError as e:
-                raise f"Flow path for {resource_name} does not exist in package {package}." from e
-        return load_flow(
+                msg = f"Flow path for {resource_name} does not exist in package {package}."
+                raise EvaluationException(
+                    message=msg,
+                    internal_message=msg,
+                    error_category=ErrorCategory.FILE_OR_FOLDER_NOT_FOUND,
+                    blame=ErrorBlame.USER_ERROR,
+                ) from e
+        prompty_model_config = construct_prompty_model_config(
+            model_config=prompty_model_config,  # type: ignore
+            default_api_version="2024-06-01",
+            user_agent=USER_AGENT,
+        )
+        return AsyncPrompty.load(
             source=user_simulator_prompty,
             model=prompty_model_config,
             **user_simulator_prompty_kwargs,
-        )
+        )  # type: ignore
 
     def _parse_prompty_response(self, *, response: str) -> Dict[str, Any]:
         """
         Parses the response from the prompty execution.
 
         :keyword response: The raw response from the prompty.
-        :paramtype str: str
+        :paramtype response: str
         :return: A dictionary representing the parsed response content.
         :rtype: Dict[str, Any]
         :raises ValueError: If the response cannot be parsed.
@@ -373,7 +402,7 @@ class Simulator:
         num_queries: int,
         query_response_generating_prompty: Optional[str],
         query_response_generating_prompty_kwargs: Dict[str, Any],
-        prompty_model_config: Dict[str, Any],
+        prompty_model_config: Any,
         **kwargs,
     ) -> List[Dict[str, str]]:
         """
@@ -388,19 +417,18 @@ class Simulator:
         :keyword query_response_generating_prompty_kwargs: Additional keyword arguments for the query response generating prompty.
         :paramtype query_response_generating_prompty_kwargs: Dict[str, Any]
         :keyword prompty_model_config: The configuration for the prompty model.
-        :paramtype prompty_model_config: Dict[str, Any]
+        :paramtype prompty_model_config: Any
         :return: A list of query-response dictionaries.
         :rtype: List[Dict[str, str]]
         :raises RuntimeError: If an error occurs during query generation.
         """
         query_flow = self._load_query_generation_flow(
-            query_response_generating_prompty=query_response_generating_prompty,
+            query_response_generating_prompty=query_response_generating_prompty,  # type: ignore
             prompty_model_config=prompty_model_config,
             query_response_generating_prompty_kwargs=query_response_generating_prompty_kwargs,
         )
-
         try:
-            query_responses = query_flow(text=text, num_queries=num_queries)
+            query_responses = await query_flow(text=text, num_queries=num_queries)
             if isinstance(query_responses, dict):
                 keys = list(query_responses.keys())
                 return query_responses[keys[0]]
@@ -411,43 +439,60 @@ class Simulator:
     def _load_query_generation_flow(
         self,
         *,
-        query_response_generating_prompty: Union[str, os.PathLike],
+        query_response_generating_prompty: Optional[Union[str, os.PathLike]],
         prompty_model_config: Dict[str, Any],
         query_response_generating_prompty_kwargs: Dict[str, Any],
-    ) -> Flow:
+    ) -> "AsyncPrompty":
         """
         Loads the flow for generating query responses.
 
         :keyword query_response_generating_prompty: Path to the query response generating prompty file.
-        :paramtype query_response_generating_prompty: Union[str, os.PathLike]
+        :paramtype query_response_generating_prompty: Optional[Union[str, os.PathLike]]
         :keyword prompty_model_config: The configuration for the prompty model.
         :paramtype prompty_model_config: Dict[str, Any]
         :keyword query_response_generating_prompty_kwargs: Additional keyword arguments for the flow.
         :paramtype query_response_generating_prompty_kwargs: Dict[str, Any]
         :return: The loaded flow for generating query responses.
-        :rtype: Flow
+        :rtype: AsyncPrompty
         """
         if not query_response_generating_prompty:
             package = "azure.ai.evaluation.simulator._prompty"
             resource_name = "task_query_response.prompty"
             try:
                 # Access the resource as a file path
+                # pylint: disable=deprecated-method
                 with pkg_resources.path(package, resource_name) as prompty_path:
-                    return load_flow(source=str(prompty_path), model=prompty_model_config)
+                    prompty_model_config = construct_prompty_model_config(
+                        model_config=prompty_model_config,  # type: ignore
+                        default_api_version="2024-06-01",
+                        user_agent=USER_AGENT,
+                    )
+                    return AsyncPrompty.load(source=prompty_path, model=prompty_model_config)  # type: ignore
             except FileNotFoundError as e:
-                raise f"Flow path for {resource_name} does not exist in package {package}." from e
-        return load_flow(
+                msg = f"Flow path for {resource_name} does not exist in package {package}."
+                raise EvaluationException(
+                    message=msg,
+                    internal_message=msg,
+                    error_category=ErrorCategory.FILE_OR_FOLDER_NOT_FOUND,
+                    blame=ErrorBlame.USER_ERROR,
+                ) from e
+        prompty_model_config = construct_prompty_model_config(
+            model_config=prompty_model_config,  # type: ignore
+            default_api_version="2024-06-01",
+            user_agent=USER_AGENT,
+        )
+        return AsyncPrompty.load(
             source=query_response_generating_prompty,
             model=prompty_model_config,
             **query_response_generating_prompty_kwargs,
-        )
+        )  # type: ignore
 
     async def _create_conversations_from_query_responses(
         self,
         *,
         query_responses: List[Dict[str, str]],
         max_conversation_turns: int,
-        tasks: List[Dict],
+        tasks: List[str],
         user_simulator_prompty: Optional[str],
         user_simulator_prompty_kwargs: Dict[str, Any],
         target: Callable,
@@ -461,7 +506,7 @@ class Simulator:
         :keyword max_conversation_turns: The maximum number of conversation turns.
         :paramtype max_conversation_turns: int
         :keyword tasks: A list of tasks for the simulation.
-        :paramtype tasks: List[Dict]
+        :paramtype tasks: List[str]
         :keyword user_simulator_prompty: Path to the user simulator prompty file.
         :paramtype user_simulator_prompty: Optional[str]
         :keyword user_simulator_prompty_kwargs: Additional keyword arguments for the user simulator prompty.
@@ -491,7 +536,7 @@ class Simulator:
             conversation = await self._complete_conversation(
                 conversation_starter=query,
                 max_conversation_turns=max_conversation_turns,
-                task=task,
+                task=task,  # type: ignore
                 user_simulator_prompty=user_simulator_prompty,
                 user_simulator_prompty_kwargs=user_simulator_prompty_kwargs,
                 target=target,
@@ -526,7 +571,7 @@ class Simulator:
         target: Callable,
         api_call_delay_sec: float,
         progress_bar: tqdm,
-    ) -> List[Dict[str, str]]:
+    ) -> List[Dict[str, Optional[str]]]:
         """
         Completes a conversation with the target model based on the conversation starter.
 
@@ -547,7 +592,7 @@ class Simulator:
         :keyword progress_bar: Progress bar for tracking simulation progress.
         :paramtype progress_bar: tqdm
         :return: A list representing the conversation history with each turn's content.
-        :rtype: List[Dict[str, str]]
+        :rtype: List[Dict[str, Optional[str]]]
         """
         conversation_history = ConversationHistory()
         # user_turn = Turn(role=ConversationRole.USER, content=conversation_starter)
@@ -555,11 +600,11 @@ class Simulator:
 
         while len(conversation_history) < max_conversation_turns:
             user_flow = self._load_user_simulation_flow(
-                user_simulator_prompty=user_simulator_prompty,
-                prompty_model_config=self._build_prompty_model_config(),
+                user_simulator_prompty=user_simulator_prompty,  # type: ignore
+                prompty_model_config=self.model_config,  # type: ignore
                 user_simulator_prompty_kwargs=user_simulator_prompty_kwargs,
             )
-            conversation_starter_from_simulated_user = user_flow(
+            conversation_starter_from_simulated_user = await user_flow(
                 task=task,
                 conversation_history=[
                     {
@@ -585,41 +630,6 @@ class Simulator:
 
         return conversation_history.to_list()
 
-    async def _build_user_simulation_response(
-        self,
-        task: str,
-        conversation_history: List[Dict[str, Any]],
-        user_simulator_prompty: Optional[str],
-        user_simulator_prompty_kwargs: Dict[str, Any],
-    ) -> str:
-        """
-        Builds a response from the user simulator based on the current conversation history.
-
-        :param task: A string representing the task details.
-        :type task: str
-        :param conversation_history: The current conversation history as a list of dictionaries.
-        :type conversation_history: List[Dict[str, Any]]
-        :param user_simulator_prompty: Path to the user simulator prompty file.
-        :type user_simulator_prompty: Optional[str]
-        :param user_simulator_prompty_kwargs: Additional keyword arguments for the user simulator prompty.
-        :type user_simulator_prompty_kwargs: Dict[str, Any]
-        :return: The generated response content from the user simulator.
-        :rtype: str
-        :raises RuntimeError: If an error occurs during response generation.
-        """
-        user_flow = self._load_user_simulation_flow(
-            user_simulator_prompty=user_simulator_prompty,
-            prompty_model_config=self._build_prompty_model_config(),
-            user_simulator_prompty_kwargs=user_simulator_prompty_kwargs,
-        )
-
-        try:
-            response_content = user_flow(task=task, conversation_history=conversation_history)
-            user_response = self._parse_prompty_response(response=response_content)
-            return user_response["content"]
-        except Exception as e:
-            raise RuntimeError("Error building user simulation response") from e
-
     async def _get_target_response(
         self, *, target: Callable, api_call_delay_sec: float, conversation_history: ConversationHistory
     ) -> str:

azure/ai/evaluation/simulator/_tracing.py

@@ -69,16 +69,16 @@ def monitor_task_simulator(func: Callable[P, R]) -> Callable[P, R]:
 
     @functools.wraps(func)
     def wrapper(*args: P.args, **kwargs: P.kwargs) -> R:
-        text_length = len(kwargs.get("text", ""))
-        user_persona_length = len(kwargs.get("user_persona", []))
+        text = kwargs.get("text")
+        user_persona = kwargs.get("user_persona")
         num_queries = kwargs.get("num_queries", 0)
         max_conversation_turns = kwargs.get("max_conversation_turns", 0)
         decorated_func = monitor_operation(
             activity_name="task.simulator.call",
             activity_type=ActivityType.PUBLICAPI,
             custom_dimensions={
-                "text_length": text_length,
-                "user_persona_length": user_persona_length,
+                "text_length": len(text) if isinstance(text, str) else 0,
+                "user_persona_length": len(user_persona) if isinstance(user_persona, list) else 0,
                 "number_of_queries": num_queries,
                 "max_conversation_turns": max_conversation_turns,
             },