Search

Search allows a standard search of Workplace AI, as if it were entered in enterprise search. It returns a DataSample object which has a .df property, a pandas data frame.

SearchAPI.search(query_string="*", search_flow_id=None, datasets=None, page_size=100, access_level=None, include=None, raw=False) 

Name	Type	Description
query_string	string	Free text, search term, can use Lucene syntax
search_flow_id	string	Optionally, the ID for the search flow to use (otherwise will use default)
datasets	list of string	List of dataset IDs to search over, if not provided, all are searched
page_size	integer	Page size (number of documents returned), defaults to 100
access_level	integer	AIE access level to use, optional, if provided overrides default privileged access state
include	string	Optional, “include” property of AIE JSON filter
raw	boolean	If true, this function returns the JSON response as a dictionary, not a DataSample object. Default is false.

Example

results = search_api.search("Hello World", search_flow_id = "engineering") 
print(results.df)