Metadata filtering on a query

[ZmeiGorynych]

Hi! I'm new to tavily and tavily-py, and would like to formulate a query that's a text search/match query on the main text field of a record, with an equality filter on another field (str or int), and an range filter on a timestamp field; so the query should only return the results that match the filters.
Could you possibly either write down example code or point me to the docs that describe how to do that?
Thanks a lot!

[ZmeiGorynych]

Ah, figured it out, here is a self-contained example for those like me who struggle to piece the docs together:

from tantivy import Query, Occur, Index, SchemaBuilder, Document

# Define schema using SchemaBuilder
schema_builder = SchemaBuilder()
schema_builder.add_text_field("title", stored=True)
schema_builder.add_integer_field("year", stored=True, indexed=True)
schema_builder.add_text_field("doc_type", stored=True)
schema = schema_builder.build()

# Create index
index = Index(schema)
writer = index.writer()

# Insert documents
# Relevant docs (matching "example" and year between 2020-2025)
writer.add_document(Document(
    title=["An example document"],
    doc_type="Confluence",
    year=[2023]
))
writer.add_document(Document(
    title=["Another example text"],
    doc_type="Slack",
    year=[2022]
))

# Irrelevant docs (either wrong title or year)
writer.add_document(Document(
    title=["Something different"],
    doc_type="Slack",
    year=[2024]
))
writer.add_document(Document(
    title=["An example but old"],
    doc_type="Confluence",
    year=[2015]
))
writer.add_document(Document(
    title=["Not matching at all"],
    doc_type="Confluence",
    year=[2018]
))

# Commit the changes
writer.commit()
writer.wait_merging_threads()

# Create searcher
searcher = index.searcher()

query = index.parse_query("example", ["title"])

# Search
hits = searcher.search(query, 10).hits

print(f"\nFound {len(hits)} matching documents:")
for score, hit in hits:
    doc = searcher.doc(hit)
    print(score, doc)

query =  Query.boolean_query(
    [(Occur.Must, index.parse_query("example", ["title"])),
     (Occur.Must, index.parse_query("year:[2022 TO 2023]", ["year"])),
     (Occur.Must, index.parse_query("Slack", ["doc_type"]))])

hits = searcher.search(query, 10).hits
print(len(hits)) # returns 1