#### NOTE
This is a **community plugin**, an external project maintained by its respective author.
Community plugins are not part of FiftyOne core and may change independently.
Please review each plugin’s documentation and license before use.

<a href="https://github.com/jacobmarks/keyword-search-plugin" target="_blank">![GitHub Repo](https://img.shields.io/badge/GitHub-Repository-black?logo=github)</a>

# Keyword Search Plugin

![keyword_search](https://github.com/jacobmarks/keyword-search-plugin/assets/12500356/08fcf04d-35c5-45e5-b950-ba732da26d14)

This plugin is a Python plugin that allows you to search through your dataset
using keywords.

# Watch On Youtube

[![Video Thumbnail](https://img.youtube.com/vi/jnNPGrM6Wr4/0.jpg)](https://www.youtube.com/watch?v=jnNPGrM6Wr4&list=PLuREAXoPgT0RZrUaT0UpX_HzwKkoB-S9j&index=6)

# Installation

```shell
fiftyone plugins download https://github.com/jacobmarks/keyword-search-plugin
```

# Operators

## `search_by_keyword`

**Description**: Search for samples by keyword

**Inputs**:

- `query`: The keyword or keyphrase to search for
- `field`: The field to search in (any `StringField`)
- `case_sensitive`: Whether to match case sensitively