> Fetch clean Markdown by appending `.md` to any page URL under https://signalwire.com/docs or requesting it with the HTTP header `Accept: text/markdown`. The root index at https://signalwire.com/docs/llms.txt lists the available documentation indexes.

# SearchEngine

> Hybrid search engine for vector and keyword search over indexed documents.

[search]: /docs/server-sdks/reference/python/agents/search/search-engine/search

[getstats]: /docs/server-sdks/reference/python/agents/search/search-engine/get-stats

`SearchEngine` performs hybrid search over indexed documents by combining vector
similarity search with keyword matching, filename search, and metadata search.
Results from all search strategies are merged and ranked using a max-signal-wins
scoring approach, with diversity penalties to prevent single-file dominance.

The engine supports two storage backends: SQLite (`.swsearch` files) for local
use, and pgvector for PostgreSQL-based deployments.

```python
from signalwire.search import SearchEngine
```

> **Warning**
>
> Requires search dependencies. Install with `pip install signalwire-sdk[search]`.

## **Properties**

**`backend`** `str`

Storage backend in use. Either `"sqlite"` or `"pgvector"`.

---

**`config`** `dict[str, str]`

Index configuration loaded from the backend, including model name, embedding
dimensions, and creation metadata.

---

**`embedding_dim`** `int`

Dimensionality of the embedding vectors in the index. Defaults to `768`.

---

**`model`** `SentenceTransformer | None` — default: None

Optional sentence transformer model instance passed at construction time.

---

## **Methods**

#### [search](/docs/server-sdks/reference/python/agents/search/search-engine/search)

Perform a hybrid search combining vector similarity, keyword matching, and metadata search.

#### [get\_stats](/docs/server-sdks/reference/python/agents/search/search-engine/get-stats)

Return statistics about the search index.

> Hybrid search engine for vector and keyword search over indexed documents.

## Docs

- [get_stats](https://signalwire.com/docs/server-sdks/reference/python/agents/search/search-engine/get-stats.md): Return statistics about the search index.
- [search](https://signalwire.com/docs/server-sdks/reference/python/agents/search/search-engine/search.md): Perform a hybrid search query against the indexed documents.