Gosseract

https://pkg.go.dev/github.com/otiai10/gosseract
Admin
Gosseract is a Go package that provides optical character recognition (OCR) capabilities by wrapping...
Tokens:6,059
Snippets:48
Trust Score:9.6
Update:6 months ago
Show doc for...
Tokens:
Raw
### Perform OCR with gosseract

Source: https://pkg.go.dev/github.com/otiai10/gosseract/v2

Basic usage example for initializing a client, setting an image, and extracting text.

```go
package main

import (
	"fmt"
	"github.com/otiai10/gosseract/v2"
)

func main() {
	client := gosseract.NewClient()
	defer client.Close()
	client.SetImage("path/to/image.png")
	text, _ := client.Text()
	fmt.Println(text)
	// Hello, World!
}
```

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

### Get bounding boxes

Source: https://pkg.go.dev/github.com/otiai10/gosseract/v2

Retrieves bounding boxes for each matched word.

```go
func (client *Client) GetBoundingBoxes(level PageIteratorLevel) (out []BoundingBox, err error)
```

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

### Run tests locally

Source: https://pkg.go.dev/github.com/otiai10/gosseract/v2

Command to execute tests when Tesseract is installed on the local machine.

```bash
% go test .
```

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

### Run tests with containerized runtimes

Source: https://pkg.go.dev/github.com/otiai10/gosseract/v2

Commands to execute tests using Docker or Vagrant if Tesseract is not installed locally.

```bash
% ./test/runtime --driver docker
% ./test/runtime --driver vagrant
```

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

### Get available languages

Source: https://pkg.go.dev/github.com/otiai10/gosseract/v2

Retrieves a list of languages available in the default tesspath.

```go
func GetAvailableLanguages() ([]string, error)
```

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

### GET /client/version

Source: https://pkg.go.dev/github.com/otiai10/gosseract/v2

Retrieves the version of the Tesseract engine currently being used by the client.

```APIDOC
## GET /client/version

### Description
Returns the version string of the Tesseract OCR engine used by the current client instance.

### Method
GET

### Response
#### Success Response (200)
- **version** (string) - The version string of the Tesseract engine.
```

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

### Get Tesseract version

Source: https://pkg.go.dev/github.com/otiai10/gosseract/v2

Returns the version string of the underlying Tesseract-OCR library.

```go
func Version() string
```

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

### Get verbose bounding boxes

Source: https://pkg.go.dev/github.com/otiai10/gosseract/v2

Returns word-level bounding boxes including block, paragraph, line, and word numbers, similar to TSV output.

```go
func (client *Client) GetBoundingBoxesVerbose() (out []BoundingBox, err error)
```

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

### Construct a new Client

Source: https://pkg.go.dev/github.com/otiai10/gosseract/v2

Initializes a new Client instance. The caller is responsible for calling Close to free resources.

```go
func NewClient() *Client
```

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

### Basic OCR Usage

Source: https://pkg.go.dev/github.com/otiai10/gosseract/v2

Demonstrates how to initialize the client, set an image, and extract text using gosseract.

```APIDOC
## Basic OCR Usage

### Description
This example shows the fundamental steps to perform OCR on an image file using the gosseract client.

### Method
N/A (This is a usage example, not a specific API endpoint)

### Endpoint
N/A

### Request Example
```go
package main

import (
	"fmt"
	"github.com/otiai10/gosseract/v2"
)

func main() {
	client := gosseract.NewClient()
	defer client.Close()
	client.SetImage("path/to/image.png")
	text, _ := client.Text()
	fmt.Println(text)
	// Expected output: "Hello, World!"
}
```

### Response Example
```
Hello, World!
```
```

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

### Client Initialization and Lifecycle

Source: https://pkg.go.dev/github.com/otiai10/gosseract/v2

Methods for creating, closing, and managing the lifecycle of a gosseract Client instance.

```APIDOC
## Client Lifecycle Management

### NewClient

#### Description
Constructs a new `Client` instance. The caller is responsible for closing the client.

#### Function Signature
```go
func NewClient() *Client
```

### Close

#### Description
Frees allocated API resources. This method **must** be called for any client constructed by `NewClient`.

#### Function Signature
```go
func (client *Client) Close() (err error)
```
```

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

### Set configuration file

Source: https://pkg.go.dev/github.com/otiai10/gosseract/v2

Sets the file path for Tesseract configuration.

```go
func (client *Client) SetConfigFile(fpath string) error
```

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

### Configuration and Settings

Source: https://pkg.go.dev/github.com/otiai10/gosseract/v2

Methods for configuring language, page segmentation mode, tessdata prefix, variables, and whitelists/blacklists.

```APIDOC
## Configuration Methods

### SetLanguage

#### Description
Sets the languages to be used for OCR. If not specified, English is used by default.

#### Parameters
- **langs** (...string) - A variadic list of language codes (e.g., `"eng"`, `"fra"`).

#### Function Signature
```go
func (client *Client) SetLanguage(langs ...string) error
```

### SetPageSegMode

#### Description
Sets the Page Segmentation Mode (PSM) to define the layout analysis of characters. Refer to Tesseract documentation for available modes.

#### Parameters
- **mode** (PageSegMode) - The desired Page Segmentation Mode.

#### Function Signature
```go
func (client *Client) SetPageSegMode(mode PageSegMode) error
```

### SetTessdataPrefix

#### Description
Sets the path to the Tesseract models directory (`tessdata`). The `TESSDATA_PREFIX` environment variable is used as a default if this is not set.

#### Parameters
- **prefix** (string) - The directory path to the tessdata models.

#### Function Signature
```go
func (client *Client) SetTessdataPrefix(prefix string) error
```

### SetVariable

#### Description
Sets a configuration variable for the Tesseract API, equivalent to `tesseract::TessBaseAPI->SetVariable`. Note that this must be called after API initialization.

#### Parameters
- **key** (SettableVariable) - The configuration variable key.
- **value** (string) - The value for the configuration variable.

#### Function Signature
```go
func (client *Client) SetVariable(key SettableVariable, value string) error
```

### SetWhitelist

#### Description
Sets a whitelist of characters that Tesseract should recognize. Refer to Tesseract documentation for details on character whitelisting.

#### Parameters
- **whitelist** (string) - A string containing the characters to whitelist.

#### Function Signature
```go
func (client *Client) SetWhitelist(whitelist string) error
```

### SetBlacklist

#### Description
Sets a blacklist of characters that Tesseract should ignore. Refer to Tesseract documentation for details on character blacklisting.

#### Parameters
- **blacklist** (string) - A string containing the characters to blacklist.

#### Function Signature
```go
func (client *Client) SetBlacklist(blacklist string) error
```

### SetConfigFile

#### Description
Sets the file path to a custom configuration file for Tesseract.

#### Parameters
- **fpath** (string) - The file path to the Tesseract configuration file.

#### Function Signature
```go
func (client *Client) SetConfigFile(fpath string) error
```

### DisableOutput

#### Description
Disables output from the Tesseract engine. This can be useful in scenarios where only specific results are needed.

#### Function Signature
```go
func (client *Client) DisableOutput() error
```
```

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

### Extract text

Source: https://pkg.go.dev/github.com/otiai10/gosseract/v2

Initializes the API, executes OCR, and returns the detected text as a string.

```go
func (client *Client) Text() (out string, err error)
```

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

### Set image path

Source: https://pkg.go.dev/github.com/otiai10/gosseract/v2

Sets the path to the image file to be processed.

```go
func (client *Client) SetImage(imagepath string) error
```

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

### Client Methods

Source: https://pkg.go.dev/github.com/otiai10/gosseract/v2

Details on various methods available for the gosseract Client.

```APIDOC
## Client Methods

### Description
This section details the methods available on the `Client` type for interacting with the Tesseract OCR engine.

### Methods

#### `NewClient()`

##### Description
Initializes and returns a new `Client` instance.

##### Returns
- `*Client` - A pointer to the newly created client.

#### `Close()`

##### Description
Closes the client and releases any associated resources.

##### Returns
- `error` - An error if closing fails, otherwise `nil`.

#### `DisableOutput()`

##### Description
Disables output from the OCR process.

##### Returns
- `error` - An error if disabling output fails.

#### `GetBoundingBoxes(level PageIteratorLevel)`

##### Description
Retrieves bounding boxes for recognized words at a specified level.

##### Parameters
- **level** (`PageIteratorLevel`) - Required - The level of detail for bounding boxes (e.g., `PageIteratorLevel.RIL_WORD`).

##### Returns
- `[]BoundingBox` - A slice of `BoundingBox` structs.
- `error` - An error if retrieval fails.

#### `GetBoundingBoxesVerbose()`

##### Description
Retrieves detailed bounding box information for recognized words.

##### Returns
- `[]BoundingBox` - A slice of `BoundingBox` structs with detailed information.
- `error` - An error if retrieval fails.

#### `HOCRText()`

##### Description
Returns the OCR result in HOCR (HTML Output Configuration) format.

##### Returns
- `string` - The OCR result as an HOCR string.
- `error` - An error if HOCR generation fails.

#### `SetBlacklist(blacklist string)`

##### Description
Sets a blacklist of characters not to recognize.

##### Parameters
- **blacklist** (`string`) - Required - A string containing characters to be blacklisted.

##### Returns
- `error` - An error if setting the blacklist fails.

#### `SetConfigFile(fpath string)`

##### Description
Sets the Tesseract configuration file path.

##### Parameters
- **fpath** (`string`) - Required - The file path to the Tesseract configuration file.

##### Returns
- `error` - An error if setting the config file fails.

#### `SetImage(imagepath string)`

##### Description
Sets the image file to be processed for OCR.

##### Parameters
- **imagepath** (`string`) - Required - The path to the image file.

##### Returns
- `error` - An error if setting the image fails.

#### `SetImageFromBytes(data []byte)`

##### Description
Sets the image data directly from a byte slice for OCR processing.

##### Parameters
- **data** (`[]byte`) - Required - The image data as a byte slice.

##### Returns
- `error` - An error if setting the image from bytes fails.

#### `SetLanguage(langs ...string)`

##### Description
Sets the language(s) for OCR recognition.

##### Parameters
- **langs** (`...string`) - Required - One or more language codes (e.g., "eng", "fra").

##### Returns
- `error` - An error if setting the language fails.

#### `SetPageSegMode(mode PageSegMode)`

##### Description
Sets the page segmentation mode for Tesseract.

##### Parameters
- **mode** (`PageSegMode`) - Required - The page segmentation mode to use.

##### Returns
- `error` - An error if setting the page segmentation mode fails.

#### `SetTessdataPrefix(prefix string)`

##### Description
Sets the prefix for the tessdata directory.

##### Parameters
- **prefix** (`string`) - Required - The prefix path for tessdata.

##### Returns
- `error` - An error if setting the tessdata prefix fails.

#### `SetVariable(key SettableVariable, value string)`

##### Description
Sets a Tesseract configuration variable.

##### Parameters
- **key** (`SettableVariable`) - Required - The configuration variable key.
- **value** (`string`) - Required - The value for the configuration variable.

##### Returns
- `error` - An error if setting the variable fails.

#### `SetWhitelist(whitelist string)`

##### Description
Sets a whitelist of characters to recognize.

##### Parameters
- **whitelist** (`string`) - Required - A string containing characters to be whitelisted.

##### Returns
- `error` - An error if setting the whitelist fails.

#### `Text()`

##### Description
Extracts and returns the recognized text from the image.

##### Returns
- `string` - The recognized text.
- `error` - An error if text extraction fails.

#### `Version()`

##### Description
Returns the version of the Tesseract OCR engine used by the client.

##### Returns
- `string` - The Tesseract version string.
```

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

### Set image from bytes

Source: https://pkg.go.dev/github.com/otiai10/gosseract/v2

Sets the raw image data to be processed.

```go
func (client *Client) SetImageFromBytes(data []byte) error
```

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

### Retrieve Tesseract Version

Source: https://pkg.go.dev/github.com/otiai10/gosseract/v2

Returns the version of the Tesseract engine currently in use by the client.

```go
func (client *Client) Version() string
```

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

### Client Configuration

Source: https://pkg.go.dev/github.com/otiai10/gosseract/v2

The Client struct holds configuration options for the OCR process, including trimming characters, tessdata path, languages, variables, and configuration file paths.

```APIDOC
## Client Type

### Description
The `Client` struct serves as an argument builder for `tesseract::TessBaseAPI`. It allows for detailed configuration of the OCR process.

### Fields
- **Trim** (bool) - Specifies characters to trim from the result string, such as leading/trailing newlines.
- **TessdataPrefix** (string) - Indicates the directory path to `tessdata`. Defaults to `/usr/local/share/tessdata/`.
- **Languages** ([]string) - Languages to be detected. Defaults to `["eng"]` if not specified.
- **Variables** (map[SettableVariable]string) - A pool for evaluating `tesseract::TessBaseAPI->SetVariable`.
- **ConfigFilePath** (string) - A file path to the configuration for Tesseract. Refer to Tesseract OCR parameters documentation for details.
```

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

### Set tessdata prefix

Source: https://pkg.go.dev/github.com/otiai10/gosseract/v2

Sets the directory path for Tesseract models. Defaults to the TESSDATA_PREFIX environment variable.

```go
func (client *Client) SetTessdataPrefix(prefix string) error
```

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

### Set page segmentation mode

Source: https://pkg.go.dev/github.com/otiai10/gosseract/v2

Configures the Page Segmentation Mode (PSM) for layout detection.

```go
func (client *Client) SetPageSegMode(mode PageSegMode) error
```

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

### Set Tesseract variable

Source: https://pkg.go.dev/github.com/otiai10/gosseract/v2

Sets Tesseract parameters. Note that this must be called after initialization.

```go
func (client *Client) SetVariable(key SettableVariable, value string) error
```

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

### Set languages

Source: https://pkg.go.dev/github.com/otiai10/gosseract/v2

Sets the languages to be used for OCR. Defaults to English.

```go
func (client *Client) SetLanguage(langs ...string) error
```

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

### Types

Source: https://pkg.go.dev/github.com/otiai10/gosseract/v2

Documentation for the types defined within the gosseract package.

```APIDOC
## Types

### Description
This section provides details on the custom types defined in the gosseract package.

### Types

#### `BoundingBox`

##### Description
Represents a bounding box around a recognized word, including its position, confidence, and the word itself.

##### Fields
- **Box** (`image.Rectangle`) - The rectangular coordinates of the bounding box.
- **Word** (`string`) - The recognized word within the bounding box.
- **Confidence** (`float64`) - The confidence score (0.0 to 1.0) for the recognition of the word.
- **BlockNum** (`int`) - The block number to which the word belongs.
- **ParNum** (`int`) - The paragraph number to which the word belongs.
- **LineNum** (`int`) - The line number to which the word belongs.
- **WordNum** (`int`) - The word number within the line.

##### Signature
```go
type BoundingBox struct {
	Box                                image.Rectangle
	Word                               string
	Confidence                         float64
	BlockNum, ParNum, LineNum, WordNum int
}
```

#### `Client`

##### Description
The main client type for interacting with the Tesseract OCR engine. It holds the state for OCR operations.

#### `Content`

##### Description
Represents OCR content, likely a structured representation of recognized text.

#### `Line`

##### Description
Represents a line of text recognized by the OCR engine.

#### `PageIteratorLevel`

##### Description
An enumeration defining the different levels of detail for iterating through OCR results (e.g., page, block, line, word).

#### `PageSegMode`

##### Description
An enumeration defining the page segmentation modes for Tesseract, controlling how the OCR engine analyzes the page layout.

#### `Par`

##### Description
Represents a paragraph of text recognized by the OCR engine.

#### `SettableVariable`

##### Description
A type representing Tesseract configuration variables that can be set via the client.

#### `Word`

##### Description
Represents a single word recognized by the OCR engine.
```

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

### Define Client struct

Source: https://pkg.go.dev/github.com/otiai10/gosseract/v2

The Client struct serves as an argument builder for the underlying tesseract::TessBaseAPI.

```go
type Client struct {

	// Trim specifies characters to trim, which would be trimed from result string.
	// As results of OCR, text often contains unnecessary characters, such as newlines, on the head/foot of string.
	// If `Trim` is set, this client will remove specified characters from the result.
	Trim bool

	// TessdataPrefix can indicate directory path to `tessdata`.
	// It is set `/usr/local/share/tessdata/` or something like that, as default.
	// TODO: Implement and test
	TessdataPrefix string

	// Languages are languages to be detected. If not specified, it's gonna be "eng".
	Languages []string

	// Variables is just a pool to evaluate "tesseract::TessBaseAPI->SetVariable" in delay.
	// TODO: Think if it should be public, or private property.
	Variables map[SettableVariable]string

	// Config is a file path to the configuration for Tesseract
	// See http://www.sk-spell.sk.cx/tesseract-ocr-parameters-in-302-version
	// TODO: Fix link to official page
	ConfigFilePath string
	// contains filtered or unexported fields
}
```

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

### Global Functions

Source: https://pkg.go.dev/github.com/otiai10/gosseract/v2

Details on global functions provided by the gosseract package.

```APIDOC
## Global Functions

### Description
This section describes the global functions available in the gosseract package.

### Functions

#### `ClearPersistentCache()`

##### Description
Clears any global memory caches used by the Tesseract library. This can be useful for freeing up memory associated with loaded language data.

##### Signature
```go
func ClearPersistentCache()
```

#### `GetAvailableLanguages()`

##### Description
Retrieves a list of languages that are currently available for Tesseract OCR based on the installed tessdata.

##### Returns
- `[]string` - A slice of strings, where each string is an available language code (e.g., "eng", "fra").
- `error` - An error if the list of languages cannot be retrieved.

##### Signature
```go
func GetAvailableLanguages() ([]string, error)
```

#### `Version()`

##### Description
Returns the version string of the Tesseract OCR engine that gosseract is linked against.

##### Returns
- `string` - The version of the Tesseract OCR engine.

##### Signature
```go
func Version() string
```
```

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

### Set whitelist characters

Source: https://pkg.go.dev/github.com/otiai10/gosseract/v2

Configures characters to be included in OCR results.

```go
func (client *Client) SetWhitelist(whitelist string) error
```

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

### Define PageSegMode Constants

Source: https://pkg.go.dev/github.com/otiai10/gosseract/v2

Enumeration for Tesseract page segmentation methods.

```go
type PageSegMode int
```

```go
const (
	// PSM_OSD_ONLY - Orientation and script detection (OSD) only.
	PSM_OSD_ONLY PageSegMode = iota
	// PSM_AUTO_OSD - Automatic page segmentation with OSD.
	PSM_AUTO_OSD
	// PSM_AUTO_ONLY - Automatic page segmentation, but no OSD, or OCR.
	PSM_AUTO_ONLY
	// PSM_AUTO - (DEFAULT) Fully automatic page segmentation, but no OSD.
	PSM_AUTO
	// PSM_SINGLE_COLUMN - Assume a single column of text of variable sizes.
	PSM_SINGLE_COLUMN
	// PSM_SINGLE_BLOCK_VERT_TEXT - Assume a single uniform block of vertically aligned text.
	PSM_SINGLE_BLOCK_VERT_TEXT
	// PSM_SINGLE_BLOCK - Assume a single uniform block of text.
	PSM_SINGLE_BLOCK
	// PSM_SINGLE_LINE - Treat the image as a single text line.
	PSM_SINGLE_LINE
	// PSM_SINGLE_WORD - Treat the image as a single word.
	PSM_SINGLE_WORD
	// PSM_CIRCLE_WORD - Treat the image as a single word in a circle.
	PSM_CIRCLE_WORD
	// PSM_SINGLE_CHAR - Treat the image as a single character.
	PSM_SINGLE_CHAR
	// PSM_SPARSE_TEXT - Find as much text as possible in no particular order.
	PSM_SPARSE_TEXT
	// PSM_SPARSE_TEXT_OSD - Sparse text with orientation and script det.
	PSM_SPARSE_TEXT_OSD
	// PSM_RAW_LINE - Treat the image as a single text line, bypassing hacks that are Tesseract-specific.
	PSM_RAW_LINE

	// PSM_COUNT - Just a number of enum entries. This is NOT a member of PSM ;)
	PSM_COUNT
)
```

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

### BoundingBox struct definition

Source: https://pkg.go.dev/github.com/otiai10/gosseract/v2

Represents the position, confidence, and text content of a recognized word.

```go
type BoundingBox struct {
	Box                                image.Rectangle
	Word                               string
	Confidence                         float64
	BlockNum, ParNum, LineNum, WordNum int
}
```

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

### Image Handling

Source: https://pkg.go.dev/github.com/otiai10/gosseract/v2

Methods for setting the image to be processed by the OCR engine, either from a file path or raw byte data.

```APIDOC
## Image Input

### SetImage

#### Description
Sets the path to the image file to be processed by OCR.

#### Function Signature
```go
func (client *Client) SetImage(imagepath string) error
```

### SetImageFromBytes

#### Description
Sets the image data (as bytes) to be processed by OCR.

#### Function Signature
```go
func (client *Client) SetImageFromBytes(data []byte) error
```
```

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

### Bounding Box Information

Source: https://pkg.go.dev/github.com/otiai10/gosseract/v2

Methods for retrieving bounding box information for detected words.

```APIDOC
## Bounding Box Retrieval

### GetBoundingBoxes

#### Description
Returns bounding boxes for each matched word. Requires a `PageIteratorLevel` to specify the level of detail.

#### Parameters
- **level** (PageIteratorLevel) - The level of detail for bounding box iteration (e.g., word, line, paragraph).

#### Function Signature
```go
func (client *Client) GetBoundingBoxes(level PageIteratorLevel) (out []BoundingBox, err error)
```

### GetBoundingBoxesVerbose

#### Description
Returns bounding boxes at the word level, including block number, paragraph number, line number, and word number, similar to the TSV output format of the C++ API (`TessBaseAPI::GetTSVText`).

#### Function Signature
```go
func (client *Client) GetBoundingBoxesVerbose() (out []BoundingBox, err error)
```
```

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

### Extract hOCR text

Source: https://pkg.go.dev/github.com/otiai10/gosseract/v2

Initializes the API, executes OCR, and returns the result in hOCR format.

```go
func (client *Client) HOCRText() (out string, err error)
```

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

### Clear persistent cache

Source: https://pkg.go.dev/github.com/otiai10/gosseract/v2

Clears global library-level memory caches for language dictionaries.

```go
func ClearPersistentCache()
```

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

### Define PageIteratorLevel Constants

Source: https://pkg.go.dev/github.com/otiai10/gosseract/v2

Enumeration representing the hierarchy of page elements used in ResultIterator.

```go
type PageIteratorLevel int
```

```go
const (
	// RIL_BLOCK - Block of text/image/separator line.
	RIL_BLOCK PageIteratorLevel = iota
	// RIL_PARA - Paragraph within a block.
	RIL_PARA
	// RIL_TEXTLINE - Line within a paragraph.
	RIL_TEXTLINE
	// RIL_WORD - Word within a textline.
	RIL_WORD
	// RIL_SYMBOL - Symbol/character within a word.
	RIL_SYMBOL
)
```

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

### Define SettableVariable Constants

Source: https://pkg.go.dev/github.com/otiai10/gosseract/v2

Configuration variables used for TessBaseAPI::SetVariable.

```go
type SettableVariable string
```

```go
const (
	// DEBUG_FILE - File to send output to.
	DEBUG_FILE SettableVariable = "debug_file"
	// TESSEDIT_CHAR_WHITELIST - Whitelist of chars to recognize
	// There is a known issue in 4.00 with LSTM
	// https://github.com/tesseract-ocr/tesseract/issues/751
	TESSEDIT_CHAR_WHITELIST SettableVariable = "tessedit_char_whitelist"
	// TESSEDIT_CHAR_BLACKLIST - Blacklist of chars not to recognize
	// There is a known issue in 4.00 with LSTM
	// https://github.com/tesseract-ocr/tesseract/issues/751
	TESSEDIT_CHAR_BLACKLIST SettableVariable = "tessedit_char_blacklist"
)
```

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

### Close the Client

Source: https://pkg.go.dev/github.com/otiai10/gosseract/v2

Frees the allocated Tesseract API. This must be called for any client created by NewClient.

```go
func (client *Client) Close() (err error)
```

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

### Set blacklist characters

Source: https://pkg.go.dev/github.com/otiai10/gosseract/v2

Configures characters to be excluded from OCR results.

```go
func (client *Client) SetBlacklist(blacklist string) error
```

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

### Disable OCR output

Source: https://pkg.go.dev/github.com/otiai10/gosseract/v2

Disables the output of the OCR process.

```go
func (client *Client) DisableOutput() error
```

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

### OCR Processing and Output

Source: https://pkg.go.dev/github.com/otiai10/gosseract/v2

Methods for performing OCR and retrieving the results in various formats, including plain text and HOCR.

```APIDOC
## OCR Execution and Results

### Text

#### Description
Initializes the Tesseract API, executes OCR, and extracts the detected text as a string.

#### Function Signature
```go
func (client *Client) Text() (out string, err error)
```

### HOCRText

#### Description
Initializes the Tesseract API, executes OCR, and returns the result in HOCR (Hierarchical OCR) format. Refer to the HOCR specification for more information.

#### Function Signature
```go
func (client *Client) HOCRText() (out string, err error)
```
```

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

### Define hOCR Data Structures

Source: https://pkg.go.dev/github.com/otiai10/gosseract/v2

Data structures representing hOCR elements for parsing OCR output.

```go
type Content struct {
	ID    string `xml:"id,attr"`
	Title string `xml:"title,attr"`
	Class string `xml:"class,attr"`
	Par   Par    `xml:"p"`
}
```

```go
type Line struct {
	ID    string `xml:"id,attr"`
	Title string `xml:"title,attr"`
	Class string `xml:"class,attr"`
	Words []Word `xml:"span"`
}
```

```go
type Page struct {
	ID      string  `xml:"id,attr"`
	Title   string  `xml:"title,attr"`
	Class   string  `xml:"class,attr"`
	Content Content `xml:"div"`
}
```

```go
type Par struct {
	ID       string `xml:"id,attr"`
	Title    string `xml:"title,attr"`
	Class    string `xml:"class,attr"`
	Language string `xml:"lang,attr"`
	Lines    []Line `xml:"span"`
}
```

```go
type Word struct {
	ID         string `xml:"id,attr"`
	Title      string `xml:"title,attr"`
	Class      string `xml:"class,attr"`
	Characters string `xml:",chardata"`
}
```
Tokens:
Raw