<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/tflite-support/blob/v0.4.4/tensorflow_lite_support/python/task/text/text_searcher.py#L50-L138) |

Class to performs text search.

    tflite_support.task.text.TextSearcher(
        options: https://developers.google.com/edge/api/tflite/python/tflite_support/task/text/TextSearcherOptions,
        cpp_searcher: _CppTextSearcher
    ) -> None

It works by performing embedding extraction on text, followed by
nearest-neighbor search in an index of embeddings through ScaNN.

<br />

<br />

<br />

| ## Attributes ||
|---|---|
| `options` | <br /> <br /> |

<br />

## Methods

### `create_from_file`

[View source](https://github.com/tensorflow/tflite-support/blob/v0.4.4/tensorflow_lite_support/python/task/text/text_searcher.py#L64-L87)

    @classmethod
    create_from_file(
        model_file_path: str, index_file_path: Optional[str] = None
    ) -> 'TextSearcher'

Creates the `TextSearcher` object from a TensorFlow Lite model.

<br />

<br />

<br />

| Args ||
|---|---|
| `model_file_path` | Path to the model. |
| `index_file_path` | Path to the index. Only required if the index is not attached to the output tensor metadata as an AssociatedFile with type SCANN_INDEX_FILE. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| `TextSearcher` object that's created from `options`. ||

<br />

<br />

<br />

<br />

| Raises ||
|---|---|
| `ValueError` | If failed to create `TextSearcher` object from the provided file such as invalid file. |
| `RuntimeError` | If other types of error occurred. |

<br />

### `create_from_options`

[View source](https://github.com/tensorflow/tflite-support/blob/v0.4.4/tensorflow_lite_support/python/task/text/text_searcher.py#L89-L106)

    @classmethod
    create_from_options(
        options: https://developers.google.com/edge/api/tflite/python/tflite_support/task/text/TextSearcherOptions
    ) -> 'TextSearcher'

Creates the `TextSearcher` object from text searcher options.

<br />

<br />

<br />

| Args ||
|---|---|
| `options` | Options for the text searcher task. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| `TextSearcher` object that's created from `options`. ||

<br />

<br />

<br />

<br />

| Raises ||
|---|---|
| `ValueError` | If failed to create `TextSearcher` object from `TextSearcherOptions` such as missing the model. |
| `RuntimeError` | If other types of error occurred. |

<br />

### `get_user_info`

[View source](https://github.com/tensorflow/tflite-support/blob/v0.4.4/tensorflow_lite_support/python/task/text/text_searcher.py#L127-L134)

    get_user_info() -> str

Gets the user info stored in the index file.

<br />

<br />

<br />

| Returns ||
|---|---|
| Opaque user info stored in the index file (if any), in raw binary form. Returns an empty string if the index doesn't contain user info. ||

<br />

### `search`

[View source](https://github.com/tensorflow/tflite-support/blob/v0.4.4/tensorflow_lite_support/python/task/text/text_searcher.py#L108-L125)

    search(
        text: str
    ) -> https://developers.google.com/edge/api/tflite/python/tflite_support/task/processor/SearchResult

Search for text with similar semantic meaning.

This method performs actual feature extraction on the provided text input,
followed by nearest-neighbor search in the index.

<br />

<br />

<br />

| Args ||
|---|---|
| [`text`](https://www.tensorflow.org/text/api_docs/python/text) | the input text, used to extract the feature vectors. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| search result. ||

<br />

<br />

<br />

<br />

| Raises ||
|---|---|
| `ValueError` | If any of the input arguments is invalid. |
| `RuntimeError` | If failed to perform nearest-neighbor search. |

<br />