Search Module API

API reference for search endpoints.

BriteCore v2 Search API endpoint wrappers.

This module provides wrappers for adding and removing documents from the BriteCore v2 search index.

britecore_sdk.api.api_calls.v2.search.add_to_index(document=None, document_id=None, index_name=None, **kwargs)

Add a document to a search index.

POST /api/v2/search/add_to_index

Parameters:

• document (dict | None)

• document_id (str | None)

• index_name (str | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.search.remove_from_index(document_id=None, index_name=None, **kwargs)

Remove a document from a search index.

POST /api/v2/search/remove_from_index

Parameters:

• document_id (str | None)

• index_name (str | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any