This documentation is for an older version of GoodData.
Go to the latest version of this article.
ComputeService.
search_ai
search_ai(workspace_id: str, question: str, deep_search: bool, limit: Optional[int], object_types: Optional[list[str]], relevant_score_threshold: Optional[float], title_to_descriptor_ratio: Optional[float]) ->
SearchResult
Search for metadata objects using similarity search.
Parameters
| name | type | description |
|---|---|---|
| workspace_id | str | workspace identifier |
| question | str | keyword/sentence input for search |
| deep_search | bool | turn on deep search - if true, content of complex objects will be searched as well |
| limit | Optional[int] | maximum number of results to return. Defaults to None. |
| object_types | Optional[list[str]] | list of object types to search for. Enum items: "attribute", "metric", "fact", "label", "date", "dataset", "visualization" and "dashboard". Defaults to None. |
| relevant_score_threshold | Optional[float] | minimum relevance score threshold for results. Defaults to None. |
| title_to_descriptor_ratio | Optional[float] | ratio of title score to descriptor score. Defaults to None. |
Returns
| type | description |
|---|---|
| SearchResult | Search results |