Skip to content
googlePublic

About

Go package for using Apache Tika

Resources

Code of conduct

Contributing

Security policy

Stars

257 stars

Watchers

9 watching

Forks

Latest commit

 

History

88 Commits

Folders and files

go-tika

Go Reference

go-tika is a Go client library and command line utility for accessing the Apache Tika Server API.

See https://pkg.go.dev/github.com/google/go-tika for more documentation on what resources are available.

Command line client

The tika binary allows you to access the Apache Tika Server API from the command line, including downloading and starting the server in the background.

To get the binary, run:

go install github.com/google/go-tika/cmd/tika@latest

To download the Apache Tika 4.1.0 Server, check the SHA-512 sum, start the server in the background, and parse a file, run:

$(go env GOPATH)/bin/tika -filename /path/to/file/to/parse -download_version 4.1.0 parse

Tika Server 4.x is distributed as a zip, so this will download and extract it to a tika-server-4.1.0 directory in your current working directory. When using the library, download it with DownloadServerDir.

Tika Server 3.x and earlier are a single JAR: for example, -download_version 3.3.2 will store tika-server-3.3.2.jar in your current working directory. If you want to control the output location of the JAR, add a -server_jar /path/to/save/tika-server.jar argument.

If you already have a downloaded Apache Tika Server JAR, you can specify it with the -server_jar flag and it will not be re-downloaded. For Tika Server 4.x, use the JAR in the extracted directory.

To configure the server that is started (for example, forking, timeouts or the maximum number of files per child process), pass a tika-config file with the -server_config flag. The file is XML for Tika Server 2.x and 3.x, and JSON for Tika Server 4.x. When using the library, set Server.ConfigPath instead.

If you already have a running Apache Tika Server, you can use it by adding the -server_url flag and omitting the -server_jar and -download_version flags.

See $(go env GOPATH)/bin/tika -h for usage instructions.

Supported Tika Server versions

go-tika can download and run Apache Tika Server 2.6.0, 2.7.0, 2.8.0, 2.9.4, 3.0.0, 3.1.0, 3.2.3, 3.3.2 and 4.1.0. Tika Server 2.x requires Java 8 or later, 3.x requires Java 11 or later, and 4.x requires Java 17 or later.

Tika Server 4.x no longer supports translation, so Translate and TranslateReader return an error with it. Tika Server 4.0.0 is not supported: it fails to parse documents unless it is started from the directory containing its JAR, which was fixed in 4.1.0.

Tika Server 1.19, 1.20 and 1.21 are deprecated: Tika 1.x is end-of-life.

License

This library is distributed under the Apache V2 License. See the LICENSE file.

Contributing

Please see the CONTRIBUTING.md file.

Use goimports to format code and make sure the go.mod/go.sum files are up to date with go mod tidy.

Disclaimer

This is not an official Google product.

About

Go package for using Apache Tika

Resources

Code of conduct

Contributing

Security policy

Stars

257 stars

Watchers

9 watching

Forks

Releases

Packages

Used by

Contributors

Languages