Flutter翻译服务插件deepl_dart的使用

deepl_dart 是一个用于与 DeepL API 交互的 Dart 库，允许开发者在他们的 Flutter 和 Dart 应用中集成高质量的机器翻译功能。以下是关于如何使用 deepl_dart 插件的详细介绍。

获取认证密钥

要使用 deepl_dart 包，您需要一个 API 认证密钥。请访问 DeepL Pro 创建账户并获取您的 API 密钥。您可以每月免费翻译最多 500,000 个字符。

安装

在您的 pubspec.yaml 文件的 dependencies 部分添加以下内容：

dependencies:
  deepl_dart: ^<latest_version>

确保将 <latest_version> 替换为最新版本号。可以通过访问 Pub.dev 获取最新版本信息。

使用方法

构造 Translator 对象

首先，导入 deepl_dart 包并创建一个 Translator 对象。构造函数需要一个包含您的 API 认证密钥的字符串。

import 'package:deepl_dart/deepl_dart.dart';

void main() async {
  // 构造 Translator 对象
  Translator translator = Translator(authKey: '<your_auth_key>');
}

翻译文本

单个文本翻译

TextResult result = await translator.translateTextSingular('Hello World', 'de');
print(result);

多个文本翻译

List<TextResult> results = await translator.translateTextList(
    ['Hello World', 'Hola Mundo'], 'de');
print(results);

指定源语言

TextResult result = await translator.translateTextSingular(
    'Hello World', 'de', sourceLang: 'en');
print(result);

获取支持的语言

List<Language> sourceLangs = await translator.getSourceLanguages();
List<Language> targetLangs = await translator.getTargetLanguages();
print(sourceLangs);
print(targetLangs);

使用选项进行翻译

TextResult resultWithOptions = await translator.translateTextSingular(
  'Hello World',
  'de',
  options: TranslateTextOptions(
    splitSentences: "0",
    preserveFormatting: true,
    formality: "more",
    glossaryId: "123",
    tagHandling: "xml",
    outlineDetection: true,
    nonSplittingTags: "tag1,tag2",
    splittingTags: "tag3,tag4",
    ignoreTags: "tag5,tag6",
    context: "This is my context.",
  ),
);
print(resultWithOptions);

翻译文档

支持的文件类型包括 .docx, .pptx, .pdf, .txt。可以指定目标语言和源语言（可选）。

DocumentStatus status = await translator.translateDocument(
    File('<input_file_path>'), File('<output_file_path>'), 'de');
print(status);

管理词汇表

创建词汇表

GlossaryInfo glossaryInfo = await translator.createGlossary(
  name: 'my glossary',
  sourceLang: 'en',
  targetLang: 'de',
  entries: GlossaryEntries(entries: {
    'hello': 'hi',
    'world': 'erde',
  }),
);
print(glossaryInfo);

使用 CSV 文件创建词汇表

GlossaryInfo csvGlossaryInfo = await translator.createGlossaryWithCsvFile(
  name: 'my glossary',
  sourceLang: 'en',
  targetLang: 'de',
  csvFile: File('<csv_file_path>'),
);
print(csvGlossaryInfo);

列出所有词汇表

List<GlossaryInfo> glossaryList = await translator.listGlossaries();
print(glossaryList);

获取特定词汇表信息

GlossaryInfo glossaryInfo = await translator.getGlossary(glossaryInfo.glossaryId);
print(glossaryInfo);

获取词汇表条目

GlossaryEntries glossaryEntries =
    await translator.getGlossaryEntries(glossaryId: glossaryInfo.glossaryId);
print(glossaryEntries);

删除词汇表

await translator.deleteGlossary(glossaryId: glossaryInfo.glossaryId);

查询使用情况

Usage usage = await translator.getUsage();
print(usage);

示例代码

下面是一个完整的示例代码，展示了如何使用 deepl_dart 进行各种操作：

import 'dart:io';
import 'package:deepl_dart/deepl_dart.dart';

void main() async {
  // 构造 Translator 对象
  Translator translator = Translator(authKey: '<your_auth_key>');

  // 获取可用语言
  List<Language> sourceLangs = await translator.getSourceLanguages();
  print(sourceLangs);
  List<Language> targetLangs = await translator.getTargetLanguages();
  print(targetLangs);

  // 翻译单个文本
  TextResult result = await translator.translateTextSingular('Hello World', 'de');
  print(result);

  // 翻译多个文本
  List<TextResult> results = await translator.translateTextList(
      ['Hello World', 'Hola Mundo'], 'de');
  print(results);

  // 翻译文档
  DocumentStatus status = await translator.translateDocument(
      File('<input_file_path>'), File('<output_file_path>'), 'de');
  print(status);

  // 获取支持的词汇表语言对
  List<GlossaryLanguagePair> langPairs = await translator.getGlossaryLanguagePairs();
  print(langPairs);

  // 创建词汇表
  GlossaryInfo glossaryInfo = await translator.createGlossary(
    name: 'my glossary',
    sourceLang: 'en',
    targetLang: 'de',
    entries: GlossaryEntries(entries: {
      'hello': 'hi',
      'world': 'erde',
    }),
  );
  print(glossaryInfo);

  // 列出所有词汇表
  List<GlossaryInfo> glossaryList = await translator.listGlossaries();
  print(glossaryList);

  // 获取特定词汇表信息
  glossaryInfo = await translator.getGlossary(glossaryInfo.glossaryId);
  print(glossaryInfo);

  // 获取词汇表条目
  GlossaryEntries glossaryEntries =
      await translator.getGlossaryEntries(glossaryId: glossaryInfo.glossaryId);
  print(glossaryEntries);

  // 删除词汇表
  await translator.deleteGlossary(glossaryId: glossaryInfo.glossaryId);

  // 查询使用情况
  Usage usage = await translator.getUsage();
  print(usage);
}

以上就是 deepl_dart 插件的使用指南，希望对您有所帮助！如果您有任何问题或需要进一步的帮助，请随时联系社区或查阅官方文档。