provenaclient.modules.search

Created Date: Thursday May 30th 2024 +1000 Author: Peter Baker —– Last Modified: Thursday May 30th 2024 10:17:36 am +1000 Modified By: Peter Baker —– Description: Search API L3 Module. —– HISTORY: Date By Comments ———- — ———————————————————

Attributes

DEFAULT_SEARCH_LIMIT

Classes

Search

This class interface just captures that the client has an instantiated auth

Module Contents

provenaclient.modules.search.DEFAULT_SEARCH_LIMIT = 25

class provenaclient.modules.search.Search(auth: provenaclient.clients.client_helpers.AuthManager, config: provenaclient.clients.client_helpers.Config, search_client: provenaclient.clients.SearchClient)[source]

Bases: provenaclient.clients.client_helpers.ClientService

This class interface just captures that the client has an instantiated auth manager which allows for helper functions abstracted for L2 clients.

_search_client: provenaclient.clients.SearchClient

_auth

_config

async search_registry(query: str, limit: int | None, subtype_filter: ProvenaInterfaces.RegistryModels.ItemSubType | None) → ProvenaInterfaces.SearchAPI.QueryResults[source]

Searches the registry for given query, limit and subtype.

Parameters:

query (str) – The query to make
limit (Optional[int]) – The query limit
subtype_filter (Optional[ItemSubType]) – The subtype to filter by if any

Returns:

Results - ids and scores

Return type:

QueryResults