SearchResult API¶
- class SearchResult(app_label, model_name, pk, score, **kwargs)¶
The SearchResult class provides structure to the results that come back from the search index. These objects are what a SearchQuerySet will return when evaluated.
Attribute Reference¶
The class exposes the following useful attributes/properties:
- app_label - The application the model is attached to.
- model_name - The model’s name.
- pk - The primary key of the model.
- score - The score provided by the search engine.
- object - The actual model instance (lazy loaded).
- model - The model class.
- verbose_name - A prettier version of the model’s class name for display.
- verbose_name_plural - A prettier version of the model’s plural class name for display.
- search_index - Returns the SearchIndex class associated with this result.
- distance - On geo-spatial queries, this returns a Distance object representing the distance the result was from the focused point.
Method Reference¶
content_type¶
- SearchResult.content_type(self)¶
Returns the content type for the result’s model instance.