AzooKeyKanaKanjiConverter

AzooKeyKanaKanjiConverterはazooKeyのために開発したかな漢字変換エンジンです。数行のコードでかな漢字変換をiOS / macOS / visionOSのアプリケーションに組み込むことができます。

また、AzooKeyKanaKanjiConverterはニューラルかな漢字変換システム「Zenzai」を利用した高精度な変換もサポートしています。

動作環境

iOS 16以降, macOS 13以降, visionOS 1以降, Ubuntu 22.04以降で動作を確認しています。Swift 6.1以上が必要です。

AzooKeyKanaKanjiConverterの開発については開発ガイドをご覧ください。 学習データの保存先やリセット方法についてはDocs/learning_data.mdを参照してください。

KanaKanjiConverterModule

かな漢字変換を受け持つモジュールです。

セットアップ

• Xcodeprojの場合、XcodeでAdd Packageしてください。

• Swift Packageの場合、Package.swiftのPackageの引数にdependencies以下の記述を追加してください。

  dependencies: [
      .package(url: "https://github.com/azooKey/AzooKeyKanaKanjiConverter", .upToNextMinor(from: "0.8.0"))
  ],

  また、ターゲットのdependenciesにも同様に追加してください。

  .target(
      name: "MyPackage",
      dependencies: [
          .product(name: "KanaKanjiConverterModuleWithDefaultDictionary", package: "AzooKeyKanaKanjiConverter")
      ],
  ),

Important

AzooKeyKanaKanjiConverterはバージョン1.0のリリースまで開発版として運用するため、マイナーバージョンの変更で破壊的変更を実施する可能性があります。バージョンを指定する際にはマイナーバージョンが上がらないよう、.upToNextMinor(from: "0.8.0")のように指定することを推奨します。

使い方

// デフォルト辞書つきの変換モジュールをインポート
import KanaKanjiConverterModuleWithDefaultDictionary

// 変換器を初期化する（デフォルト辞書を利用）
let converter = KanaKanjiConverter.withDefaultDictionary()
// 入力を初期化する
var c = ComposingText()
// 変換したい文章を追加する
c.insertAtCursorPosition("あずーきーはしんじだいのきーぼーどあぷりです", inputStyle: .direct)
// 変換のためのオプションを指定して、変換を要求
let results = converter.requestCandidates(c, options: .init(
    N_best: 10,
    requireJapanesePrediction: true,
    requireEnglishPrediction: false,
    keyboardLanguage: .ja_JP,
    englishCandidateInRoman2KanaInput: true,
    fullWidthRomanCandidate: false,
    halfWidthKanaCandidate: false,
    learningType: .inputAndOutput,
    maxMemoryCount: 65536,
    shouldResetMemory: false,
    memoryDirectoryURL: FileManager.default.urls(for: .documentDirectory, in: .userDomainMask).first!,
    sharedContainerURL: FileManager.default.urls(for: .documentDirectory, in: .userDomainMask).first!,
    textReplacer: .withDefaultEmojiDictionary(),
    specialCandidateProviders: KanaKanjiConverter.defaultSpecialCandidateProviders,
    metadata: .init(versionString: "Your App Version X")
))
// 結果の一番目を表示
print(results.mainResults.first!.text)  // azooKeyは新時代のキーボードアプリです

ConvertRequestOptionsは変換リクエストに必要な情報を指定します。詳しくはコード内のドキュメントコメントを参照してください。

ConvertRequestOptions

ConvertRequestOptionsは変換リクエストに必要な設定値です。例えば以下のように設定します。

let documents = FileManager.default
    .urls(for: .documentDirectory, in: .userDomainMask)
    .first!
let options = ConvertRequestOptions(
    // 日本語予測変換
    requireJapanesePrediction: true,
    // 英語予測変換 
    requireEnglishPrediction: false,
    // 入力言語 
    keyboardLanguage: .ja_JP,
    // 学習タイプ 
    learningType: .nothing, 
    // 学習データを保存するディレクトリのURL（書類フォルダを指定）
    memoryDirectoryURL: documents,
    // ユーザ辞書データのあるディレクトリのURL（書類フォルダを指定）
    sharedContainerURL: documents,
    // メタデータ
    metadata: .init(versionString: "Your App Version X"),
    textReplacer: .withDefaultEmojiDictionary(),
    specialCandidateProviders: KanaKanjiConverter.defaultSpecialCandidateProviders
)

開く際に保存処理が中断された .pause ファイルが残っている場合は、変換器が自動的に復旧を試みてファイルを削除します。

ComposingText

ComposingTextは入力管理を行いつつ変換をリクエストするためのAPIです。ローマ字入力などを適切にハンドルするために利用できます。詳しくはドキュメントを参照してください。

Zenzaiを使う

ニューラルかな漢字変換システム「Zenzai」を利用するには、追加でSwift Package Traitsの設定を行う必要があります。AzooKeyKanaKanjiConverterはGPU向けの「Zenzai」およびCPU専用の「ZenzaiCPU」というTraitをサポートしています。環境に応じていずれかを追加してください。

dependencies: [
    // GPU (Metal/CUDA 等) を使う場合
    .package(url: "https://github.com/azooKey/AzooKeyKanaKanjiConverter", .upToNextMinor(from: "0.8.0"), traits: ["Zenzai"]),
    // CPU のみで動作させる場合（オフロード無効）
    // .package(url: "https://github.com/azooKey/AzooKeyKanaKanjiConverter", .upToNextMinor(from: "0.8.0"), traits: ["ZenzaiCPU"]),
],

ConvertRequestOptionsのzenzaiModeを指定します。詳しい引数の情報についてはドキュメントを参照してください。

let options = ConvertRequestOptions(
    // ...
    requireJapanesePrediction: true,
    requireEnglishPrediction: false,
    keyboardLanguage: .ja_JP,
    learningType: .nothing,
    memoryDirectoryURL: documents,
    sharedContainerURL: documents,
    textReplacer: .withDefaultEmojiDictionary(),
    specialCandidateProviders: KanaKanjiConverter.defaultSpecialCandidateProviders,
    zenzaiMode: .on(weight: url, inferenceLimit: 10),
    metadata: .init(versionString: "Your App Version X")
)

辞書データ

AzooKeyKanaKanjiConverterのデフォルト辞書としてazooKey_dictionary_storageがサブモジュールとして指定されています。過去のバージョンの辞書データはGoogle Driveからもダウンロードすることができます。

また、以下のフォーマットであれば自前で用意した辞書データを利用することもできます。カスタム辞書データのサポートは限定的なので、ソースコードを確認の上ご利用ください。

- Dictionary/
  - louds/
    - charId.chid
    - X.louds
    - X.loudschars2
    - X.loudstxt3
    - ...
  - p/
    - X.csv
  - cb/
    - 0.binary
    - 1.binary
    - ...
  - mm.binary

デフォルト以外の辞書データを利用する場合、ターゲットのdependenciesに以下を追加してください。

.target(
  name: "MyPackage",
  dependencies: [
      .product(name: "KanaKanjiConverterModule", package: "AzooKeyKanaKanjiConverter")
  ],
),

利用時に、辞書データのディレクトリを明示的に指定する必要があります（オプションではなく、変換器の初期化時に指定します）。

// デフォルト辞書を含まない変換モジュールを指定
import KanaKanjiConverterModule

let documents = FileManager.default
    .urls(for: .documentDirectory, in: .userDomainMask)
    .first!
// カスタム辞書ディレクトリを指定して変換器を初期化
let dictionaryURL = Bundle.main.bundleURL.appending(path: "Dictionary", directoryHint: .isDirectory)
let converter = KanaKanjiConverter(dictionaryURL: dictionaryURL, preloadDictionary: true)

// 変換リクエスト時のオプションを用意
let options = ConvertRequestOptions(
    requireJapanesePrediction: true,
    requireEnglishPrediction: false,
    keyboardLanguage: .ja_JP,
    learningType: .nothing,
    memoryDirectoryURL: documents,
    sharedContainerURL: documents,
    textReplacer: .withDefaultEmojiDictionary(),
    specialCandidateProviders: KanaKanjiConverter.defaultSpecialCandidateProviders,
    metadata: .init(versionString: "Your App Version X")
)

dictionaryResourceURL は ConvertRequestOptions から廃止されました。デフォルト辞書を使う場合は KanaKanjiConverterModuleWithDefaultDictionary を、カスタム辞書を使う場合は KanaKanjiConverterModule を利用し、変換器初期化時に辞書ディレクトリを指定してください。

SwiftUtils

Swift一般に利用できるユーティリティのモジュールです。