Tantivy-Go

https://pkg.go.dev/github.com/anyproto/tantivy-go
Admin
Go bindings for the Tantivy search engine library, providing Rust-based full-text search...
Tokens:42,029
Snippets:203
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install Tantivy Go Bindings

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/index

Command to install the Tantivy Go bindings using the go get tool. Ensure your libraries are in your ld path.

```bash
go get github.com/anyproto/tantivy-go
```

--------------------------------

### Install Tantivy Go Bindings

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/@v1.0

Command to install the Tantivy Go bindings using the go get tool. Ensure your libraries are in your ld path.

```bash
go get github.com/anyproto/tantivy-go
```

--------------------------------

### Install Rust Architectures

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/index

Installs the necessary Rust architectures for cross-compilation. This command is typically run within the project's Rust directory.

```shell
make setup
```

--------------------------------

### Install Rust Libraries (Release)

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/index

Installs release versions of Rust libraries for all supported platforms. This command should be executed from within the 'rust' directory of the project.

```shell
make install-all
```

--------------------------------

### Install Rust Architectures

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/@v1.0

Installs the necessary Rust architectures for cross-compilation. This command is typically run within the project's Rust directory.

```shell
make setup
```

--------------------------------

### Install Musl Cross-Compiler

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/index

Installs the musl cross-compiler toolchain for Linux on macOS using Homebrew, enabling builds for musl-based Linux targets.

```shell
brew tap messense/macos-cross-toolchains && brew install x86_64-unknown-linux-musl
```

--------------------------------

### Install Rust Libraries (Debug)

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/index

Installs debug versions of Rust libraries for all supported platforms. This command should be executed from within the 'rust' directory of the project.

```shell
make install-debug-all
```

--------------------------------

### Install GCC Support (MinGW-w64)

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/index

Installs the MinGW-w64 cross-compiler toolchain on macOS using Homebrew, which is required for Windows GCC support in the build process.

```shell
brew install mingw-w64
```

--------------------------------

### Install Rust Libraries (Release)

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/@v1.0

Installs release versions of Rust libraries for all supported platforms. This command should be executed from within the 'rust' directory of the project.

```shell
make install-all
```

--------------------------------

### Install Rust Libraries (Debug)

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/@v1.0

Installs debug versions of Rust libraries for all supported platforms. This command should be executed from within the 'rust' directory of the project.

```shell
make install-debug-all
```

--------------------------------

### Install Musl Cross-Compiler

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/@v1.0

Installs the musl cross-compiler toolchain for Linux on macOS using Homebrew, enabling builds for musl-based Linux targets.

```shell
brew tap messense/macos-cross-toolchains && brew install x86_64-unknown-linux-musl
```

--------------------------------

### Install Rust Libraries (Specific Target)

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/index

Installs a release version of Rust libraries for a specific architecture and operating system (GOOS). Replace ARCH and GOOS with the desired target.

```shell
make install-ARCH-GOOS
```

--------------------------------

### Install GCC Support (MinGW-w64)

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/@v1.0

Installs the MinGW-w64 cross-compiler toolchain on macOS using Homebrew, which is required for Windows GCC support in the build process.

```shell
brew install mingw-w64
```

--------------------------------

### Install Rust Libraries (Specific Target)

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/@v1.0

Installs a release version of Rust libraries for a specific architecture and operating system (GOOS). Replace ARCH and GOOS with the desired target.

```shell
make install-ARCH-GOOS
```

--------------------------------

### Install Rust Libraries (Debug Specific Target)

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/index

Installs a debug version of Rust libraries for a specific architecture and operating system (GOOS). Replace ARCH and GOOS with the desired target.

```shell
make install-debug-ARCH-GOOS
```

--------------------------------

### Install Rust Libraries (Debug Specific Target)

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/@v1.0

Installs a debug version of Rust libraries for a specific architecture and operating system (GOOS). Replace ARCH and GOOS with the desired target.

```shell
make install-debug-ARCH-GOOS
```

--------------------------------

### Tantivy-go Initialization

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/@v1.0

Initializes the tantivy-go library with configurable options for panic handling and UTF-8 leniency. Supports optional directives for logging levels.

```go
func LibInit(cleanOnPanic, utf8Lenient bool, directive ...string) error
```

--------------------------------

### Configure and Run Rust Index Creation

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/@v1.0.4/testquality

Builds and runs the Rust application responsible for index creation. Ensure the stemmer and other configurations in src/main.rs match the selected language.

```rust
# src/main.rs
# Ensure stemmer corresponds to the selected language and other configurations are set.

# Run the Rust application
# cargo run

```

--------------------------------

### LibInit Function Documentation

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/@v1.0.4/internal

Provides documentation for the LibInit function, detailing its signature, purpose, and parameters. This function is used for test initialization.

```APIDOC
func LibInit(cleanOnPanic, utf8Lenient bool, directive ...string) error
  - Initializes library settings for tests.
  - Parameters:
    - cleanOnPanic: bool - If true, cleans up on panic.
    - utf8Lenient: bool - If true, allows lenient UTF-8 handling.
    - directive: ...string - Optional directives for initialization.
  - Returns:
    - error: An error if initialization fails.
```

--------------------------------

### Tantivy-go Initialization

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/index

Initializes the tantivy-go library with configurable options for panic handling and UTF-8 leniency. Supports optional directives for logging levels.

```go
func LibInit(cleanOnPanic, utf8Lenient bool, directive ...string) error
```

--------------------------------

### LibInit Function - Go

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/internal

Initializes the library for testing purposes. It accepts boolean flags for cleaning on panic and lenient UTF-8 handling, along with optional string directives.

```go
func LibInit(cleanOnPanic, utf8Lenient bool, directive ...string) error
```

--------------------------------

### Download Tantivy Dependencies

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/@v1.0

Make command to download all necessary Tantivy dependencies, typically executed within the rust folder of the project.

```bash
make download-tantivy-all
```

--------------------------------

### Download Tantivy Dependencies

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/index

Make command to download all necessary Tantivy dependencies, typically executed within the rust folder of the project.

```bash
make download-tantivy-all
```

--------------------------------

### Configure and Run Rust Index Creation

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/testquality

Navigates to the 'testquality/rust' directory and configures the Rust application's main file. It requires setting the correct language stemmer and other configurations before running the build.

```rust
# Navigate to testquality/rust folder
# cd testquality/rust

# Open src/main.rs and configure:
# - Stemmer for the selected language
# - Other configurations

# Run the Rust application
cargo run
```

--------------------------------

### Core Go Functions

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/@v1.0

Provides essential functions for interacting with the Tantivy Go bindings, including search result processing and library initialization.

```APIDOC
GetSearchResults(searchResult, tc, f, includeFields)
  - Processes search results.
  - Parameters:
    - searchResult: The search result object.
    - tc: Search context.
    - f: Field mapping.
    - includeFields: List of fields to include.

LibInit(cleanOnPanic, utf8Lenient, directive)
  - Initializes the Tantivy library.
  - Parameters:
    - cleanOnPanic: Boolean to clean on panic.
    - utf8Lenient: Boolean for UTF-8 leniency.
    - directive: Initialization directive.

ToModel(doc, tc, includeFields, f)
  - Converts a document to a model.
  - Parameters:
    - doc: The document object.
    - tc: Search context.
    - includeFields: List of fields to include.
    - f: Field mapping.
```

--------------------------------

### Get Document Count

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/index

Returns the total number of documents currently present in the index.

```APIDOC
func (tc *TantivyContext) NumDocs() (uint64, error)

Description:
NumDocs returns the number of documents in the index.

Returns:
* uint64: The number of documents.
* error: An error if retrieving the document count fails.
```

--------------------------------

### Get Document Count

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/@v1.0

Returns the total number of documents currently present in the index.

```APIDOC
func (tc *TantivyContext) NumDocs() (uint64, error)

Description:
NumDocs returns the number of documents in the index.

Returns:
* uint64: The number of documents.
* error: An error if retrieving the document count fails.
```

--------------------------------

### Core Go Functions

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/index

Provides essential functions for interacting with the Tantivy Go bindings, including search result processing and library initialization.

```APIDOC
GetSearchResults(searchResult, tc, f, includeFields)
  - Processes search results.
  - Parameters:
    - searchResult: The search result object.
    - tc: Search context.
    - f: Field mapping.
    - includeFields: List of fields to include.

LibInit(cleanOnPanic, utf8Lenient, directive)
  - Initializes the Tantivy library.
  - Parameters:
    - cleanOnPanic: Boolean to clean on panic.
    - utf8Lenient: Boolean for UTF-8 leniency.
    - directive: Initialization directive.

ToModel(doc, tc, includeFields, f)
  - Converts a document to a model.
  - Parameters:
    - doc: The document object.
    - tc: Search context.
    - includeFields: List of fields to include.
    - f: Field mapping.
```

--------------------------------

### Go DoNothing Function

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/gomobile

A Go function named DoNothing. Its purpose is not explicitly defined in the provided text, but it serves as an example function within the package.

```Go
func DoNothing()

```

--------------------------------

### DoNothing Function

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/go@v0.0.5/tantivy/gomobile

The DoNothing function is a simple Go function that performs no operation. It serves as a placeholder or example function within the package.

```go
func DoNothing() {
}
```

--------------------------------

### Go DoNothing Function

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/@v1.0.4/gomobile

The DoNothing function is a simple Go function that performs no operation. It serves as a placeholder or example function within the gomobile package.

```go
func DoNothing()
```

--------------------------------

### Get Document from SearchResult

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/index

Retrieves a document from the search result at a specified index. Returns the document and an error if retrieval fails or the index is out of bounds.

```go
func (r *SearchResult) Get(index uint64) (*Document, error)
```

--------------------------------

### Get Document from SearchResult

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/@v1.0

Retrieves a document from the search result at a specified index. Returns the document and an error if retrieval fails or the index is out of bounds.

```go
func (r *SearchResult) Get(index uint64) (*Document, error)
```

--------------------------------

### Configure and Run Go Test

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/testquality

Adjusts settings in the 'testquality/main.go' file, including the number of results ('k' value) and the target language. The Go application is then executed using the 'go run' command.

```go
# Open testquality/main.go
# Adjust settings:
# - k value (number of results)
# - Language (e.g., "en")
# - Search Method (tantivySearch or searchJson)

# Run the Go application
go run main.go
```

--------------------------------

### Prepare Index (Python)

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/testquality

Configures and runs a Python script to prepare the search index. This involves setting paths for relevance and query files based on the selected language.

```python
# Configure paths for relevance_file and queries_file
# ...

python prepare_index.py
```

--------------------------------

### SearchResult Go API

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/go/tantivy

Details the `SearchResult` type and its associated methods for accessing and managing search results. Includes `Free` for resource management, `Get` to retrieve a specific document, and `GetSize` to obtain the number of results.

```go
type SearchResult struct {
	// contains filtered or unexported fields
}
```

```go
func (r *SearchResult) Free()
```

```go
func (r *SearchResult) Get(index uint64) (*Document, error)
```

```go
func (r *SearchResult) GetSize() (uint64, error)
```

--------------------------------

### Troubleshooting SIGSEGV with Musl/Windows

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/@v1.0

Provides linker flags to add when experiencing SIGSEGV issues with musl or Windows targets, likely related to stack size limitations.

```shell
-extldflags '-static -Wl,-z stack-size=1000000'
```

--------------------------------

### SearchResult Go API

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/go@v0.0.5/tantivy

Details the `SearchResult` type and its associated methods for accessing and managing search results. Includes `Free` for resource management, `Get` to retrieve a specific document, and `GetSize` to obtain the number of results.

```go
type SearchResult struct {
	// contains filtered or unexported fields
}
```

```go
func (r *SearchResult) Free()
```

```go
func (r *SearchResult) Get(index uint64) (*Document, error)
```

```go
func (r *SearchResult) GetSize() (uint64, error)
```

--------------------------------

### Troubleshooting SIGSEGV with Musl/Windows

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/index

Provides linker flags to add when experiencing SIGSEGV issues with musl or Windows targets, likely related to stack size limitations.

```shell
-extldflags '-static -Wl,-z stack-size=1000000'
```

--------------------------------

### SearchResult Go API

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/go/tantivy@v0.0

Details the `SearchResult` type and its associated methods for accessing and managing search results. Includes `Free` for resource management, `Get` to retrieve a specific document, and `GetSize` to obtain the number of results.

```go
type SearchResult struct {
	// contains filtered or unexported fields
}
```

```go
func (r *SearchResult) Free()
```

```go
func (r *SearchResult) Get(index uint64) (*Document, error)
```

```go
func (r *SearchResult) GetSize() (uint64, error)
```

--------------------------------

### Get Last Commit Opstamp

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/index

Retrieves the opstamp of the last commit. Note: Due to a bug, this may return the initial commit opstamp, not the latest, until the index is closed and reopened. During an active session, it returns 0 for a new index or the opstamp from when the index was opened.

```APIDOC
func (tc *TantivyContext) CommitOpstamp() uint64

Description:
CommitOpstamp gets the opstamp of the last commit.

Note: Due to a bug in Tantivy (<https://github.com/quickwit-oss/tantivy/issues/2666>),
this returns the INITIAL commit opstamp, not the latest one. The value is only
updated after the index is closed and reopened. During an active session, this
will return 0 for a new index or the opstamp from when the index was opened.
```

--------------------------------

### Get Last Commit Opstamp

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/@v1.0

Retrieves the opstamp of the last commit. Note: Due to a bug, this may return the initial commit opstamp, not the latest, until the index is closed and reopened. During an active session, it returns 0 for a new index or the opstamp from when the index was opened.

```APIDOC
func (tc *TantivyContext) CommitOpstamp() uint64

Description:
CommitOpstamp gets the opstamp of the last commit.

Note: Due to a bug in Tantivy (<https://github.com/quickwit-oss/tantivy/issues/2666>),
this returns the INITIAL commit opstamp, not the latest one. The value is only
updated after the index is closed and reopened. During an active session, this
will return 0 for a new index or the opstamp from when the index was opened.
```

--------------------------------

### SearchContextBuilder Methods

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/index

Methods for configuring and building a search context, including query parameters and limits.

```APIDOC
func NewSearchContextBuilder() *SearchContextBuilder
  - Creates a new SearchContextBuilder.
  - Returns:
    - *SearchContextBuilder: A pointer to the SearchContextBuilder.

func (b *SearchContextBuilder) AddField(field string, weight float32) *SearchContextBuilder
  - Adds a field to the search context with a specific weight.
  - Parameters:
    - field: The name of the field to add.
    - weight: The weight assigned to the field for scoring.
  - Returns:
    - *SearchContextBuilder: The modified SearchContextBuilder.

func (b *SearchContextBuilder) AddFieldDefaultWeight(field string) *SearchContextBuilder
  - Adds a field to the search context with its default weight.
  - Parameters:
    - field: The name of the field to add.
  - Returns:
    - *SearchContextBuilder: The modified SearchContextBuilder.

func (b *SearchContextBuilder) Build() SearchContext
  - Constructs the SearchContext object.
  - Returns:
    - SearchContext: The built SearchContext.

func (b *SearchContextBuilder) SetDocsLimit(limit uintptr) *SearchContextBuilder
  - Sets the maximum number of documents to retrieve.
  - Parameters:
    - limit: The maximum number of documents.
  - Returns:
    - *SearchContextBuilder: The modified SearchContextBuilder.

func (b *SearchContextBuilder) SetQuery(query string) *SearchContextBuilder
  - Sets the search query string.
  - Parameters:
    - query: The search query string.
  - Returns:
    - *SearchContextBuilder: The modified SearchContextBuilder.

func (b *SearchContextBuilder) SetQueryFromJson(query *FinalQuery) *SearchContextBuilder
  - Sets the search query using a pre-built FinalQuery object.
  - Parameters:
    - query: The FinalQuery object.
  - Returns:
    - *SearchContextBuilder: The modified SearchContextBuilder.

func (b *SearchContextBuilder) SetWithHighlights(withHighlights bool) *SearchContextBuilder
  - Enables or disables highlighting in search results.
  - Parameters:
    - withHighlights: Boolean indicating whether to enable highlighting.
  - Returns:
    - *SearchContextBuilder: The modified SearchContextBuilder.
```

--------------------------------

### SearchContextBuilder Methods

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/@v1.0

Methods for configuring and building a search context, including query parameters and limits.

```APIDOC
func NewSearchContextBuilder() *SearchContextBuilder
  - Creates a new SearchContextBuilder.
  - Returns:
    - *SearchContextBuilder: A pointer to the SearchContextBuilder.

func (b *SearchContextBuilder) AddField(field string, weight float32) *SearchContextBuilder
  - Adds a field to the search context with a specific weight.
  - Parameters:
    - field: The name of the field to add.
    - weight: The weight assigned to the field for scoring.
  - Returns:
    - *SearchContextBuilder: The modified SearchContextBuilder.

func (b *SearchContextBuilder) AddFieldDefaultWeight(field string) *SearchContextBuilder
  - Adds a field to the search context with its default weight.
  - Parameters:
    - field: The name of the field to add.
  - Returns:
    - *SearchContextBuilder: The modified SearchContextBuilder.

func (b *SearchContextBuilder) Build() SearchContext
  - Constructs the SearchContext object.
  - Returns:
    - SearchContext: The built SearchContext.

func (b *SearchContextBuilder) SetDocsLimit(limit uintptr) *SearchContextBuilder
  - Sets the maximum number of documents to retrieve.
  - Parameters:
    - limit: The maximum number of documents.
  - Returns:
    - *SearchContextBuilder: The modified SearchContextBuilder.

func (b *SearchContextBuilder) SetQuery(query string) *SearchContextBuilder
  - Sets the search query string.
  - Parameters:
    - query: The search query string.
  - Returns:
    - *SearchContextBuilder: The modified SearchContextBuilder.

func (b *SearchContextBuilder) SetQueryFromJson(query *FinalQuery) *SearchContextBuilder
  - Sets the search query using a pre-built FinalQuery object.
  - Parameters:
    - query: The FinalQuery object.
  - Returns:
    - *SearchContextBuilder: The modified SearchContextBuilder.

func (b *SearchContextBuilder) SetWithHighlights(withHighlights bool) *SearchContextBuilder
  - Enables or disables highlighting in search results.
  - Parameters:
    - withHighlights: Boolean indicating whether to enable highlighting.
  - Returns:
    - *SearchContextBuilder: The modified SearchContextBuilder.
```

--------------------------------

### Tantivy Go Package Functions

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/go@v0.0.5/tantivy

Provides core functionalities for interacting with the Tantivy search engine in Go. Includes functions for initializing the library, performing searches, and converting documents.

```APIDOC
func GetSearchResults[T any](searchResult *SearchResult, schema *Schema, f func(json string) (T, error), ...[]string) ([]T, error)
  - Retrieves and deserializes search results from a SearchResult object.
  - Parameters:
    - searchResult: Pointer to the SearchResult object containing raw search data.
    - schema: Pointer to the Schema object used for deserialization.
    - f: A function to deserialize each document's JSON into a specific type T.
    - includeFields: Optional list of fields to include in the deserialized output.
  - Returns: A slice of deserialized results of type T and an error if any occurred.

func LibInit(directive ...string) error
  - Initializes the Tantivy library, potentially with specific directives.
  - Parameters:
    - directive: Optional configuration directives for library initialization.
  - Returns: An error if initialization fails.

func ToModel[T any](doc *Document, schema *Schema, includeFields []string, f func(json string) (T, error)) (T, error)
  - Converts a Document object into a Go model of type T.
  - Parameters:
    - doc: Pointer to the Document object to convert.
    - schema: Pointer to the Schema object for context.
    - includeFields: List of fields to include in the conversion.
    - f: A function to deserialize the document's JSON into type T.
  - Returns: The converted model of type T and an error if conversion fails.
```

--------------------------------

### QueryBuilder Methods

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/@v1.0

Methods for constructing complex search queries programmatically.

```APIDOC
func NewQueryBuilder() *QueryBuilder
  - Creates a new QueryBuilder instance.
  - Returns:
    - *QueryBuilder: A pointer to the new QueryBuilder.

func (qb *QueryBuilder) AddField(field string) int
  - Adds a field to the query builder, returning its internal ID.
  - Parameters:
    - field: The name of the field to add.
  - Returns:
    - int: The internal ID assigned to the field.

func (qb *QueryBuilder) AddText(text string) int
  - Adds text content to the query builder, returning its internal ID.
  - Parameters:
    - text: The text content to add.
  - Returns:
    - int: The internal ID assigned to the text.

func (qb *QueryBuilder) BooleanQuery(modifier QueryModifier, subBuilder *QueryBuilder, boost float64) *QueryBuilder
  - Creates a boolean query clause within the current builder.
  - Parameters:
    - modifier: The boolean modifier (e.g., MUST, SHOULD, MUST_NOT).
    - subBuilder: The QueryBuilder for the sub-query.
    - boost: The boost factor for this clause.
  - Returns:
    - *QueryBuilder: The modified QueryBuilder.

func (qb *QueryBuilder) Build() FinalQuery
  - Finalizes the query construction and returns the complete query.
  - Returns:
    - FinalQuery: The constructed query object.

func (qb *QueryBuilder) NestedBuilder() *QueryBuilder
  - Creates a new nested QueryBuilder for building sub-queries.
  - Returns:
    - *QueryBuilder: A new QueryBuilder for nested queries.

func (qb *QueryBuilder) Query(modifier QueryModifier, field string, text string, queryType QueryType, ...)
  - Adds a basic query clause (e.g., term, phrase) to the builder.
  - Parameters:
    - modifier: The query modifier.
    - field: The field to query.
    - text: The text to search for.
    - queryType: The type of query (e.g., TERM, PHRASE).
  - Returns:
    - *QueryBuilder: The modified QueryBuilder.
```

--------------------------------

### Prepare Corpus and Index (Python)

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/@v1.0.4/testquality

Scripts to prepare the corpus data and create an index for testing. Requires setting the desired language and file paths in the respective Python scripts.

```python
# extract_corpus.py
# Set the desired language for testing
lang = 'en'  # Example: English

# Run the script to process data
# python extract_corpus.py

```

```python
# prepare_index.py
# Configure paths for relevance_file and queries_file

# Run the script to complete the indexing process
# python prepare_index.py

```

--------------------------------

### Tantivy Go Package Functions

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/go/tantivy

Provides core functionalities for interacting with the Tantivy search engine in Go. Includes functions for initializing the library, performing searches, and converting documents.

```APIDOC
func GetSearchResults[T any](searchResult *SearchResult, schema *Schema, f func(json string) (T, error), ...[]string) ([]T, error)
  - Retrieves and deserializes search results from a SearchResult object.
  - Parameters:
    - searchResult: Pointer to the SearchResult object containing raw search data.
    - schema: Pointer to the Schema object used for deserialization.
    - f: A function to deserialize each document's JSON into a specific type T.
    - includeFields: Optional list of fields to include in the deserialized output.
  - Returns: A slice of deserialized results of type T and an error if any occurred.

func LibInit(directive ...string) error
  - Initializes the Tantivy library, potentially with specific directives.
  - Parameters:
    - directive: Optional configuration directives for library initialization.
  - Returns: An error if initialization fails.

func ToModel[T any](doc *Document, schema *Schema, includeFields []string, f func(json string) (T, error)) (T, error)
  - Converts a Document object into a Go model of type T.
  - Parameters:
    - doc: Pointer to the Document object to convert.
    - schema: Pointer to the Schema object for context.
    - includeFields: List of fields to include in the conversion.
    - f: A function to deserialize the document's JSON into type T.
  - Returns: The converted model of type T and an error if conversion fails.
```

--------------------------------

### Document Methods

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/index

Methods for creating, manipulating, and serializing documents within the Tantivy index.

```APIDOC
func NewDocument() *Document
  - Creates a new, empty Document.
  - Returns:
    - *Document: A pointer to the newly created Document.

func (d *Document) AddField(fieldValue string, tc *TantivyContext, fieldName string) error
  - Adds a single field with its value to the document.
  - Parameters:
    - fieldValue: The string value for the field.
    - tc: The TantivyContext.
    - fieldName: The name of the field to add.
  - Returns:
    - error: An error if adding the field fails.

func (d *Document) AddFields(fieldValue string, tc *TantivyContext, fieldNames ...string) error
  - Adds a field value to multiple fields in the document.
  - Parameters:
    - fieldValue: The string value to add to the fields.
    - tc: The TantivyContext.
    - fieldNames: A variadic list of field names to add the value to.
  - Returns:
    - error: An error if adding fields fails.

func (d *Document) Free()
  - Frees resources associated with the Document.

func (d *Document) FreeStrings()
  - Frees string data associated with the Document.

func (d *Document) ToJson(tc *TantivyContext, includeFields ...string) (string, error)
  - Serializes the document to a JSON string, optionally including specified fields.
  - Parameters:
    - tc: The TantivyContext.
    - includeFields: A variadic list of field names to include in the JSON output.
  - Returns:
    - string: The JSON representation of the document.
    - error: An error if serialization fails.
```

--------------------------------

### Tantivy Go Package Functions

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/go/tantivy@v0.0

Provides core functionalities for interacting with the Tantivy search engine in Go. Includes functions for initializing the library, performing searches, and converting documents.

```APIDOC
func GetSearchResults[T any](searchResult *SearchResult, schema *Schema, f func(json string) (T, error), ...[]string) ([]T, error)
  - Retrieves and deserializes search results from a SearchResult object.
  - Parameters:
    - searchResult: Pointer to the SearchResult object containing raw search data.
    - schema: Pointer to the Schema object used for deserialization.
    - f: A function to deserialize each document's JSON into a specific type T.
    - includeFields: Optional list of fields to include in the deserialized output.
  - Returns: A slice of deserialized results of type T and an error if any occurred.

func LibInit(directive ...string) error
  - Initializes the Tantivy library, potentially with specific directives.
  - Parameters:
    - directive: Optional configuration directives for library initialization.
  - Returns: An error if initialization fails.

func ToModel[T any](doc *Document, schema *Schema, includeFields []string, f func(json string) (T, error)) (T, error)
  - Converts a Document object into a Go model of type T.
  - Parameters:
    - doc: Pointer to the Document object to convert.
    - schema: Pointer to the Schema object for context.
    - includeFields: List of fields to include in the conversion.
    - f: A function to deserialize the document's JSON into type T.
  - Returns: The converted model of type T and an error if conversion fails.
```

--------------------------------

### Document Methods

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/@v1.0

Methods for creating, manipulating, and serializing documents within the Tantivy index.

```APIDOC
func NewDocument() *Document
  - Creates a new, empty Document.
  - Returns:
    - *Document: A pointer to the newly created Document.

func (d *Document) AddField(fieldValue string, tc *TantivyContext, fieldName string) error
  - Adds a single field with its value to the document.
  - Parameters:
    - fieldValue: The string value for the field.
    - tc: The TantivyContext.
    - fieldName: The name of the field to add.
  - Returns:
    - error: An error if adding the field fails.

func (d *Document) AddFields(fieldValue string, tc *TantivyContext, fieldNames ...string) error
  - Adds a field value to multiple fields in the document.
  - Parameters:
    - fieldValue: The string value to add to the fields.
    - tc: The TantivyContext.
    - fieldNames: A variadic list of field names to add the value to.
  - Returns:
    - error: An error if adding fields fails.

func (d *Document) Free()
  - Frees resources associated with the Document.

func (d *Document) FreeStrings()
  - Frees string data associated with the Document.

func (d *Document) ToJson(tc *TantivyContext, includeFields ...string) (string, error)
  - Serializes the document to a JSON string, optionally including specified fields.
  - Parameters:
    - tc: The TantivyContext.
    - includeFields: A variadic list of field names to include in the JSON output.
  - Returns:
    - string: The JSON representation of the document.
    - error: An error if serialization fails.
```

--------------------------------

### SearchContextBuilder API

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/@v1.0

Configures the context for search operations, including setting limits, queries, and highlighting preferences.

```APIDOC
SearchContextBuilder Type Methods:

NewSearchContextBuilder()
  - Creates a new SearchContextBuilder.
  - Returns: A new SearchContextBuilder object.

(b) AddField(field, weight)
  - Adds a field with a specific weight to the context.
  - Parameters:
    - field: The field to add.
    - weight: The weight of the field.

(b) AddFieldDefaultWeight(field)
  - Adds a field with its default weight.
  - Parameters:
    - field: The field to add.

(b) Build()
  - Builds the SearchContext.
  - Returns: The constructed SearchContext object.

(b) SetDocsLimit(limit)
  - Sets the maximum number of documents to return.
  - Parameters:
    - limit: The document limit.

(b) SetQuery(query)
  - Sets the search query.
  - Parameters:
    - query: The query object.

(b) SetQueryFromJson(query)
  - Sets the search query from a JSON string.
  - Parameters:
    - query: The JSON query string.

(b) SetWithHighlights(withHighlights)
  - Enables or disables highlighting in search results.
  - Parameters:
    - withHighlights: Boolean to enable/disable highlights.
```

--------------------------------

### Nix Development Shell

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/@v1.0

Enters a Nix development shell environment that provides all necessary build dependencies for the project. This shell is configured via flake.nix.

```shell
nix develop .
```

--------------------------------

### Go Schema Builder API

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/@v1.0

Provides functionality to create and manage search schemas. Includes a constructor for the SchemaBuilder.

```APIDOC
SchemaBuilder:
  // Constructor for SchemaBuilder.
  // Creates a new SchemaBuilder instance.
  // Returns a pointer to the SchemaBuilder and an error if creation fails.
  NewSchemaBuilder() (*SchemaBuilder, error)

Schema:
  // Represents the search schema.
  // Contains filtered or unexported fields.
```

--------------------------------

### QueryBuilder Methods

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/index

Methods for constructing complex search queries programmatically.

```APIDOC
func NewQueryBuilder() *QueryBuilder
  - Creates a new QueryBuilder instance.
  - Returns:
    - *QueryBuilder: A pointer to the new QueryBuilder.

func (qb *QueryBuilder) AddField(field string) int
  - Adds a field to the query builder, returning its internal ID.
  - Parameters:
    - field: The name of the field to add.
  - Returns:
    - int: The internal ID assigned to the field.

func (qb *QueryBuilder) AddText(text string) int
  - Adds text content to the query builder, returning its internal ID.
  - Parameters:
    - text: The text content to add.
  - Returns:
    - int: The internal ID assigned to the text.

func (qb *QueryBuilder) BooleanQuery(modifier QueryModifier, subBuilder *QueryBuilder, boost float64) *QueryBuilder
  - Creates a boolean query clause within the current builder.
  - Parameters:
    - modifier: The boolean modifier (e.g., MUST, SHOULD, MUST_NOT).
    - subBuilder: The QueryBuilder for the sub-query.
    - boost: The boost factor for this clause.
  - Returns:
    - *QueryBuilder: The modified QueryBuilder.

func (qb *QueryBuilder) Build() FinalQuery
  - Finalizes the query construction and returns the complete query.
  - Returns:
    - FinalQuery: The constructed query object.

func (qb *QueryBuilder) NestedBuilder() *QueryBuilder
  - Creates a new nested QueryBuilder for building sub-queries.
  - Returns:
    - *QueryBuilder: A new QueryBuilder for nested queries.

func (qb *QueryBuilder) Query(modifier QueryModifier, field string, text string, queryType QueryType, ...)
  - Adds a basic query clause (e.g., term, phrase) to the builder.
  - Parameters:
    - modifier: The query modifier.
    - field: The field to query.
    - text: The text to search for.
    - queryType: The type of query (e.g., TERM, PHRASE).
  - Returns:
    - *QueryBuilder: The modified QueryBuilder.
```

--------------------------------

### SearchContextBuilder API

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/index

Configures the context for search operations, including setting limits, queries, and highlighting preferences.

```APIDOC
SearchContextBuilder Type Methods:

NewSearchContextBuilder()
  - Creates a new SearchContextBuilder.
  - Returns: A new SearchContextBuilder object.

(b) AddField(field, weight)
  - Adds a field with a specific weight to the context.
  - Parameters:
    - field: The field to add.
    - weight: The weight of the field.

(b) AddFieldDefaultWeight(field)
  - Adds a field with its default weight.
  - Parameters:
    - field: The field to add.

(b) Build()
  - Builds the SearchContext.
  - Returns: The constructed SearchContext object.

(b) SetDocsLimit(limit)
  - Sets the maximum number of documents to return.
  - Parameters:
    - limit: The document limit.

(b) SetQuery(query)
  - Sets the search query.
  - Parameters:
    - query: The query object.

(b) SetQueryFromJson(query)
  - Sets the search query from a JSON string.
  - Parameters:
    - query: The JSON query string.

(b) SetWithHighlights(withHighlights)
  - Enables or disables highlighting in search results.
  - Parameters:
    - withHighlights: Boolean to enable/disable highlights.
```

--------------------------------

### Schema Building

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/go/tantivy

Tools for defining the structure and fields of a search index.

```APIDOC
SchemaBuilder Type:
  Used to construct a Schema object.

NewSchemaBuilder()
  - Creates and returns a new SchemaBuilder.
  - Returns: A pointer to a new SchemaBuilder.

(b) AddTextField(name, stored, isText, isFast, indexRecordOption, tokenizer)
  - Adds a text field to the schema definition.
  - Parameters:
    - name: The name of the field.
    - stored: Boolean indicating if the field value should be stored.
    - isText: Boolean indicating if the field is text-based and should be tokenized.
    - isFast: Boolean indicating if the field should be indexed for fast retrieval.
    - indexRecordOption: The indexing record option (e.g., 'WithFreq', 'WithPos', 'WithFreqAndPos').
    - tokenizer: The name of the text tokenizer to use for this field.
  - Returns: The SchemaBuilder itself for chaining, and an error if adding the field fails.

(b) BuildSchema()
  - Finalizes the schema definition and returns a Schema object.
  - Returns: A Schema object and an error if the schema is invalid.
```

--------------------------------

### Configure and Run Go Test

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/@v1.0.4/testquality

Executes the Go application for testing Tantivy quality. Users can adjust parameters like 'k' value (number of results), language, and search method (tantivySearch or searchJson) within the main.go file.

```go
# testquality/main.go

# Adjust settings:
# k value: Change the number of results you want to evaluate.
# Language: Set the language to match the dataset used (e.g., "en" for English).
# Search Method: Choose between "tantivySearch" or "searchJson".

# Run the Go application
# go run main.go

```

--------------------------------

### Add Android Libraries to PATH

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/@v1.0

Configures the system's PATH environment variable to include Android SDK tools and libraries, essential for Android development or cross-compilation targets.

```shell
export PATH=$PATH:$ANDROID_HOME/tools:$ANDROID_HOME/emulator:$ANDROID_HOME/platform-tools:$ANDROID_HOME/ndk/25.2.9519653/toolchains/llvm/prebuilt/darwin-x86_64/bin
```

--------------------------------

### Nix Development Shell

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/index

Enters a Nix development shell environment that provides all necessary build dependencies for the project. This shell is configured via flake.nix.

```shell
nix develop .
```

--------------------------------

### Schema Building

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/go@v0.0.5/tantivy

Tools for defining the structure and fields of a search index.

```APIDOC
SchemaBuilder Type:
  Used to construct a Schema object.

NewSchemaBuilder()
  - Creates and returns a new SchemaBuilder.
  - Returns: A pointer to a new SchemaBuilder.

(b) AddTextField(name, stored, isText, isFast, indexRecordOption, tokenizer)
  - Adds a text field to the schema definition.
  - Parameters:
    - name: The name of the field.
    - stored: Boolean indicating if the field value should be stored.
    - isText: Boolean indicating if the field is text-based and should be tokenized.
    - isFast: Boolean indicating if the field should be indexed for fast retrieval.
    - indexRecordOption: The indexing record option (e.g., 'WithFreq', 'WithPos', 'WithFreqAndPos').
    - tokenizer: The name of the text tokenizer to use for this field.
  - Returns: The SchemaBuilder itself for chaining, and an error if adding the field fails.

(b) BuildSchema()
  - Finalizes the schema definition and returns a Schema object.
  - Returns: A Schema object and an error if the schema is invalid.
```

--------------------------------

### Add Android Libraries to PATH

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/index

Configures the system's PATH environment variable to include Android SDK tools and libraries, essential for Android development or cross-compilation targets.

```shell
export PATH=$PATH:$ANDROID_HOME/tools:$ANDROID_HOME/emulator:$ANDROID_HOME/platform-tools:$ANDROID_HOME/ndk/25.2.9519653/toolchains/llvm/prebuilt/darwin-x86_64/bin
```

--------------------------------

### Document API

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/index

Manages document creation, field addition, serialization, and resource management within the Tantivy index.

```APIDOC
Document Type Methods:

NewDocument()
  - Creates a new document.
  - Returns: A new Document object.

(d) AddField(fieldValue, tc, fieldName)
  - Adds a field to the document.
  - Parameters:
    - fieldValue: The value of the field.
    - tc: Search context.
    - fieldName: The name of the field.

(d) AddFields(fieldValue, tc, fieldNames)
  - Adds multiple fields to the document.
  - Parameters:
    - fieldValue: The value for the fields.
    - tc: Search context.
    - fieldNames: A list of field names.

(d) Free()
  - Frees the resources associated with the document.

(d) FreeStrings()
  - Frees string resources within the document.

(d) ToJson(tc, includeFields)
  - Serializes the document to JSON.
  - Parameters:
    - tc: Search context.
    - includeFields: List of fields to include.
  - Returns: JSON string representation of the document.
```

--------------------------------

### Document API

Source: https://pkg.go.dev/github.com/anyproto/tantivy-go/@v1.0

Manages document creation, field addition, serialization, and resource management within the Tantivy index.

```APIDOC
Document Type Methods:

NewDocument()
  - Creates a new document.
  - Returns: A new Document object.

(d) AddField(fieldValue, tc, fieldName)
  - Adds a field to the document.
  - Parameters:
    - fieldValue: The value of the field.
    - tc: Search context.
    - fieldName: The name of the field.

(d) AddFields(fieldValue, tc, fieldNames)
  - Adds multiple fields to the document.
  - Parameters:
    - fieldValue: The value for the fields.
    - tc: Search context.
    - fieldNames: A list of field names.

(d) Free()
  - Frees the resources associated with the document.

(d) FreeStrings()
  - Frees string resources within the document.

(d) ToJson(tc, includeFields)
  - Serializes the document to JSON.
  - Parameters:
    - tc: Search context.
    - includeFields: List of fields to include.
  - Returns: JSON string representation of the document.
```
Tokens:
Raw