rapidata 2.33.2__py3-none-any.whl → 2.34.0__py3-none-any.whl

rapidata/api_client/api/prompt_api.py

@@ -0,0 +1,320 @@
+# coding: utf-8
+
+"""
+    Rapidata.Dataset
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: v1
+    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 StrictStr
+from typing import Optional
+from rapidata.api_client.models.update_prompt_tags_model import UpdatePromptTagsModel
+
+from rapidata.api_client.api_client import ApiClient, RequestSerialized
+from rapidata.api_client.api_response import ApiResponse
+from rapidata.api_client.rest import RESTResponseType
+
+
+class PromptApi:
+    """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 benchmark_prompt_prompt_id_tags_put(
+        self,
+        prompt_id: StrictStr,
+        update_prompt_tags_model: Optional[UpdatePromptTagsModel] = 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,
+    ) -> None:
+        """Updates the tags associated with a prompt.
+
+
+        :param prompt_id:  (required)
+        :type prompt_id: str
+        :param update_prompt_tags_model: 
+        :type update_prompt_tags_model: UpdatePromptTagsModel
+        :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._benchmark_prompt_prompt_id_tags_put_serialize(
+            prompt_id=prompt_id,
+            update_prompt_tags_model=update_prompt_tags_model,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '204': None,
+        }
+        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 benchmark_prompt_prompt_id_tags_put_with_http_info(
+        self,
+        prompt_id: StrictStr,
+        update_prompt_tags_model: Optional[UpdatePromptTagsModel] = 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[None]:
+        """Updates the tags associated with a prompt.
+
+
+        :param prompt_id:  (required)
+        :type prompt_id: str
+        :param update_prompt_tags_model: 
+        :type update_prompt_tags_model: UpdatePromptTagsModel
+        :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._benchmark_prompt_prompt_id_tags_put_serialize(
+            prompt_id=prompt_id,
+            update_prompt_tags_model=update_prompt_tags_model,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '204': None,
+        }
+        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 benchmark_prompt_prompt_id_tags_put_without_preload_content(
+        self,
+        prompt_id: StrictStr,
+        update_prompt_tags_model: Optional[UpdatePromptTagsModel] = 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:
+        """Updates the tags associated with a prompt.
+
+
+        :param prompt_id:  (required)
+        :type prompt_id: str
+        :param update_prompt_tags_model: 
+        :type update_prompt_tags_model: UpdatePromptTagsModel
+        :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._benchmark_prompt_prompt_id_tags_put_serialize(
+            prompt_id=prompt_id,
+            update_prompt_tags_model=update_prompt_tags_model,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '204': None,
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _benchmark_prompt_prompt_id_tags_put_serialize(
+        self,
+        prompt_id,
+        update_prompt_tags_model,
+        _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
+        if prompt_id is not None:
+            _path_params['promptId'] = prompt_id
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+        if update_prompt_tags_model is not None:
+            _body_params = update_prompt_tags_model
+
+
+
+        # set the HTTP header `Content-Type`
+        if _content_type:
+            _header_params['Content-Type'] = _content_type
+        else:
+            _default_content_type = (
+                self.api_client.select_header_content_type(
+                    [
+                        'application/json', 
+                        'text/json', 
+                        'application/*+json'
+                    ]
+                )
+            )
+            if _default_content_type is not None:
+                _header_params['Content-Type'] = _default_content_type
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'bearer', 
+            'oauth2'
+        ]
+
+        return self.api_client.param_serialize(
+            method='PUT',
+            resource_path='/benchmark-prompt/{promptId}/tags',
+            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
+        )
+
+

rapidata/api_client/api/validation_set_api.py

@@ -3186,7 +3186,7 @@ class ValidationSetApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> None:
-        """(Deprecated) Updates the dimensions of all rapids within a validation set.
+        """(Deprecated) Updates the  of all rapshouldAlert property of all rapids within a validation set.
 
 
         :param validation_set_id: The Id of the validation set to update the dimensions for. (required)
@@ -3257,7 +3257,7 @@ class ValidationSetApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> ApiResponse[None]:
-        """(Deprecated) Updates the dimensions of all rapids within a validation set.
+        """(Deprecated) Updates the  of all rapshouldAlert property of all rapids within a validation set.
 
 
         :param validation_set_id: The Id of the validation set to update the dimensions for. (required)
@@ -3328,7 +3328,7 @@ class ValidationSetApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> RESTResponseType:
-        """(Deprecated) Updates the dimensions of all rapids within a validation set.
+        """(Deprecated) Updates the  of all rapshouldAlert property of all rapids within a validation set.
 
 
         :param validation_set_id: The Id of the validation set to update the dimensions for. (required)

rapidata/api_client/models/__init__.py

@@ -331,6 +331,7 @@ from rapidata.api_client.models.source_url_metadata_model import SourceUrlMetada
 from rapidata.api_client.models.standing_by_leaderboard import StandingByLeaderboard
 from rapidata.api_client.models.standing_by_leaderboard_paged_result import StandingByLeaderboardPagedResult
 from rapidata.api_client.models.standing_status import StandingStatus
+from rapidata.api_client.models.standings_by_leaderboard_result import StandingsByLeaderboardResult
 from rapidata.api_client.models.static_selection import StaticSelection
 from rapidata.api_client.models.sticky_state import StickyState
 from rapidata.api_client.models.stream_file_wrapper import StreamFileWrapper
@@ -342,6 +343,7 @@ from rapidata.api_client.models.submit_order_model import SubmitOrderModel
 from rapidata.api_client.models.submit_participant_result import SubmitParticipantResult
 from rapidata.api_client.models.submit_prompt_model import SubmitPromptModel
 from rapidata.api_client.models.submit_prompt_model_prompt_asset import SubmitPromptModelPromptAsset
+from rapidata.api_client.models.tags_by_benchmark_result import TagsByBenchmarkResult
 from rapidata.api_client.models.text_asset import TextAsset
 from rapidata.api_client.models.text_asset_input import TextAssetInput
 from rapidata.api_client.models.text_asset_model import TextAssetModel
@@ -365,6 +367,7 @@ from rapidata.api_client.models.update_dimensions_model import UpdateDimensionsM
 from rapidata.api_client.models.update_leaderboard_name_model import UpdateLeaderboardNameModel
 from rapidata.api_client.models.update_order_name_model import UpdateOrderNameModel
 from rapidata.api_client.models.update_participant_name_model import UpdateParticipantNameModel
+from rapidata.api_client.models.update_prompt_tags_model import UpdatePromptTagsModel
 from rapidata.api_client.models.update_should_alert_model import UpdateShouldAlertModel
 from rapidata.api_client.models.update_validation_rapid_model import UpdateValidationRapidModel
 from rapidata.api_client.models.update_validation_rapid_model_truth import UpdateValidationRapidModelTruth

rapidata/api_client/models/conditional_validation_selection.py

@@ -31,7 +31,8 @@ class ConditionalValidationSelection(BaseModel):
     validation_set_id: StrictStr = Field(alias="validationSetId")
     validation_chances: List[ValidationChance] = Field(alias="validationChances")
     dimension: Optional[StrictStr] = None
-    __properties: ClassVar[List[str]] = ["_t", "validationSetId", "validationChances", "dimension"]
+    dimensions: Optional[List[StrictStr]] = None
+    __properties: ClassVar[List[str]] = ["_t", "validationSetId", "validationChances", "dimension", "dimensions"]
 
     @field_validator('t')
     def t_validate_enum(cls, value):
@@ -106,7 +107,8 @@ class ConditionalValidationSelection(BaseModel):
             "_t": obj.get("_t") if obj.get("_t") is not None else 'ConditionalValidationSelection',
             "validationSetId": obj.get("validationSetId"),
             "validationChances": [ValidationChance.from_dict(_item) for _item in obj["validationChances"]] if obj.get("validationChances") is not None else None,
-            "dimension": obj.get("dimension")
+            "dimension": obj.get("dimension"),
+            "dimensions": obj.get("dimensions")
         })
         return _obj
 

rapidata/api_client/models/create_leaderboard_model.py

@@ -35,7 +35,8 @@ class CreateLeaderboardModel(BaseModel):
     response_budget: Optional[StrictInt] = Field(default=None, description="Total amount of responses that get collected per run", alias="responseBudget")
     min_responses: Optional[StrictInt] = Field(default=None, description="The minimum amount of responses that need to be collected per comparison.", alias="minResponses")
     is_inversed: Optional[StrictBool] = Field(default=None, description="If the results should be inversed, meaning people should select the worse model.", alias="isInversed")
-    __properties: ClassVar[List[str]] = ["benchmarkId", "benchmarkName", "name", "instruction", "showPrompt", "showPromptAsset", "responseBudget", "minResponses", "isInversed"]
+    validation_set_id: Optional[StrictStr] = Field(default=None, description="The Validation set that should be attached to every run.", alias="validationSetId")
+    __properties: ClassVar[List[str]] = ["benchmarkId", "benchmarkName", "name", "instruction", "showPrompt", "showPromptAsset", "responseBudget", "minResponses", "isInversed", "validationSetId"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -86,6 +87,11 @@ class CreateLeaderboardModel(BaseModel):
         if self.benchmark_name is None and "benchmark_name" in self.model_fields_set:
             _dict['benchmarkName'] = None
 
+        # set to None if validation_set_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.validation_set_id is None and "validation_set_id" in self.model_fields_set:
+            _dict['validationSetId'] = None
+
         return _dict
 
     @classmethod
@@ -106,7 +112,8 @@ class CreateLeaderboardModel(BaseModel):
             "showPromptAsset": obj.get("showPromptAsset"),
             "responseBudget": obj.get("responseBudget"),
             "minResponses": obj.get("minResponses"),
-            "isInversed": obj.get("isInversed")
+            "isInversed": obj.get("isInversed"),
+            "validationSetId": obj.get("validationSetId")
         })
         return _obj
 

rapidata/api_client/models/get_standing_by_id_result.py

@@ -17,8 +17,8 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr, field_validator
-from typing import Any, ClassVar, Dict, List, Optional, Union
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -32,10 +32,7 @@ class GetStandingByIdResult(BaseModel):
     dataset_id: StrictStr = Field(alias="datasetId")
     status: StrictStr
     is_disabled: StrictBool = Field(alias="isDisabled")
-    score: Optional[Union[StrictFloat, StrictInt]] = None
-    wins: StrictInt
-    total_matches: StrictInt = Field(alias="totalMatches")
-    __properties: ClassVar[List[str]] = ["id", "name", "benchmarkId", "datasetId", "status", "isDisabled", "score", "wins", "totalMatches"]
+    __properties: ClassVar[List[str]] = ["id", "name", "benchmarkId", "datasetId", "status", "isDisabled"]
 
     @field_validator('status')
     def status_validate_enum(cls, value):
@@ -83,11 +80,6 @@ class GetStandingByIdResult(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
-        # set to None if score (nullable) is None
-        # and model_fields_set contains the field
-        if self.score is None and "score" in self.model_fields_set:
-            _dict['score'] = None
-
         return _dict
 
     @classmethod
@@ -105,10 +97,7 @@ class GetStandingByIdResult(BaseModel):
             "benchmarkId": obj.get("benchmarkId"),
             "datasetId": obj.get("datasetId"),
             "status": obj.get("status"),
-            "isDisabled": obj.get("isDisabled"),
-            "score": obj.get("score"),
-            "wins": obj.get("wins"),
-            "totalMatches": obj.get("totalMatches")
+            "isDisabled": obj.get("isDisabled")
         })
         return _obj
 

rapidata/api_client/models/prompt_by_benchmark_result.py

@@ -28,12 +28,13 @@ class PromptByBenchmarkResult(BaseModel):
     """
     PromptByBenchmarkResult
     """ # noqa: E501
+    id: StrictStr
     prompt: Optional[StrictStr] = None
     prompt_asset: Optional[GetValidationRapidsResultAsset] = Field(default=None, alias="promptAsset")
     identifier: StrictStr
     created_at: datetime = Field(alias="createdAt")
     tags: List[StrictStr]
-    __properties: ClassVar[List[str]] = ["prompt", "promptAsset", "identifier", "createdAt", "tags"]
+    __properties: ClassVar[List[str]] = ["id", "prompt", "promptAsset", "identifier", "createdAt", "tags"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -99,6 +100,7 @@ class PromptByBenchmarkResult(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
+            "id": obj.get("id"),
             "prompt": obj.get("prompt"),
             "promptAsset": GetValidationRapidsResultAsset.from_dict(obj["promptAsset"]) if obj.get("promptAsset") is not None else None,
             "identifier": obj.get("identifier"),

rapidata/api_client/models/standing_by_leaderboard.py

@@ -29,7 +29,7 @@ class StandingByLeaderboard(BaseModel):
     id: StrictStr
     name: StrictStr
     leaderboard_id: StrictStr = Field(alias="leaderboardId")
-    dataset_id: StrictStr = Field(alias="datasetId")
+    dataset_id: Optional[StrictStr] = Field(default=None, alias="datasetId")
     status: StrictStr
     score: Optional[Union[StrictFloat, StrictInt]] = None
     wins: StrictInt

rapidata/api_client/models/standings_by_leaderboard_result.py

@@ -0,0 +1,95 @@
+# coding: utf-8
+
+"""
+    Rapidata.Dataset
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: v1
+    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
+from typing import Any, ClassVar, Dict, List
+from rapidata.api_client.models.standing_by_leaderboard import StandingByLeaderboard
+from typing import Optional, Set
+from typing_extensions import Self
+
+class StandingsByLeaderboardResult(BaseModel):
+    """
+    StandingsByLeaderboardResult
+    """ # noqa: E501
+    items: List[StandingByLeaderboard]
+    __properties: ClassVar[List[str]] = ["items"]
+
+    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 StandingsByLeaderboardResult 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 items (list)
+        _items = []
+        if self.items:
+            for _item_items in self.items:
+                if _item_items:
+                    _items.append(_item_items.to_dict())
+            _dict['items'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of StandingsByLeaderboardResult from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "items": [StandingByLeaderboard.from_dict(_item) for _item in obj["items"]] if obj.get("items") is not None else None
+        })
+        return _obj
+
+