go

Go library

This directory contains the Go library for Magika.

The inference relies on the ONNX Runtime, and it requires cgo for interfacing with the ONNX Runtime C API.

Usage

As illustrated in example/main.go, calling magika from go boils down to creating a scanner associated with a given model, and scanning the content.

//go:build cgo && onnxruntime

// This package illustrates the usage of the Magika go binding.
//
// It requires the onnxruntime and the Magika assets to be accessible.
// onnxruntime is available on https://github.com/microsoft/onnxruntime/releases
// Magika asserts are available on https://github.com/google/magika/tree/main/assets
//
// Tag and link directives must be provided a build or run time:
// go run -tags onnxruntime -ldflags="-linkmode=external -extldflags=-L/opt/onnxruntime/lib" .

package main

import (
	"fmt"
	"strings"

	"github.com/google/magika/go/magika"
)

const (
	// assetsDir holds where the Magika assets have been installed.
	assetsDir = "/opt/magika/assets"
	// modelName holds the Magika model to use.
	modelName = "standard_v3_3"
)

func main() {
	// Create a scanner.
	s, err := magika.NewScanner(assetsDir, modelName)
	if err != nil {
		log.Fatalf("NewScanner failed: %v", err)
	}
	// Scan
	ct, err := s.Scan(strings.NewReader("Hello world"), 11)
	if err != nil {
		log.Fatalf("Scan failed: %v", err)
	}
	fmt.Printf("%+v\n", ct)
}

Inspiration on how to download and install onnxruntime and magika assets can be found in docker/Dockerfile, and cli/cli.go provides a somewhat more elaborate usage of the go binding.

Content

• docker contains a sample docker file that builds a container image that ties together a Magika CLI, an ONNX Runtime, and a model.
• cli contains a basic CLI that illustrates how the Magika go library may be called from within an application.
• magika contains the library, that extracts features from a sequence of bytes, and provides a scanner to infer content types.
• onnx wraps the C API of the ONNX Runtime to provide an inference engine.
• example contains a rudimentary example for creating and using a content type scanner.