GOgooddata
Smart Functions

(BETA) Semantic Search in Metadata

(BETA) Uses similarity (e.g. cosine distance) search to find top X most similar metadata objects.

post/api/v1/ai/workspaces/{workspace_id}/search

Request

  • Base URL
    https://www.gooddata.ai
  • Auth
    none declared

Path parameters

workspace_idstring required

Request body

deepSearchboolean

Turn on deep search. If true, content of complex objects will be searched as well, e.g. metrics in visualizations.

enableHybridSearchboolean

If true, enables hybrid search combining vector similarity and keyword matching. This can improve search results by considering both semantic similarity and exact keyword matches.

excludeTagsstring[]

Exclude objects that contain any of the specified tags. This parameter only affects the search results. Objects with excluded tags are completely hidden from the results.

includeHiddenboolean

If true, includes hidden objects in search results. If false (default), excludes objects where isHidden=true.

includeTagsstring[]

Include only objects that contain at least one of the specified tags (OR logic). This parameter only affects the search results. If an object has multiple tags, it will be included as long as it matches at least one tag from this parameter.

limitinteger

Maximum number of results to return. There is a hard limit and the actual number of returned results may be lower than what is requested. This can happen when post-search filters are applied (e.g., reranker threshold filtering or allowedRelationshipTypes filtering), which may exclude some results after the initial search.

objectTypesstring[]

Object type to search for.

questionstring required

Keyword/sentence is input for search.

relevantScoreThresholdnumber

Score, above which we return found objects. Below this score objects are not relevant.

titleToDescriptorRationumber

Temporary for experiments. Ratio of title score to descriptor score.

Response

Successful Response

reasoningstring required

DEPRECATED: Use top-level reasoning.steps instead. If something is not working properly this field will contain explanation.

Changes

No recorded changes to this operation across all 1 revision of this API.