clarifai 10.5.3__py3-none-any.whl → 10.7.0__py3-none-any.whl

clarifai/__init__.py

@@ -0,0 +1 @@
+__version__ = "10.7.0"

clarifai/client/app.py

@@ -592,6 +592,32 @@ class App(Lister, BaseClient):
     """
     return Inputs.from_auth_helper(self.auth_helper)
 
+  def patch_dataset(self, dataset_id: str, action: str = 'merge', **kwargs) -> Dataset:
+    """Patches a dataset for the app.
+
+    Args:
+        dataset_id (str): The dataset ID for the dataset to create.
+        action (str): The action to perform on the dataset (merge/overwrite/remove).
+        **kwargs: Additional keyword arguments to be passed to patch the Dataset.
+
+    Returns:
+        Dataset: A Dataset object for the specified dataset ID.
+    """
+    if "visibility" in kwargs:
+      kwargs["visibility"] = resources_pb2.Visibility(gettable=kwargs["visibility"])
+    if "image_url" in kwargs:
+      kwargs["image"] = resources_pb2.Image(url=kwargs.pop("image_url"))
+    request = service_pb2.PatchDatasetsRequest(
+        user_app_id=self.user_app_id,
+        datasets=[resources_pb2.Dataset(id=dataset_id, **kwargs)],
+        action=action)
+    response = self._grpc_request(self.STUB.PatchDatasets, request)
+    if response.status.code != status_code_pb2.SUCCESS:
+      raise Exception(response.status)
+    self.logger.info("\nDataset patched\n%s", response.status)
+
+    return Dataset.from_auth_helper(self.auth_helper, dataset_id=dataset_id, **kwargs)
+
   def delete_dataset(self, dataset_id: str) -> None:
     """Deletes an dataset for the user.
 

clarifai/client/base.py

@@ -1,6 +1,7 @@
 from datetime import datetime
 from typing import Any, Callable
 
+from clarifai_grpc.grpc.api import resources_pb2
 from google.protobuf import struct_pb2
 from google.protobuf.timestamp_pb2 import Timestamp
 from google.protobuf.wrappers_pb2 import BoolValue
@@ -176,6 +177,10 @@ class BaseClient:
             continue
           elif key == 'size':
             value = int(value)
+          elif key == 'image_info':
+            value = resources_pb2.ImageInfo(**value)
+          elif key == 'hosted_image_info':
+            continue
           elif key in ['metadata']:
             if isinstance(value, dict) and value != {}:
               value_s = struct_pb2.Struct()

clarifai/client/input.py

@@ -65,7 +65,7 @@ class Inputs(Lister, BaseClient):
 
   @staticmethod
   def _get_proto(input_id: str,
-                 dataset_id: Union[str, None],
+                 dataset_id: str = None,
                  imagepb: Image = None,
                  video_pb: Video = None,
                  audio_pb: Audio = None,
@@ -481,7 +481,11 @@ class Inputs(Lister, BaseClient):
     return input_protos
 
   @staticmethod
-  def get_bbox_proto(input_id: str, label: str, bbox: List, label_id: str = None) -> Annotation:
+  def get_bbox_proto(input_id: str,
+                     label: str,
+                     bbox: List,
+                     label_id: str = None,
+                     annot_id: str = None) -> Annotation:
     """Create an annotation proto for each bounding box, label input pair.
 
     Args:
@@ -489,6 +493,7 @@ class Inputs(Lister, BaseClient):
         label (str): annotation label name
         bbox (List): a list of a single bbox's coordinates. # bbox ordering: [xmin, ymin, xmax, ymax]
         label_id (str): annotation label ID
+        annot_id (str): annotation ID
 
     Returns:
         An annotation object for the specified input ID.
@@ -499,31 +504,35 @@ class Inputs(Lister, BaseClient):
     """
     if not isinstance(bbox, list):
       raise UserError("must be a list of bbox cooridnates")
-    input_annot_proto = resources_pb2.Annotation(
-        input_id=input_id,
-        data=resources_pb2.Data(regions=[
-            resources_pb2.Region(
-                region_info=resources_pb2.RegionInfo(bounding_box=resources_pb2.BoundingBox(
-                    # bbox ordering: [xmin, ymin, xmax, ymax]
-                    # top_row must be less than bottom row
-                    # left_col must be less than right col
-                    top_row=bbox[1],  #y_min
-                    left_col=bbox[0],  #x_min
-                    bottom_row=bbox[3],  #y_max
-                    right_col=bbox[2]  #x_max
-                )),
-                data=resources_pb2.Data(concepts=[
-                    resources_pb2.Concept(
-                        id=f"id-{''.join(label.split(' '))}", name=label, value=1.)
-                    if not label_id else resources_pb2.Concept(id=label_id, name=label, value=1.)
-                ]))
-        ]))
+    annot_data = resources_pb2.Data(regions=[
+        resources_pb2.Region(
+            region_info=resources_pb2.RegionInfo(bounding_box=resources_pb2.BoundingBox(
+                # bbox ordering: [xmin, ymin, xmax, ymax]
+                # top_row must be less than bottom row
+                # left_col must be less than right col
+                top_row=bbox[1],  #y_min
+                left_col=bbox[0],  #x_min
+                bottom_row=bbox[3],  #y_max
+                right_col=bbox[2]  #x_max
+            )),
+            data=resources_pb2.Data(concepts=[
+                resources_pb2.Concept(id=f"id-{''.join(label.split(' '))}", name=label, value=1.)
+                if not label_id else resources_pb2.Concept(id=label_id, name=label, value=1.)
+            ]))
+    ])
+    if annot_id:
+      input_annot_proto = resources_pb2.Annotation(id=annot_id, input_id=input_id, data=annot_data)
+    else:
+      input_annot_proto = resources_pb2.Annotation(input_id=input_id, data=annot_data)
 
     return input_annot_proto
 
   @staticmethod
-  def get_mask_proto(input_id: str, label: str, polygons: List[List[float]],
-                     label_id: str = None) -> Annotation:
+  def get_mask_proto(input_id: str,
+                     label: str,
+                     polygons: List[List[float]],
+                     label_id: str = None,
+                     annot_id: str = None) -> Annotation:
     """Create an annotation proto for each polygon box, label input pair.
 
     Args:
@@ -531,6 +540,7 @@ class Inputs(Lister, BaseClient):
         label (str): annotation label name
         polygons (List): Polygon x,y points iterable
         label_id (str): annotation label ID
+        annot_id (str): annotation ID
 
     Returns:
         An annotation object for the specified input ID.
@@ -541,23 +551,24 @@ class Inputs(Lister, BaseClient):
     """
     if not isinstance(polygons, list):
       raise UserError("polygons must be a list of points")
-    input_mask_proto = resources_pb2.Annotation(
-        input_id=input_id,
-        data=resources_pb2.Data(regions=[
-            resources_pb2.Region(
-                region_info=resources_pb2.RegionInfo(polygon=resources_pb2.Polygon(
-                    points=[
-                        resources_pb2.Point(
-                            row=_point[1],  # row is y point
-                            col=_point[0],  # col is x point
-                            visibility="VISIBLE") for _point in polygons
-                    ])),
-                data=resources_pb2.Data(concepts=[
-                    resources_pb2.Concept(
-                        id=f"id-{''.join(label.split(' '))}", name=label, value=1.)
-                    if not label_id else resources_pb2.Concept(id=label_id, name=label, value=1.)
-                ]))
-        ]))
+    annot_data = resources_pb2.Data(regions=[
+        resources_pb2.Region(
+            region_info=resources_pb2.RegionInfo(polygon=resources_pb2.Polygon(
+                points=[
+                    resources_pb2.Point(
+                        row=_point[1],  # row is y point
+                        col=_point[0],  # col is x point
+                        visibility="VISIBLE") for _point in polygons
+                ])),
+            data=resources_pb2.Data(concepts=[
+                resources_pb2.Concept(id=f"id-{''.join(label.split(' '))}", name=label, value=1.)
+                if not label_id else resources_pb2.Concept(id=label_id, name=label, value=1.)
+            ]))
+    ])
+    if annot_id:
+      input_mask_proto = resources_pb2.Annotation(id=annot_id, input_id=input_id, data=annot_data)
+    else:
+      input_mask_proto = resources_pb2.Annotation(input_id=input_id, data=annot_data)
 
     return input_mask_proto
 
@@ -707,7 +718,7 @@ class Inputs(Lister, BaseClient):
 
     return input_job_id, response
 
-  def patch_inputs(self, inputs: List[Input], action: str = 'merge') -> str:
+  def patch_inputs(self, inputs: List[Input], action: str = 'merge') -> None:
     """Patch list of input objects to the app.
 
     Args:
@@ -719,7 +730,6 @@ class Inputs(Lister, BaseClient):
     """
     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)
@@ -727,9 +737,9 @@ class Inputs(Lister, BaseClient):
       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)
+        self.logger.warning(f"Patch inputs failed, status: {response.status}")
+    else:
+      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]]:
@@ -761,6 +771,67 @@ class Inputs(Lister, BaseClient):
 
     return retry_upload
 
+  def patch_annotations(self, batch_annot: List[resources_pb2.Annotation],
+                        action: str = 'merge') -> None:
+    """Patch image annotations to app.
+
+    Args:
+        batch_annot: annot batch protos
+        action (str): Action to perform on the input. Options: 'merge', 'overwrite', 'remove'.
+
+    """
+    if not isinstance(batch_annot, list):
+      raise UserError("batch_annot must be a list of Annotation objects")
+    request = service_pb2.PatchAnnotationsRequest(
+        user_app_id=self.user_app_id, annotations=batch_annot, action=action)
+    response = self._grpc_request(self.STUB.PatchAnnotations, request)
+    response_dict = MessageToDict(response)
+    if response.status.code != status_code_pb2.SUCCESS:
+      try:
+        for annot in response_dict["annotations"]:
+          if annot['status']['code'] != status_code_pb2.ANNOTATION_SUCCESS:
+            self.logger.warning(f"Patch annotations failed, status: {annot['status']}")
+      except Exception:
+        self.logger.warning(f"Patch annotations failed due to {response.status}")
+    else:
+      self.logger.info("\nPatch Annotations Uploaded Successful\n%s", response.status)
+
+  def patch_concepts(self,
+                     concept_ids: List[str],
+                     labels: List[str] = [],
+                     values: List[float] = [],
+                     action: str = 'overwrite') -> None:
+    """Patch concepts to app.
+
+    Args:
+        concept_ids:  A list of concept
+        labels: A list of label names
+        values: concept value
+        action (str): Action to perform on the input. Options: 'overwrite'.
+
+    """
+    if not labels:
+      labels = list(concept_ids)
+    if values:
+      concepts=[
+              resources_pb2.Concept(
+              id=concept_id, name=label, value=value)\
+              for concept_id, label, value in zip(concept_ids, labels, values)
+          ]
+    else:
+      concepts=[
+              resources_pb2.Concept(
+              id=concept_id, name=label, value=1.)\
+              for concept_id, label in zip(concept_ids, labels)
+          ]
+    request = service_pb2.PatchConceptsRequest(
+        user_app_id=self.user_app_id, concepts=concepts, action=action)
+    response = self._grpc_request(self.STUB.PatchConcepts, request)
+    if response.status.code != status_code_pb2.SUCCESS:
+      self.logger.warning(f"Patch Concepts failed, status: {response.status.details}")
+    else:
+      self.logger.info("\nPatch Concepts Successful\n%s", response.status)
+
   def _upload_batch(self, inputs: List[Input]) -> List[Input]:
     """Upload a batch of input objects to the app.
 

clarifai/client/search.py

@@ -277,7 +277,8 @@ class Search(Lister, BaseClient):
         Get successful inputs of type image or text
         >>> from clarifai.client.search import Search
         >>> search = Search(user_id='user_id', app_id='app_id', top_k=10, metric='cosine')
-        >>> res = search.query(filters=[{'input_types': ['image', 'text']}, {'input_status_code': 30000}])
+        # This performs OR operation on input_types and input_status_code
+        >>> res = search.query(filters=[{'input_types': ['image', 'text'], 'input_status_code': 30000}])
 
         Vector search over inputs
         >>> from clarifai.client.search import Search
@@ -298,43 +299,27 @@ class Search(Lister, BaseClient):
       raise UserError(f"Invalid rank or filter input: {err}")
 
     # For each rank, create a Rank proto message
-    rank_annot_proto = []
+    # For ranks it only allows resources_pb2.Annotation proto, so no need of splitting protos into annotation and input.
+    all_ranks = []
     for rank_dict in ranks:
-      rank_annot_proto.append(self._get_annot_proto(**rank_dict))
-    all_ranks = [resources_pb2.Rank(annotation=rank_annot) for rank_annot in rank_annot_proto]
-
-    # Calls PostInputsSearches for annotation ranks, input filters
-    if any(["input" in k for k in filters[0].keys()]):
-      filters_input_proto = []
-      for filter_dict in filters:
-        filters_input_proto.append(self._get_input_proto(**filter_dict))
-      all_filters = [
-          resources_pb2.Filter(input=filter_input) for filter_input in filters_input_proto
-      ]
-      request_data = dict(
-          user_app_id=self.user_app_id,
-          searches=[
-              resources_pb2.Search(
-                  query=resources_pb2.Query(ranks=all_ranks, filters=all_filters),
-                  algorithm=self.algorithm,
-                  metric=self.metric_distance)
-          ])
-      if self.pagination:
-        return self._list_all_pages_generator(self.STUB.PostInputsSearches,
-                                              service_pb2.PostInputsSearchesRequest, request_data,
-                                              page_no, per_page)
-      return self._list_topk_generator(self.STUB.PostInputsSearches,
-                                       service_pb2.PostInputsSearchesRequest, request_data)
-
-    # Calls PostAnnotationsSearches for annotation ranks, filters
-    filters_annot_proto = []
-    for filter_dict in filters:
-      filters_annot_proto.append(self._get_annot_proto(**filter_dict))
-
-    all_filters = [
-        resources_pb2.Filter(annotation=filter_annot) for filter_annot in filters_annot_proto
-    ]
-
+      rank_annot_proto = self._get_annot_proto(**rank_dict)
+      all_ranks.append(resources_pb2.Rank(annotation=rank_annot_proto))
+
+    all_filters = []
+    # check for filters which is compatible with input proto
+    for each_filter in filters:
+      input_dict = {
+          key: each_filter.pop(key)
+          for key in ['input_types', 'input_dataset_ids', 'input_status_code']
+          if key in each_filter
+      }
+
+      all_filters.append(
+          resources_pb2.Filter(
+              annotation=self._get_annot_proto(**each_filter),
+              input=self._get_input_proto(**input_dict)))
+
+    # Create a PostInputsSearchesRequest proto message
     request_data = dict(
         user_app_id=self.user_app_id,
         searches=[
@@ -343,9 +328,10 @@ class Search(Lister, BaseClient):
                 algorithm=self.algorithm,
                 metric=self.metric_distance)
         ])
+    # Calls PostInputsSearches for annotation ranks, input filters
     if self.pagination:
-      return self._list_all_pages_generator(self.STUB.PostAnnotationsSearches,
-                                            service_pb2.PostAnnotationsSearchesRequest,
-                                            request_data, page_no, per_page)
-    return self._list_topk_generator(self.STUB.PostAnnotationsSearches,
-                                     service_pb2.PostAnnotationsSearchesRequest, request_data)
+      return self._list_all_pages_generator(self.STUB.PostInputsSearches,
+                                            service_pb2.PostInputsSearchesRequest, request_data,
+                                            page_no, per_page)
+    return self._list_topk_generator(self.STUB.PostInputsSearches,
+                                     service_pb2.PostInputsSearchesRequest, request_data)

clarifai/client/user.py

@@ -3,6 +3,7 @@ from typing import Any, Dict, Generator, List
 from clarifai_grpc.grpc.api import resources_pb2, service_pb2
 from clarifai_grpc.grpc.api.status import status_code_pb2
 from google.protobuf.json_format import MessageToDict
+from google.protobuf.wrappers_pb2 import BoolValue
 
 from clarifai.client.app import App
 from clarifai.client.base import BaseClient
@@ -222,6 +223,38 @@ class User(Lister, BaseClient):
 
     return dict(self.auth_helper, check_runner_exists=False, **kwargs)
 
+  def patch_app(self, app_id: str, action: str = 'overwrite', **kwargs) -> App:
+    """Patch an app for the user.
+
+    Args:
+        app_id (str): The app ID for the app to patch.
+        action (str): The action to perform on the app (overwrite/remove).
+        **kwargs: Additional keyword arguments to be passed to patch the App.
+
+    Returns:
+        App: Patched App object for the specified app ID.
+    """
+    if "base_workflow" in kwargs:
+      kwargs["default_workflow"] = resources_pb2.Workflow(
+          id=kwargs.pop("base_workflow"), app_id="main", user_id="clarifai")
+    if "visibility" in kwargs:
+      kwargs["visibility"] = resources_pb2.Visibility(gettable=kwargs["visibility"])
+    if "image_url" in kwargs:
+      kwargs["image"] = resources_pb2.Image(url=kwargs.pop("image_url"))
+    if "is_template" in kwargs:
+      kwargs["is_template"] = BoolValue(value=kwargs["is_template"])
+    request = service_pb2.PatchAppRequest(
+        user_app_id=resources_pb2.UserAppIDSet(user_id=self.id, app_id=app_id),
+        app=resources_pb2.App(id=app_id, **kwargs),
+        action=action,
+        reindex=False)
+    response = self._grpc_request(self.STUB.PatchApp, request)
+    if response.status.code != status_code_pb2.SUCCESS:
+      raise Exception(response.status)
+    self.logger.info("\nApp patched\n%s", response.status)
+
+    return App.from_auth_helper(auth=self.auth_helper, app_id=app_id)
+
   def delete_app(self, app_id: str) -> None:
     """Deletes an app for the user.
 

clarifai/constants/dataset.py

@@ -22,3 +22,5 @@ TASK_TO_ANNOTATION_TYPE = {
 }
 
 MAX_RETRIES = 2
+
+CONTENT_TYPE = {"json": "application/json", "zip": "application/zip"}

clarifai/datasets/export/inputs_annotations.py

@@ -12,6 +12,7 @@ from google.protobuf.json_format import MessageToDict
 from PIL import ImageFile
 from tqdm import tqdm
 
+from clarifai.constants.dataset import CONTENT_TYPE
 from clarifai.errors import UserError
 from clarifai.utils.logging import get_logger
 
@@ -61,8 +62,11 @@ class DatasetExportReader:
   def _download_temp_archive(self, archive_url: str,
                              chunk_size: int = 128) -> tempfile.TemporaryFile:
     """Downloads the temp archive of InputBatches."""
-    session = requests.Session()
-    r = session.get(archive_url, stream=True)
+    r = self.session.get(archive_url, stream=True)
+    if r.headers['content-type'] == CONTENT_TYPE['json']:
+      raise Exception("File is a json file :\n {}".format(r.json()))
+    elif r.headers['content-type'] != CONTENT_TYPE['zip']:
+      raise Exception('File is not a zip file')
     temp_file = tempfile.TemporaryFile()
     for chunk in r.iter_content(chunk_size=chunk_size):
       temp_file.write(chunk)

clarifai/rag/rag.py

@@ -14,7 +14,9 @@ from clarifai.constants.rag import MAX_UPLOAD_BATCH_SIZE
 from clarifai.errors import UserError
 from clarifai.rag.utils import (convert_messages_to_str, format_assistant_message, load_documents,
                                 split_document)
+from clarifai.utils.constants import CLARIFAI_USER_ID_ENV_VAR
 from clarifai.utils.logging import get_logger
+from clarifai.utils.misc import get_from_dict_or_env
 
 DEFAULT_RAG_PROMPT_TEMPLATE = "Context information is below:\n{data.hits}\nGiven the context information and not prior knowledge, answer the query.\nQuery: {data.text.raw}\nAnswer: "
 
@@ -75,6 +77,12 @@ class RAG:
         >>> rag_agent = RAG.setup(app_url=YOUR_APP_URL)
         >>> rag_agent.chat(messages=[{"role":"human", "content":"What is Clarifai"}])
     """
+    if not app_url:
+      try:
+        user_id = get_from_dict_or_env(key="user_id", env_key=CLARIFAI_USER_ID_ENV_VAR, **kwargs)
+      except Exception:
+        pass
+
     now_ts = uuid.uuid4().hex[:10]
     if user_id and not app_url:
       user = User(user_id=user_id, base_url=base_url, pat=pat)

clarifai/utils/constants.py

@@ -1,2 +1,3 @@
 CLARIFAI_PAT_ENV_VAR = "CLARIFAI_PAT"
 CLARIFAI_SESSION_TOKEN_ENV_VAR = "CLARIFAI_SESSION_TOKEN"
+CLARIFAI_USER_ID_ENV_VAR = "CLARIFAI_USER_ID"

clarifai/utils/logging.py

@@ -3,6 +3,7 @@ from collections import defaultdict
 from typing import Dict, List, Optional, Union
 
 from rich import print as rprint
+from rich.console import Console
 from rich.logging import RichHandler
 from rich.table import Table
 from rich.traceback import install
@@ -84,7 +85,8 @@ def _configure_logger(name: str, logger_level: Union[int, str] = logging.NOTSET)
     logger.removeHandler(handler)
 
   # Add the new rich handler and formatter
-  handler = RichHandler(rich_tracebacks=True, log_time_format="%Y-%m-%d %H:%M:%S")
+  handler = RichHandler(
+      rich_tracebacks=True, log_time_format="%Y-%m-%d %H:%M:%S", console=Console(width=255))
   formatter = logging.Formatter('%(name)s:  %(message)s')
   handler.setFormatter(formatter)
   logger.addHandler(handler)

clarifai/versions.py

@@ -1,6 +1,7 @@
 import os
+from clarifai import __version__
 
-CLIENT_VERSION = "10.5.3"
+CLIENT_VERSION = __version__
 OS_VER = os.sys.platform
 PYTHON_VERSION = '.'.join(
     map(str, [os.sys.version_info.major, os.sys.version_info.minor, os.sys.version_info.micro]))

{clarifai-10.5.3.dist-info → clarifai-10.7.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: clarifai
-Version: 10.5.3
+Version: 10.7.0
 Summary: Clarifai Python SDK
 Home-page: https://github.com/Clarifai/clarifai-python
 Author: Clarifai
@@ -20,7 +20,7 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: clarifai-grpc >=10.5.0
+Requires-Dist: clarifai-grpc >=10.7.0
 Requires-Dist: numpy >=1.22.0
 Requires-Dist: tqdm >=4.65.0
 Requires-Dist: tritonclient >=2.34.0