{py:mod}abx_plugin_sonic_search.searchbackend

:allowtitles:

Module Contents

Classes

:class: autosummary longtable
:align: left

* - {py:obj}`SonicSearchBackend <abx_plugin_sonic_search.searchbackend.SonicSearchBackend>`
  -

Data

:class: autosummary longtable
:align: left

* - {py:obj}`SONIC_SEARCH_BACKEND <abx_plugin_sonic_search.searchbackend.SONIC_SEARCH_BACKEND>`
  - ```{autodoc2-docstring} abx_plugin_sonic_search.searchbackend.SONIC_SEARCH_BACKEND
    :summary:
    ```

API

:canonical: abx_plugin_sonic_search.searchbackend.SonicSearchBackend

Bases: {py:obj}`abx_spec_searchbackend.BaseSearchBackend`

````{py:attribute} name
:canonical: abx_plugin_sonic_search.searchbackend.SonicSearchBackend.name
:type: str
:value: >
   'sonic'

```{autodoc2-docstring} abx_plugin_sonic_search.searchbackend.SonicSearchBackend.name
```

````

````{py:attribute} docs_url
:canonical: abx_plugin_sonic_search.searchbackend.SonicSearchBackend.docs_url
:type: str
:value: >
   'https://github.com/valeriansaliou/sonic'

```{autodoc2-docstring} abx_plugin_sonic_search.searchbackend.SonicSearchBackend.docs_url
```

````

````{py:method} index(snapshot_id: str, texts: typing.List[str])
:canonical: abx_plugin_sonic_search.searchbackend.SonicSearchBackend.index
:staticmethod:

```{autodoc2-docstring} abx_plugin_sonic_search.searchbackend.SonicSearchBackend.index
```

````

````{py:method} flush(snapshot_ids: typing.Generator[str, None, None])
:canonical: abx_plugin_sonic_search.searchbackend.SonicSearchBackend.flush
:staticmethod:

```{autodoc2-docstring} abx_plugin_sonic_search.searchbackend.SonicSearchBackend.flush
```

````

````{py:method} search(text: str) -> typing.List[str]
:canonical: abx_plugin_sonic_search.searchbackend.SonicSearchBackend.search
:staticmethod:

```{autodoc2-docstring} abx_plugin_sonic_search.searchbackend.SonicSearchBackend.search
```

````

:canonical: abx_plugin_sonic_search.searchbackend.SONIC_SEARCH_BACKEND
:value: >
   'SonicSearchBackend(...)'

```{autodoc2-docstring} abx_plugin_sonic_search.searchbackend.SONIC_SEARCH_BACKEND
```