Documentation ¶
Overview ¶
Package tika provides a client and server for downloading, starting, and using Apache Tika's (http://tika.apache.org) Server.
Start with basic imports:
import "github.com/google/go-tika/tika"
You will need a running Server to make API calls to. So, if you don't have a server that is already running and you don't have the Server JAR already downloaded, you can download one. The caller is responsible for removing the file when no longer needed.
err := tika.DownloadServer(context.Background(), "1.16", "tika-server-1.16.jar") if err != nil { log.Fatal(err) }
If you don't have a running Tika Server, you can start one.
// Optionally pass a port as the second argument. s, err := tika.NewServer("tika-server-1.16.jar", "") if err != nil { log.Fatal(err) } err := s.Start(context.Background()) if err != nil { log.Fatal(err) } defer s.Stop()
To parse the contents of a file (or any io.Reader), you will need to open the io.Reader, create a client, and call client.Parse.
// import "os" f, err := os.Open("path/to/file") if err != nil { log.Fatal(err) } defer f.Close() client := tika.NewClient(nil, s.URL()) body, err := client.Parse(context.Background(), f)
If you pass an *http.Client to tika.NewClient, it will be used for all requests.
Some functions return a custom type, like Parsers(), Detectors(), and MIMETypes(). Use these to see what features are supported by the current Tika server.
Index ¶
- Constants
- Variables
- func DownloadServer(ctx context.Context, v Version, path string) error
- type ChildOptions
- type Client
- func (c *Client) Detect(ctx context.Context, input io.Reader) (string, error)
- func (c *Client) Detectors(ctx context.Context) (*Detector, error)
- func (c *Client) Language(ctx context.Context, input io.Reader) (string, error)
- func (c *Client) LanguageString(ctx context.Context, input string) (string, error)
- func (c *Client) MIMETypes(ctx context.Context) (map[string]MIMEType, error)
- func (c *Client) Meta(ctx context.Context, input io.Reader) (string, error)
- func (c *Client) MetaField(ctx context.Context, input io.Reader, field string) (string, error)
- func (c *Client) MetaRecursive(ctx context.Context, input io.Reader) ([]map[string][]string, error)
- func (c *Client) MetaRecursiveType(ctx context.Context, input io.Reader, contentType string) ([]map[string][]string, error)
- func (c *Client) Parse(ctx context.Context, input io.Reader) (string, error)
- func (c *Client) ParseRecursive(ctx context.Context, input io.Reader) ([]string, error)
- func (c *Client) Parsers(ctx context.Context) (*Parser, error)
- func (c *Client) Translate(ctx context.Context, input io.Reader, t Translator, src, dst string) (string, error)
- func (c *Client) Version(ctx context.Context) (string, error)
- type Detector
- type MIMEType
- type Parser
- type Server
- type Translator
- type Version
Constants ¶
const XTIKAContent = "X-TIKA:content"
XTIKAContent is the metadata field of the content of a file after recursive parsing. See ParseRecursive and MetaRecursive.
Variables ¶
var Versions = []Version{Version119, Version120, Version121}
Versions is a list of supported versions of Apache Tika.
Functions ¶
func DownloadServer ¶
DownloadServer downloads and validates the given server version, saving it at path. DownloadServer returns an error if it could not be downloaded/validated. It is the caller's responsibility to remove the file when no longer needed. If the file already exists and has the correct sha512, DownloadServer will do nothing.
Types ¶
type ChildOptions ¶
type ChildOptions struct { MaxFiles int TaskPulseMillis int TaskTimeoutMillis int PingPulseMillis int PingTimeoutMillis int }
ChildOptions represent command line parameters that can be used when Tika is run with the -spawnChild option. If a field is less than or equal to 0, the associated flag is not included.
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client represents a connection to a Tika Server.
func NewClient ¶
NewClient creates a new Client. If httpClient is nil, the http.DefaultClient will be used.
func (*Client) Detect ¶
Detect gets the mimetype of the given input, returning the mimetype and an error. If the error is not nil, the mimetype is undefined.
func (*Client) Detectors ¶
Detectors returns the list of available Detectors for this server. To get all available detectors, iterate through the Children of every Detector.
func (*Client) Language ¶
Language detects the language of the given input, returning the two letter language code and an error. If the error is not nil, the language is undefined.
func (*Client) LanguageString ¶
LanguageString detects the language of the given string, returning the two letter language code and an error. If the error is not nil, the language is undefined.
func (*Client) MIMETypes ¶
MIMETypes returns a map from MIME Type name to MIMEType, or properties about that specific MIMEType.
func (*Client) Meta ¶
Meta parses the metadata from the given input, returning the metadata and an error. If the error is not nil, the metadata is undefined.
func (*Client) MetaField ¶
MetaField parses the metadata from the given input and returns the given field. If the error is not nil, the result string is undefined.
func (*Client) MetaRecursive ¶
MetaRecursive parses the given input and all embedded documents. The result is a list of maps from metadata key to value for each document. The content of each document is in the XTIKAContent field in text form. See ParseRecursive to just get the content of each document. If the error is not nil, the result list is undefined.
func (*Client) MetaRecursiveType ¶
func (c *Client) MetaRecursiveType(ctx context.Context, input io.Reader, contentType string) ([]map[string][]string, error)
MetaRecursiveType parses the given input and all embedded documents. The result is a list of maps from metadata key to value for each document. The content of each document is in the XTIKAContent field, and is of the type indicated by the contentType parameter An empty string can be passed in for a default type of XML. See ParseRecursive to just get the content of each document. If the error is not nil, the result list is undefined.
func (*Client) Parse ¶
Parse parses the given input, returning the body of the input and an error. If the error is not nil, the body is undefined.
func (*Client) ParseRecursive ¶
ParseRecursive parses the given input and all embedded documents, returning a list of the contents of the input with one element per document. See MetaRecursive for access to all metadata fields. If the error is not nil, the result is undefined.
func (*Client) Parsers ¶
Parsers returns the list of available parsers and an error. If the error is not nil, the list is undefined. To get all available parsers, iterate through the Children of every Parser.
type Detector ¶
A Detector represents a Tika Detector. Detectors are used to get the filetype of a file. To get a list of all Detectors, see Detectors().
type MIMEType ¶
MIMEType represents a Tika MIME Type. To get a list of all MIME Types, see MIMETypes.
type Parser ¶
type Parser struct { Name string Decorated bool Composite bool Children []Parser SupportedTypes []string }
A Parser represents a Tika Parser. To get a list of all Parsers, see Parsers().
type Server ¶
type Server struct { JavaProps map[string]string CustomProp []string // contains filtered or unexported fields }
func (*Server) ChildMode ¶
func (s *Server) ChildMode(ops *ChildOptions) error
ChildMode sets up the server to use the -spawnChild option. If used, ChildMode must be called before starting the server. If you want to turn off the -spawnChild option, call Server.ChildMode(nil).
func (*Server) Shutdown ¶
Shutdown attempts to close the server gracefully before using SIGKILL, Stop() uses SIGKILL right away, which causes the kernal to stop the java process instantly.
func (*Server) Start ¶
Start starts the given server. Start will start a new Java process. The caller must call Stop() to shut down the process when finished with the Server. Start will wait for the server to be available or until ctx is cancelled.
func (*Server) Stop ¶
Stop shuts the server down, killing the underlying Java process. Stop must be called when finished with the server to avoid leaking the Java process. If s has not been started, Stop will panic. If not running in a Windows environment, it is recommended to use Shutdown for a more graceful shutdown of the Java process.
type Translator ¶
type Translator string
Translator represents the Java package of a Tika Translator.
const ( Lingo24Translator Translator = "org.apache.tika.language.translate.Lingo24Translator" GoogleTranslator Translator = "org.apache.tika.language.translate.GoogleTranslator" MosesTranslator Translator = "org.apache.tika.language.translate.MosesTranslator" JoshuaTranslator Translator = "org.apache.tika.language.translate.JoshuaTranslator" MicrosoftTranslator Translator = "org.apache.tika.language.translate.MicrosoftTranslator" YandexTranslator Translator = "org.apache.tika.language.translate.YandexTranslator" )
Translators available by defult in Tika. You must configure all required authentication details in Tika Server (for example, an API key).