clarifai 11.4.3rc1__py3-none-any.whl → 11.4.4__py3-none-any.whl

clarifai/__init__.py

@@ -1 +1 @@
-__version__ = "11.4.3rc1"
+__version__ = "11.4.4"

clarifai/cli/base.py

@@ -144,9 +144,8 @@ def dump(ctx_obj, output_format):
 
 
 @config.command(['cat'])
-@click.option('-o', '--output-format', default='yaml', type=click.Choice(['yaml', 'json']))
 @click.pass_obj
-def env(ctx_obj, output_format):
+def env(ctx_obj):
     """Print env vars. Use: eval "$(clarifai config env)" """
     ctx_obj.current.print_env_vars()
 

clarifai/cli/model.py

@@ -546,8 +546,6 @@ def local_dev(ctx, model_path):
         base_url=ctx.obj.current.api_base,
     )
 
-    # TODO: put in the ClarifaiUrlHelper to create the model url.
-
     logger.info("""\n
 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 # About to start up the local dev runner in this terminal...

clarifai/client/app.py

@@ -19,6 +19,7 @@ from clarifai.client.workflow import Workflow
 from clarifai.constants.model import TRAINABLE_MODEL_TYPES
 from clarifai.errors import UserError
 from clarifai.urls.helper import ClarifaiUrlHelper
+from clarifai.utils.constants import DEFAULT_BASE
 from clarifai.utils.logging import display_concept_relations_tree, display_workflow_tree, logger
 from clarifai.utils.misc import concept_relations_accumulation
 from clarifai.workflows.utils import get_yaml_output_info_proto, is_same_yaml_model
@@ -33,7 +34,7 @@ class App(Lister, BaseClient):
         url: str = None,
         app_id: str = None,
         user_id: str = None,
-        base_url: str = "https://api.clarifai.com",
+        base_url: str = DEFAULT_BASE,
         pat: str = None,
         token: str = None,
         root_certificates_path: str = None,

clarifai/client/auth/helper.py

@@ -7,10 +7,12 @@ from clarifai_grpc.channel.clarifai_channel import ClarifaiChannel
 from clarifai_grpc.grpc.api import resources_pb2, service_pb2_grpc
 
 from clarifai import __version__
-from clarifai.utils.constants import CLARIFAI_PAT_ENV_VAR, CLARIFAI_SESSION_TOKEN_ENV_VAR
-
-DEFAULT_BASE = "https://api.clarifai.com"
-DEFAULT_UI = "https://clarifai.com"
+from clarifai.utils.constants import (
+    CLARIFAI_PAT_ENV_VAR,
+    CLARIFAI_SESSION_TOKEN_ENV_VAR,
+    DEFAULT_BASE,
+    DEFAULT_UI,
+)
 
 REQUEST_ID_PREFIX_HEADER = "x-clarifai-request-id-prefix"
 REQUEST_ID_PREFIX = f"sdk-python-{__version__}"

clarifai/client/compute_cluster.py

@@ -10,6 +10,7 @@ from clarifai.client.base import BaseClient
 from clarifai.client.lister import Lister
 from clarifai.client.nodepool import Nodepool
 from clarifai.errors import UserError
+from clarifai.utils.constants import DEFAULT_BASE
 from clarifai.utils.logging import logger
 
 
@@ -20,7 +21,7 @@ class ComputeCluster(Lister, BaseClient):
         self,
         compute_cluster_id: str = None,
         user_id: str = None,
-        base_url: str = "https://api.clarifai.com",
+        base_url: str = DEFAULT_BASE,
         pat: str = None,
         token: str = None,
         root_certificates_path: str = None,

clarifai/client/dataset.py

@@ -45,6 +45,7 @@ ClarifaiDatasetType = TypeVar(
     VisualSegmentationDataset,
     TextClassificationDataset,
 )
+from clarifai.utils.constants import DEFAULT_BASE
 
 
 class Dataset(Lister, BaseClient):
@@ -55,7 +56,7 @@ class Dataset(Lister, BaseClient):
         url: str = None,
         dataset_id: str = None,
         dataset_version_id: str = None,
-        base_url: str = "https://api.clarifai.com",
+        base_url: str = DEFAULT_BASE,
         pat: str = None,
         token: str = None,
         root_certificates_path: str = None,

clarifai/client/deployment.py

@@ -2,6 +2,7 @@ from clarifai_grpc.grpc.api import resources_pb2
 
 from clarifai.client.base import BaseClient
 from clarifai.client.lister import Lister
+from clarifai.utils.constants import DEFAULT_BASE
 from clarifai.utils.logging import logger
 from clarifai.utils.protobuf import dict_to_protobuf
 
@@ -13,7 +14,7 @@ class Deployment(Lister, BaseClient):
         self,
         deployment_id: str = None,
         user_id: str = None,
-        base_url: str = "https://api.clarifai.com",
+        base_url: str = DEFAULT_BASE,
         pat: str = None,
         token: str = None,
         root_certificates_path: str = None,

clarifai/client/input.py

@@ -21,6 +21,7 @@ from clarifai.client.lister import Lister
 from clarifai.constants.dataset import MAX_RETRIES
 from clarifai.constants.input import MAX_UPLOAD_BATCH_SIZE
 from clarifai.errors import UserError
+from clarifai.utils.constants import DEFAULT_BASE
 from clarifai.utils.logging import logger
 from clarifai.utils.misc import BackoffIterator, Chunker, clean_input_id
 
@@ -33,7 +34,7 @@ class Inputs(Lister, BaseClient):
         user_id: str = None,
         app_id: str = None,
         logger_level: str = "INFO",
-        base_url: str = "https://api.clarifai.com",
+        base_url: str = DEFAULT_BASE,
         pat: str = None,
         token: str = None,
         root_certificates_path: str = None,

clarifai/client/model.py

@@ -34,6 +34,7 @@ from clarifai.constants.model import (
 )
 from clarifai.errors import UserError
 from clarifai.urls.helper import ClarifaiUrlHelper
+from clarifai.utils.constants import DEFAULT_BASE
 from clarifai.utils.logging import logger
 from clarifai.utils.misc import BackoffIterator
 from clarifai.utils.model_train import (
@@ -58,7 +59,7 @@ class Model(Lister, BaseClient):
         url: str = None,
         model_id: str = None,
         model_version: Dict = {'id': ""},
-        base_url: str = "https://api.clarifai.com",
+        base_url: str = DEFAULT_BASE,
         pat: str = None,
         token: str = None,
         root_certificates_path: str = None,

clarifai/client/model_client.py

@@ -8,7 +8,6 @@ from clarifai_grpc.grpc.api.status import status_code_pb2
 from clarifai.constants.model import MAX_MODEL_PREDICT_INPUTS
 from clarifai.errors import UserError
 from clarifai.runners.utils import code_script, method_signatures
-from clarifai.runners.utils.data_utils import is_openai_chat_format
 from clarifai.runners.utils.method_signatures import (
     CompatibilitySerializer,
     deserialize,
@@ -16,6 +15,7 @@ from clarifai.runners.utils.method_signatures import (
     serialize,
     signatures_from_json,
 )
+from clarifai.runners.utils.openai_convertor import is_openai_chat_format
 from clarifai.utils.logging import logger
 from clarifai.utils.misc import BackoffIterator, status_is_retryable
 
@@ -196,7 +196,7 @@ class ModelClient:
             f.__name__ = method_name
             f.__qualname__ = f'{self.__class__.__name__}.{method_name}'
             input_annotations = code_script._get_annotations_source(method_signature)
-            return_annotation = input_annotations.pop('return', (None, None))[0]
+            return_annotation = input_annotations.pop('return', (None, None, None))[0]
             sig = inspect.signature(f).replace(
                 parameters=[
                     inspect.Parameter(k, inspect.Parameter.POSITIONAL_OR_KEYWORD, annotation=v[0])

clarifai/client/module.py

@@ -6,6 +6,7 @@ from clarifai.client.base import BaseClient
 from clarifai.client.lister import Lister
 from clarifai.errors import UserError
 from clarifai.urls.helper import ClarifaiUrlHelper
+from clarifai.utils.constants import DEFAULT_BASE
 from clarifai.utils.logging import logger
 
 
@@ -17,7 +18,7 @@ class Module(Lister, BaseClient):
         url: str = None,
         module_id: str = None,
         module_version: Dict = {'id': ""},
-        base_url: str = "https://api.clarifai.com",
+        base_url: str = DEFAULT_BASE,
         pat: str = None,
         token: str = None,
         root_certificates_path: str = None,

clarifai/client/nodepool.py

@@ -11,6 +11,7 @@ from clarifai.client.deployment import Deployment
 from clarifai.client.lister import Lister
 from clarifai.client.runner import Runner
 from clarifai.errors import UserError
+from clarifai.utils.constants import DEFAULT_BASE
 from clarifai.utils.logging import logger
 
 
@@ -21,7 +22,7 @@ class Nodepool(Lister, BaseClient):
         self,
         nodepool_id: str = None,
         user_id: str = None,
-        base_url: str = "https://api.clarifai.com",
+        base_url: str = DEFAULT_BASE,
         pat: str = None,
         token: str = None,
         root_certificates_path: str = None,

clarifai/client/runner.py

@@ -2,6 +2,7 @@ from clarifai_grpc.grpc.api import resources_pb2
 
 from clarifai.client.base import BaseClient
 from clarifai.client.lister import Lister
+from clarifai.utils.constants import DEFAULT_BASE
 from clarifai.utils.logging import logger
 from clarifai.utils.protobuf import dict_to_protobuf
 
@@ -13,7 +14,7 @@ class Runner(Lister, BaseClient):
         self,
         runner_id: str = None,
         user_id: str = None,
-        base_url: str = "https://api.clarifai.com",
+        base_url: str = DEFAULT_BASE,
         pat: str = None,
         token: str = None,
         root_certificates_path: str = None,

clarifai/client/search.py

@@ -17,6 +17,7 @@ from clarifai.constants.search import (
 )
 from clarifai.errors import UserError
 from clarifai.schema.search import get_schema
+from clarifai.utils.constants import DEFAULT_BASE
 
 
 class Search(Lister, BaseClient):
@@ -28,7 +29,7 @@ class Search(Lister, BaseClient):
         metric: str = DEFAULT_SEARCH_METRIC,
         algorithm: str = DEFAULT_SEARCH_ALGORITHM,
         pagination: bool = False,
-        base_url: str = "https://api.clarifai.com",
+        base_url: str = DEFAULT_BASE,
         pat: str = None,
         token: str = None,
         root_certificates_path: str = None,

clarifai/client/user.py

@@ -12,6 +12,7 @@ from clarifai.client.base import BaseClient
 from clarifai.client.compute_cluster import ComputeCluster
 from clarifai.client.lister import Lister
 from clarifai.errors import UserError
+from clarifai.utils.constants import DEFAULT_BASE
 from clarifai.utils.logging import logger
 
 
@@ -21,7 +22,7 @@ class User(Lister, BaseClient):
     def __init__(
         self,
         user_id: str = None,
-        base_url: str = "https://api.clarifai.com",
+        base_url: str = DEFAULT_BASE,
         pat: str = None,
         token: str = None,
         root_certificates_path: str = None,

clarifai/client/workflow.py

@@ -14,6 +14,7 @@ from clarifai.client.model import Model
 from clarifai.constants.workflow import MAX_WORKFLOW_PREDICT_INPUTS
 from clarifai.errors import UserError
 from clarifai.urls.helper import ClarifaiUrlHelper
+from clarifai.utils.constants import DEFAULT_BASE
 from clarifai.utils.logging import logger
 from clarifai.utils.misc import BackoffIterator, status_is_retryable
 from clarifai.workflows.export import Exporter
@@ -28,7 +29,7 @@ class Workflow(Lister, BaseClient):
         workflow_id: str = None,
         workflow_version: Dict = {'id': ""},
         output_config: Dict = {'min_value': 0},
-        base_url: str = "https://api.clarifai.com",
+        base_url: str = DEFAULT_BASE,
         pat: str = None,
         token: str = None,
         root_certificates_path: str = None,

clarifai/runners/models/mcp_class.py

@@ -10,32 +10,6 @@ from mcp.shared.exceptions import McpError
 
 from clarifai.runners.models.model_class import ModelClass
 
-# class MCPServerProvider(abc.ABC):
-#     """
-#     Base class for creating Model Context Protocol (MCP) servers.
-
-#     This class provides a base implementation of the MCP server, including
-#     methods for handling requests and responses, as well as error handling and
-#     logging.
-
-#     Attributes:
-#     _server: The FastMCP server instance.
-#     _tools: List of tools available in the server.
-#     _resources: List of resources available in the server.
-#     _prompts: List of prompts available in the server.
-
-#     Methods:
-#     get_server(): Returns the FastMCP server instance.
-#     mcp_transport(msg): Handles incoming messages and sends them to the FastMCP server.
-#     """
-
-#     @abc.abstractmethod
-#     def get_server(self) -> FastMCP:
-#         """Required method for each subclass to implement to return the FastMCP server to use."""
-#         if self._server is None:
-#             raise ValueError("Server not initialized")
-#         return self._server
-
 
 class MCPModelClass(ModelClass):
     """Base class for wrapping FastMCP servers as a model running in Clarfai. This handles
@@ -82,8 +56,6 @@ class MCPModelClass(ModelClass):
                 )
 
                 result_type = None
-                print("AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA")
-                print(types.PingRequest)
                 if isinstance(client_message.root, types.PingRequest):
                     result_type = types.EmptyResult
                 elif isinstance(client_message.root, types.InitializeRequest):
@@ -125,19 +97,18 @@ class MCPModelClass(ModelClass):
         # The JSONRPCRequest are supposed to have an id but the InitializeRequest
         # does not have it.
         d = json.loads(msg)
+        id = d.get('id', "")
 
         # If we have an id it's a JSONRPCRequest
-        if not d.get('method', None).startswith("notifications/"):
-            # rpc_message2 = types.JSONRPCRequest.model_validate(rpc_message)
-            # underlying: types.JSONRPCRequest = rpc_message.root
+        if not d.get('method', '').startswith("notifications/"):
             client_message = types.ClientRequest.model_validate(d)
-            response = asyncio.run(
-                send_request(client_message, id=d.get('id', ""))
-            )  # underlying.id))
+            response = asyncio.run(send_request(client_message, id=id))
         else:  # JSONRPCRequest
             client_message = types.ClientNotification.model_validate(d)
             response = asyncio.run(send_notification(client_message))
         if response is None:
-            return ""
+            response = types.JSONRPCError(
+                jsonrpc="2.0", id=id, error="Got empty response from MCP server."
+            )
         # return as a serialized json string
         return response.model_dump_json(by_alias=True, exclude_none=True)

clarifai/runners/models/model_builder.py

@@ -413,6 +413,12 @@ class ModelBuilder:
     def get_method_signatures(self, mocking=True):
         """
         Returns the method signatures for the model class.
+
+        Args:
+          mocking (bool): Whether to mock the model class or not. Defaults to False.
+
+        Returns:
+          list: A list of method signatures for the model class.
         """
         model_class = self.load_model_class(mocking=mocking)
         method_info = model_class._get_method_info()
@@ -436,22 +442,42 @@ class ModelBuilder:
         return self._client
 
     @property
-    def model_url(self):
+    def model_ui_url(self):
+        url_helper = ClarifaiUrlHelper(self._client.auth_helper)
+        # Note(zeiler): the UI experience isn't the best when including version id right now.
+        # if self.model_version_id is not None:
+        #     return url_helper.clarifai_url(
+        #         self.client.user_app_id.user_id,
+        #         self.client.user_app_id.app_id,
+        #         "models",
+        #         self.model_id,
+        #         self.model_version_id,
+        #     )
+        # else:
+        return url_helper.clarifai_url(
+            self.client.user_app_id.user_id,
+            self.client.user_app_id.app_id,
+            "models",
+            self.model_id,
+        )
+
+    @property
+    def model_api_url(self):
         url_helper = ClarifaiUrlHelper(self._client.auth_helper)
         if self.model_version_id is not None:
-            return url_helper.clarifai_url(
+            return url_helper.api_url(
                 self.client.user_app_id.user_id,
                 self.client.user_app_id.app_id,
                 "models",
                 self.model_id,
+                self.model_version_id,
             )
         else:
-            return url_helper.clarifai_url(
+            return url_helper.api_url(
                 self.client.user_app_id.user_id,
                 self.client.user_app_id.app_id,
                 "models",
                 self.model_id,
-                self.model_version_id,
             )
 
     def _get_model_proto(self):
@@ -930,44 +956,20 @@ class ModelBuilder:
             return
         self.model_version_id = response.model_version_id
         logger.info(f"Created Model Version ID: {self.model_version_id}")
-        logger.info(f"Full url to that version is: {self.model_url}")
+        logger.info(f"Full url to that version is: {self.model_ui_url}")
         try:
             is_uploaded = self.monitor_model_build()
             if is_uploaded:
-                # Provide an mcp client config
-                if model_type_id == "mcp":
-                    snippet = (
-                        """
-import asyncio
-import os
-from fastmcp import Client
-from fastmcp.client.transports import StreamableHttpTransport
-
-transport = StreamableHttpTransport(url="%s/mcp",
-                                    headers={"Authorization": "Bearer " + os.environ["CLARIFAI_PAT"]})
-
-async def main():
-  async with Client(transport) as client:
-    tools = await client.list_tools()
-    print(f"Available tools: {tools}")
-    result = await client.call_tool(tools[0].name, {"a": 5, "b": 3})
-    print(f"Result: {result[0].text}")
-
-if __name__ == "__main__":
-  asyncio.run(main())
-"""
-                        % self.model_url
-                    )
-                else:  # python code to run the model.
-                    from clarifai.runners.utils import code_script
-
-                    method_signatures = self.get_method_signatures()
-                    snippet = code_script.generate_client_script(
-                        method_signatures,
-                        user_id=self.client.user_app_id.user_id,
-                        app_id=self.client.user_app_id.app_id,
-                        model_id=self.model_proto.id,
-                    )
+                # python code to run the model.
+                from clarifai.runners.utils import code_script
+
+                method_signatures = self.get_method_signatures()
+                snippet = code_script.generate_client_script(
+                    method_signatures,
+                    user_id=self.client.user_app_id.user_id,
+                    app_id=self.client.user_app_id.app_id,
+                    model_id=self.model_proto.id,
+                )
                 logger.info("""\n
 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 # Here is a code snippet to use this model:
@@ -1074,7 +1076,7 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
                 logger.info("Model build complete!")
                 logger.info(f"Build time elapsed {time.time() - st:.1f}s)")
                 logger.info(
-                    f"Check out the model at {self.model_url} version: {self.model_version_id}"
+                    f"Check out the model at {self.model_ui_url} version: {self.model_version_id}"
                 )
                 return True
             else:
@@ -1099,10 +1101,12 @@ def upload_model(folder, stage, skip_dockerfile):
     exists = builder.check_model_exists()
     if exists:
         logger.info(
-            f"Model already exists at {builder.model_url}, this upload will create a new version for it."
+            f"Model already exists at {builder.model_ui_url}, this upload will create a new version for it."
         )
     else:
-        logger.info(f"New model will be created at {builder.model_url} with it's first version.")
+        logger.info(
+            f"New model will be created at {builder.model_ui_url} with it's first version."
+        )
 
     input("Press Enter to continue...")
     builder.upload_model_version()

clarifai/runners/utils/code_script.py

@@ -4,6 +4,7 @@ from typing import List
 from clarifai_grpc.grpc.api import resources_pb2
 
 from clarifai.runners.utils import data_utils
+from clarifai.urls.helper import ClarifaiUrlHelper
 
 
 def generate_client_script(
@@ -15,6 +16,38 @@ def generate_client_script(
     deployment_id: str = None,
     use_ctx: bool = False,
 ) -> str:
+    url_helper = ClarifaiUrlHelper()
+
+    # Provide an mcp client config
+    if len(method_signatures) == 1 and method_signatures[0].name == "mcp_transport":
+        api_url = url_helper.api_url(
+            user_id,
+            app_id,
+            "models",
+            model_id,
+        )
+
+        _CLIENT_TEMPLATE = """
+import asyncio
+import os
+from fastmcp import Client
+from fastmcp.client.transports import StreamableHttpTransport
+
+transport = StreamableHttpTransport(url="%s/mcp",
+                                    headers={"Authorization": "Bearer " + os.environ["CLARIFAI_PAT"]})
+
+async def main():
+  async with Client(transport) as client:
+    tools = await client.list_tools()
+    print(f"Available tools: {tools}")
+    result = await client.call_tool(tools[0].name, {"a": 5, "b": 3})
+    print(f"Result: {result[0].text}")
+
+if __name__ == "__main__":
+  asyncio.run(main())
+"""
+        return _CLIENT_TEMPLATE % api_url
+
     _CLIENT_TEMPLATE = """\
 import os
 
@@ -35,8 +68,9 @@ from clarifai.runners.utils import data_types
         model_section = """
 model = Model.from_current_context()"""
     else:
+        model_ui_url = url_helper.clarifai_url(user_id, app_id, "models", model_id)
         model_section = f"""
-model = Model("https://clarifai.com/{user_id}/{app_id}/models/{model_id}",
+model = Model({model_ui_url},
                deployment_id = {deployment_id}, # Only needed for dedicated deployed models
                {base_url_str}
  )
@@ -53,13 +87,13 @@ model = Model("https://clarifai.com/{user_id}/{app_id}/models/{model_id}",
         method_name = method_signature.name
         client_script_str = f'response = model.{method_name}('
         annotations = _get_annotations_source(method_signature)
-        for param_name, (param_type, default_value) in annotations.items():
+        for param_name, (param_type, default_value, required) in annotations.items():
             print(
                 f"param_name: {param_name}, param_type: {param_type}, default_value: {default_value}"
             )
             if param_name == "return":
                 continue
-            if default_value is None:
+            if default_value is None and required:
                 default_value = _set_default_value(param_type)
             client_script_str += f"{param_name}={default_value}, "
         client_script_str = client_script_str.rstrip(", ") + ")"
@@ -98,7 +132,7 @@ def _get_annotations_source(method_signature: resources_pb2.MethodSignature) ->
         default_value = None
         if data_utils.Param.get_default(input_field):
             default_value = _parse_default_value(input_field)
-        annotations[param_name] = (param_type, default_value)
+        annotations[param_name] = (param_type, default_value, input_field.required)
     if not method_signature.output_fields:
         raise ValueError("MethodSignature must have at least one output field")
     for output_field in method_signature.output_fields:
@@ -106,7 +140,7 @@ def _get_annotations_source(method_signature: resources_pb2.MethodSignature) ->
         param_type = _get_base_type(output_field)
         if output_field.iterator:
             param_type = f"Iterator[{param_type}]"
-        annotations[param_name] = (param_type, None)
+        annotations[param_name] = (param_type, None, output_field.required)
     return annotations
 
 
@@ -155,7 +189,7 @@ def _map_default_value(field_type):
     default_value = None
 
     if field_type == "str":
-        default_value = 'What is the future of AI?'
+        default_value = repr('What is the future of AI?')
     elif field_type == "bytes":
         default_value = b""
     elif field_type == "int":
@@ -190,11 +224,9 @@ def _set_default_value(field_type):
     Set the default value of a field if it is not set.
     """
     is_iterator = False
-    print(f"before field_type: {field_type}")
     if field_type.startswith("Iterator["):
         is_iterator = True
         field_type = field_type[9:-1]
-    print(f"after field_type: {field_type}")
     default_value = None
     default_value = _map_default_value(field_type)
     if field_type.startswith("List["):
@@ -211,11 +243,8 @@ def _set_default_value(field_type):
         element_type_defaults = [_map_default_value(et) for et in element_types]
         default_value = f"{{{', '.join([str(et) for et in element_type_defaults])}}}"
 
-    if field_type == 'str':
-        default_value = repr(default_value)
     if is_iterator:
         default_value = f'iter([{default_value}])'
-    print(f"after default_value: {default_value}")
     return default_value