> ## Documentation Index
> Fetch the complete documentation index at: https://algolia.com/llms.txt
> Use this file to discover all available pages before exploring further.

# tagFilters

> Filter results by the special "_tags" attribute

export const Setting = ({type, default: defaultValue, defaultNote, scope, min, max, formerly}) => {
  const renderedDefault = defaultValue === '' ? '""' : defaultValue;
  const renderedNote = defaultNote ? `(${defaultNote})` : '';
  return <ul>
      <li><strong>Type:</strong> <code>{type}</code></li>
      <li><strong>Default:</strong> <code>{renderedDefault}</code>{renderedNote}</li>
      {min && <li><strong>Min:</strong> <code>{min}</code></li>}
      {max && <li><strong>Max:</strong> <code>{max}</code></li>}
      <li><strong>Scope:</strong> <a href="/doc/api-reference/api-parameters"><code>{scope}</code></a></li>
      {formerly && <li>
          <strong>Deprecated name:</strong> <code>{formerly}</code>
        </li>}
    </ul>;
};

<Setting type="list<string>" default="[]" scope="search" formerly="tags" />

The `tagFilters` parameter lets you filter records based on values in the `_tags` attribute.
It uses the same syntax and structure as [`facetFilters`](/doc/api-reference/api-parameters/facetFilters).

Unlike regular facets, `_tags` is always available for filtering—you don't need to include it in `attributesForFaceting`.

To use this parameter, your records must contain a top-level `_tags` attribute.
This parameter is only for filtering—**it doesn't return facet counts** or support faceting behavior.

<Tip>
  For advanced use cases or filters on arbitrary attributes,
  use the [`filters`](/doc/api-reference/api-parameters/filters) parameter instead.
</Tip>

## Usage notes

* Tag names are case-sensitive.
* Multiple tags in an array are combined with `AND`.\
  Use nested arrays for `OR` conditions.
* Prefix a tag with `-` to exclude it.\
  Example: `["tag1", "-tag2"]` means `tag1 AND NOT tag2`.

For more information, see [`facetFilters`](/doc/api-reference/api-parameters/facetFilters#usage).

## Example

<AccordionGroup>
  <Accordion title="Current API clients" defaultOpen="true">
    <CodeGroup>
      ```cs C# theme={"system"}
      var response = await client.SearchSingleIndexAsync<Hit>(
        "INDEX_NAME",
        new SearchParams(
          new SearchParamsObject
          {
            Query = "query",
            TagFilters = new TagFilters(
              new List<TagFilters>
              {
                new TagFilters("SciFi"),
                new TagFilters(
                  new List<TagFilters> { new TagFilters("Book"), new TagFilters("Movie") }
                ),
              }
            ),
          }
        )
      );
      ```

      ```dart Dart theme={"system"}
      final response = await client.searchSingleIndex(
        indexName: "INDEX_NAME",
        searchParams: SearchParamsObject(
          query: "query",
          tagFilters: [
            "SciFi",
            [
              "Book",
              "Movie",
            ],
          ],
        ),
      );
      ```

      ```go Go theme={"system"}
      response, err := client.SearchSingleIndex(client.NewApiSearchSingleIndexRequest(
        "INDEX_NAME").WithSearchParams(search.SearchParamsObjectAsSearchParams(
        search.NewEmptySearchParamsObject().SetQuery("query").SetTagFilters(search.ArrayOfTagFiltersAsTagFilters(
          []search.TagFilters{*search.StringAsTagFilters("SciFi"), *search.ArrayOfTagFiltersAsTagFilters(
            []search.TagFilters{*search.StringAsTagFilters("Book"), *search.StringAsTagFilters("Movie")})})))))
      if err != nil {
        // handle the eventual error
        panic(err)
      }
      ```

      ```java Java theme={"system"}
      SearchResponse response = client.searchSingleIndex(
        "INDEX_NAME",
        new SearchParamsObject()
          .setQuery("query")
          .setTagFilters(
            TagFilters.of(Arrays.asList(TagFilters.of("SciFi"), TagFilters.of(Arrays.asList(TagFilters.of("Book"), TagFilters.of("Movie")))))
          ),
        Hit.class
      );
      ```

      ```js JavaScript theme={"system"}
      const response = await client.searchSingleIndex({
        indexName: 'indexName',
        searchParams: { query: 'query', tagFilters: ['SciFi', ['Book', 'Movie']] },
      });
      ```

      ```kotlin Kotlin theme={"system"}
      var response =
        client.searchSingleIndex(
          indexName = "INDEX_NAME",
          searchParams =
            SearchParamsObject(
              query = "query",
              tagFilters =
                TagFilters.of(
                  listOf(
                    TagFilters.of("SciFi"),
                    TagFilters.of(listOf(TagFilters.of("Book"), TagFilters.of("Movie"))),
                  )
                ),
            ),
        )
      ```

      ```php PHP theme={"system"}
      $response = $client->searchSingleIndex(
          'INDEX_NAME',
          ['query' => 'query',
              'tagFilters' => [
                  'SciFi',

                  [
                      'Book',

                      'Movie',
                  ],
              ],
          ],
      );
      ```

      ```python Python theme={"system"}
      response = client.search_single_index(
          index_name="INDEX_NAME",
          search_params={
              "query": "query",
              "tagFilters": [
                  "SciFi",
                  [
                      "Book",
                      "Movie",
                  ],
              ],
          },
      )
      ```

      ```ruby Ruby theme={"system"}
      response = client.search_single_index(
        "INDEX_NAME",
        Algolia::Search::SearchParamsObject.new(query: "query", tag_filters: ["SciFi", ["Book", "Movie"]])
      )
      ```

      ```scala Scala theme={"system"}
      val response = Await.result(
        client.searchSingleIndex(
          indexName = "INDEX_NAME",
          searchParams = Some(
            SearchParamsObject(
              query = Some("query"),
              tagFilters =
                Some(TagFilters(Seq(TagFilters("SciFi"), TagFilters(Seq(TagFilters("Book"), TagFilters("Movie"))))))
            )
          )
        ),
        Duration(100, "sec")
      )
      ```

      ```swift Swift theme={"system"}
      let response: SearchResponse<Hit> = try await client.searchSingleIndex(
          indexName: "INDEX_NAME",
          searchParams: SearchSearchParams.searchSearchParamsObject(SearchSearchParamsObject(
              query: "query",
              tagFilters: SearchTagFilters.arrayOfSearchTagFilters([
                  SearchTagFilters.string("SciFi"),
                  SearchTagFilters.arrayOfSearchTagFilters([
                      SearchTagFilters.string("Book"),
                      SearchTagFilters.string("Movie"),
                  ]),
              ])
          ))
      )
      ```
    </CodeGroup>
  </Accordion>

  <Accordion title="Legacy API clients">
    <CodeGroup>
      ```cs C# theme={"system"}
      index.Search(new Query("query")
      {
        TagFilters = new List>
        {
          new List { "Book", "Movie" },
          new List { "SciFi" }
        }
      });
      ```

      ```go Go theme={"system"}
      res, err := index.Search(
      	"query",
      	opt.TagFilterAnd(
      		opt.TagFilterOr("Book", "Movie"),
      		"SciFi",
      	),
      )
      ```

      ```java Java theme={"system"}
      index.search(
        new Query("query")
          .setTagFilters(Arrays.asList(
            Arrays.asList(
              "Book",
              "Movie"
            ),
            "SciFi"
          ))
      );
      ```

      ```js JavaScript theme={"system"}
      index
        .search("query", {
          tagFilters: [["Book", "Movie"], "SciFi"],
        })
        .then(({ hits }) => {
          console.log(hits);
        });
      ```

      ```kotlin Kotlin theme={"system"}
      val query = query("query") {
          tagFilters {
              or {
                  tag("book")
                  tag("movie")
              }
              and {
                  tag("SciFi")
              }
          }
      }

      index.search(query)
      ```

      ```php PHP theme={"system"}
      $results = $index->search('query', [
        'tagFilters' => [
          [
            "Book",
            "Movie"
          ],
          "SciFi"
        ]
      ]);
      ```

      ```python Python theme={"system"}
      results = index.search("query", {"tagFilters": [["Book", "Movie"], "SciFi"]})
      ```

      ```ruby Ruby theme={"system"}
      results = index.search(
        "query",
        {
          tagFilters: [
            [
              "Book",
              "Movie"
            ],
            "SciFi"
          ]
        }
      )
      ```

      ```scala Scala theme={"system"}
      client.execute {
        search into "myIndex" query Query(
          query = Some("query"),
          tagFilters = Some(Seq(
            Some(Seq(
              "Book",
              "Movie"
            )),
            "SciFi"
          ))
        )
      }
      ```

      ```swift Swift theme={"system"}
      let query = Query("query").set(\.tagFilters, to: [
        .or("Book", "Movie"),
        "SciFi"
      ])

      index.search(query: query) { result in
        if case .success(let response) = result {
          print("Response: \(response)")
        }
      }
      ```
    </CodeGroup>
  </Accordion>
</AccordionGroup>