@@ -672,7 +672,9 @@ def search(
672672 batch_id (str): batch id that an image must be in
673673 annotation_job (bool): whether the image must be in an annotation job
674674 annotation_job_id (str): annotation job id that an image must be in
675- fields (list): fields to return in results (default: ["id", "created", "name", "labels"])
675+ fields (list): fields to return in results (default: ["id", "created", "name", "labels"]).
676+ Available fields: id, name, created, annotations, labels, split, tags, owner,
677+ embedding, user_metadata.
676678
677679 Returns:
678680 A list of images that match the search criteria.
@@ -684,7 +686,14 @@ def search(
684686
685687 >>> project = rf.workspace().project("PROJECT_ID")
686688
687- >>> results = project.search(query="cat", limit=10)
689+ >>> # Basic search
690+ >>> results = project.search(prompt="cat", limit=10)
691+
692+ >>> # Search with tags and user_metadata
693+ >>> results = project.search(
694+ ... limit=10,
695+ ... fields=["id", "name", "tags", "user_metadata"]
696+ ... )
688697 """ # noqa: E501 // docs
689698 if fields is None :
690699 fields = ["id" , "created" , "name" , "labels" ]
@@ -764,10 +773,12 @@ def search_all(
764773 batch_id (str): batch id that an image must be in
765774 annotation_job (bool): whether the image must be in an annotation job
766775 annotation_job_id (str): annotation job id that an image must be in
767- fields (list): fields to return in results (default: ["id", "created", "name", "labels"])
776+ fields (list): fields to return in results (default: ["id", "created"]).
777+ Available fields: id, name, created, annotations, labels, split, tags, owner,
778+ embedding, user_metadata.
768779
769780 Returns:
770- A list of images that match the search criteria.
781+ A generator yielding images that match the search criteria.
771782
772783 Example:
773784 >>> import roboflow
@@ -776,10 +787,9 @@ def search_all(
776787
777788 >>> project = rf.workspace().project("PROJECT_ID")
778789
779- >>> results = project.search_all(query ="cat", limit=10)
790+ >>> results = project.search_all(prompt ="cat", limit=10)
780791
781792 >>> for result in results:
782-
783793 >>> print(result)
784794 """ # noqa: E501 // docs
785795 if fields is None :
0 commit comments