arize 8.0.0a22__py3-none-any.whl → 8.0.0b0__py3-none-any.whl

arize/_generated/api_client/api_client.py

@@ -3,9 +3,9 @@
 """
     Arize REST API
 
-    API specification for the backend data server. The API is hosted globally at https://api.arize.com/v2 or in your own environment. You can access the OpenAPI spec for this API at https://api.arize.com/v2/spec.yaml 
+    API specification for the backend data server. The API is hosted globally at https://api.arize.com/v2 or in your own environment. 
 
-    The version of the OpenAPI document: 0.0.1
+    The version of the OpenAPI document: 2.0.0
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.

arize/_generated/api_client/configuration.py

@@ -3,9 +3,9 @@
 """
     Arize REST API
 
-    API specification for the backend data server. The API is hosted globally at https://api.arize.com/v2 or in your own environment. You can access the OpenAPI spec for this API at https://api.arize.com/v2/spec.yaml 
+    API specification for the backend data server. The API is hosted globally at https://api.arize.com/v2 or in your own environment. 
 
-    The version of the OpenAPI document: 0.0.1
+    The version of the OpenAPI document: 2.0.0
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.
@@ -113,7 +113,7 @@ HTTPSignatureAuthSetting = TypedDict(
 AuthSettings = TypedDict(
     "AuthSettings",
     {
-        "ApiKeyAuth": APIKeyAuthSetting,
+        "bearerAuth": BearerFormatAuthSetting,
     },
     total=False,
 )
@@ -163,27 +163,10 @@ class Configuration:
     :param retries: Number of retries for API requests.
     :param ca_cert_data: verify the peer using concatenated CA certificate data
       in PEM (str) or DER (bytes) format.
+    :param cert_file: the path to a client certificate file, for mTLS.
+    :param key_file: the path to a client key file, for mTLS. 
 
     :Example:
-
-    API Key Authentication Example.
-    Given the following security scheme in the OpenAPI specification:
-      components:
-        securitySchemes:
-          cookieAuth:         # name for the security scheme
-            type: apiKey
-            in: cookie
-            name: JSESSIONID  # cookie name
-
-    You can programmatically set the cookie:
-
-conf = arize._generated.api_client.Configuration(
-    api_key={'cookieAuth': 'abc123'}
-    api_key_prefix={'cookieAuth': 'JSESSIONID'}
-)
-
-    The following cookie will be added to the HTTP request:
-       Cookie: JSESSIONID abc123
     """
 
     _default: ClassVar[Optional[Self]] = None
@@ -204,12 +187,14 @@ conf = arize._generated.api_client.Configuration(
         ssl_ca_cert: Optional[str]=None,
         retries: Optional[int] = None,
         ca_cert_data: Optional[Union[str, bytes]] = None,
+        cert_file: Optional[str]=None,
+        key_file: Optional[str]=None,
         *,
         debug: Optional[bool] = None,
     ) -> None:
         """Constructor
         """
-        self._base_path = "http://localhost" if host is None else host
+        self._base_path = "https://api.arize.com" if host is None else host
         """Default Base url
         """
         self.server_index = 0 if server_index is None and host is None else server_index
@@ -285,10 +270,10 @@ conf = arize._generated.api_client.Configuration(
         """Set this to verify the peer using PEM (str) or DER (bytes)
            certificate data.
         """
-        self.cert_file = None
+        self.cert_file = cert_file
         """client certificate file
         """
-        self.key_file = None
+        self.key_file = key_file
         """client key file
         """
         self.assert_hostname = None
@@ -511,14 +496,13 @@ conf = arize._generated.api_client.Configuration(
         :return: The Auth Settings information dict.
         """
         auth: AuthSettings = {}
-        if 'ApiKeyAuth' in self.api_key:
-            auth['ApiKeyAuth'] = {
-                'type': 'api_key',
+        if self.access_token is not None:
+            auth['bearerAuth'] = {
+                'type': 'bearer',
                 'in': 'header',
+                'format': '<api-key>',
                 'key': 'Authorization',
-                'value': self.get_api_key_with_prefix(
-                    'ApiKeyAuth',
-                ),
+                'value': 'Bearer ' + self.access_token
             }
         return auth
 
@@ -530,7 +514,7 @@ conf = arize._generated.api_client.Configuration(
         return "Python SDK Debug Report:\n"\
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
-               "Version of the API: 0.0.1\n"\
+               "Version of the API: 2.0.0\n"\
                "SDK Package Version: 1.0.0".\
                format(env=sys.platform, pyversion=sys.version)
 
@@ -541,8 +525,32 @@ conf = arize._generated.api_client.Configuration(
         """
         return [
             {
-                'url': "",
-                'description': "No description provided",
+                'url': "https://api.arize.com",
+                'description': "Global",
+            },
+            {
+                'url': "https://api.{region}.arize.com",
+                'description': "Regional",
+                'variables': {
+                    'region': {
+                        'description': "No description provided",
+                        'default_value': "eu-west-1a",
+                        'enum_values': [
+                            "eu-west-1a",
+                            "ca-central-1a"
+                        ]
+                        }
+                    }
+            },
+            {
+                'url': "https://{host}",
+                'description': "Custom Host",
+                'variables': {
+                    'host': {
+                        'description': "No description provided",
+                        'default_value': "api.arize.com",
+                        }
+                    }
             }
         ]
 

arize/_generated/api_client/exceptions.py

@@ -3,9 +3,9 @@
 """
     Arize REST API
 
-    API specification for the backend data server. The API is hosted globally at https://api.arize.com/v2 or in your own environment. You can access the OpenAPI spec for this API at https://api.arize.com/v2/spec.yaml 
+    API specification for the backend data server. The API is hosted globally at https://api.arize.com/v2 or in your own environment. 
 
-    The version of the OpenAPI document: 0.0.1
+    The version of the OpenAPI document: 2.0.0
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.

arize/_generated/api_client/models/__init__.py

@@ -4,9 +4,9 @@
 """
     Arize REST API
 
-    API specification for the backend data server. The API is hosted globally at https://api.arize.com/v2 or in your own environment. You can access the OpenAPI spec for this API at https://api.arize.com/v2/spec.yaml 
+    API specification for the backend data server. The API is hosted globally at https://api.arize.com/v2 or in your own environment. 
 
-    The version of the OpenAPI document: 0.0.1
+    The version of the OpenAPI document: 2.0.0
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.
@@ -14,13 +14,24 @@
 
 # import models into model package
 from arize._generated.api_client.models.dataset import Dataset
+from arize._generated.api_client.models.dataset_example import DatasetExample
+from arize._generated.api_client.models.dataset_example_update import DatasetExampleUpdate
 from arize._generated.api_client.models.dataset_version import DatasetVersion
 from arize._generated.api_client.models.datasets_create_request import DatasetsCreateRequest
+from arize._generated.api_client.models.datasets_examples_insert_request import DatasetsExamplesInsertRequest
+from arize._generated.api_client.models.datasets_examples_list200_response import DatasetsExamplesList200Response
+from arize._generated.api_client.models.datasets_examples_update_request import DatasetsExamplesUpdateRequest
 from arize._generated.api_client.models.datasets_list200_response import DatasetsList200Response
-from arize._generated.api_client.models.datasets_list_examples200_response import DatasetsListExamples200Response
-from arize._generated.api_client.models.error import Error
 from arize._generated.api_client.models.experiment import Experiment
+from arize._generated.api_client.models.experiment_run import ExperimentRun
+from arize._generated.api_client.models.experiment_run_create import ExperimentRunCreate
 from arize._generated.api_client.models.experiments_create_request import ExperimentsCreateRequest
 from arize._generated.api_client.models.experiments_list200_response import ExperimentsList200Response
 from arize._generated.api_client.models.experiments_runs_list200_response import ExperimentsRunsList200Response
+from arize._generated.api_client.models.pagination_metadata import PaginationMetadata
+from arize._generated.api_client.models.primitive_value import PrimitiveValue
+from arize._generated.api_client.models.problem import Problem
+from arize._generated.api_client.models.project import Project
+from arize._generated.api_client.models.projects_create_request import ProjectsCreateRequest
+from arize._generated.api_client.models.projects_list200_response import ProjectsList200Response
 

arize/_generated/api_client/models/dataset.py

@@ -3,9 +3,9 @@
 """
     Arize REST API
 
-    API specification for the backend data server. The API is hosted globally at https://api.arize.com/v2 or in your own environment. You can access the OpenAPI spec for this API at https://api.arize.com/v2/spec.yaml 
+    API specification for the backend data server. The API is hosted globally at https://api.arize.com/v2 or in your own environment. 
 
-    The version of the OpenAPI document: 0.0.1
+    The version of the OpenAPI document: 2.0.0
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.
@@ -26,15 +26,15 @@ from typing_extensions import Self
 
 class Dataset(BaseModel):
     """
-    A dataset message
+    A dataset is a structured collection of examples used to test and evaluate LLM applications. Datasets allow you to test models consistently across any real-world scenarios and edge cases, quickly identify regressions, and track measurable improvements. 
     """ # noqa: E501
     id: StrictStr = Field(description="Unique identifier for the dataset")
     name: StrictStr = Field(description="Name of the dataset")
-    space_id: StrictStr = Field(description="Unique identifier for the space this dataset belongs to", alias="spaceId")
-    created_at: Optional[datetime] = Field(default=None, description="Timestamp for when the dataset was created", alias="createdAt")
-    updated_at: Optional[datetime] = Field(default=None, description="Timestamp for the last update of the dataset", alias="updatedAt")
+    space_id: StrictStr = Field(description="Unique identifier for the space this dataset belongs to")
+    created_at: datetime = Field(description="Timestamp for when the dataset was created")
+    updated_at: datetime = Field(description="Timestamp for the last update of the dataset")
     versions: Optional[List[DatasetVersion]] = Field(default=None, description="List of versions associated with this dataset")
-    __properties: ClassVar[List[str]] = ["id", "name", "spaceId", "createdAt", "updatedAt", "versions"]
+    __properties: ClassVar[List[str]] = ["id", "name", "space_id", "created_at", "updated_at", "versions"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -101,9 +101,9 @@ class Dataset(BaseModel):
         _obj = cls.model_validate({
             "id": obj.get("id"),
             "name": obj.get("name"),
-            "spaceId": obj.get("spaceId"),
-            "createdAt": obj.get("createdAt"),
-            "updatedAt": obj.get("updatedAt"),
+            "space_id": obj.get("space_id"),
+            "created_at": obj.get("created_at"),
+            "updated_at": obj.get("updated_at"),
             "versions": [DatasetVersion.from_dict(_item) for _item in obj["versions"]] if obj.get("versions") is not None else None
         })
         return _obj

arize/_generated/api_client/models/dataset_example.py

@@ -0,0 +1,111 @@
+# coding: utf-8
+
+"""
+    Arize REST API
+
+    API specification for the backend data server. The API is hosted globally at https://api.arize.com/v2 or in your own environment. 
+
+    The version of the OpenAPI document: 2.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class DatasetExample(BaseModel):
+    """
+    A dataset example with arbitrary user-defined fields. System-managed fields are included as read-only for responses. 
+    """ # noqa: E501
+    id: StrictStr = Field(description="System-assigned unique ID for the example")
+    created_at: datetime = Field(description="Timestamp for when the example was created")
+    updated_at: datetime = Field(description="Timestamp for the last update of the example")
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["id", "created_at", "updated_at"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of DatasetExample from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set([
+            "id",
+            "created_at",
+            "updated_at",
+            "additional_properties",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of DatasetExample from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "created_at": obj.get("created_at"),
+            "updated_at": obj.get("updated_at")
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+

arize/_generated/api_client/models/dataset_example_update.py

@@ -0,0 +1,100 @@
+# coding: utf-8
+
+"""
+    Arize REST API
+
+    API specification for the backend data server. The API is hosted globally at https://api.arize.com/v2 or in your own environment. 
+
+    The version of the OpenAPI document: 2.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class DatasetExampleUpdate(BaseModel):
+    """
+    A dataset example with arbitrary user-defined fields. System-managed fields, except 'id', are excluded for update requests. 
+    """ # noqa: E501
+    id: StrictStr = Field(description="System-assigned unique ID for the example")
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["id"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of DatasetExampleUpdate from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set([
+            "additional_properties",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of DatasetExampleUpdate from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id")
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+

arize/_generated/api_client/models/dataset_version.py

@@ -3,9 +3,9 @@
 """
     Arize REST API
 
-    API specification for the backend data server. The API is hosted globally at https://api.arize.com/v2 or in your own environment. You can access the OpenAPI spec for this API at https://api.arize.com/v2/spec.yaml 
+    API specification for the backend data server. The API is hosted globally at https://api.arize.com/v2 or in your own environment. 
 
-    The version of the OpenAPI document: 0.0.1
+    The version of the OpenAPI document: 2.0.0
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.
@@ -19,20 +19,20 @@ import json
 
 from datetime import datetime
 from pydantic import BaseModel, ConfigDict, Field, StrictStr
-from typing import Any, ClassVar, Dict, List, Optional
+from typing import Any, ClassVar, Dict, List
 from typing import Optional, Set
 from typing_extensions import Self
 
 class DatasetVersion(BaseModel):
     """
-    DatasetVersion
+    A dataset version is a saved snapshot of a dataset. Arize stores datasets as version-controlled collections of examples for experiments. When you update a dataset, you can do so inplace  or create a new version while preserving access to previous versions. 
     """ # noqa: E501
-    id: Optional[StrictStr] = Field(default=None, description="Unique identifier for the dataset version")
-    name: Optional[StrictStr] = Field(default=None, description="Name of the dataset version")
-    dataset_id: Optional[StrictStr] = Field(default=None, description="Unique identifier for the dataset this version belongs to", alias="datasetId")
-    created_at: Optional[datetime] = Field(default=None, description="Timestamp for when the dataset version was created", alias="createdAt")
-    updated_at: Optional[datetime] = Field(default=None, description="Timestamp for the last update of the dataset version", alias="updatedAt")
-    __properties: ClassVar[List[str]] = ["id", "name", "datasetId", "createdAt", "updatedAt"]
+    id: StrictStr = Field(description="Unique identifier for the dataset version")
+    name: StrictStr = Field(description="Name of the dataset version")
+    dataset_id: StrictStr = Field(description="Unique identifier for the dataset this version belongs to")
+    created_at: datetime = Field(description="Timestamp for when the dataset version was created")
+    updated_at: datetime = Field(description="Timestamp for the last update of the dataset version")
+    __properties: ClassVar[List[str]] = ["id", "name", "dataset_id", "created_at", "updated_at"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -92,9 +92,9 @@ class DatasetVersion(BaseModel):
         _obj = cls.model_validate({
             "id": obj.get("id"),
             "name": obj.get("name"),
-            "datasetId": obj.get("datasetId"),
-            "createdAt": obj.get("createdAt"),
-            "updatedAt": obj.get("updatedAt")
+            "dataset_id": obj.get("dataset_id"),
+            "created_at": obj.get("created_at"),
+            "updated_at": obj.get("updated_at")
         })
         return _obj
 

arize/_generated/api_client/models/datasets_create_request.py

@@ -3,9 +3,9 @@
 """
     Arize REST API
 
-    API specification for the backend data server. The API is hosted globally at https://api.arize.com/v2 or in your own environment. You can access the OpenAPI spec for this API at https://api.arize.com/v2/spec.yaml 
+    API specification for the backend data server. The API is hosted globally at https://api.arize.com/v2 or in your own environment. 
 
-    The version of the OpenAPI document: 0.0.1
+    The version of the OpenAPI document: 2.0.0
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.
@@ -19,6 +19,7 @@ import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List
+from arize._generated.api_client.models.primitive_value import PrimitiveValue
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -26,10 +27,10 @@ class DatasetsCreateRequest(BaseModel):
     """
     DatasetsCreateRequest
     """ # noqa: E501
-    name: StrictStr
-    space_id: StrictStr = Field(alias="spaceId")
-    examples: List[Dict[str, Any]]
-    __properties: ClassVar[List[str]] = ["name", "spaceId", "examples"]
+    name: StrictStr = Field(description="Name of the new dataset")
+    space_id: StrictStr = Field(description="ID of the space the dataset will belong to")
+    examples: List[Dict[str, PrimitiveValue]] = Field(description="Array of examples for the new dataset")
+    __properties: ClassVar[List[str]] = ["name", "space_id", "examples"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -70,6 +71,13 @@ class DatasetsCreateRequest(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
+        # override the default output from pydantic by calling `to_dict()` of each item in examples (list)
+        _items = []
+        if self.examples:
+            for _item_examples in self.examples:
+                if _item_examples:
+                    _items.append(_item_examples.to_dict())
+            _dict['examples'] = _items
         return _dict
 
     @classmethod
@@ -88,8 +96,8 @@ class DatasetsCreateRequest(BaseModel):
 
         _obj = cls.model_validate({
             "name": obj.get("name"),
-            "spaceId": obj.get("spaceId"),
-            "examples": obj.get("examples")
+            "space_id": obj.get("space_id"),
+            "examples": [Dict[str, PrimitiveValue].from_dict(_item) for _item in obj["examples"]] if obj.get("examples") is not None else None
         })
         return _obj