Go

このページは英語から翻訳されています。内容に相違がある場合は、英語のページが正しい内容です。英語のページを読む

Go ライブラリは lingara パッケージで、モジュール github.com/Spinning-Cat-Studios/lingara_api_clients/go に含まれています。Go 1.23 以降が必要で、標準ライブラリのみを使用します。

使い方

すべての呼び出しは最初の引数に context.Context を取ります。コンテキストをキャンセルすると呼び出しもキャンセルされます。返されるエラーはコンテキスト自身のものなので、errors.Is(err, context.Canceled) が機能します。
呼び出しは同期的です。複数を同時に実行したい場合はゴルーチンで実行してください。1 つのクライアントは安全に共有できます。
ストリームは for ev, err := range s.Events() で読み取り、各イベントは型 switch で照合します。defer s.Close() で閉じてください。
エラーは lingara.Error インターフェースを共有する 4 つの型です。特定の型を取り出すには errors.As を使います。API が待機時間を示さなかった場合、RetryAfter は nil です。
オプションは関数型です。lingara.WithHTTPClient を渡すと、独自の http.Client を使えます。その場合、その Timeout がストリームを含むすべての呼び出しを制限します。

以下のサンプルでは、モジュールのインストール、クライアントの作成、語彙リストのストリーミング、エラー処理を行います。

go get github.com/Spinning-Cat-Studios/lingara_api_clients/go@v0.1.0-alpha.6

import (
	"os"

	lingara "github.com/Spinning-Cat-Studios/lingara_api_clients/go"
)

client, err := lingara.New(
	lingara.WithClientCredentials(os.Getenv("LINGARA_CLIENT_ID"), os.Getenv("LINGARA_CLIENT_SECRET")),
)
if err != nil {
	return nil, err
}

count := uint8(8)
s, err := client.GenerateVocabulary(ctx, lingara.VocabRequest{Level: 2, SourceLang: "en", TargetLang: "zh", Count: &count})
if err != nil {
	return err
}
defer s.Close()
for ev, err := range s.Events() {
	if err != nil {
		return err
	}
	if item, ok := ev.(lingara.GenerateVocabularyEventItem); ok {
		fmt.Println(item.Data.Word, item.Data.Translation)
	}
}

_, err := client.GetUsage(ctx)
var apiErr *lingara.APIError
var oauthErr *lingara.OAuthError
var maintenance *lingara.MaintenanceError
var transport *lingara.TransportError
switch {
case err == nil:
case errors.As(err, &apiErr):
	// A refusal from the API: Status, Code (stable) and Message (localised).
	fmt.Println(apiErr.Status, apiErr.Code, apiErr.Message)
	if apiErr.RetryAfter != nil {
		fmt.Println("retry after", *apiErr.RetryAfter)
	}
case errors.As(err, &oauthErr):
	// The token endpoint refused the credentials or the scopes.
	fmt.Println(oauthErr.Status, oauthErr.ErrorCode, oauthErr.Description)
case errors.As(err, &maintenance):
	fmt.Println("under maintenance")
	if maintenance.RetryAfter != nil {
		fmt.Println("retry after", *maintenance.RetryAfter)
	}
case errors.As(err, &transport):
	// No usable answer: connect, tls, reset, timeout, and so on.
	fmt.Println("transport:", transport.Kind)
default:
	// ctx was cancelled or timed out: errors.Is(err, context.Canceled).
	fmt.Println(err)
}

Go

使い方

このページがラップするもの