Skip to content
YosoiDocs

SearchHit

yosoi.search.SearchHit

class SearchHit(ImmutableModel):

An accepted organic result in provider order, with possible rank gaps.

Attributes: url: Validated HTTP(S) destination for an explicit later request. organic_rank: One-based organic row rank; rejected or duplicate rows can leave gaps. placement_index: One-based placement on the provider page, including rich features. metadata: Optional provider-displayed details, without a destination fetch.

Source: python/yosoi/search.py:118

Members below are declared on this class. Inherited Pydantic methods and generated constructor signatures are not expanded.

url: SearchResultUrl = Field(repr=False)
organic_rank: Rank
placement_index: Rank
metadata: SearchHitMetadata = Field(repr=False)
@property
def title(self) -> str | None:

Return the provider-displayed title, or None when unavailable.

Source: python/yosoi/search.py:147

@property
def snippet(self) -> str | None:

Return the provider excerpt without fetching or verifying the destination.

Source: python/yosoi/search.py:152

@property
def display_url(self) -> str | None:

Return the displayed address, which can differ from the destination.

Source: python/yosoi/search.py:157

@property
def publisher(self) -> str | None:

Return the unverified provider-displayed publisher label.

Source: python/yosoi/search.py:162

@property
def published_at(self) -> str | None:

Return displayed date text, not a verified publication date.

Source: python/yosoi/search.py:167

@property
def thumbnail_url(self) -> str | None:

Return the validated thumbnail destination, without fetching an image.

Source: python/yosoi/search.py:172