Multi modal docstring improvements (Azure#38193)

* docstring-update

* doc string updates

* doc string updates

Author: w-javed

sdk/evaluation/azure-ai-evaluation/azure/ai/evaluation/_evaluators/_multimodal/_content_safety_multimodal.py

@@ -32,7 +32,6 @@ class ContentSafetyMultimodalEvaluator:
     :type kwargs: Any
 
     :return: A function that evaluates multimodal chat messages and generates content safety metrics.
-    :rtype: Callable
 
     **Usage Example**
 
@@ -44,7 +43,7 @@ class ContentSafetyMultimodalEvaluator:
             "project_name": "<project_name>",
         }
         eval_fn = ContentSafetyMultimodalEvaluator(azure_ai_project)
-        result = eval_fn(
+        result = eval_fn(conversation=
             {
                 "messages": [
                     {
@@ -103,8 +102,9 @@ def __init__(self, credential, azure_ai_project, **kwargs):
     def __call__(self, *, conversation, **kwargs):
         """
         Evaluates content-safety metrics for list of messages.
+
         :keyword conversation: The conversation contains list of messages to be evaluated.
-            Each message should have "role" and "content" keys.
+            Each message should have "role" and "content" keys. It supports single turn only.
         :paramtype conversation: ~azure.ai.evaluation.Conversation
         :return: The evaluation score based on the Content Safety Metrics.
         :rtype: Dict[str, Union[float, str]]

sdk/evaluation/azure-ai-evaluation/azure/ai/evaluation/_evaluators/_multimodal/_hate_unfairness.py

@@ -28,7 +28,7 @@ class HateUnfairnessMultimodalEvaluator:
             "project_name": "<project_name>",
         }
         eval_fn = HateUnfairnessMultimodalEvaluator(azure_ai_project)
-        result = eval_fn(
+        result = eval_fn(conversation=
             {
                 "messages": [
                     {
@@ -72,8 +72,9 @@ def __init__(self, credential, azure_ai_project):
     def __call__(self, *, conversation, **kwargs):
         """
         Evaluates hate unfairness content.
+
         :keyword conversation: The conversation contains list of messages to be evaluated.
-            Each message should have "role" and "content" keys.
+            Each message should have "role" and "content" keys. It supports single turn only.
         :paramtype conversation: ~azure.ai.evaluation.Conversation
         :return: The hate unfairness score.
         :rtype: Dict[str, Union[float, str]]

sdk/evaluation/azure-ai-evaluation/azure/ai/evaluation/_evaluators/_multimodal/_protected_material.py

@@ -22,7 +22,6 @@ class ProtectedMaterialMultimodalEvaluator:
     :type azure_ai_project: ~azure.ai.evaluation.AzureAIProject
 
     :return: A dictionary containing the evaluation result label and reasoning.
-    :rtype: Dict[str, str]
 
     **Usage Example**
 
@@ -34,7 +33,7 @@ class ProtectedMaterialMultimodalEvaluator:
             "project_name": "<project_name>",
         }
         eval_fn = ProtectedMaterialMultimodalEvaluator(azure_ai_project)
-        result = eval_fn(
+        result = eval_fn(conversation=
             {
                 "messages": [
                     {
@@ -82,8 +81,9 @@ def __call__(self, *, conversation, **kwargs):
         """
         Evaluates protected materials content.
 
-        :keyword messages: The messages to be evaluated. Each message should have "role" and "content" keys.
-        :paramtype messages: ~azure.ai.evaluation.Conversation
+        :keyword conversation: The conversation contains list of messages to be evaluated.
+            Each message should have "role" and "content" keys. It supports single turn only.
+        :paramtype conversation: ~azure.ai.evaluation.Conversation
         :return: A dictionary containing a boolean label and reasoning.
         :rtype: Dict[str, str]
         """
@@ -101,8 +101,9 @@ def __init__(self, credential, azure_ai_project):
     async def __call__(self, *, conversation, **kwargs):
         """
         Evaluates content according to this evaluator's metric.
+
         :keyword conversation: The conversation contains list of messages to be evaluated.
-        Each message should have "role" and "content" keys.
+            Each message should have "role" and "content" keys. It supports single turn only.
         :paramtype conversation: ~azure.ai.evaluation.Conversation
         :return: The evaluation score computation based on the Content Safety metric (self.metric).
         :rtype: Any

sdk/evaluation/azure-ai-evaluation/azure/ai/evaluation/_evaluators/_multimodal/_self_harm.py

@@ -28,7 +28,7 @@ class SelfHarmMultimodalEvaluator:
             "project_name": "<project_name>",
         }
         eval_fn = SelfHarmMultimodalEvaluator(azure_ai_project)
-        result = eval_fn(
+        result = eval_fn(conversation=
             {
                 "messages": [
                     {
@@ -72,8 +72,9 @@ def __init__(self, credential, azure_ai_project):
     def __call__(self, *, conversation, **kwargs):
         """
         Evaluates self harm content.
+
         :keyword conversation: The conversation contains list of messages to be evaluated.
-            Each message should have "role" and "content" keys.
+            Each message should have "role" and "content" keys. It supports single turn only.
         :paramtype conversation: ~azure.ai.evaluation.Conversation
         :return: The self harm score.
         :rtype: Dict[str, Union[float, str]]

sdk/evaluation/azure-ai-evaluation/azure/ai/evaluation/_evaluators/_multimodal/_sexual.py

@@ -28,7 +28,7 @@ class SexualMultimodalEvaluator:
             "project_name": "<project_name>",
         }
         eval_fn = SexualMultimodalEvaluator(azure_ai_project)
-        result = eval_fn(
+        result = eval_fn(conversation=
             {
                 "messages": [
                     {
@@ -72,8 +72,9 @@ def __init__(self, credential, azure_ai_project):
     def __call__(self, *, conversation, **kwargs):
         """
         Evaluates sexual content.
+
         :keyword conversation: The conversation contains list of messages to be evaluated.
-            Each message should have "role" and "content" keys.
+            Each message should have "role" and "content" keys. It supports single turn only.
         :paramtype conversation: ~azure.ai.evaluation.Conversation
         :return: The sexual score.
         :rtype: Dict[str, Union[float, str]]

sdk/evaluation/azure-ai-evaluation/azure/ai/evaluation/_evaluators/_multimodal/_violence.py

@@ -28,7 +28,7 @@ class ViolenceMultimodalEvaluator:
             "project_name": "<project_name>",
         }
         eval_fn = ViolenceMultimodalEvaluator(azure_ai_project)
-        result = eval_fn(
+        result = eval_fn(conversation=
             {
                 "messages": [
                     {
@@ -72,8 +72,9 @@ def __init__(self, credential, azure_ai_project):
     def __call__(self, *, conversation, **kwargs):
         """
         Evaluates violence content.
+
         :keyword conversation: The conversation contains list of messages to be evaluated.
-            Each message should have "role" and "content" keys.
+            Each message should have "role" and "content" keys. It supports single turn only.
         :paramtype conversation: ~azure.ai.evaluation.Conversation
         :return: The violence score.
         :rtype: Dict[str, Union[float, str]]