Flutter插件ghana_npl_dart的使用方法介绍

本文将详细介绍如何在Flutter项目中使用ghana_npl_dart插件，该插件提供了对GhanaNLP API的支持，包括自动语音识别（ASR）和文本转语音（TTS）功能。通过这些功能，您可以轻松地在多种加纳语和非洲语言之间进行音频处理。

GhanaNLP Dart Package

此Dart包提供了一个用于GhanaNLP API的客户端，支持自动语音识别（ASR）和文本转语音（TTS）。它允许您轻松地转录音频并合成各种加纳语和非洲语言的语音。要获取API密钥，请访问 https://ghananlp.org。

支持的语言

• Twi (tw)
• Ga (gaa)
• Dagbani (dag)
• Ewe (ee)
• Kikuyu (ki)

插件ghana_npl_dart的安装

首先，在您的项目中添加以下依赖项到pubspec.yaml文件：

dependencies:
  ghana_nlp_dart:
    git:
      url: https://github.com/iamEtornam/GhanaNLP-Dart.git
      ref: main

然后运行以下命令以安装依赖项：

dart pub get

插件ghana_npl_dart的使用

以下是使用ghana_npl_dart包的基本示例。

自动语音识别（ASR）

以下代码演示了如何使用GhanaNLP的ASR API来转录音频文件：

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

void main() async {
  final apiKey = 'your_api_key_here'; // 替换为您的API密钥
  final ghanaNlpAsr = GhanaNlpAsr(apiKey: apiKey);

  // 读取音频文件
  final file = File('path_to_your_audio_file.mp3'); // 替换为您的音频文件路径
  final audioBytes = await file.readAsBytes();

  try {
    final transcription = await ghanaNlpAsr.transcribe(audioBytes, Language.twi.code); // 使用Twi语言
    print('Transcription: $transcription');
  } catch (e) {
    print('Error: $e');
  }
}

文本转语音（TTS）

以下代码演示了如何使用GhanaNLP的TTS API从文本生成语音：

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

void main() async {
  final apiKey = 'your_api_key_here'; // 替换为您的API密钥
  final ghanaNlpTts = GhanaNlpTts(apiKey: apiKey);

  try {
    final audioBytes = await ghanaNlpTts.synthesize('Ɛte sɛn?', Language.twi.code); // 合成Twi语言的语音
    await File('output.mp3').writeAsBytes(audioBytes); // 将生成的音频保存到文件
    print('Audio saved to output.mp3');
  } catch (e) {
    print('Error: $e');
  }
}

翻译功能

以下代码演示了如何使用GhanaNLP的翻译API进行文本翻译：

import 'package:ghana_nlp_dart/ghana_nlp_dart.dart';

void main() async {
  final api = GhanaNLPTranslation(apiKey: 'your_api_key_here'); // 替换为您的API密钥

  // 翻译文本
  try {
    final translatedText = await api.translate(
      text: 'Hello, how are you?', // 要翻译的文本
      languagePair: 'en-tw', // 从英语翻译到Twi
    );
    print('Translated text: $translatedText');
  } catch (e) {
    print('Translation error: $e');
  }

  // 获取支持的语言
  try {
    final languages = await api.getLanguages();
    print('Supported languages: $languages');
  } catch (e) {
    print('Error fetching languages: $e');
  }
}

API参考

GhanaNlpAsr

用于与GhanaNLP ASR API交互的类。

构造函数

GhanaNlpAsr({required String apiKey, http.Client? client})

方法

Future<String> transcribe(Uint8List audioData, String language)

GhanaNlpTts

用于与GhanaNLP TTS API交互的类。

构造函数

GhanaNlpTts({required String apiKey, http.Client? client})

方法

Future<List<int>> synthesize(String text, String language)

参数说明：

• text: 要转换为语音的文本。
• language: 语言代码（例如，tw表示Twi）。

返回值：

• 返回一个包含音频数据字节的Future<List<int>>。

GhanaNLPTranslation

用于与GhanaNLP翻译REST API交互的类。

构造函数

GhanaNLPTranslation({required String apiKey, http.Client? client})

方法

Future<String> translate({required String text, required String languagePair})

参数说明：

• text: 要翻译的文本。
• languagePair: 语言对（例如，en-tw表示从英语翻译到Twi）。

返回值：

• 返回一个包含翻译结果的Future<String>。

Language

表示支持语言的枚举。

enum Language {
  twi('tw'),
  yoruba('yo'),
  ga('gaa'),
  dagbani('dag'),
  ewe('ee'),
  kikuyu('ki')
}

使用方法：

Language.fromCode(String code)

错误处理

该包会在以下情况下抛出异常：

• ArgumentError: 如果提供了无效的语言代码。
• Exception: 如果API调用失败或API返回非200状态码。

建议在API调用时使用try-catch块来捕获和处理这些异常。

认证

此包使用API密钥认证。初始化GhanaNlpAsr或GhanaNlpTts类时需要提供API密钥。API密钥会作为Ocp-Apim-Subscription-Key头发送到每个请求中。

贡献

欢迎贡献！如果您有改进或新增功能的建议，请提交Pull Request。

许可证

该项目受Apache许可证保护，详见许可证文件。

示例代码

以下是一个完整的示例代码，展示了如何结合ASR、TTS和翻译功能：

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

final apiKey = 'your_api_key_here';

void main() async {
  ghanaNLPAsr();
  ghanaNLPTextToSpeech();
  ghanaNLPTranslation();
}

/// 示例：使用GhanaNLP ASR API转录音频文件。
void ghanaNLPAsr() async {
  final ghanaNlpAsr = GhanaNlpAsr(apiKey: apiKey);

  final file = File('path_to_your_audio_file.mp3');
  final audioBytes = await file.readAsBytes();

  try {
    final transcription = await ghanaNlpAsr.transcribe(audioBytes, Language.twi.code);
    print('Transcription: $transcription');
  } catch (e) {
    print('Error: $e');
  }
}

/// 示例：使用GhanaNLP TTS API从文本生成语音。
void ghanaNLPTextToSpeech() async {
  final ghanaNlpTts = GhanaNlpTts(apiKey: apiKey);

  try {
    final audioBytes = await ghanaNlpTts.synthesize('Ɛte sɛn?', Language.twi.code);
    await File('output.mp3').writeAsBytes(audioBytes);
    print('Audio saved to output.mp3');
  } catch (e) {
    print('Error: $e');
  }
}

/// 示例：使用GhanaNLP Translation API翻译文本和获取支持的语言。
void ghanaNLPTranslation() async {
  final api = GhanaNLPTranslation(apiKey: apiKey);

  try {
    final translatedText = await api.translate(
      text: 'Hello, how are you?',
      languagePair: 'en-tw',
    );
    print('Translated text: $translatedText');
  } catch (e) {
    print('Translation error: $e');
  }

  try {
    final languages = await api.getLanguages();
    print('Supported languages: $languages');
  } catch (e) {
    print('Error fetching languages: $e');
  }
}