truefoundry 0.5.10rc1__py3-none-any.whl → 0.5.11rc1__py3-none-any.whl

truefoundry/ml/{autogen/client/models/artifact_version_manifest.py → _autogen/client/models/artifact_manifest.py}

@@ -1,11 +1,11 @@
 # coding: utf-8
 
 """
-FastAPI
+TrueFoundry ML API
 
 No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 0.1.0
+The version of the OpenAPI document: 1.0.0
 Generated by OpenAPI Generator (https://openapi-generator.tech)
 
 Do not edit the class manually.
@@ -18,7 +18,7 @@ import pprint
 import re  # noqa: F401
 from typing import Any, Dict, Optional
 
-from truefoundry.ml.autogen.client.models.source import Source
+from truefoundry.ml._autogen.client.models.source import Source
 from truefoundry.pydantic_v1 import (
     BaseModel,
     Field,
@@ -29,67 +29,73 @@ from truefoundry.pydantic_v1 import (
 )
 
 
-class ArtifactVersionManifest(BaseModel):
+class ArtifactManifest(BaseModel):
     """
     Artifact Version manifest.  # noqa: E501
     """
 
-    description: Optional[constr(strict=True, max_length=512)] = Field(
-        default=None, description="+sort=2 +label=Description"
+    name: Optional[constr(strict=True, max_length=256)] = Field(
+        default=None, description="Name of the entity"
     )
+    description: Optional[constr(strict=True, max_length=512)] = None
     metadata: Dict[str, Any] = Field(
         default=...,
-        description="+label=Metadata +docs=Key value pairs to store additional metadata +usage=Key value pairs to store additional metadata +uiType=JsonInput",
+        description='Key value metadata. Should be valid JSON. For e.g. `{"business-unit": "sales", "quality": "good", "rating": 4.5}`',
     )
     version_alias: Optional[constr(strict=True, max_length=128)] = Field(
         default=None,
-        description="+label=Version Alias +usage=The version alias should start with 'v' followed by alphanumeric and it can include '.' and '-' in between (e.g. v1.0.0, v1-prod, v3-dev, etc) +docs=The version alias should start with 'v' followed by alphanumeric and it can include '.' and '-' in between (e.g. v1.0.0, v1-prod, v3-dev, etc) +message=The version alias should start with 'v' followed by alphanumeric and it can include '.' and '-' in between (e.g. v1.0.0, v1-prod, v3-dev, etc)",
-    )
-    name: Optional[constr(strict=True, max_length=256)] = Field(
-        default=None,
-        description="+sort=1 +label=Name +message=The name should start with lowercase alphabets  and can contain alphanumeric and can include '-' in between",
+        description="Version alias is alternate, ideally human readable, version string to reference an artifact version. It should start with `v` followed by alphanumeric and it can include `.` and `-` in between (e.g. `v1.0.0`, `v1-prod`, `v3-dev`, etc)",
     )
     ml_repo: Optional[constr(strict=True)] = Field(
-        default=None,
-        description="+label=ML Repo +usage=name of the ML Repo +docs=name of the ML Repo +uiType=Hidden",
+        default=None, description="Name of the ML Repo"
+    )
+    version: Optional[conint(strict=True, ge=1)] = Field(
+        default=None, description="Version of the entity"
     )
     type: Optional[StrictStr] = "artifact-version"
     source: Source = Field(...)
     step: Optional[conint(strict=True, ge=0)] = Field(
-        default=0, description="+label=Step"
+        default=0,
+        description="Step/Epoch number in an iterative training loop the artifact version was created. Generally useful when logging a model version from a MLRepo Run",
+    )
+    run_id: Optional[StrictStr] = Field(
+        default=None,
+        description="ID of the MLRepo Run that generated the artifact version",
     )
     __properties = [
+        "name",
         "description",
         "metadata",
         "version_alias",
-        "name",
         "ml_repo",
+        "version",
         "type",
         "source",
         "step",
+        "run_id",
     ]
 
-    @validator("version_alias")
-    def version_alias_validate_regular_expression(cls, value):
+    @validator("name")
+    def name_validate_regular_expression(cls, value):
         """Validates the regular expression"""
         if value is None:
             return value
 
-        if not re.match(r"^v[a-zA-Z0-9.-]*([a-zA-Z0-9]+)$", value):
+        if not re.match(r"^[A-Za-z0-9_\-]+$", value):
             raise ValueError(
-                r"must validate the regular expression /^v[a-zA-Z0-9.-]*([a-zA-Z0-9]+)$/"
+                r"must validate the regular expression /^[A-Za-z0-9_\-]+$/"
             )
         return value
 
-    @validator("name")
-    def name_validate_regular_expression(cls, value):
+    @validator("version_alias")
+    def version_alias_validate_regular_expression(cls, value):
         """Validates the regular expression"""
         if value is None:
             return value
 
-        if not re.match(r"^[A-Za-z0-9_\-]+$", value):
+        if not re.match(r"^v[a-zA-Z0-9.-]*([a-zA-Z0-9]+)$", value):
             raise ValueError(
-                r"must validate the regular expression /^[A-Za-z0-9_\-]+$/"
+                r"must validate the regular expression /^v[a-zA-Z0-9.-]*([a-zA-Z0-9]+)$/"
             )
         return value
 
@@ -130,8 +136,8 @@ class ArtifactVersionManifest(BaseModel):
         return json.dumps(self.to_dict())
 
     @classmethod
-    def from_json(cls, json_str: str) -> ArtifactVersionManifest:
-        """Create an instance of ArtifactVersionManifest from a JSON string"""
+    def from_json(cls, json_str: str) -> ArtifactManifest:
+        """Create an instance of ArtifactManifest from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self):
@@ -143,21 +149,22 @@ class ArtifactVersionManifest(BaseModel):
         return _dict
 
     @classmethod
-    def from_dict(cls, obj: dict) -> ArtifactVersionManifest:
-        """Create an instance of ArtifactVersionManifest from a dict"""
+    def from_dict(cls, obj: dict) -> ArtifactManifest:
+        """Create an instance of ArtifactManifest from a dict"""
         if obj is None:
             return None
 
         if not isinstance(obj, dict):
-            return ArtifactVersionManifest.parse_obj(obj)
+            return ArtifactManifest.parse_obj(obj)
 
-        _obj = ArtifactVersionManifest.parse_obj(
+        _obj = ArtifactManifest.parse_obj(
             {
+                "name": obj.get("name"),
                 "description": obj.get("description"),
                 "metadata": obj.get("metadata"),
                 "version_alias": obj.get("version_alias"),
-                "name": obj.get("name"),
                 "ml_repo": obj.get("ml_repo"),
+                "version": obj.get("version"),
                 "type": obj.get("type")
                 if obj.get("type") is not None
                 else "artifact-version",
@@ -165,6 +172,7 @@ class ArtifactVersionManifest(BaseModel):
                 if obj.get("source") is not None
                 else None,
                 "step": obj.get("step") if obj.get("step") is not None else 0,
+                "run_id": obj.get("run_id"),
             }
         )
         return _obj

truefoundry/ml/_autogen/client/models/artifact_path.py

@@ -0,0 +1,70 @@
+# coding: utf-8
+
+"""
+TrueFoundry ML API
+
+No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.0.0
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+
+import json
+import pprint
+import re  # noqa: F401
+from typing import Optional
+
+from truefoundry.pydantic_v1 import BaseModel, Field, StrictStr
+
+
+class ArtifactPath(BaseModel):
+    """
+    ArtifactPath
+    """
+
+    src: StrictStr = Field(default=..., description="Local file or folder path")
+    dest: Optional[StrictStr] = Field(
+        default=None,
+        description="Relative path where the file or folder will be uploaded to in the artifact",
+    )
+    __properties = ["src", "dest"]
+
+    class Config:
+        """Pydantic configuration"""
+
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.dict(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> ArtifactPath:
+        """Create an instance of ArtifactPath from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True, exclude={}, exclude_none=True)
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> ArtifactPath:
+        """Create an instance of ArtifactPath from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return ArtifactPath.parse_obj(obj)
+
+        _obj = ArtifactPath.parse_obj({"src": obj.get("src"), "dest": obj.get("dest")})
+        return _obj

truefoundry/ml/{autogen → _autogen}/client/models/artifact_response_dto.py

@@ -1,11 +1,11 @@
 # coding: utf-8
 
 """
-FastAPI
+TrueFoundry ML API
 
 No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 0.1.0
+The version of the OpenAPI document: 1.0.0
 Generated by OpenAPI Generator (https://openapi-generator.tech)
 
 Do not edit the class manually.
@@ -17,7 +17,7 @@ import json
 import pprint
 import re  # noqa: F401
 
-from truefoundry.ml.autogen.client.models.artifact_dto import ArtifactDto
+from truefoundry.ml._autogen.client.models.artifact_dto import ArtifactDto
 from truefoundry.pydantic_v1 import BaseModel, Field
 
 

truefoundry/ml/{autogen → _autogen}/client/models/artifact_type.py

@@ -1,11 +1,11 @@
 # coding: utf-8
 
 """
-FastAPI
+TrueFoundry ML API
 
 No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 0.1.0
+The version of the OpenAPI document: 1.0.0
 Generated by OpenAPI Generator (https://openapi-generator.tech)
 
 Do not edit the class manually.
@@ -30,7 +30,7 @@ class ArtifactType(str, Enum):
     PLOT = "plot"
     IMAGE = "image"
     CHAT_PROMPT = "chat_prompt"
-    OPENAPI_TOOL = "openapi_tool"
+    OPENAPI_MINUS_TOOL = "openapi-tool"
     AGENT = "agent"
 
     @classmethod

truefoundry/ml/{autogen → _autogen}/client/models/artifact_version_dto.py

@@ -1,11 +1,11 @@
 # coding: utf-8
 
 """
-FastAPI
+TrueFoundry ML API
 
 No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 0.1.0
+The version of the OpenAPI document: 1.0.0
 Generated by OpenAPI Generator (https://openapi-generator.tech)
 
 Do not edit the class manually.
@@ -19,15 +19,14 @@ import re  # noqa: F401
 from datetime import datetime
 from typing import Any, Dict, Optional
 
-from truefoundry.ml.autogen.client.models.artifact_version_serialization_format import (
+from truefoundry.ml._autogen.client.models.artifact_version_serialization_format import (
     ArtifactVersionSerializationFormat,
 )
-from truefoundry.ml.autogen.client.models.artifact_version_status import (
+from truefoundry.ml._autogen.client.models.artifact_version_status import (
     ArtifactVersionStatus,
 )
-from truefoundry.ml.autogen.client.models.internal_metadata import InternalMetadata
-from truefoundry.ml.autogen.client.models.manifest import Manifest
-from truefoundry.ml.autogen.client.models.subject import Subject
+from truefoundry.ml._autogen.client.models.manifest1 import Manifest1
+from truefoundry.ml._autogen.client.models.subject import Subject
 from truefoundry.pydantic_v1 import BaseModel, Field, StrictInt, StrictStr
 
 
@@ -55,9 +54,9 @@ class ArtifactVersionDto(BaseModel):
     usage_code_snippet: Optional[StrictStr] = None
     run_id: Optional[StrictStr] = None
     artifact_name: Optional[StrictStr] = None
-    internal_metadata: Optional[InternalMetadata] = None
+    internal_metadata: Optional[Dict[str, Any]] = None
     artifact_size: Optional[StrictInt] = None
-    manifest: Optional[Manifest] = None
+    manifest: Optional[Manifest1] = None
     serialization_format: ArtifactVersionSerializationFormat = Field(...)
     __properties = [
         "id",
@@ -110,9 +109,6 @@ class ArtifactVersionDto(BaseModel):
         # override the default output from truefoundry.pydantic_v1 by calling `to_dict()` of created_by_subject
         if self.created_by_subject:
             _dict["created_by_subject"] = self.created_by_subject.to_dict()
-        # override the default output from truefoundry.pydantic_v1 by calling `to_dict()` of internal_metadata
-        if self.internal_metadata:
-            _dict["internal_metadata"] = self.internal_metadata.to_dict()
         # override the default output from truefoundry.pydantic_v1 by calling `to_dict()` of manifest
         if self.manifest:
             _dict["manifest"] = self.manifest.to_dict()
@@ -150,13 +146,9 @@ class ArtifactVersionDto(BaseModel):
                 "usage_code_snippet": obj.get("usage_code_snippet"),
                 "run_id": obj.get("run_id"),
                 "artifact_name": obj.get("artifact_name"),
-                "internal_metadata": InternalMetadata.from_dict(
-                    obj.get("internal_metadata")
-                )
-                if obj.get("internal_metadata") is not None
-                else None,
+                "internal_metadata": obj.get("internal_metadata"),
                 "artifact_size": obj.get("artifact_size"),
-                "manifest": Manifest.from_dict(obj.get("manifest"))
+                "manifest": Manifest1.from_dict(obj.get("manifest"))
                 if obj.get("manifest") is not None
                 else None,
                 "serialization_format": obj.get("serialization_format"),

truefoundry/ml/{autogen → _autogen}/client/models/artifact_version_response_dto.py

@@ -1,11 +1,11 @@
 # coding: utf-8
 
 """
-FastAPI
+TrueFoundry ML API
 
 No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 0.1.0
+The version of the OpenAPI document: 1.0.0
 Generated by OpenAPI Generator (https://openapi-generator.tech)
 
 Do not edit the class manually.
@@ -17,7 +17,9 @@ import json
 import pprint
 import re  # noqa: F401
 
-from truefoundry.ml.autogen.client.models.artifact_version_dto import ArtifactVersionDto
+from truefoundry.ml._autogen.client.models.artifact_version_dto import (
+    ArtifactVersionDto,
+)
 from truefoundry.pydantic_v1 import BaseModel, Field
 
 

truefoundry/ml/{autogen → _autogen}/client/models/artifact_version_serialization_format.py

@@ -1,11 +1,11 @@
 # coding: utf-8
 
 """
-FastAPI
+TrueFoundry ML API
 
 No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 0.1.0
+The version of the OpenAPI document: 1.0.0
 Generated by OpenAPI Generator (https://openapi-generator.tech)
 
 Do not edit the class manually.

truefoundry/ml/{autogen → _autogen}/client/models/artifact_version_status.py

@@ -1,11 +1,11 @@
 # coding: utf-8
 
 """
-FastAPI
+TrueFoundry ML API
 
 No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 0.1.0
+The version of the OpenAPI document: 1.0.0
 Generated by OpenAPI Generator (https://openapi-generator.tech)
 
 Do not edit the class manually.

truefoundry/ml/{autogen → _autogen}/client/models/assistant_message.py

@@ -1,11 +1,11 @@
 # coding: utf-8
 
 """
-FastAPI
+TrueFoundry ML API
 
 No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 0.1.0
+The version of the OpenAPI document: 1.0.0
 Generated by OpenAPI Generator (https://openapi-generator.tech)
 
 Do not edit the class manually.
@@ -18,19 +18,19 @@ import pprint
 import re  # noqa: F401
 from typing import Optional
 
-from truefoundry.ml.autogen.client.models.content import Content
+from truefoundry.ml._autogen.client.models.content import Content
 from truefoundry.pydantic_v1 import BaseModel, Field, StrictStr, validator
 
 
 class AssistantMessage(BaseModel):
     """
-    +usage=Assistant message +docs=Defines the structure of an assistant message, including role and content +label=Assistant Message  # noqa: E501
+    Assistant message turn  # noqa: E501
     """
 
-    role: StrictStr = Field(...)
+    role: StrictStr = Field(default=..., description="Role of the message")
     content: Content = Field(...)
     name: Optional[StrictStr] = Field(
-        default=None, description="+label=Name +usage=Name of the assistant message"
+        default=None, description="Name of the assistant this message is from"
     )
     __properties = ["role", "content", "name"]
 

truefoundry/ml/{autogen → _autogen}/client/models/authorize_user_for_model_request_dto.py

@@ -1,11 +1,11 @@
 # coding: utf-8
 
 """
-FastAPI
+TrueFoundry ML API
 
 No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 0.1.0
+The version of the OpenAPI document: 1.0.0
 Generated by OpenAPI Generator (https://openapi-generator.tech)
 
 Do not edit the class manually.

truefoundry/ml/{autogen → _autogen}/client/models/authorize_user_for_model_version_request_dto.py

@@ -1,11 +1,11 @@
 # coding: utf-8
 
 """
-FastAPI
+TrueFoundry ML API
 
 No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 0.1.0
+The version of the OpenAPI document: 1.0.0
 Generated by OpenAPI Generator (https://openapi-generator.tech)
 
 Do not edit the class manually.

truefoundry/ml/{autogen → _autogen}/client/models/blob_storage_reference.py

@@ -1,11 +1,11 @@
 # coding: utf-8
 
 """
-FastAPI
+TrueFoundry ML API
 
 No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 0.1.0
+The version of the OpenAPI document: 1.0.0
 Generated by OpenAPI Generator (https://openapi-generator.tech)
 
 Do not edit the class manually.
@@ -17,23 +17,20 @@ import json
 import pprint
 import re  # noqa: F401
 
-from truefoundry.ml.autogen.client.models.mime_type import MimeType
+from truefoundry.ml._autogen.client.models.mime_type import MimeType
 from truefoundry.pydantic_v1 import BaseModel, Field, StrictStr, constr, validator
 
 
 class BlobStorageReference(BaseModel):
     """
-    +usage=Blob Storage Location +label=Blob Storage Location +docs=Defines the structure for blob storage content references, including type, path, and mime_type  # noqa: E501
+    A reference to content offloaded to blob storage  # noqa: E501
     """
 
     type: StrictStr = Field(...)
     path: constr(strict=True) = Field(
-        default=...,
-        description="+label=Path +usage=Path to the content in blob storage",
-    )
-    mime_type: MimeType = Field(
-        default=..., description="+label=MIME Type +usage=MIME type of the content"
+        default=..., description="Path to the content in blob storage"
     )
+    mime_type: MimeType = Field(default=..., description="MIME type of the content")
     __properties = ["type", "path", "mime_type"]
 
     @validator("type")

truefoundry/ml/{autogen → _autogen}/client/models/body_get_search_runs_get.py

@@ -1,11 +1,11 @@
 # coding: utf-8
 
 """
-FastAPI
+TrueFoundry ML API
 
 No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 0.1.0
+The version of the OpenAPI document: 1.0.0
 Generated by OpenAPI Generator (https://openapi-generator.tech)
 
 Do not edit the class manually.