deepl

README

deepl-go

This library provides a simple API client function for Deepl.

Usage

1. Install package

   > go get github.com/DaikiYamakawa/deepl-go
   

2. We should register valid API key in the environment variable.

   > export DEEPL_API_KEY=xxx-xxx-xxx
   

3. We can call deepl library in our code.

    package main
   
    import (
        "context"
        "fmt"
   
        "github.com/DaikiYamakawa/deepl-go"
    )
   
    func main() {
        cli, err := deepl.New("https://api.deepl.com", nil)
        if err != nil {
            fmt.Printf("Failed to create client:\n   %+v\n", err)
        }
        translateResponse, err := cli.TranslateSentence(context.Background(), "Hello", "EN", "JA")
        if err != nil {
            fmt.Printf("Failed to translate text:\n   %+v\n", err)
        } else {
            fmt.Printf("%+v\n", translateResponse)
        }
    }
   

   &{Translations:[{DetectedSourceLanguage:EN Text:こんにちは}]}
   

Documentation

Index

• Variables
• type AccountStatus
• type Client
  • func New(apiKind DeeplAPIKind, logger *log.Logger, apiKey string) (result *Client, err error)
  • func (c *Client) GetAccountStatus(ctx context.Context) (*AccountStatus, error)
  • func (c *Client) TranslateSentence(ctx context.Context, text string, sourceLang string, targetLang string) (*TranslateResponse, error)
• type DeeplAPIKind
• type ErrorResponse
• type TranslateResponse

Variables

var (
	EInvalidAPIKind error = errors.New("deepl-go: Invalid API Kind")
)

Types

type AccountStatus

type AccountStatus struct {
	CharacterCount int `json:"character_count"`
	CharacterLimit int `json:"character_limit"`
}

type Client

type Client struct {
	BaseURL    *url.URL
	HTTPClient *http.Client
	Logger     *log.Logger
	// contains filtered or unexported fields
}

func New

func New(apiKind DeeplAPIKind, logger *log.Logger, apiKey string) (result *Client, err error)

func (*Client) GetAccountStatus

func (c *Client) GetAccountStatus(ctx context.Context) (*AccountStatus, error)

func (*Client) TranslateSentence

func (c *Client) TranslateSentence(ctx context.Context, text string, sourceLang string, targetLang string) (*TranslateResponse, error)

type DeeplAPIKind

type DeeplAPIKind string

const (
	DeeplAPIFree DeeplAPIKind = "free"
	DeeplAPIPro  DeeplAPIKind = "pro"
)

type ErrorResponse

type ErrorResponse struct {
	ErrMessage string `json:"message"`
}

type TranslateResponse

type TranslateResponse struct {
	Translations []translation `json:"translations"`
}