truefoundry 0.4.1__tar.gz → 0.4.1rc1__tar.gz

{truefoundry-0.4.1 → truefoundry-0.4.1rc1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: truefoundry
-Version: 0.4.1
+Version: 0.4.1rc1
 Summary: Truefoundry CLI
 Author: Abhishek Choudhary
 Author-email: abhishek@truefoundry.com

{truefoundry-0.4.1 → truefoundry-0.4.1rc1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "truefoundry"
-version = "0.4.1"
+version = "0.4.1rc1"
 description = "Truefoundry CLI"
 authors = ["Abhishek Choudhary <abhishek@truefoundry.com>"]
 readme = "README.md"

{truefoundry-0.4.1 → truefoundry-0.4.1rc1}/truefoundry/ml/autogen/client/__init__.py

@@ -144,6 +144,9 @@ from truefoundry.ml.autogen.client.models.delete_artifact_versions_request_dto i
 from truefoundry.ml.autogen.client.models.delete_dataset_request_dto import (
     DeleteDatasetRequestDto,
 )
+from truefoundry.ml.autogen.client.models.delete_files_for_dataset_request_dto import (
+    DeleteFilesForDatasetRequestDto,
+)
 from truefoundry.ml.autogen.client.models.delete_model_version_request_dto import (
     DeleteModelVersionRequestDto,
 )

{truefoundry-0.4.1 → truefoundry-0.4.1rc1}/truefoundry/ml/autogen/client/api/mlfoundry_artifacts_api.py

@@ -73,6 +73,9 @@ from truefoundry.ml.autogen.client.models.delete_artifact_versions_request_dto i
 from truefoundry.ml.autogen.client.models.delete_dataset_request_dto import (
     DeleteDatasetRequestDto,
 )
+from truefoundry.ml.autogen.client.models.delete_files_for_dataset_request_dto import (
+    DeleteFilesForDatasetRequestDto,
+)
 from truefoundry.ml.autogen.client.models.delete_model_version_request_dto import (
     DeleteModelVersionRequestDto,
 )
@@ -2280,6 +2283,166 @@ class MlfoundryArtifactsApi:
             _request_auth=_params.get("_request_auth"),
         )
 
+    @validate_arguments
+    def delete_files_for_dataset_delete(
+        self,
+        delete_files_for_dataset_request_dto: DeleteFilesForDatasetRequestDto,
+        **kwargs,
+    ) -> object:  # noqa: E501
+        """Delete Files For Dataset  # noqa: E501
+
+        Delete files from the dataset.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.delete_files_for_dataset_delete(delete_files_for_dataset_request_dto, async_req=True)
+        >>> result = thread.get()
+
+        :param delete_files_for_dataset_request_dto: (required)
+        :type delete_files_for_dataset_request_dto: DeleteFilesForDatasetRequestDto
+        :param async_req: Whether to execute the request asynchronously.
+        :type async_req: bool, optional
+        :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.
+        :return: Returns the result object.
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: object
+        """
+        kwargs["_return_http_data_only"] = True
+        if "_preload_content" in kwargs:
+            message = "Error! Please call the delete_files_for_dataset_delete_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data"  # noqa: E501
+            raise ValueError(message)
+        return self.delete_files_for_dataset_delete_with_http_info(
+            delete_files_for_dataset_request_dto, **kwargs
+        )  # noqa: E501
+
+    @validate_arguments
+    def delete_files_for_dataset_delete_with_http_info(
+        self,
+        delete_files_for_dataset_request_dto: DeleteFilesForDatasetRequestDto,
+        **kwargs,
+    ) -> ApiResponse:  # noqa: E501
+        """Delete Files For Dataset  # noqa: E501
+
+        Delete files from the dataset.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.delete_files_for_dataset_delete_with_http_info(delete_files_for_dataset_request_dto, async_req=True)
+        >>> result = thread.get()
+
+        :param delete_files_for_dataset_request_dto: (required)
+        :type delete_files_for_dataset_request_dto: DeleteFilesForDatasetRequestDto
+        :param async_req: Whether to execute the request asynchronously.
+        :type async_req: bool, optional
+        :param _preload_content: if False, the ApiResponse.data will
+                                 be set to none and raw_data will store the
+                                 HTTP response body without reading/decoding.
+                                 Default is True.
+        :type _preload_content: bool, optional
+        :param _return_http_data_only: response data instead of ApiResponse
+                                       object with status code, headers, etc
+        :type _return_http_data_only: bool, optional
+        :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.
+        :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
+        :type _content_type: string, optional: force content-type for the request
+        :return: Returns the result object.
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: tuple(object, status_code(int), headers(HTTPHeaderDict))
+        """
+
+        _params = locals()
+
+        _all_params = ["delete_files_for_dataset_request_dto"]
+        _all_params.extend(
+            [
+                "async_req",
+                "_return_http_data_only",
+                "_preload_content",
+                "_request_timeout",
+                "_request_auth",
+                "_content_type",
+                "_headers",
+            ]
+        )
+
+        # validate the arguments
+        for _key, _val in _params["kwargs"].items():
+            if _key not in _all_params:
+                raise ApiTypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method delete_files_for_dataset_delete" % _key
+                )
+            _params[_key] = _val
+        del _params["kwargs"]
+
+        _collection_formats = {}
+
+        # process the path parameters
+        _path_params = {}
+
+        # process the query parameters
+        _query_params = []
+        # process the header parameters
+        _header_params = dict(_params.get("_headers", {}))
+        # process the form parameters
+        _form_params = []
+        _files = {}
+        # process the body parameter
+        _body_params = None
+        if _params["delete_files_for_dataset_request_dto"] is not None:
+            _body_params = _params["delete_files_for_dataset_request_dto"]
+
+        # set the HTTP header `Accept`
+        _header_params["Accept"] = self.api_client.select_header_accept(
+            ["application/json"]
+        )  # noqa: E501
+
+        # set the HTTP header `Content-Type`
+        _content_types_list = _params.get(
+            "_content_type",
+            self.api_client.select_header_content_type(["application/json"]),
+        )
+        if _content_types_list:
+            _header_params["Content-Type"] = _content_types_list
+
+        # authentication setting
+        _auth_settings = ["HTTPBearer", "APIKeyCookie"]  # noqa: E501
+
+        _response_types_map = {
+            "200": "object",
+            "422": "HTTPValidationError",
+        }
+
+        return self.api_client.call_api(
+            "/api/2.0/mlflow/mlfoundry-artifacts/datasets/files/",
+            "DELETE",
+            _path_params,
+            _query_params,
+            _header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            response_types_map=_response_types_map,
+            auth_settings=_auth_settings,
+            async_req=_params.get("async_req"),
+            _return_http_data_only=_params.get("_return_http_data_only"),  # noqa: E501
+            _preload_content=_params.get("_preload_content", True),
+            _request_timeout=_params.get("_request_timeout"),
+            collection_formats=_collection_formats,
+            _request_auth=_params.get("_request_auth"),
+        )
+
     @validate_arguments
     def delete_model_version_post(
         self, delete_model_version_request_dto: DeleteModelVersionRequestDto, **kwargs

{truefoundry-0.4.1 → truefoundry-0.4.1rc1}/truefoundry/ml/autogen/client/models/__init__.py

@@ -115,6 +115,9 @@ from truefoundry.ml.autogen.client.models.delete_artifact_versions_request_dto i
 from truefoundry.ml.autogen.client.models.delete_dataset_request_dto import (
     DeleteDatasetRequestDto,
 )
+from truefoundry.ml.autogen.client.models.delete_files_for_dataset_request_dto import (
+    DeleteFilesForDatasetRequestDto,
+)
 from truefoundry.ml.autogen.client.models.delete_model_version_request_dto import (
     DeleteModelVersionRequestDto,
 )

truefoundry-0.4.1rc1/truefoundry/ml/autogen/client/models/delete_files_for_dataset_request_dto.py

@@ -0,0 +1,68 @@
+# coding: utf-8
+
+"""
+FastAPI
+
+No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 0.1.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 truefoundry.pydantic_v1 import BaseModel, Field, StrictStr, conlist
+
+
+class DeleteFilesForDatasetRequestDto(BaseModel):
+    """
+    DeleteFilesForDatasetRequestDto
+    """
+
+    dataset_fqn: StrictStr = Field(...)
+    paths: conlist(StrictStr, max_items=100) = Field(...)
+    __properties = ["dataset_fqn", "paths"]
+
+    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) -> DeleteFilesForDatasetRequestDto:
+        """Create an instance of DeleteFilesForDatasetRequestDto 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) -> DeleteFilesForDatasetRequestDto:
+        """Create an instance of DeleteFilesForDatasetRequestDto from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return DeleteFilesForDatasetRequestDto.parse_obj(obj)
+
+        _obj = DeleteFilesForDatasetRequestDto.parse_obj(
+            {"dataset_fqn": obj.get("dataset_fqn"), "paths": obj.get("paths")}
+        )
+        return _obj

{truefoundry-0.4.1 → truefoundry-0.4.1rc1}/truefoundry/ml/autogen/client_README.md

@@ -98,6 +98,7 @@ Class | Method | HTTP request | Description
 *MlfoundryArtifactsApi* | [**delete_artifact_post**](truefoundry/ml/autogen/client/docs/MlfoundryArtifactsApi.md#delete_artifact_post) | **POST** /api/2.0/mlflow/mlfoundry-artifacts/artifact/delete | Delete Artifact
 *MlfoundryArtifactsApi* | [**delete_artifact_version_post**](truefoundry/ml/autogen/client/docs/MlfoundryArtifactsApi.md#delete_artifact_version_post) | **POST** /api/2.0/mlflow/mlfoundry-artifacts/artifact-versions/delete | Delete Artifact Version
 *MlfoundryArtifactsApi* | [**delete_dataset_post**](truefoundry/ml/autogen/client/docs/MlfoundryArtifactsApi.md#delete_dataset_post) | **POST** /api/2.0/mlflow/mlfoundry-artifacts/datasets/delete | Delete Dataset
+*MlfoundryArtifactsApi* | [**delete_files_for_dataset_delete**](truefoundry/ml/autogen/client/docs/MlfoundryArtifactsApi.md#delete_files_for_dataset_delete) | **DELETE** /api/2.0/mlflow/mlfoundry-artifacts/datasets/files/ | Delete Files For Dataset
 *MlfoundryArtifactsApi* | [**delete_model_version_post**](truefoundry/ml/autogen/client/docs/MlfoundryArtifactsApi.md#delete_model_version_post) | **POST** /api/2.0/mlflow/mlfoundry-artifacts/model-versions/delete | Delete Model Version
 *MlfoundryArtifactsApi* | [**finalize_artifact_version_post**](truefoundry/ml/autogen/client/docs/MlfoundryArtifactsApi.md#finalize_artifact_version_post) | **POST** /api/2.0/mlflow/mlfoundry-artifacts/artifact-versions/finalize | Finalize Artifact Version
 *MlfoundryArtifactsApi* | [**get_artifact_by_fqn_get**](truefoundry/ml/autogen/client/docs/MlfoundryArtifactsApi.md#get_artifact_by_fqn_get) | **GET** /api/2.0/mlflow/mlfoundry-artifacts/artifacts/get-by-fqn | Get Artifact By Fqn
@@ -197,6 +198,7 @@ Class | Method | HTTP request | Description
  - [DatasetResponseDto](truefoundry/ml/autogen/client/docs/DatasetResponseDto.md)
  - [DeleteArtifactVersionsRequestDto](truefoundry/ml/autogen/client/docs/DeleteArtifactVersionsRequestDto.md)
  - [DeleteDatasetRequestDto](truefoundry/ml/autogen/client/docs/DeleteDatasetRequestDto.md)
+ - [DeleteFilesForDatasetRequestDto](truefoundry/ml/autogen/client/docs/DeleteFilesForDatasetRequestDto.md)
  - [DeleteModelVersionRequestDto](truefoundry/ml/autogen/client/docs/DeleteModelVersionRequestDto.md)
  - [DeleteRunRequest](truefoundry/ml/autogen/client/docs/DeleteRunRequest.md)
  - [DeleteTagRequestDto](truefoundry/ml/autogen/client/docs/DeleteTagRequestDto.md)

truefoundry-0.4.1rc1/truefoundry/ml/autogen/entities/artifacts.py

@@ -0,0 +1,286 @@
+# generated by datamodel-codegen:
+#   filename:  artifacts.json
+#   timestamp: 2024-09-12T13:40:36+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import Any, Dict, List, Literal, Optional, Union
+
+from truefoundry.pydantic_v1 import BaseModel, Field, constr
+
+
+class Agent(BaseModel):
+    type: Literal["agent"] = Field(..., description="+value=agent")
+    name: constr(regex=r"^[a-zA-Z][a-zA-Z0-9\-]{1,30}[a-zA-Z0-9]$") = Field(
+        ..., description="Names cannot repeat accross agent\n+uiType=Hidden"
+    )
+    available_tools: List[constr(min_length=1)] = Field(
+        ..., description="+sort=30\n+uiType=Hidden"
+    )
+    goal: constr(min_length=1, max_length=128) = Field(
+        ..., description="+sort=10\n+uiType=TextArea"
+    )
+    instruction: constr(min_length=1, max_length=2620) = Field(
+        ...,
+        description='`instruction` is the system prompt for now. (2.5 * 1024)\n+sort=20\n+uiType=AgentInstructions\n+uiProps={"helpText":"Use the syntax ${Tool FQN} to reference a tool, and ${AGENT FQN} to reference another agent"}',
+    )
+    model_id: constr(min_length=1) = Field(
+        ...,
+        description='+sort=40\n+uiType=EnabledModelSelector\n+uiProps={"searchable":true,"modelType":"chat","providerType":"openai"}',
+    )
+
+
+class Method(str, Enum):
+    """
+    +sort=50
+    +uiType=Hidden
+    """
+
+    get = "get"
+    post = "post"
+    put = "put"
+    delete = "delete"
+    patch = "patch"
+
+
+class AgentWithFQN(Agent):
+    id: str
+    fqn: str
+
+
+class MimeType(str, Enum):
+    """
+    +label=MIME Type
+    +usage=MIME type of the content
+    """
+
+    text_plain = "text/plain"
+    application_json = "application/json"
+    image_png = "image/png"
+    image_jpeg = "image/jpeg"
+    application_x_directory = "application/x-directory"
+
+
+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
+    """
+
+    type: Literal["blob-storage"]
+    path: constr(regex=r"^.{1,}$") = Field(
+        ..., description="+label=Path\n+usage=Path to the content in blob storage"
+    )
+    mime_type: MimeType = Field(
+        ..., description="+label=MIME Type\n+usage=MIME type of the content"
+    )
+
+
+class ImageUrl(BaseModel):
+    """
+    +label=URL for the image
+    +usage=The URL for the image, must be a non-empty valid HTTPS URL or a data URL
+    """
+
+    url: Union[
+        constr(
+            regex=r"^\b((https?://)?(?:www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}(?:[-a-zA-Z0-9()@:%_\+.~#?&/=]*)|data:image/[a-zA-Z]+;base64,[a-zA-Z0-9+/=\s]+)$"
+        ),
+        BlobStorageReference,
+    ] = Field(
+        ...,
+        description="+label=URL for the image\n+usage=The URL for the image, must be a non-empty valid HTTPS URL or a data URL",
+    )
+
+
+class ImageContentPart(BaseModel):
+    """
+    +usage=Image URL
+    +label=Image URL
+    """
+
+    type: Literal["image_url"]
+    image_url: ImageUrl = Field(
+        ...,
+        description="+label=URL for the image\n+usage=The URL for the image, must be a non-empty valid HTTPS URL or a data URL",
+    )
+
+
+class Parameters(BaseModel):
+    """
+    +usage=Parameters for the provider
+    +label=Parameters
+    +docs=Key-value pairs to store additional parameters for the provider
+    """
+
+    max_tokens: Optional[int] = None
+    temperature: Optional[float] = None
+    top_k: Optional[float] = None
+    top_p: Optional[float] = None
+    stop: Optional[Union[List[str], str]] = None
+
+
+class ModelConfiguration(BaseModel):
+    """
+    +label=Model Configuration
+    +icon=fa-cogs:#326ce5
+    +message=Configuration details for the provider and corresponding config
+    +usage=Define the provider and its configuration
+    +docs=Configuration settings specific to the provider, including model settings and other parameters.
+    """
+
+    provider: str = Field(
+        ...,
+        description='+label=Provider Name\n+usage=Name of the provider, must be non-empty, e.g., "openai", "google_gemini"',
+    )
+    model: constr(regex=r"^[a-zA-Z][a-zA-Z0-9\-]{1,30}[a-zA-Z0-9]$") = Field(
+        ..., description="+label=Model name\n+usage=Model name, must be non-empty"
+    )
+    parameters: Optional[Parameters] = Field(
+        None,
+        description="+usage=Parameters for the provider\n+label=Parameters\n+docs=Key-value pairs to store additional parameters for the provider",
+    )
+    extra_parameters: Optional[Dict[str, Any]] = Field(
+        None,
+        description="+usage=Extra parameters for the provider\n+label=Extra Parameters\n+docs=Additional parameters for the provider",
+    )
+
+
+class SystemMessage(BaseModel):
+    """
+    +usage=System message
+    +docs=Defines the structure of a system message, including role and content
+    +label=System Message
+    """
+
+    role: Literal["system"]
+    content: Union[constr(regex=r"^.[\s\S]*$"), BlobStorageReference] = Field(
+        ..., description="+label=Content\n+usage=Text content for the system message"
+    )
+    name: Optional[str] = Field(
+        None, description="+label=Name\n+usage=Name of the system"
+    )
+
+
+class TextContentPart(BaseModel):
+    """
+    +usage=Text content
+    +label=Text content
+    """
+
+    type: Literal["text"]
+    text: Union[constr(regex=r"^.[\s\S]*$"), BlobStorageReference]
+
+
+class UserMessage(BaseModel):
+    """
+    +usage=User message
+    +docs=Defines the structure of a user message, including role and content
+    +label=User Message
+    """
+
+    role: Literal["user"]
+    content: Union[
+        constr(regex=r"^.[\s\S]*$"),
+        BlobStorageReference,
+        List[Union[TextContentPart, ImageContentPart]],
+    ] = Field(
+        ..., description="+label=Content\n+usage=Text content for the user message"
+    )
+    name: Optional[str] = Field(
+        None, description="+label=Name\n+usage=Name of the user message"
+    )
+
+
+class AgentOpenAPITool(BaseModel):
+    type: Literal["openapi-tool"] = Field(..., description="+value=openapi-tool")
+    name: constr(regex=r"^[a-zA-Z][a-zA-Z0-9\-]{1,30}[a-zA-Z0-9]$") = Field(
+        ..., description="Names cannot repeat accross tools\n+uiType=Hidden"
+    )
+    description: constr(min_length=1, max_length=128) = Field(
+        ..., description="+sort=10\n+uiType=TextArea"
+    )
+    openapi_spec: Union[BlobStorageReference, Dict[str, Any]] = Field(
+        ..., description="+sort=20\n+uiType=OpenapiSchema"
+    )
+    base_url: constr(
+        regex=r"^(https?://)?(?:www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}(?:[-a-zA-Z0-9()@:%_\+.~#?&/=]*)$"
+    ) = Field(..., description="+sort=30")
+    path: constr(min_length=1) = Field(
+        ...,
+        description="+sort=40\n+uiType=MethodPathSelector\n+label=Method + Path\n+usage=Select one Method and Path for this tool",
+    )
+    method: Method = Field(..., description="+sort=50\n+uiType=Hidden")
+    headers: Optional[Dict[str, str]] = Field(
+        None,
+        description='+sort=60\n+uiType=KV\n+uiProps={"allowSecrets":true,"secretConfig":{"enableNew":true,"hideOptions":true}}',
+    )
+
+
+class AgentOpenAPIToolWithFQN(AgentOpenAPITool):
+    id: str
+    fqn: str
+
+
+class AssistantMessage(BaseModel):
+    """
+    +usage=Assistant message
+    +docs=Defines the structure of an assistant message, including role and content
+    +label=Assistant Message
+    """
+
+    role: Literal["assistant"]
+    content: Union[constr(regex=r"^.[\s\S]*$"), BlobStorageReference] = Field(
+        ..., description="+label=Content\n+usage=Text content for the assistant message"
+    )
+    name: Optional[str] = Field(
+        None, description="+label=Name\n+usage=Name of the assistant message"
+    )
+
+
+class BasePrompt(BaseModel):
+    """
+    Main prompt structure
+    """
+
+    name: constr(regex=r"^[a-zA-Z][a-zA-Z0-9-_]{0,254}[a-zA-Z0-9]$") = Field(
+        ...,
+        description="+label=Prompt Name\n+icon=fa-desktop:#326ce5\n+message=Alphanumeric word, may contain '-' with a maximum length of 256 characters\n+sort=1000\n+usage=Name of the Prompt. This uniquely identifies it in the workspace.\n+docs=The unique name for the prompt, consisting of alphanumeric characters and dashes, max length 100.",
+    )
+    description: Optional[constr(min_length=1, max_length=512)] = Field(
+        None,
+        description="+label=Description\n+icon=fa-desktop:#326ce5\n+message=Description in a maximum of 512 characters\n+sort=2000\n+usage=Description of the prompt\n+docs=An optional description for the prompt, with a maximum length of 512 characters.\n+optional",
+    )
+    model_configuration: ModelConfiguration
+    metadata: Dict[str, str] = Field(
+        ...,
+        description="+label=Metadata\n+icon=fa-info-circle:#326ce5\n+message=Additional metadata for the prompt\n+sort=7000\n+usage=Define additional metadata for the prompt\n+docs=Key-value pairs to store additional metadata related to the prompt.",
+    )
+
+
+class ChatPrompt(BasePrompt):
+    type: Literal["chat_prompt"] = Field(
+        ...,
+        description='+label=Type\n+icon=fa-desktop:#326ce5\n+message=Type of the prompt\n+sort=3000\n+usage=Type of the prompt\n+docs=Type of the prompt, set to "chat_prompt"\n+default="chat_prompt"',
+    )
+    messages: List[Union[SystemMessage, AssistantMessage, UserMessage]] = Field(
+        ...,
+        description="+sort=4000\n+usage=Chat completion messages\n+label=Messages in the chat conversation\n+message=Chat completion messages\n+usage=List of messages in the chat conversation, must be non-empty\n+docs=Messages that define the chat conversation, including system, assistant, and user messages.",
+    )
+    variables: Optional[Dict[str, Optional[str]]] = Field(
+        None,
+        description="+label=Variables\n+usage=Variables for the chat completion messages to be used in the prompt messages\n+sort=5000",
+    )
+
+
+class AgentApp(BaseModel):
+    type: Literal["agent-app"] = Field(..., description="+value=agent-app")
+    tools: List[AgentOpenAPIToolWithFQN]
+    agents: List[AgentWithFQN]
+    root_agent: constr(min_length=1)
+
+
+class Artifacts(BaseModel):
+    __root__: Union[ChatPrompt, AgentOpenAPITool, Agent, AgentApp]

{truefoundry-0.4.1 → truefoundry-0.4.1rc1}/truefoundry/ml/log_types/artifacts/artifact.py

@@ -5,7 +5,7 @@ import os
 import tempfile
 import uuid
 from pathlib import Path
-from typing import TYPE_CHECKING, Any, Dict, NamedTuple, Optional, Tuple, Union
+from typing import TYPE_CHECKING, Any, Dict, List, NamedTuple, Optional, Tuple, Union
 
 from truefoundry.ml.artifact.truefoundry_artifact_repo import (
     ArtifactIdentifier,
@@ -25,6 +25,7 @@ from truefoundry.ml.autogen.client import (  # type: ignore[attr-defined]
 from truefoundry.ml.autogen.client import (  # type: ignore[attr-defined]
     InternalMetadata as InternalMetadataDto,
 )
+from truefoundry.ml.autogen.entities.artifacts import ChatPrompt
 from truefoundry.ml.exceptions import MlFoundryException
 from truefoundry.ml.log_types.artifacts.constants import INTERNAL_METADATA_PATH
 from truefoundry.ml.log_types.artifacts.utils import (
@@ -351,6 +352,63 @@ class ArtifactVersion:
         self._set_mutable_attrs()
 
 
+class ChatPromptVersion(ArtifactVersion):
+    def __init__(self, artifact_version: ArtifactVersionDto, artifact: ArtifactDto):
+        if artifact.type != ArtifactType.CHAT_PROMPT:
+            raise ValueError(
+                f"{artifact_version.fqn!r} is not a chat prompt type artifact"
+            )
+        super().__init__(
+            artifact_version=artifact_version,
+            artifact=artifact,
+        )
+        self._chat_prompt = ChatPrompt.parse_obj(
+            artifact_version.internal_metadata.to_dict()
+        )
+
+    @classmethod
+    def from_fqn(cls, fqn: str) -> "ChatPromptVersion":
+        api_client = _get_api_client()
+        mlfoundry_artifacts_api = MlfoundryArtifactsApi(api_client=api_client)
+        _artifact_version = mlfoundry_artifacts_api.get_artifact_version_by_fqn_get(
+            fqn=fqn
+        )
+        artifact_version = _artifact_version.artifact_version
+        _artifact = mlfoundry_artifacts_api.get_artifact_by_id_get(
+            id=artifact_version.artifact_id
+        )
+        return cls(
+            artifact_version=_artifact_version.artifact_version,
+            artifact=_artifact.artifact,
+        )
+
+    @property
+    def model(self) -> str:
+        return self._chat_prompt.model_configuration.model
+
+    @property
+    def provider(self) -> str:
+        return self._chat_prompt.model_configuration.provider
+
+    @property
+    def messages(self) -> List[Dict[str, Any]]:
+        return [message.dict() for message in self._chat_prompt.messages]
+
+    @property
+    def parameters(self) -> Dict[str, Any]:
+        _parameters = self._chat_prompt.model_configuration.parameters
+        return _parameters.dict(exclude_unset=True) if _parameters else {}
+
+    @property
+    def extra_parameters(self) -> Dict[str, Any]:
+        _extra_parameters = self._chat_prompt.model_configuration.extra_parameters
+        return _extra_parameters.dict(exclude_unset=True) if _extra_parameters else {}
+
+    @property
+    def variables(self) -> Dict[str, Any]:
+        return self._chat_prompt.variables or {}
+
+
 def _log_artifact_version_helper(
     run: "MlFoundryRun",
     name: str,