<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/vision/image_searcher.py#L53-L155) |

Class to performs image search.

    tflite_support.task.vision.ImageSearcher(
        options: https://developers.google.com/edge/api/tflite/python/tflite_support/task/vision/ImageSearcherOptions,
        cpp_searcher: _CppImageSearcher
    ) -> None

It works by performing embedding extraction on images, 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/vision/image_searcher.py#L67-L91)

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

Creates the `ImageSearcher` 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 ||
|---|---|
| `ImageSearcher` object that's created from `options`. ||

<br />

<br />

<br />

<br />

| Raises ||
|---|---|
| `ValueError` | If failed to create `ImageSearcher` 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/vision/image_searcher.py#L93-L111)

    @classmethod
    create_from_options(
        options: https://developers.google.com/edge/api/tflite/python/tflite_support/task/vision/ImageSearcherOptions
    ) -> 'ImageSearcher'

Creates the `ImageSearcher` object from image searcher options.

<br />

<br />

<br />

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

<br />

<br />

<br />

<br />

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

<br />

<br />

<br />

<br />

| Raises ||
|---|---|
| `ValueError` | If failed to create `ImageSearcher` object from `ImageSearcherOptions` 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/vision/image_searcher.py#L144-L151)

    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/vision/image_searcher.py#L113-L142)

    search(
        image: https://developers.google.com/edge/api/tflite/python/tflite_support/task/vision/TensorImage,
        bounding_box: Optional[https://developers.google.com/edge/api/tflite/python/tflite_support/task/processor/BoundingBox] = None
    ) -> https://developers.google.com/edge/api/tflite/python/tflite_support/task/processor/SearchResult

Search for image with similar semantic meaning.

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

<br />

<br />

<br />

| Args ||
|---|---|
| `image` | Tensor image, used to extract the feature vectors. |
| `bounding_box` | Bounding box, optional. If set, performed feature vector extraction only on the provided region of interest. Note that the region of interest is not clamped, so this method will fail if the region is out of bounds of the input image. |

<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 />