arize 8.0.0b4__tar.gz → 8.0.2__tar.gz

{arize-8.0.0b4 → arize-8.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: arize
-Version: 8.0.0b4
+Version: 8.0.2
 Summary: A helper library to interact with Arize AI APIs
 Project-URL: Homepage, https://arize.com
 Project-URL: Documentation, https://docs.arize.com/arize
@@ -33,7 +33,7 @@ Requires-Dist: opentelemetry-exporter-otlp-proto-grpc>=1.38.0
 Requires-Dist: opentelemetry-sdk>=1.38.0
 Requires-Dist: opentelemetry-semantic-conventions<1,>=0.43b0
 Requires-Dist: pandas<3,>=2.0.0
-Requires-Dist: protobuf<6,>=4.21.0
+Requires-Dist: protobuf<7,>=4.21.0
 Requires-Dist: pyarrow>=0.15.0
 Requires-Dist: pydantic<3,>=2
 Requires-Dist: python-dateutil<3,>=2.8.2
@@ -54,6 +54,13 @@ Requires-Dist: types-python-dateutil>=2.9.0; extra == 'dev'
 Requires-Dist: types-requests>=2.31.0; extra == 'dev'
 Requires-Dist: types-tabulate>=0.9.0; extra == 'dev'
 Requires-Dist: types-tqdm>=4.66.0; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: myst-parser>=2.0.0; extra == 'docs'
+Requires-Dist: pydata-sphinx-theme>=0.15.0; extra == 'docs'
+Requires-Dist: sphinx-autobuild>=2024.0.0; extra == 'docs'
+Requires-Dist: sphinx-copybutton>=0.5.0; extra == 'docs'
+Requires-Dist: sphinx-design>=0.5.0; extra == 'docs'
+Requires-Dist: sphinx<8.0.0,>=7.0.0; extra == 'docs'
 Provides-Extra: embeddings
 Requires-Dist: datasets!=2.14.*,<3,>=2.8; extra == 'embeddings'
 Requires-Dist: pillow<11,>=8.4.0; extra == 'embeddings'

{arize-8.0.0b4 → arize-8.0.2}/pyproject.toml

@@ -38,7 +38,7 @@ dependencies = [
     "opentelemetry-sdk>=1.38.0",
     "opentelemetry-semantic-conventions>=0.43b0, <1",
     "pandas>=2.0.0, <3",
-    "protobuf>=4.21.0, <6",
+    "protobuf>=4.21.0, <7",
     "pyarrow>=0.15.0",
     "pydantic>=2, <3",
     "python-dateutil>=2.8.2, <3",
@@ -77,6 +77,14 @@ embeddings = [
     "torch>=1.13, <3",
     "transformers>=4.25, <5",
 ]
+docs = [
+    "sphinx>=7.0.0, <8.0.0",
+    "sphinx-autobuild>=2024.0.0",
+    "pydata-sphinx-theme>=0.15.0",
+    "sphinx-copybutton>=0.5.0",
+    "sphinx-design>=0.5.0",
+    "myst-parser>=2.0.0",
+]
 
 [project.urls]
 Homepage = "https://arize.com"
@@ -164,6 +172,7 @@ ignore = [
     "S101",   # Allow assert statements in tests
     "S108",   # Allow insecure usage of temporary file or directory
     "TRY301", # Allow generic exception catching in tests
+    "B017",   # Allow blind asserting exception: `Exception`
 ]
 
 [tool.ruff.lint.isort]
@@ -226,9 +235,9 @@ addopts = [
 ]
 # Custom markers that can be used to categorize tests (use with @pytest.mark.marker_name)
 markers = [
-    "slow: marks tests as slow (deselect with '-m \"not slow\"')",
+    "unit: marks tests as unit tests (fast, isolated, uses mocks)",
     "integration: marks tests as integration tests",
-    "unit: marks tests as unit tests",
+    "slow: marks tests as slow (deselect with '-m \"not slow\"')",
 ]
 
 [tool.coverage.run]
@@ -239,16 +248,14 @@ omit = [
     "*/_generated/*",
     "*/__pycache__/*",
     "*/site-packages/*",
+    "src/arize/constants/*", # We don't need to test constants, they are just definitions
+    "src/arize/exceptions/*", # We don't need to test exceptions, they are just definitions
     # Exclude other src/arize modules. TODO(Kiko): Remove them progressively.
-    "src/arize/constants/*",
     "src/arize/datasets/*",
-    "src/arize/embeddings/*",
-    "src/arize/exceptions/*",
     "src/arize/experiments/*",
     "src/arize/ml/*",
     "src/arize/projects/*",
     "src/arize/spans/*",
-    "src/arize/utils/*",
 ]
 # Enable branch coverage (measures whether all branches of if/else/try/except are tested)
 # Without this, only line coverage is measured

{arize-8.0.0b4 → arize-8.0.2}/src/arize/_generated/api_client/__init__.py

@@ -21,6 +21,7 @@ __all__ = [
     "DatasetsApi",
     "ExperimentsApi",
     "ProjectsApi",
+    "PromptsApi",
     "ApiResponse",
     "ApiClient",
     "Configuration",
@@ -50,12 +51,15 @@ __all__ = [
     "Project",
     "ProjectsCreateRequest",
     "ProjectsList200Response",
+    "Prompt",
+    "PromptsList200Response",
 ]
 
 # import apis into sdk package
 from arize._generated.api_client.api.datasets_api import DatasetsApi as DatasetsApi
 from arize._generated.api_client.api.experiments_api import ExperimentsApi as ExperimentsApi
 from arize._generated.api_client.api.projects_api import ProjectsApi as ProjectsApi
+from arize._generated.api_client.api.prompts_api import PromptsApi as PromptsApi
 
 # import ApiClient
 from arize._generated.api_client.api_response import ApiResponse as ApiResponse
@@ -89,4 +93,6 @@ from arize._generated.api_client.models.problem import Problem as Problem
 from arize._generated.api_client.models.project import Project as Project
 from arize._generated.api_client.models.projects_create_request import ProjectsCreateRequest as ProjectsCreateRequest
 from arize._generated.api_client.models.projects_list200_response import ProjectsList200Response as ProjectsList200Response
+from arize._generated.api_client.models.prompt import Prompt as Prompt
+from arize._generated.api_client.models.prompts_list200_response import PromptsList200Response as PromptsList200Response
 

{arize-8.0.0b4 → arize-8.0.2}/src/arize/_generated/api_client/api/__init__.py

@@ -4,4 +4,5 @@
 from arize._generated.api_client.api.datasets_api import DatasetsApi
 from arize._generated.api_client.api.experiments_api import ExperimentsApi
 from arize._generated.api_client.api.projects_api import ProjectsApi
+from arize._generated.api_client.api.prompts_api import PromptsApi
 

arize-8.0.2/src/arize/_generated/api_client/api/prompts_api.py

@@ -0,0 +1,349 @@
+# 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
+
+import warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from pydantic import Field, StrictStr
+from typing import Optional
+from typing_extensions import Annotated
+from arize._generated.api_client.models.prompts_list200_response import PromptsList200Response
+
+from arize._generated.api_client.api_client import ApiClient, RequestSerialized
+from arize._generated.api_client.api_response import ApiResponse
+from arize._generated.api_client.rest import RESTResponseType
+
+
+class PromptsApi:
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None) -> None:
+        if api_client is None:
+            api_client = ApiClient.get_default()
+        self.api_client = api_client
+
+
+    @validate_call
+    def prompts_list(
+        self,
+        space_id: Annotated[Optional[StrictStr], Field(description="Filter search results to a particular space ID")] = None,
+        limit: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Maximum items to return")] = None,
+        cursor: Annotated[Optional[StrictStr], Field(description="Opaque pagination cursor returned from a previous response (`pagination.next_cursor`). Treat it as an unreadable token; do not attempt to parse or construct it. ")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> PromptsList200Response:
+        """List prompts
+
+        List prompts the user has access to.  The prompts are sorted by update date, with the most recently updated prompts coming first.  <Warning>This endpoint is in alpha, read more [here](https://arize.com/docs/ax/rest-reference#api-version-stages).</Warning> 
+
+        :param space_id: Filter search results to a particular space ID
+        :type space_id: str
+        :param limit: Maximum items to return
+        :type limit: int
+        :param cursor: Opaque pagination cursor returned from a previous response (`pagination.next_cursor`). Treat it as an unreadable token; do not attempt to parse or construct it. 
+        :type cursor: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._prompts_list_serialize(
+            space_id=space_id,
+            limit=limit,
+            cursor=cursor,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "PromptsList200Response",
+            '400': "Problem",
+            '401': "Problem",
+            '403': "Problem",
+            '429': "Problem",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def prompts_list_with_http_info(
+        self,
+        space_id: Annotated[Optional[StrictStr], Field(description="Filter search results to a particular space ID")] = None,
+        limit: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Maximum items to return")] = None,
+        cursor: Annotated[Optional[StrictStr], Field(description="Opaque pagination cursor returned from a previous response (`pagination.next_cursor`). Treat it as an unreadable token; do not attempt to parse or construct it. ")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[PromptsList200Response]:
+        """List prompts
+
+        List prompts the user has access to.  The prompts are sorted by update date, with the most recently updated prompts coming first.  <Warning>This endpoint is in alpha, read more [here](https://arize.com/docs/ax/rest-reference#api-version-stages).</Warning> 
+
+        :param space_id: Filter search results to a particular space ID
+        :type space_id: str
+        :param limit: Maximum items to return
+        :type limit: int
+        :param cursor: Opaque pagination cursor returned from a previous response (`pagination.next_cursor`). Treat it as an unreadable token; do not attempt to parse or construct it. 
+        :type cursor: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._prompts_list_serialize(
+            space_id=space_id,
+            limit=limit,
+            cursor=cursor,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "PromptsList200Response",
+            '400': "Problem",
+            '401': "Problem",
+            '403': "Problem",
+            '429': "Problem",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def prompts_list_without_preload_content(
+        self,
+        space_id: Annotated[Optional[StrictStr], Field(description="Filter search results to a particular space ID")] = None,
+        limit: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Maximum items to return")] = None,
+        cursor: Annotated[Optional[StrictStr], Field(description="Opaque pagination cursor returned from a previous response (`pagination.next_cursor`). Treat it as an unreadable token; do not attempt to parse or construct it. ")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """List prompts
+
+        List prompts the user has access to.  The prompts are sorted by update date, with the most recently updated prompts coming first.  <Warning>This endpoint is in alpha, read more [here](https://arize.com/docs/ax/rest-reference#api-version-stages).</Warning> 
+
+        :param space_id: Filter search results to a particular space ID
+        :type space_id: str
+        :param limit: Maximum items to return
+        :type limit: int
+        :param cursor: Opaque pagination cursor returned from a previous response (`pagination.next_cursor`). Treat it as an unreadable token; do not attempt to parse or construct it. 
+        :type cursor: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._prompts_list_serialize(
+            space_id=space_id,
+            limit=limit,
+            cursor=cursor,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "PromptsList200Response",
+            '400': "Problem",
+            '401': "Problem",
+            '403': "Problem",
+            '429': "Problem",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _prompts_list_serialize(
+        self,
+        space_id,
+        limit,
+        cursor,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        if space_id is not None:
+            
+            _query_params.append(('space_id', space_id))
+            
+        if limit is not None:
+            
+            _query_params.append(('limit', limit))
+            
+        if cursor is not None:
+            
+            _query_params.append(('cursor', cursor))
+            
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json', 
+                    'application/problem+json'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'bearerAuth'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/v2/prompts',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+

{arize-8.0.0b4 → arize-8.0.2}/src/arize/_generated/api_client/models/__init__.py

@@ -33,4 +33,6 @@ 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
+from arize._generated.api_client.models.prompt import Prompt
+from arize._generated.api_client.models.prompts_list200_response import PromptsList200Response
 

arize-8.0.2/src/arize/_generated/api_client/models/prompt.py

@@ -0,0 +1,112 @@
+# 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, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Prompt(BaseModel):
+    """
+    A prompt is a reusable template for LLM interactions. Prompts can be versioned and labeled to track changes over time. Use prompts to standardize how you interact with LLMs across your application. 
+    """ # noqa: E501
+    id: StrictStr = Field(description="The prompt ID")
+    name: StrictStr = Field(description="The prompt name")
+    description: Optional[StrictStr] = Field(default=None, description="The prompt description")
+    space_id: StrictStr = Field(description="The space ID the prompt belongs to")
+    created_at: datetime = Field(description="When the prompt was created")
+    updated_at: datetime = Field(description="When the prompt was last updated")
+    created_by_user_id: StrictStr = Field(description="The user ID of the user who created the prompt")
+    tags: Optional[List[StrictStr]] = Field(default=None, description="The tags associated with the prompt")
+    __properties: ClassVar[List[str]] = ["id", "name", "description", "space_id", "created_at", "updated_at", "created_by_user_id", "tags"]
+
+    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 Prompt 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,
+        )
+        # set to None if description (nullable) is None
+        # and model_fields_set contains the field
+        if self.description is None and "description" in self.model_fields_set:
+            _dict['description'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Prompt 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 Prompt) in the input: " + _key)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "name": obj.get("name"),
+            "description": obj.get("description"),
+            "space_id": obj.get("space_id"),
+            "created_at": obj.get("created_at"),
+            "updated_at": obj.get("updated_at"),
+            "created_by_user_id": obj.get("created_by_user_id"),
+            "tags": obj.get("tags")
+        })
+        return _obj
+
+