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

arize/_generated/api_client/models/datasets_examples_insert_request.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
+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
+
+class DatasetsExamplesInsertRequest(BaseModel):
+    """
+    DatasetsExamplesInsertRequest
+    """ # noqa: E501
+    examples: List[Dict[str, PrimitiveValue]] = Field(description="Array of examples to append to the dataset version")
+    __properties: ClassVar[List[str]] = ["examples"]
+
+    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 DatasetsExamplesInsertRequest 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.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            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
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of DatasetsExamplesInsertRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        # raise errors for additional fields in the input
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                raise ValueError("Error due to additional fields (not defined in DatasetsExamplesInsertRequest) in the input: " + _key)
+
+        _obj = cls.model_validate({
+            "examples": [Dict[str, PrimitiveValue].from_dict(_item) for _item in obj["examples"]] if obj.get("examples") is not None else None
+        })
+        return _obj
+
+

arize/_generated/api_client/models/datasets_examples_list200_response.py

@@ -0,0 +1,106 @@
+# 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
+from typing import Any, ClassVar, Dict, List
+from arize._generated.api_client.models.dataset_example import DatasetExample
+from arize._generated.api_client.models.pagination_metadata import PaginationMetadata
+from typing import Optional, Set
+from typing_extensions import Self
+
+class DatasetsExamplesList200Response(BaseModel):
+    """
+    DatasetsExamplesList200Response
+    """ # noqa: E501
+    examples: List[DatasetExample] = Field(description="Array of example objects from the dataset")
+    pagination: PaginationMetadata
+    __properties: ClassVar[List[str]] = ["examples", "pagination"]
+
+    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 DatasetsExamplesList200Response 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.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            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
+        # override the default output from pydantic by calling `to_dict()` of pagination
+        if self.pagination:
+            _dict['pagination'] = self.pagination.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of DatasetsExamplesList200Response from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        # raise errors for additional fields in the input
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                raise ValueError("Error due to additional fields (not defined in DatasetsExamplesList200Response) in the input: " + _key)
+
+        _obj = cls.model_validate({
+            "examples": [DatasetExample.from_dict(_item) for _item in obj["examples"]] if obj.get("examples") is not None else None,
+            "pagination": PaginationMetadata.from_dict(obj["pagination"]) if obj.get("pagination") is not None else None
+        })
+        return _obj
+
+

arize/_generated/api_client/models/datasets_examples_update_request.py

@@ -0,0 +1,102 @@
+# 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, Optional
+from arize._generated.api_client.models.dataset_example_update import DatasetExampleUpdate
+from typing import Optional, Set
+from typing_extensions import Self
+
+class DatasetsExamplesUpdateRequest(BaseModel):
+    """
+    DatasetsExamplesUpdateRequest
+    """ # noqa: E501
+    examples: List[DatasetExampleUpdate] = Field(description="Array of examples with 'id' field for matching and updating existing records")
+    new_version: Optional[StrictStr] = Field(default=None, description="Name for the new version. If provided (non-empty), creates a new version with that name.  If omitted or empty, updates the existing version in-place. ")
+    __properties: ClassVar[List[str]] = ["examples", "new_version"]
+
+    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 DatasetsExamplesUpdateRequest 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.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            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
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of DatasetsExamplesUpdateRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        # raise errors for additional fields in the input
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                raise ValueError("Error due to additional fields (not defined in DatasetsExamplesUpdateRequest) in the input: " + _key)
+
+        _obj = cls.model_validate({
+            "examples": [DatasetExampleUpdate.from_dict(_item) for _item in obj["examples"]] if obj.get("examples") is not None else None,
+            "new_version": obj.get("new_version")
+        })
+        return _obj
+
+

arize/_generated/api_client/models/datasets_list200_response.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.
@@ -20,6 +20,7 @@ import json
 from pydantic import BaseModel, ConfigDict, Field
 from typing import Any, ClassVar, Dict, List
 from arize._generated.api_client.models.dataset import Dataset
+from arize._generated.api_client.models.pagination_metadata import PaginationMetadata
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -28,7 +29,8 @@ class DatasetsList200Response(BaseModel):
     DatasetsList200Response
     """ # noqa: E501
     datasets: List[Dataset] = Field(description="A list of datasets")
-    __properties: ClassVar[List[str]] = ["datasets"]
+    pagination: PaginationMetadata
+    __properties: ClassVar[List[str]] = ["datasets", "pagination"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -76,6 +78,9 @@ class DatasetsList200Response(BaseModel):
                 if _item_datasets:
                     _items.append(_item_datasets.to_dict())
             _dict['datasets'] = _items
+        # override the default output from pydantic by calling `to_dict()` of pagination
+        if self.pagination:
+            _dict['pagination'] = self.pagination.to_dict()
         return _dict
 
     @classmethod
@@ -93,7 +98,8 @@ class DatasetsList200Response(BaseModel):
                 raise ValueError("Error due to additional fields (not defined in DatasetsList200Response) in the input: " + _key)
 
         _obj = cls.model_validate({
-            "datasets": [Dataset.from_dict(_item) for _item in obj["datasets"]] if obj.get("datasets") is not None else None
+            "datasets": [Dataset.from_dict(_item) for _item in obj["datasets"]] if obj.get("datasets") is not None else None,
+            "pagination": PaginationMetadata.from_dict(obj["pagination"]) if obj.get("pagination") is not None else None
         })
         return _obj
 

arize/_generated/api_client/models/experiment.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.
@@ -25,17 +25,16 @@ from typing_extensions import Self
 
 class Experiment(BaseModel):
     """
-    An experiment message
+    Experiments combine a dataset (example inputs/expected outputs), a task (the function that produces model outputs), and one or more evaluators (code or LLM judges) to measure performance. Each run is stored independently so you can compare runs, track progress, and validate improvements over time. See the full definition on the Experiments page.  Use an experiment to run tasks on a dataset, attach evaluators to score outputs, and compare runs to confirm improvements. 
     """ # noqa: E501
     id: StrictStr = Field(description="Unique identifier for the experiment")
     name: StrictStr = Field(description="Name of the experiment")
-    dataset_id: StrictStr = Field(description="Unique identifier for the dataset this experiment belongs to", alias="datasetId")
-    dataset_version_id: StrictStr = Field(description="Unique identifier for the dataset version this experiment belongs to", alias="datasetVersionId")
-    created_at: datetime = Field(description="Timestamp for when the experiment was created", alias="createdAt")
-    updated_at: datetime = Field(description="Timestamp for the last update of the experiment", alias="updatedAt")
-    created_by: StrictStr = Field(description="Unique identifier for the user who created the experiment", alias="createdBy")
-    experiment_traces_project_id: Optional[StrictStr] = Field(default=None, description="Unique identifier for the experiment traces project this experiment belongs to (if it exists)", alias="experimentTracesProjectId")
-    __properties: ClassVar[List[str]] = ["id", "name", "datasetId", "datasetVersionId", "createdAt", "updatedAt", "createdBy", "experimentTracesProjectId"]
+    dataset_id: StrictStr = Field(description="Unique identifier for the dataset this experiment belongs to")
+    dataset_version_id: StrictStr = Field(description="Unique identifier for the dataset version this experiment belongs to")
+    created_at: datetime = Field(description="Timestamp for when the experiment was created")
+    updated_at: datetime = Field(description="Timestamp for the last update of the experiment")
+    experiment_traces_project_id: Optional[StrictStr] = Field(default=None, description="Unique identifier for the experiment traces project this experiment belongs to (if it exists)")
+    __properties: ClassVar[List[str]] = ["id", "name", "dataset_id", "dataset_version_id", "created_at", "updated_at", "experiment_traces_project_id"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -95,12 +94,11 @@ class Experiment(BaseModel):
         _obj = cls.model_validate({
             "id": obj.get("id"),
             "name": obj.get("name"),
-            "datasetId": obj.get("datasetId"),
-            "datasetVersionId": obj.get("datasetVersionId"),
-            "createdAt": obj.get("createdAt"),
-            "updatedAt": obj.get("updatedAt"),
-            "createdBy": obj.get("createdBy"),
-            "experimentTracesProjectId": obj.get("experimentTracesProjectId")
+            "dataset_id": obj.get("dataset_id"),
+            "dataset_version_id": obj.get("dataset_version_id"),
+            "created_at": obj.get("created_at"),
+            "updated_at": obj.get("updated_at"),
+            "experiment_traces_project_id": obj.get("experiment_traces_project_id")
         })
         return _obj
 

arize/_generated/api_client/models/experiment_run.py

@@ -0,0 +1,108 @@
+# 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 ExperimentRun(BaseModel):
+    """
+    An experiment run with experiment data including outputs, evaluations, and trace metadata
+    """ # noqa: E501
+    id: StrictStr = Field(description="System-assigned unique ID for the example")
+    example_id: StrictStr = Field(description="ID of the dataset example associated with this experiment run")
+    output: StrictStr = Field(description="output of the task for the matching example")
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["id", "example_id", "output"]
+
+    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 ExperimentRun 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.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set([
+            "id",
+            "example_id",
+            "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 ExperimentRun 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"),
+            "example_id": obj.get("example_id"),
+            "output": obj.get("output")
+        })
+        # 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/experiment_run_create.py

@@ -0,0 +1,102 @@
+# 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 ExperimentRunCreate(BaseModel):
+    """
+    An experiment run with experiment data including outputs, evaluations, and trace metadata
+    """ # noqa: E501
+    example_id: StrictStr = Field(description="ID of the dataset example associated with this experiment run")
+    output: StrictStr = Field(description="output of the task for the matching example")
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["example_id", "output"]
+
+    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 ExperimentRunCreate 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 ExperimentRunCreate from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "example_id": obj.get("example_id"),
+            "output": obj.get("output")
+        })
+        # 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
+
+