DEPRECATED: Moved to GLAIR's repository
GLAIR Vision Go SDK
## Requirement
- Go 1.18 or later with Go modules.
## Installation
You can import the SDK in your Go files with `import`:
```go
import (
"github.com/glair-ai/glair-vision-go"
"github.com/glair-ai/glair-vision-go/client"
)
```
After that, you can run `go` commands and let the Go toolchain resolve and fetch the SDK module automatically.
Alternatively, you can also run `go get` to explicitly resolve and fetch the SDK module:
```bash
go get -u github.com/glair-ai/glair-vision-go
```
## Usage
The package needs to be configured with your credentials, see [here](https://docs.glair.ai/vision/authentication) for more detailed instructions
```go
package main
import (
"github.com/glair-ai/glair-vision-go"
"github.com/glair-ai/glair-vision-go/client"
)
func main() {
config := glair.NewConfig("
", "", "")
client := client.New(config)
}
```
The configuration object will be initialized with the following values:
| Option | Default | Description |
| ------------ | ----------------------------- | --------------------------------------------------------------- |
| `BaseUrl` | `https://api.vision.glair.ai` | Base URL for GLAIR Vision API |
| `ApiVersion` | `v1` | GLAIR Vision API version to be used |
| `Client` | Default Go HTTP client | HTTP Client to be used when sending request to GLAIR Vision API |
You can change the above values using the provided `With` method of the configuration object, for example:
```go
package main
import (
"github.com/glair-ai/glair-vision-go"
"github.com/glair-ai/glair-vision-go/client"
)
func main() {
config := glair.NewConfig("", "", "")
// set the base url to `http://localhost:3000`
config = config.WithBaseURL("http://localhost:3000")
client := client.New(config)
}
```
Afterwards, you can use the provided functions to access GLAIR Vision API.
## Documentation
For comprehensive list of available API provided by GLAIR Vision Go SDK, check out the [API Documentation](https://docs.glair.ai/vision). You can also see the runnable examples in the [examples folder](./examples). For details on all the functionality in this library, see the Go documentation.
Below are a few simple usage examples:
### Fetch KTP
```go
package main
import (
"context"
"fmt"
"log"
"os"
"github.com/glair-ai/glair-vision-go"
"github.com/glair-ai/glair-vision-go/client"
)
func main() {
ctx := context.Background()
config := glair.NewConfig("", "", "")
client := client.New(config)
file, _ := os.Open("path/to/image.jpg")
result, err := client.Ocr.KTP(ctx, glair.OCRInput{
File: file,
})
if err != nil {
log.Fatalln(err.Error())
}
fmt.Println(result.Read.Nama)
}
```
## Error Handling
Whenever an error occurs, GLAIR Vision Go SDK will wrap the error into a `glair.Error` object that contains the following properties
| Property | Type | Description |
| ---------- | ----------- | ------------------------------------------------------------------------------------------------------------- |
| `Code` | `ErrorCode` | Unique identifier that distinguish errors |
| `Message` | `string` | Human-readable error message. Contains basic information of error cause |
| `Err` | `error` | The original error object returned by the SDK |
| `Response` | `Response` | GLAIR Vision API response body. Only available if the request has been successfully sent the GLAIR Vision API |
It's recommended to assert the error to `glair.Error` whenever an error is returned, for example:
```go
package main
import (
"context"
"fmt"
"log"
"os"
"github.com/glair-ai/glair-vision-go"
"github.com/glair-ai/glair-vision-go/client"
)
func main() {
ctx := context.Background()
config := glair.NewConfig("", "", "")
client := client.New(config)
file, _ := os.Open("path/to/image.jpg")
result, err := client.Ocr.KTP(ctx, glair.OCRInput{
File: file,
})
if err != nil {
// is a glair.Error, assert the error code
if glairErr, ok := err.(*glair.Error); ok {
switch glairErr.Code {
case glair.ErrorCodeInvalidFile:
fmt.Println("Cannot read input file")
case glair.ErrorCodeFileCorrupted:
fmt.Println("File corrupted")
case glair.ErrorCodeInvalidURL:
fmt.Println("URL is invalid")
default:
fmt.Printf("GLAIR SDK returns error code: %d", glairErr.Code)
}
} else {
fmt.Printf("Unexpected error occured: %w", err)
}
}
}
```
### Error Code
To make debugging errors easier, GLAIR Vision Go SDK provides error code to all `glair.Error` objects. Below are the list of error codes that are returned by GLAIR Vision Go SDK
| Error Code | Reason |
| -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ErrorCodeInvalidFile` | The SDK fails to read the input file. It's possible that the file doesn't exist or the SDK cannot access the file from the given path. This code also returned when incorrect representation of file is provided |
| `ErrorCodeFileCorrupted` | The SDK fails to parse the input file due to corrupted contents. |
| `ErrorCodeInvalidURL` | The SDK fails to make a request to GLAIR Vision API due to invalid `BaseURL` in the configuration object |
| `ErrorCodeBadClient` | The SDK fails to make a request to GLAIR Vision API due to failures in the HTTP client provided in the configuration object |
| `ErrorCodeAPIError` | GLAIR Vision API returns a non-OK response. Please inspect the `Response` object for more detailed explanation if this code is returned |
| `ErrorCodeInvalidResponse` | GLAIR Vision API returns an unexpected response. Please contact us if you receive this error code |
### `Response`
When error with code `ErrorCodeAPIError` is returned, GLAIR Vision SDK with return additional context of the failure encapsulated in the `Response` object. The `Response` object has the following properties.
| Property | Description |
| -------- | ------------------------------------------------------------------------------------------------------------------------ |
| `Code` | HTTP Status code returned by GLAIR Vision API |
| `Status` | GLAIR Vision API status string. Please refer to the [API Documentation](https://docs.glair.ai/vision) for list of status |
| `Reason` | Human-readable error message from GLAIR Vision API |
## Logging
GLAIR Vision Go SDK provides basic logging functions... TBD
## License
This project is licensed under [the MIT License](./LICENSE) 
