azure-ai-evaluation 1.3.0__py3-none-any.whl → 1.5.0__py3-none-any.whl

azure/ai/evaluation/_common/raiclient/models/_models.py

@@ -0,0 +1,651 @@
+# coding=utf-8
+# --------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# Code generated by Microsoft (R) Python Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is regenerated.
+# --------------------------------------------------------------------------
+# pylint: disable=useless-super-delegation
+
+from typing import Any, Dict, List, Mapping, Optional, TYPE_CHECKING, Union, overload
+
+from .. import _model_base
+from .._model_base import rest_field
+
+if TYPE_CHECKING:
+    from .. import models as _models
+
+
+class AnnotationDTO(_model_base.Model):
+    """AnnotationDTO.
+
+    :ivar annotation_task: Required.
+    :vartype annotation_task: str
+    :ivar content_type: Required.
+    :vartype content_type: str
+    :ivar user_text_list: Required.
+    :vartype user_text_list: list[str]
+    :ivar contents: Required.
+    :vartype contents: list[~raiclient.models.Content]
+    :ivar metric_list: Required.
+    :vartype metric_list: list[str]
+    :ivar prompt_version: Required.
+    :vartype prompt_version: str
+    """
+
+    annotation_task: str = rest_field(name="AnnotationTask", visibility=["read", "create", "update", "delete", "query"])
+    """Required."""
+    content_type: str = rest_field(name="ContentType", visibility=["read", "create", "update", "delete", "query"])
+    """Required."""
+    user_text_list: List[str] = rest_field(
+        name="UserTextList", visibility=["read", "create", "update", "delete", "query"]
+    )
+    """Required."""
+    contents: List["_models.Content"] = rest_field(
+        name="Contents", visibility=["read", "create", "update", "delete", "query"]
+    )
+    """Required."""
+    metric_list: List[str] = rest_field(name="MetricList", visibility=["read", "create", "update", "delete", "query"])
+    """Required."""
+    prompt_version: str = rest_field(name="PromptVersion", visibility=["read", "create", "update", "delete", "query"])
+    """Required."""
+
+    @overload
+    def __init__(
+        self,
+        *,
+        annotation_task: str,
+        content_type: str,
+        user_text_list: List[str],
+        contents: List["_models.Content"],
+        metric_list: List[str],
+        prompt_version: str,
+    ) -> None: ...
+
+    @overload
+    def __init__(self, mapping: Mapping[str, Any]) -> None:
+        """
+        :param mapping: raw JSON to initialize the model.
+        :type mapping: Mapping[str, Any]
+        """
+
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        super().__init__(*args, **kwargs)
+
+
+class AttackObjective(_model_base.Model):
+    """Attack Objective.
+
+    :ivar id: The unique identifier. Required.
+    :vartype id: str
+    :ivar metadata: The metadata.
+    :vartype metadata: ~raiclient.models.Metadata
+    :ivar source: List of sources. Required.
+    :vartype source: list[str]
+    :ivar modality: The modality. Required.
+    :vartype modality: str
+    :ivar messages: The messages. Required.
+    :vartype messages: list[~raiclient.models.Message]
+    """
+
+    id: str = rest_field(name="Id", visibility=["read", "create", "update", "delete", "query"])
+    """The unique identifier. Required."""
+    metadata: Optional["_models.Metadata"] = rest_field(
+        name="Metadata", visibility=["read", "create", "update", "delete", "query"]
+    )
+    """The metadata."""
+    source: List[str] = rest_field(name="Source", visibility=["read", "create", "update", "delete", "query"])
+    """List of sources. Required."""
+    modality: str = rest_field(name="Modality", visibility=["read", "create", "update", "delete", "query"])
+    """The modality. Required."""
+    messages: List["_models.Message"] = rest_field(
+        name="Messages", visibility=["read", "create", "update", "delete", "query"]
+    )
+    """The messages. Required."""
+
+    @overload
+    def __init__(
+        self,
+        *,
+        id: str,  # pylint: disable=redefined-builtin
+        source: List[str],
+        modality: str,
+        messages: List["_models.Message"],
+        metadata: Optional["_models.Metadata"] = None,
+    ) -> None: ...
+
+    @overload
+    def __init__(self, mapping: Mapping[str, Any]) -> None:
+        """
+        :param mapping: raw JSON to initialize the model.
+        :type mapping: Mapping[str, Any]
+        """
+
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        super().__init__(*args, **kwargs)
+
+
+class Content(_model_base.Model):
+    """Content.
+
+    :ivar messages: Required.
+    :vartype messages: list[any]
+    """
+
+    messages: List[Any] = rest_field(name="Messages", visibility=["read", "create", "update", "delete", "query"])
+    """Required."""
+
+    @overload
+    def __init__(
+        self,
+        *,
+        messages: List[Any],
+    ) -> None: ...
+
+    @overload
+    def __init__(self, mapping: Mapping[str, Any]) -> None:
+        """
+        :param mapping: raw JSON to initialize the model.
+        :type mapping: Mapping[str, Any]
+        """
+
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        super().__init__(*args, **kwargs)
+
+
+class CustomizationParameters(_model_base.Model):
+    """Customization Parameters.
+
+    :ivar application_scenario: Application scenario.
+    :vartype application_scenario: str
+    :ivar harm_categories: List of harm categories. Required.
+    :vartype harm_categories: list[str]
+    """
+
+    application_scenario: Optional[str] = rest_field(
+        name="ApplicationScenario", visibility=["read", "create", "update", "delete", "query"]
+    )
+    """Application scenario."""
+    harm_categories: List[str] = rest_field(
+        name="HarmCategories", visibility=["read", "create", "update", "delete", "query"]
+    )
+    """List of harm categories. Required."""
+
+    @overload
+    def __init__(
+        self,
+        *,
+        harm_categories: List[str],
+        application_scenario: Optional[str] = None,
+    ) -> None: ...
+
+    @overload
+    def __init__(self, mapping: Mapping[str, Any]) -> None:
+        """
+        :param mapping: raw JSON to initialize the model.
+        :type mapping: Mapping[str, Any]
+        """
+
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        super().__init__(*args, **kwargs)
+
+
+class Data(_model_base.Model):
+    """Data.
+
+    :ivar asset_id: Required.
+    :vartype asset_id: str
+    """
+
+    asset_id: str = rest_field(name="assetId", visibility=["read", "create", "update", "delete", "query"])
+    """Required."""
+
+    @overload
+    def __init__(
+        self,
+        *,
+        asset_id: str,
+    ) -> None: ...
+
+    @overload
+    def __init__(self, mapping: Mapping[str, Any]) -> None:
+        """
+        :param mapping: raw JSON to initialize the model.
+        :type mapping: Mapping[str, Any]
+        """
+
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        super().__init__(*args, **kwargs)
+
+
+class Grader(_model_base.Model):
+    """Grader.
+
+    :ivar name: Required.
+    :vartype name: str
+    :ivar description: Required.
+    :vartype description: str
+    :ivar config: Required.
+    :vartype config: ~raiclient.models.GraderConfigBase
+    """
+
+    name: str = rest_field(name="Name", visibility=["read", "create", "update", "delete", "query"])
+    """Required."""
+    description: str = rest_field(name="Description", visibility=["read", "create", "update", "delete", "query"])
+    """Required."""
+    config: "_models.GraderConfigBase" = rest_field(
+        name="Config", visibility=["read", "create", "update", "delete", "query"]
+    )
+    """Required."""
+
+    @overload
+    def __init__(
+        self,
+        *,
+        name: str,
+        description: str,
+        config: "_models.GraderConfigBase",
+    ) -> None: ...
+
+    @overload
+    def __init__(self, mapping: Mapping[str, Any]) -> None:
+        """
+        :param mapping: raw JSON to initialize the model.
+        :type mapping: Mapping[str, Any]
+        """
+
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        super().__init__(*args, **kwargs)
+
+
+class GraderConfigBase(_model_base.Model):
+    """GraderConfigBase.
+
+    :ivar type: Required.
+    :vartype type: str
+    """
+
+    type: str = rest_field(name="Type", visibility=["read", "create", "update", "delete", "query"])
+    """Required."""
+
+    @overload
+    def __init__(
+        self,
+        *,
+        type: str,
+    ) -> None: ...
+
+    @overload
+    def __init__(self, mapping: Mapping[str, Any]) -> None:
+        """
+        :param mapping: raw JSON to initialize the model.
+        :type mapping: Mapping[str, Any]
+        """
+
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        super().__init__(*args, **kwargs)
+
+
+class GradersDTO(_model_base.Model):
+    """GradersDTO.
+
+    :ivar data: Required.
+    :vartype data: ~raiclient.models.Data
+    :ivar model_config: Required.
+    :vartype model_config: ~raiclient.models.ModelConfig
+    :ivar sample_generators: Required.
+    :vartype sample_generators: list[~raiclient.models.SampleGenerator]
+    :ivar graders: Required.
+    :vartype graders: list[~raiclient.models.Grader]
+    """
+
+    data: "_models.Data" = rest_field(name="Data", visibility=["read", "create", "update", "delete", "query"])
+    """Required."""
+    model_config: "_models.ModelConfig" = rest_field(
+        name="ModelConfig", visibility=["read", "create", "update", "delete", "query"]
+    )
+    """Required."""
+    sample_generators: List["_models.SampleGenerator"] = rest_field(
+        name="SampleGenerators", visibility=["read", "create", "update", "delete", "query"]
+    )
+    """Required."""
+    graders: List["_models.Grader"] = rest_field(
+        name="Graders", visibility=["read", "create", "update", "delete", "query"]
+    )
+    """Required."""
+
+    @overload
+    def __init__(
+        self,
+        *,
+        data: "_models.Data",
+        model_config: "_models.ModelConfig",
+        sample_generators: List["_models.SampleGenerator"],
+        graders: List["_models.Grader"],
+    ) -> None: ...
+
+    @overload
+    def __init__(self, mapping: Mapping[str, Any]) -> None:
+        """
+        :param mapping: raw JSON to initialize the model.
+        :type mapping: Mapping[str, Any]
+        """
+
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        super().__init__(*args, **kwargs)
+
+
+class LongRunningResponse(_model_base.Model):
+    """LongRunningResponse.
+
+    :ivar location: Required.
+    :vartype location: str
+    :ivar operation_result: Required.
+    :vartype operation_result: any
+    """
+
+    location: str = rest_field(name="Location", visibility=["read", "create", "update", "delete", "query"])
+    """Required."""
+    operation_result: Any = rest_field(
+        name="OperationResult", visibility=["read", "create", "update", "delete", "query"]
+    )
+    """Required."""
+
+    @overload
+    def __init__(
+        self,
+        *,
+        location: str,
+        operation_result: Any,
+    ) -> None: ...
+
+    @overload
+    def __init__(self, mapping: Mapping[str, Any]) -> None:
+        """
+        :param mapping: raw JSON to initialize the model.
+        :type mapping: Mapping[str, Any]
+        """
+
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        super().__init__(*args, **kwargs)
+
+
+class Message(_model_base.Model):
+    """Message.
+
+    :ivar role: The role.
+    :vartype role: str
+    :ivar content: The content.
+    :vartype content: str
+    """
+
+    role: Optional[str] = rest_field(name="Role", visibility=["read", "create", "update", "delete", "query"])
+    """The role."""
+    content: Optional[str] = rest_field(name="Content", visibility=["read", "create", "update", "delete", "query"])
+    """The content."""
+
+    @overload
+    def __init__(
+        self,
+        *,
+        role: Optional[str] = None,
+        content: Optional[str] = None,
+    ) -> None: ...
+
+    @overload
+    def __init__(self, mapping: Mapping[str, Any]) -> None:
+        """
+        :param mapping: raw JSON to initialize the model.
+        :type mapping: Mapping[str, Any]
+        """
+
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        super().__init__(*args, **kwargs)
+
+
+class Metadata(_model_base.Model):
+    """Metadata.
+
+    :ivar target_harms: List of target harms. Required.
+    :vartype target_harms: list[~raiclient.models.TargetHarm]
+    :ivar language: The language. Required.
+    :vartype language: str
+    """
+
+    target_harms: List["_models.TargetHarm"] = rest_field(
+        name="TargetHarms", visibility=["read", "create", "update", "delete", "query"]
+    )
+    """List of target harms. Required."""
+    language: str = rest_field(name="Language", visibility=["read", "create", "update", "delete", "query"])
+    """The language. Required."""
+
+    @overload
+    def __init__(
+        self,
+        *,
+        target_harms: List["_models.TargetHarm"],
+        language: str,
+    ) -> None: ...
+
+    @overload
+    def __init__(self, mapping: Mapping[str, Any]) -> None:
+        """
+        :param mapping: raw JSON to initialize the model.
+        :type mapping: Mapping[str, Any]
+        """
+
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        super().__init__(*args, **kwargs)
+
+
+class ModelConfig(_model_base.Model):
+    """ModelConfig.
+
+    :ivar azure_endpoint: Required.
+    :vartype azure_endpoint: str
+    """
+
+    azure_endpoint: str = rest_field(name="AzureEndpoint", visibility=["read", "create", "update", "delete", "query"])
+    """Required."""
+
+    @overload
+    def __init__(
+        self,
+        *,
+        azure_endpoint: str,
+    ) -> None: ...
+
+    @overload
+    def __init__(self, mapping: Mapping[str, Any]) -> None:
+        """
+        :param mapping: raw JSON to initialize the model.
+        :type mapping: Mapping[str, Any]
+        """
+
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        super().__init__(*args, **kwargs)
+
+
+class SampleGenerator(_model_base.Model):
+    """SampleGenerator.
+
+    :ivar model_name: Required.
+    :vartype model_name: str
+    :ivar type: Required.
+    :vartype type: str
+    :ivar sampling_params: Required.
+    :vartype sampling_params: any
+    :ivar trajectory_template: Required.
+    :vartype trajectory_template: any
+    """
+
+    model_name: str = rest_field(name="ModelName", visibility=["read", "create", "update", "delete", "query"])
+    """Required."""
+    type: str = rest_field(name="Type", visibility=["read", "create", "update", "delete", "query"])
+    """Required."""
+    sampling_params: Any = rest_field(name="SamplingParams", visibility=["read", "create", "update", "delete", "query"])
+    """Required."""
+    trajectory_template: Any = rest_field(
+        name="TrajectoryTemplate", visibility=["read", "create", "update", "delete", "query"]
+    )
+    """Required."""
+
+    @overload
+    def __init__(
+        self,
+        *,
+        model_name: str,
+        type: str,
+        sampling_params: Any,
+        trajectory_template: Any,
+    ) -> None: ...
+
+    @overload
+    def __init__(self, mapping: Mapping[str, Any]) -> None:
+        """
+        :param mapping: raw JSON to initialize the model.
+        :type mapping: Mapping[str, Any]
+        """
+
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        super().__init__(*args, **kwargs)
+
+
+class SimulationDTO(_model_base.Model):
+    """Customization Parameters.
+
+    :ivar headers: Additional headers.
+    :vartype headers: dict[str, str]
+    :ivar params: Parameters.
+    :vartype params: dict[str, str]
+    :ivar template_parameters: Template parameters.
+    :vartype template_parameters: dict[str, str]
+    :ivar customization_parameters: Customization parameters.
+    :vartype customization_parameters: ~raiclient.models.CustomizationParameters
+    :ivar json: Json.
+    :vartype json: str
+    :ivar url: Url.
+    :vartype url: str
+    :ivar template_key: Template key.
+    :vartype template_key: str
+    :ivar simulation_type: Type of Simulation. Known values are: "Default", "CustomPersona", and
+     "HarmTurnGenerator".
+    :vartype simulation_type: str or ~raiclient.models.SimulationType
+    :ivar is_microsoft_tenant: 'True' if Microsoft internal tenant and 'False' otherwise.
+    :vartype is_microsoft_tenant: bool
+    :ivar subscription_id: Azure subscription id.
+    :vartype subscription_id: str
+    :ivar resource_group_name: Resource group name.
+    :vartype resource_group_name: str
+    :ivar workspace_name: Workspace name.
+    :vartype workspace_name: str
+    """
+
+    headers: Optional[Dict[str, str]] = rest_field(
+        name="Headers", visibility=["read", "create", "update", "delete", "query"]
+    )
+    """Additional headers."""
+    params: Optional[Dict[str, str]] = rest_field(
+        name="Params", visibility=["read", "create", "update", "delete", "query"]
+    )
+    """Parameters."""
+    template_parameters: Optional[Dict[str, str]] = rest_field(
+        name="TemplateParameters", visibility=["read", "create", "update", "delete", "query"]
+    )
+    """Template parameters."""
+    customization_parameters: Optional["_models.CustomizationParameters"] = rest_field(
+        name="CustomizationParameters", visibility=["read", "create", "update", "delete", "query"]
+    )
+    """Customization parameters."""
+    json: Optional[str] = rest_field(name="Json", visibility=["read", "create", "update", "delete", "query"])
+    """Json."""
+    url: Optional[str] = rest_field(name="Url", visibility=["read", "create", "update", "delete", "query"])
+    """Url."""
+    template_key: Optional[str] = rest_field(
+        name="TemplateKey", visibility=["read", "create", "update", "delete", "query"]
+    )
+    """Template key."""
+    simulation_type: Optional[Union[str, "_models.SimulationType"]] = rest_field(
+        name="SimulationType", visibility=["read", "create", "update", "delete", "query"]
+    )
+    """Type of Simulation. Known values are: \"Default\", \"CustomPersona\", and
+     \"HarmTurnGenerator\"."""
+    is_microsoft_tenant: Optional[bool] = rest_field(
+        name="IsMicrosoftTenant", visibility=["read", "create", "update", "delete", "query"]
+    )
+    """'True' if Microsoft internal tenant and 'False' otherwise."""
+    subscription_id: Optional[str] = rest_field(
+        name="SubscriptionId", visibility=["read", "create", "update", "delete", "query"]
+    )
+    """Azure subscription id."""
+    resource_group_name: Optional[str] = rest_field(
+        name="ResourceGroupName", visibility=["read", "create", "update", "delete", "query"]
+    )
+    """Resource group name."""
+    workspace_name: Optional[str] = rest_field(
+        name="WorkspaceName", visibility=["read", "create", "update", "delete", "query"]
+    )
+    """Workspace name."""
+
+    @overload
+    def __init__(
+        self,
+        *,
+        headers: Optional[Dict[str, str]] = None,
+        params: Optional[Dict[str, str]] = None,
+        template_parameters: Optional[Dict[str, str]] = None,
+        customization_parameters: Optional["_models.CustomizationParameters"] = None,
+        json: Optional[str] = None,
+        url: Optional[str] = None,
+        template_key: Optional[str] = None,
+        simulation_type: Optional[Union[str, "_models.SimulationType"]] = None,
+        is_microsoft_tenant: Optional[bool] = None,
+        subscription_id: Optional[str] = None,
+        resource_group_name: Optional[str] = None,
+        workspace_name: Optional[str] = None,
+    ) -> None: ...
+
+    @overload
+    def __init__(self, mapping: Mapping[str, Any]) -> None:
+        """
+        :param mapping: raw JSON to initialize the model.
+        :type mapping: Mapping[str, Any]
+        """
+
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        super().__init__(*args, **kwargs)
+
+
+class TargetHarm(_model_base.Model):
+    """Target Harm.
+
+    :ivar risk_type: The risk type.
+    :vartype risk_type: str
+    :ivar risk_sub_type: The risk sub type.
+    :vartype risk_sub_type: str
+    """
+
+    risk_type: Optional[str] = rest_field(name="RiskType", visibility=["read", "create", "update", "delete", "query"])
+    """The risk type."""
+    risk_sub_type: Optional[str] = rest_field(
+        name="RiskSubType", visibility=["read", "create", "update", "delete", "query"]
+    )
+    """The risk sub type."""
+
+    @overload
+    def __init__(
+        self,
+        *,
+        risk_type: Optional[str] = None,
+        risk_sub_type: Optional[str] = None,
+    ) -> None: ...
+
+    @overload
+    def __init__(self, mapping: Mapping[str, Any]) -> None:
+        """
+        :param mapping: raw JSON to initialize the model.
+        :type mapping: Mapping[str, Any]
+        """
+
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        super().__init__(*args, **kwargs)

azure/ai/evaluation/_common/raiclient/models/_patch.py

@@ -0,0 +1,20 @@
+# ------------------------------------
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+# ------------------------------------
+"""Customize generated code here.
+
+Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize
+"""
+from typing import List
+
+__all__: List[str] = []  # Add all objects you want publicly available to users at this package level
+
+
+def patch_sdk():
+    """Do not remove from this file.
+
+    `patch_sdk` is a last resort escape hatch that allows you to do customizations
+    you can't accomplish using the techniques described in
+    https://aka.ms/azsdk/python/dpcodegen/python/customize
+    """

azure/ai/evaluation/_common/raiclient/operations/__init__.py

@@ -0,0 +1,25 @@
+# coding=utf-8
+# --------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# Code generated by Microsoft (R) Python Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is regenerated.
+# --------------------------------------------------------------------------
+# pylint: disable=wrong-import-position
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from ._patch import *  # pylint: disable=unused-wildcard-import
+
+from ._operations import RAISvcOperations  # type: ignore
+
+from ._patch import __all__ as _patch_all
+from ._patch import *
+from ._patch import patch_sdk as _patch_sdk
+
+__all__ = [
+    "RAISvcOperations",
+]
+__all__.extend([p for p in _patch_all if p not in __all__])  # pyright: ignore
+_patch_sdk()