clarifai 10.1.0__py3-none-any.whl → 10.1.1__py3-none-any.whl

clarifai/client/app.py

@@ -32,6 +32,7 @@ class App(Lister, BaseClient):
                app_id: str = None,
                base_url: str = "https://api.clarifai.com",
                pat: str = None,
+               token: str = None,
                **kwargs):
     """Initializes an App object.
 
@@ -40,6 +41,7 @@ class App(Lister, BaseClient):
         app_id (str): The App ID for the App to interact with.
         base_url (str): Base API url. Default "https://api.clarifai.com"
         pat (str): A personal access token for authentication. Can be set as env var CLARIFAI_PAT
+        token (str): A session token for authentication. Accepts either a session token or a pat. Can be set as env var CLARIFAI_SESSION_TOKEN
         **kwargs: Additional keyword arguments to be passed to the App.
             - name (str): The name of the app.
             - description (str): The description of the app.
@@ -52,7 +54,8 @@ class App(Lister, BaseClient):
     self.kwargs = {**kwargs, 'id': app_id}
     self.app_info = resources_pb2.App(**self.kwargs)
     self.logger = get_logger(logger_level="INFO", name=__name__)
-    BaseClient.__init__(self, user_id=self.user_id, app_id=self.id, base=base_url, pat=pat)
+    BaseClient.__init__(
+        self, user_id=self.user_id, app_id=self.id, base=base_url, pat=pat, token=token)
     Lister.__init__(self)
 
   def list_datasets(self, page_no: int = None,
@@ -85,7 +88,7 @@ class App(Lister, BaseClient):
     for dataset_info in all_datasets_info:
       if 'version' in list(dataset_info.keys()):
         del dataset_info['version']['metrics']
-      yield Dataset(base_url=self.base, pat=self.pat, **dataset_info)
+      yield Dataset.from_auth_helper(auth=self.auth_helper, **dataset_info)
 
   def list_models(self,
                   filter_by: Dict[str, Any] = {},
@@ -126,7 +129,7 @@ class App(Lister, BaseClient):
       if only_in_app:
         if model_info['app_id'] != self.id:
           continue
-      yield Model(base_url=self.base, pat=self.pat, **model_info)
+      yield Model.from_auth_helper(auth=self.auth_helper, **model_info)
 
   def list_workflows(self,
                      filter_by: Dict[str, Any] = {},
@@ -165,7 +168,7 @@ class App(Lister, BaseClient):
       if only_in_app:
         if workflow_info['app_id'] != self.id:
           continue
-      yield Workflow(base_url=self.base, pat=self.pat, **workflow_info)
+      yield Workflow.from_auth_helper(auth=self.auth_helper, **workflow_info)
 
   def list_modules(self,
                    filter_by: Dict[str, Any] = {},
@@ -204,7 +207,7 @@ class App(Lister, BaseClient):
       if only_in_app:
         if module_info['app_id'] != self.id:
           continue
-      yield Module(base_url=self.base, pat=self.pat, **module_info)
+      yield Module.from_auth_helper(auth=self.auth_helper, **module_info)
 
   def list_installed_module_versions(self,
                                      filter_by: Dict[str, Any] = {},
@@ -239,11 +242,8 @@ class App(Lister, BaseClient):
     for imv_info in all_imv_infos:
       del imv_info['deploy_url']
       del imv_info['installed_module_version_id']  # TODO: remove this after the backend fix
-      yield Module(
-          module_id=imv_info['module_version']['module_id'],
-          base_url=self.base,
-          pat=self.pat,
-          **imv_info)
+      yield Module.from_auth_helper(
+          auth=self.auth_helper, module_id=imv_info['module_version']['module_id'], **imv_info)
 
   def list_concepts(self, page_no: int = None,
                     per_page: int = None) -> Generator[Concept, None, None]:
@@ -308,14 +308,8 @@ class App(Lister, BaseClient):
     if response.status.code != status_code_pb2.SUCCESS:
       raise Exception(response.status)
     self.logger.info("\nDataset created\n%s", response.status)
-    kwargs.update({
-        'app_id': self.id,
-        'user_id': self.user_id,
-        'base_url': self.base,
-        'pat': self.pat
-    })
 
-    return Dataset(dataset_id=dataset_id, **kwargs)
+    return Dataset.from_auth_helper(self.auth_helper, dataset_id=dataset_id, **kwargs)
 
   def create_model(self, model_id: str, **kwargs) -> Model:
     """Creates a model for the app.
@@ -339,14 +333,11 @@ class App(Lister, BaseClient):
       raise Exception(response.status)
     self.logger.info("\nModel created\n%s", response.status)
     kwargs.update({
-        'app_id': self.id,
-        'user_id': self.user_id,
+        'model_id': model_id,
         'model_type_id': response.model.model_type_id,
-        'base_url': self.base,
-        'pat': self.pat
     })
 
-    return Model(model_id=model_id, **kwargs)
+    return Model.from_auth_helper(auth=self.auth_helper, **kwargs)
 
   def create_workflow(self,
                       config_filepath: str,
@@ -436,9 +427,8 @@ class App(Lister, BaseClient):
       display_workflow_tree(dict_response["workflows"][0]["nodes"])
     kwargs = self.process_response_keys(dict_response[list(dict_response.keys())[1]][0],
                                         "workflow")
-    kwargs.update({'base_url': self.base, 'pat': self.pat})
 
-    return Workflow(**kwargs)
+    return Workflow.from_auth_helper(auth=self.auth_helper, **kwargs)
 
   def create_module(self, module_id: str, description: str, **kwargs) -> Module:
     """Creates a module for the app.
@@ -464,14 +454,8 @@ class App(Lister, BaseClient):
     if response.status.code != status_code_pb2.SUCCESS:
       raise Exception(response.status)
     self.logger.info("\nModule created\n%s", response.status)
-    kwargs.update({
-        'app_id': self.id,
-        'user_id': self.user_id,
-        'base_url': self.base,
-        'pat': self.pat
-    })
 
-    return Module(module_id=module_id, **kwargs)
+    return Module.from_auth_helper(auth=self.auth_helper, module_id=module_id, **kwargs)
 
   def dataset(self, dataset_id: str, **kwargs) -> Dataset:
     """Returns a Dataset object for the existing dataset ID.
@@ -496,8 +480,7 @@ class App(Lister, BaseClient):
     kwargs = self.process_response_keys(dict_response[list(dict_response.keys())[1]],
                                         list(dict_response.keys())[1])
     kwargs['version'] = response.dataset.version if response.dataset.version else None
-    kwargs.update({'base_url': self.base, 'pat': self.pat})
-    return Dataset(**kwargs)
+    return Dataset.from_auth_helper(auth=self.auth_helper, **kwargs)
 
   def model(self, model_id: str, model_version_id: str = "", **kwargs) -> Model:
     """Returns a Model object for the existing model ID.
@@ -532,9 +515,8 @@ class App(Lister, BaseClient):
     kwargs = self.process_response_keys(dict_response['model'], 'model')
     kwargs[
         'model_version'] = response.model.model_version if response.model.model_version else None
-    kwargs.update({'base_url': self.base, 'pat': self.pat})
 
-    return Model(**kwargs)
+    return Model.from_auth_helper(self.auth_helper, **kwargs)
 
   def workflow(self, workflow_id: str, **kwargs) -> Workflow:
     """Returns a workflow object for the existing workflow ID.
@@ -558,9 +540,8 @@ class App(Lister, BaseClient):
     dict_response = MessageToDict(response, preserving_proto_field_name=True)
     kwargs = self.process_response_keys(dict_response[list(dict_response.keys())[1]],
                                         list(dict_response.keys())[1])
-    kwargs.update({'base_url': self.base, 'pat': self.pat})
 
-    return Workflow(**kwargs)
+    return Workflow.from_auth_helper(auth=self.auth_helper, **kwargs)
 
   def module(self, module_id: str, module_version_id: str = "", **kwargs) -> Module:
     """Returns a Module object for the existing module ID.
@@ -585,9 +566,8 @@ class App(Lister, BaseClient):
       raise Exception(response.status)
     dict_response = MessageToDict(response, preserving_proto_field_name=True)
     kwargs = self.process_response_keys(dict_response['module'], 'module')
-    kwargs.update({'base_url': self.base, 'pat': self.pat})
 
-    return Module(**kwargs)
+    return Module.from_auth_helper(auth=self.auth_helper, **kwargs)
 
   def inputs(self,):
     """Returns an Input object.
@@ -595,7 +575,7 @@ class App(Lister, BaseClient):
     Returns:
         Inputs: An input object.
     """
-    return Inputs(self.user_id, self.id, base_url=self.base, pat=self.pat)
+    return Inputs.from_auth_helper(self.auth_helper)
 
   def delete_dataset(self, dataset_id: str) -> None:
     """Deletes an dataset for the user.
@@ -684,9 +664,9 @@ class App(Lister, BaseClient):
         >>> app = App(app_id="app_id", user_id="user_id")
         >>> search_client = app.search(top_k=12, metric="euclidean")
     """
-    user_id = kwargs.get("user_id", self.user_app_id.user_id)
-    app_id = kwargs.get("app_id", self.user_app_id.app_id)
-    return Search(user_id=user_id, app_id=app_id, base_url=self.base, pat=self.pat, **kwargs)
+    kwargs.get("user_id", self.user_app_id.user_id)
+    kwargs.get("app_id", self.user_app_id.app_id)
+    return Search.from_auth_helper(auth=self.auth_helper, **kwargs)
 
   def __getattr__(self, name):
     return getattr(self.app_info, name)

clarifai/client/base.py

@@ -7,7 +7,7 @@ from google.protobuf.wrappers_pb2 import BoolValue
 
 from clarifai.client.auth import create_stub
 from clarifai.client.auth.helper import ClarifaiAuthHelper
-from clarifai.errors import ApiError
+from clarifai.errors import ApiError, UserError
 from clarifai.utils.misc import get_from_dict_or_env
 
 
@@ -19,9 +19,11 @@ class BaseClient:
           - user_id (str): A user ID for authentication.
           - app_id (str): An app ID for the application to interact with.
           - pat (str): A personal access token for authentication.
+          - token (str): A session token for authentication. Accepts either a session token or a pat.
           - base (str): The base URL for the API endpoint. Defaults to 'https://api.clarifai.com'.
           - ui (str): The URL for the UI. Defaults to 'https://clarifai.com'.
 
+
   Attributes:
       auth_helper (ClarifaiAuthHelper): An instance of ClarifaiAuthHelper for authentication.
       STUB (Stub): The gRPC Stub object for API interaction.
@@ -31,15 +33,53 @@ class BaseClient:
   """
 
   def __init__(self, **kwargs):
-    pat = get_from_dict_or_env(key="pat", env_key="CLARIFAI_PAT", **kwargs)
-    kwargs.update({'pat': pat})
+    token, pat = "", ""
+    try:
+      pat = get_from_dict_or_env(key="pat", env_key="CLARIFAI_PAT", **kwargs)
+    except UserError:
+      token = get_from_dict_or_env(key="token", env_key="CLARIFAI_SESSION_TOKEN", **kwargs)
+    finally:
+      assert token or pat, Exception(
+          "Need 'pat' or 'token' in args or use one of the CLARIFAI_PAT or CLARIFAI_SESSION_TOKEN env vars"
+      )
+    kwargs.update({'token': token, 'pat': pat})
+
     self.auth_helper = ClarifaiAuthHelper(**kwargs, validate=False)
     self.STUB = create_stub(self.auth_helper)
     self.metadata = self.auth_helper.metadata
     self.pat = self.auth_helper.pat
+    self.token = self.auth_helper._token
     self.user_app_id = self.auth_helper.get_user_app_id_proto()
     self.base = self.auth_helper.base
 
+  @classmethod
+  def from_auth_helper(cls, auth: ClarifaiAuthHelper, **kwargs):
+    default_kwargs = {
+        "user_id": kwargs.get("user_id", None) or auth.user_id,
+        "app_id": kwargs.get("app_id", None) or auth.app_id,
+        "pat": kwargs.get("pat", None) or auth.pat,
+        "token": kwargs.get("token", None) or auth._token,
+    }
+    _base = kwargs.get("base", None) or auth.base
+    _clss = cls.__mro__[0]
+    if _clss == BaseClient:
+      kwargs = {
+        **default_kwargs,
+        "base": _base, # Baseclient uses `base`
+        "ui": kwargs.get("ui", None) or auth.ui
+      }
+    else:
+      # Remove user_id and app_id if a custom URL is provided
+      if kwargs.get("url"):
+        default_kwargs.pop("user_id", "")
+        default_kwargs.pop("app_id", "")
+      # Remove app_id if the class name contains "Runner"
+      if 'Runner' in _clss.__name__:
+        default_kwargs.pop("app_id", "")
+      kwargs.update({**default_kwargs, "base_url": _base})
+
+    return cls(**kwargs)
+
   def _grpc_request(self, method: Callable, argument: Any):
     """Makes a gRPC request to the API.
 
@@ -52,7 +92,7 @@ class BaseClient:
     """
 
     try:
-      res = method(argument)
+      res = method(argument, metadata=self.auth_helper.metadata)
       # MessageToDict(res) TODO global debug logger
       return res
     except ApiError:

clarifai/client/dataset.py

@@ -43,6 +43,7 @@ class Dataset(Lister, BaseClient):
                dataset_id: str = None,
                base_url: str = "https://api.clarifai.com",
                pat: str = None,
+               token: str = None,
                **kwargs):
     """Initializes a Dataset object.
 
@@ -51,6 +52,7 @@ class Dataset(Lister, BaseClient):
         dataset_id (str): The Dataset ID within the App to interact with.
         base_url (str): Base API url. Default "https://api.clarifai.com"
         pat (str): A personal access token for authentication. Can be set as env var CLARIFAI_PAT
+        token (str): A session token for authentication. Accepts either a session token or a pat. Can be set as env var CLARIFAI_SESSION_TOKEN
         **kwargs: Additional keyword arguments to be passed to the Dataset.
     """
     if url and dataset_id:
@@ -66,9 +68,10 @@ class Dataset(Lister, BaseClient):
     self.max_retires = 10
     self.batch_size = 128  # limit max protos in a req
     self.task = None  # Upload dataset type
-    self.input_object = Inputs(user_id=self.user_id, app_id=self.app_id, pat=pat)
+    self.input_object = Inputs(user_id=self.user_id, app_id=self.app_id, pat=pat, token=token)
     self.logger = get_logger(logger_level="INFO", name=__name__)
-    BaseClient.__init__(self, user_id=self.user_id, app_id=self.app_id, base=base_url, pat=pat)
+    BaseClient.__init__(
+        self, user_id=self.user_id, app_id=self.app_id, base=base_url, pat=pat, token=token)
     Lister.__init__(self)
 
   def create_version(self, **kwargs) -> 'Dataset':
@@ -98,13 +101,10 @@ class Dataset(Lister, BaseClient):
     self.logger.info("\nDataset Version created\n%s", response.status)
     kwargs.update({
         'dataset_id': self.id,
-        'app_id': self.app_id,
-        'user_id': self.user_id,
         'version': response.dataset_versions[0],
-        'base_url': self.base,
-        'pat': self.pat
     })
-    return Dataset(**kwargs)
+
+    return Dataset.from_auth_helper(self.auth_helper, **kwargs)
 
   def delete_version(self, version_id: str) -> None:
     """Deletes a dataset version for the Dataset.
@@ -162,13 +162,9 @@ class Dataset(Lister, BaseClient):
       del dataset_version_info['metrics']
       kwargs = {
           'dataset_id': self.id,
-          'app_id': self.app_id,
-          'user_id': self.user_id,
           'version': resources_pb2.DatasetVersion(**dataset_version_info),
-          'base_url': self.base,
-          'pat': self.pat
       }
-      yield Dataset(**kwargs)
+      yield Dataset.from_auth_helper(self.auth_helper, **kwargs)
 
   def _concurrent_annot_upload(self, annots: List[List[resources_pb2.Annotation]]
                               ) -> Union[List[resources_pb2.Annotation], List[None]]:

clarifai/client/input.py

@@ -32,6 +32,7 @@ class Inputs(Lister, BaseClient):
                logger_level: str = "INFO",
                base_url: str = "https://api.clarifai.com",
                pat: str = None,
+               token: str = None,
                **kwargs):
     """Initializes an Input object.
 
@@ -39,6 +40,8 @@ class Inputs(Lister, BaseClient):
         user_id (str): A user ID for authentication.
         app_id (str): An app ID for the application to interact with.
         base_url (str): Base API url. Default "https://api.clarifai.com"
+        pat (str): A personal access token for authentication. Can be set as env var CLARIFAI_PAT
+        token (str): A session token for authentication. Accepts either a session token or a pat. Can be set as env var CLARIFAI_SESSION_TOKEN
         **kwargs: Additional keyword arguments to be passed to the Input
     """
     self.user_id = user_id
@@ -46,7 +49,8 @@ class Inputs(Lister, BaseClient):
     self.kwargs = {**kwargs}
     self.input_info = resources_pb2.Input(**self.kwargs)
     self.logger = get_logger(logger_level=logger_level, name=__name__)
-    BaseClient.__init__(self, user_id=self.user_id, app_id=self.app_id, base=base_url, pat=pat)
+    BaseClient.__init__(
+        self, user_id=self.user_id, app_id=self.app_id, base=base_url, pat=pat, token=token)
     Lister.__init__(self)
 
   @staticmethod
@@ -670,6 +674,30 @@ class Inputs(Lister, BaseClient):
 
     return input_job_id, response
 
+  def patch_inputs(self, inputs: List[Input], action: str = 'merge') -> str:
+    """Patch list of input objects to the app.
+
+    Args:
+        inputs (list): List of input objects to upload.
+        action (str): Action to perform on the input. Options: 'merge', 'overwrite', 'remove'.
+
+    Returns:
+        response: Response from the grpc request.
+    """
+    if not isinstance(inputs, list):
+      raise UserError("inputs must be a list of Input objects")
+    uuid.uuid4().hex  # generate a unique id for this job
+    request = service_pb2.PatchInputsRequest(
+        user_app_id=self.user_app_id, inputs=inputs, action=action)
+    response = self._grpc_request(self.STUB.PatchInputs, request)
+    if response.status.code != status_code_pb2.SUCCESS:
+      try:
+        self.logger.warning(f"Patch inputs failed, status: {response.annotations[0].status}")
+      except Exception:
+        self.logger.warning(f"Patch inputs failed, status: {response.status.details}")
+
+    self.logger.info("\nPatch Inputs Successful\n%s", response.status)
+
   def upload_annotations(self, batch_annot: List[resources_pb2.Annotation], show_log: bool = True
                         ) -> Union[List[resources_pb2.Annotation], List[None]]:
     """Upload image annotations to app.

clarifai/client/model.py

@@ -1,6 +1,6 @@
 import os
 import time
-from typing import Any, Dict, Generator, List
+from typing import Any, Dict, Generator, List, Union
 
 import requests
 import yaml
@@ -32,6 +32,7 @@ class Model(Lister, BaseClient):
                model_version: Dict = {'id': ""},
                base_url: str = "https://api.clarifai.com",
                pat: str = None,
+               token: str = None,
                **kwargs):
     """Initializes a Model object.
 
@@ -41,6 +42,7 @@ class Model(Lister, BaseClient):
         model_version (dict): The Model Version to interact with.
         base_url (str): Base API url. Default "https://api.clarifai.com"
         pat (str): A personal access token for authentication. Can be set as env var CLARIFAI_PAT
+        token (str): A session token for authentication. Accepts either a session token or a pat. Can be set as env var CLARIFAI_SESSION_TOKEN
         **kwargs: Additional keyword arguments to be passed to the Model.
     """
     if url and model_id:
@@ -55,7 +57,8 @@ class Model(Lister, BaseClient):
     self.model_info = resources_pb2.Model(**self.kwargs)
     self.logger = get_logger(logger_level="INFO", name=__name__)
     self.training_params = {}
-    BaseClient.__init__(self, user_id=self.user_id, app_id=self.app_id, base=base_url, pat=pat)
+    BaseClient.__init__(
+        self, user_id=self.user_id, app_id=self.app_id, base=base_url, pat=pat, token=token)
     Lister.__init__(self)
 
   def list_training_templates(self) -> List[str]:
@@ -212,6 +215,8 @@ class Model(Lister, BaseClient):
         >>> model_params = model.get_params(template='template', yaml_file='model_params.yaml')
         >>> model.train('model_params.yaml')
     """
+    if not self.model_info.model_type_id:
+      self.load_info()
     if self.model_info.model_type_id not in TRAINABLE_MODEL_TYPES:
       raise UserError(f"Model type {self.model_info.model_type_id} is not trainable")
     if not yaml_file and len(self.training_params) == 0:
@@ -222,8 +227,10 @@ class Model(Lister, BaseClient):
         params_dict = yaml.safe_load(file)
     else:
       params_dict = self.training_params
-
-    train_dict = params_parser(params_dict)
+    #getting all the concepts for the model type
+    if self.model_info.model_type_id not in ["clusterer", "text-to-text"]:
+      concepts = self._list_concepts()
+    train_dict = params_parser(params_dict, concepts)
     request = service_pb2.PostModelVersionsRequest(
         user_app_id=self.user_app_id,
         model_id=self.id,
@@ -331,7 +338,7 @@ class Model(Lister, BaseClient):
     dict_response = MessageToDict(response, preserving_proto_field_name=True)
     kwargs = self.process_response_keys(dict_response['model'], 'model')
 
-    return Model(base_url=self.base, pat=self.pat, **kwargs)
+    return Model(base_url=self.base, pat=self.pat, token=self.token, **kwargs)
 
   def list_versions(self, page_no: int = None,
                     per_page: int = None) -> Generator['Model', None, None]:
@@ -373,11 +380,8 @@ class Model(Lister, BaseClient):
         del model_version_info['train_info']['dataset']['version']['metrics']
       except KeyError:
         pass
-      yield Model(
-          model_id=self.id,
-          base_url=self.base,
-          pat=self.pat,
-          **dict(self.kwargs, model_version=model_version_info))
+      yield Model.from_auth_helper(
+          model_id=self.id, **dict(self.kwargs, model_version=model_version_info))
 
   def predict(self, inputs: List[Input], inference_params: Dict = {}, output_config: Dict = {}):
     """Predicts the model based on the given inputs.
@@ -548,6 +552,17 @@ class Model(Lister, BaseClient):
         resources_pb2.OutputInfo(
             output_config=resources_pb2.OutputConfig(**output_config), params=params))
 
+  def _list_concepts(self) -> List[str]:
+    """Lists all the concepts for the model type.
+
+    Returns:
+        concepts (List): List of concepts for the model type.
+    """
+    request_data = dict(user_app_id=self.user_app_id)
+    all_concepts_infos = self.list_pages_generator(self.STUB.ListConcepts,
+                                                   service_pb2.ListConceptsRequest, request_data)
+    return [concept_info['concept_id'] for concept_info in all_concepts_infos]
+
   def load_info(self) -> None:
     """Loads the model info."""
     request = service_pb2.GetModelRequest(
@@ -576,3 +591,169 @@ class Model(Lister, BaseClient):
         if hasattr(self.model_info, param)
     ]
     return f"Model Details: \n{', '.join(attribute_strings)}\n"
+
+  def list_evaluations(self) -> resources_pb2.EvalMetrics:
+    """List all eval_metrics of current model version
+
+    Raises:
+        Exception: Failed to call API
+
+    Returns:
+        resources_pb2.EvalMetrics
+    """
+    assert self.model_info.model_version.id, "Model version is empty. Please provide `model_version` as arguments or with a URL as the format '{user_id}/{app_id}/models/{your_model_id}/model_version_id/{your_version_model_id}' when initializing."
+    request = service_pb2.ListModelVersionEvaluationsRequest(
+        user_app_id=self.user_app_id,
+        model_id=self.id,
+        model_version_id=self.model_info.model_version.id)
+    response = self._grpc_request(self.STUB.ListModelVersionEvaluations, request)
+
+    if response.status.code != status_code_pb2.SUCCESS:
+      raise Exception(response.status)
+
+    return response.eval_metrics
+
+  def evaluate(self,
+               dataset_id: str,
+               dataset_app_id: str = None,
+               dataset_user_id: str = None,
+               eval_id: str = None,
+               extended_metrics: dict = None,
+               eval_info: dict = None) -> resources_pb2.EvalMetrics:
+    """ Run evaluation
+
+    Args:
+      dataset_id (str): Dataset Id.
+      dataset_app_id (str): App ID for cross app evaluation, leave it as None to use Model App ID. Default is None.
+      dataset_user_id (str): User ID for cross app evaluation, leave it as None to use Model User ID. Default is None.
+      eval_id (str): Specific ID for the evaluation. You must specify this parameter to either overwrite the result with the dataset ID or format your evaluation in an informative manner. If you don't, it will use random ID from system. Default is None.
+      extended_metrics (dict): user custom metrics result. Default is None.
+      eval_info (dict): custom eval info. Default is empty dict.
+
+    Return
+      eval_metrics
+
+    """
+    assert self.model_info.model_version.id, "Model version is empty. Please provide `model_version` as arguments or with a URL as the format '{user_id}/{app_id}/models/{your_model_id}/model_version_id/{your_version_model_id}' when initializing."
+    metrics = None
+    if isinstance(extended_metrics, dict):
+      metrics = Struct()
+      metrics.update(extended_metrics)
+      metrics = resources_pb2.ExtendedMetrics(user_metrics=metrics)
+
+    eval_info_params = None
+    if isinstance(eval_info, dict):
+      eval_info_params = Struct()
+      eval_info_params.update(eval_info)
+      eval_info_params = resources_pb2.EvalInfo(params=eval_info_params)
+
+    eval_metric = resources_pb2.EvalMetrics(
+        id=eval_id,
+        model=resources_pb2.Model(
+            id=self.id,
+            app_id=self.auth_helper.app_id,
+            user_id=self.auth_helper.user_id,
+            model_version=resources_pb2.ModelVersion(id=self.model_info.model_version.id),
+        ),
+        extended_metrics=metrics,
+        ground_truth_dataset=resources_pb2.Dataset(
+            id=dataset_id,
+            app_id=dataset_app_id or self.auth_helper.app_id,
+            user_id=dataset_user_id or self.auth_helper.user_id,
+        ),
+        eval_info=eval_info_params,
+    )
+    request = service_pb2.PostEvaluationsRequest(
+        user_app_id=self.user_app_id,
+        eval_metrics=[eval_metric],
+    )
+    response = self._grpc_request(self.STUB.PostEvaluations, request)
+    if response.status.code != status_code_pb2.SUCCESS:
+      raise Exception(response.status)
+    self.logger.info(
+        "\nModel evaluation in progress. Kindly allow a few minutes for completion. Processing time may vary based on the model and dataset sizes."
+    )
+
+    return response.eval_metrics
+
+  def get_eval_by_id(
+      self,
+      eval_id: str,
+      label_counts=False,
+      test_set=False,
+      binary_metrics=False,
+      confusion_matrix=False,
+      metrics_by_class=False,
+      metrics_by_area=False,
+  ) -> resources_pb2.EvalMetrics:
+    """Get detail eval_metrics by eval_id with extra metric fields
+
+    Args:
+        eval_id (str): eval id
+        label_counts (bool, optional): Set True to get label counts. Defaults to False.
+        test_set (bool, optional): Set True to get test set. Defaults to False.
+        binary_metrics (bool, optional): Set True to get binary metric. Defaults to False.
+        confusion_matrix (bool, optional): Set True to get confusion matrix. Defaults to False.
+        metrics_by_class (bool, optional): Set True to get metrics by class. Defaults to False.
+        metrics_by_area (bool, optional): Set True to get metrics by area. Defaults to False.
+
+    Raises:
+        Exception: Failed to call API
+
+    Returns:
+        resources_pb2.EvalMetrics: eval_metrics
+    """
+    request = service_pb2.GetEvaluationRequest(
+        user_app_id=self.user_app_id,
+        evaluation_id=eval_id,
+        fields=resources_pb2.FieldsValue(
+            label_counts=label_counts,
+            test_set=test_set,
+            binary_metrics=binary_metrics,
+            confusion_matrix=confusion_matrix,
+            metrics_by_class=metrics_by_class,
+            metrics_by_area=metrics_by_area,
+        ))
+    response = self._grpc_request(self.STUB.GetEvaluation, request)
+
+    if response.status.code != status_code_pb2.SUCCESS:
+      raise Exception(response.status)
+
+    return response.eval_metrics
+
+  def get_latest_eval(self,
+                      label_counts=False,
+                      test_set=False,
+                      binary_metrics=False,
+                      confusion_matrix=False,
+                      metrics_by_class=False,
+                      metrics_by_area=False) -> Union[resources_pb2.EvalMetrics, None]:
+    """
+    Run `get_eval_by_id` method with latest `eval_id`
+
+    Args:
+      label_counts (bool, optional): Set True to get label counts. Defaults to False.
+      test_set (bool, optional): Set True to get test set. Defaults to False.
+      binary_metrics (bool, optional): Set True to get binary metric. Defaults to False.
+      confusion_matrix (bool, optional): Set True to get confusion matrix. Defaults to False.
+      metrics_by_class (bool, optional): Set True to get metrics by class. Defaults to False.
+      metrics_by_area (bool, optional): Set True to get metrics by area. Defaults to False.
+
+    Returns:
+      eval_metric if model is evaluated otherwise None.
+
+    """
+
+    _latest = self.list_evaluations()[0]
+    result = None
+    if _latest.status.code == status_code_pb2.MODEL_EVALUATED:
+      result = self.get_eval_by_id(
+          eval_id=_latest.id,
+          label_counts=label_counts,
+          test_set=test_set,
+          binary_metrics=binary_metrics,
+          confusion_matrix=confusion_matrix,
+          metrics_by_class=metrics_by_class,
+          metrics_by_area=metrics_by_area)
+
+    return result