Flutter自然语言生成插件 google_generative_language_api 的使用

Generative Language API (PaLM)

这是一个Dart包，提供了对Generative Language API的便捷访问。它允许你与API交互，生成消息、生成文本、嵌入文本、检索模型、列出可用模型以及计算消息令牌数。

该包是一个第三方包装器，围绕REST API构建，不是官方的Google包。尽管如此，我已尽力使该包尽可能易于使用，并将模型和文档适配为Dart。如果你遇到任何差异、问题或有建议，请在GitHub上提交问题。

PaLM API允许开发者使用PaLM模型构建生成式AI应用程序。大型语言模型（LLMs）是一种强大的、多用途的机器学习模型，能够通过一系列提示使计算机理解并生成自然语言。

PaLM API基于Google的新一代LLM，PaLM。它在多种任务中表现出色，如代码生成、推理和写作。你可以使用PaLM API构建用于内容生成、对话代理、摘要和分类系统的生成式AI应用程序。

更多信息请参阅 Generative Language API 文档。

特性

• 使用指定的模型生成消息。
• 使用指定的模型生成文本。
• 使用指定的模型嵌入文本。
• 检索特定模型的详细信息。
• 列出可用模型，支持分页。
• 计算消息中的令牌数。

入门

在使用此包之前，你需要获取Generative Language API的API密钥。请按照以下步骤操作：

1. 前往 MakerSuite
2. 点击“创建API密钥”
3. 根据需要选择“在新项目中创建API密钥”或“在现有项目中创建API密钥”。
4. 复制生成的API密钥并保存到安全的地方。
   • 请勿与任何人共享你的API密钥，也请勿将其提交到公共仓库。
   • 使用API密钥时请注意安全，并遵循最佳实践。

获取API密钥后，可以通过在 pubspec.yaml 文件中添加包来安装它：

dependencies:
  google_generative_language_api: ^latest

然后在终端中运行 flutter pub get。

使用方法

在Dart文件中导入包：

import 'package:google_generative_language_api/google_generative_language_api.dart';

你可以使用包提供的各种方法，例如：

获取模型详细信息

void main() async {
  final Model model = await GenerativeLanguageAPI.getModel(
    modelName: 'models/chat-bison-001',
    apiKey: 'PALM_API_KEY',
  );

  print('Model Name: ${model.name}');
  print('Description: ${model.description}');
  // 打印其他相关的模型详细信息
}

列出所有可用模型

void main() async {
  final ListModelResponse response =
      await GenerativeLanguageAPI.listModels(apiKey: 'PALM_API_KEY');

  print('Models:');
  for (final Model model in response.models) {
    print('Name: ${model.name}');
    print('Description: ${model.description}');
    // 打印其他相关的模型详细信息
  }

  if (response.nextPageToken != null) {
    print('Next Page Token: ${response.nextPageToken}');
  }
}

生成消息

void main() async {
  const request = GenerateMessageRequest(
    prompt: MessagePrompt(
      messages: [
        Message(author: '1', content: 'hi'),
      ],
    ),
  );

  final GeneratedMessage generatedMessage =
  await GenerativeLanguageAPI.generateMessage(
    modelName: 'models/chat-bison-001',
    request: request,
    apiKey: 'PALM_API_KEY',
  );

  print(generatedMessage.messages.map((message) => message.content).join('\n'));
  print(generatedMessage.candidates.map((message) => message.content).join('\n'));
}

生成文本

void main() async {
  const request = GenerateTextRequest(
    prompt: TextPrompt(text: 'Write a story about a magic backpack.'),
    temperature: 1.0,
    candidateCount: 2,
  );

  final GeneratedText text = await GenerativeLanguageAPI.generateText(
    modelName: 'models/text-bison-001',
    request: request,
    apiKey: 'PALM_API_KEY',
  );

  print(text.candidates.map((candidate) => candidate.output).join('\n'));
}

嵌入文本

void main() async {
  const request = EmbedTextRequest(text: 'say something nice!');

  final EmbeddedText embed = await GenerativeLanguageAPI.embedText(
    modelName: 'models/embedding-gecko-001',
    request: request,
    apiKey: 'PALM_API_KEY',
  );

  print(embed.embedding.values.join('\n'));
}

计算消息中的令牌数

void main() async {
  final int tokenCount = await GenerativeLanguageAPI.countMessageTokens(
    modelName: 'models/chat-bison-001',
    request: CountMessageTokensRequest(prompt: MessagePrompt(messages: [Message(author: '1', content: 'hi')])),
    apiKey: 'PALM_API_KEY',
  );

  print('Token Count: $tokenCount');
}

额外信息

更多详细信息，请参阅 [Generative Language API 文档]。此包仅是REST API的第三方包装器。

如果遇到任何问题或有建议，请在GitHub上提交问题。

社交媒体

• 网站
• Twitter
• Discord

示例代码

以下是一个完整的示例代码，展示了如何使用 google_generative_language_api 包：

import 'dart:convert';

import 'package:dotenv/dotenv.dart';
import 'package:google_generative_language_api/google_generative_language_api.dart';

/// API密钥存储在本地的 .env 文件中。如果你想运行此示例，请创建一个 .env 文件或替换此apiKey为你自己的。
///
/// 请勿公开分享你的API密钥。
/// .env 文件应包含如下行：
///
/// API_KEY=<PALM_API_KEY>
late final String apiKey;

void main() async {
  final DotEnv env = DotEnv(includePlatformEnvironment: true)..load();
  apiKey = env['API_KEY']!;

  const String chatModel = 'models/chat-bison-001';
  const String textModel = 'models/text-bison-001';
  const String embedModel = 'models/embedding-gecko-001';

  // 获取模型详细信息。
  final Model model = await GenerativeLanguageAPI.getModel(
    modelName: chatModel,
    apiKey: apiKey,
  );

  print('Model Name: ${model.name}');
  print('Description: ${model.description}');
  // 打印其他相关的模型详细信息

  // 列出API密钥可用的所有模型。
  final ListModelResponse listModelResponse =
      await GenerativeLanguageAPI.listModels(
    pageSize: 50,
    pageToken: null,
    apiKey: apiKey,
  );

  print('Models:');
  for (final Model model in listModelResponse.models) {
    print('Name: ${model.name}');
    print('Description: ${model.description}');
    // 打印其他相关的模型详细信息
  }

  if (listModelResponse.nextPageToken != null) {
    print('Next Page Token: ${listModelResponse.nextPageToken}');
  }

  // 生成消息。
  const messagePrompt = MessagePrompt(
    messages: [
      Message(author: '1', content: 'hi'),
    ],
  );
  const messageRequest = GenerateMessageRequest(
    prompt: messagePrompt,
  );

  final GeneratedMessage messageResponse =
      await GenerativeLanguageAPI.generateMessage(
    modelName: chatModel,
    request: messageRequest,
    apiKey: apiKey,
  );

  print(const JsonEncoder.withIndent('  ').convert(messageResponse));

  // 计算消息中的令牌数。
  final int tokenCount = await GenerativeLanguageAPI.countMessageTokens(
    modelName: chatModel,
    request: const CountMessageTokensRequest(prompt: messagePrompt),
    apiKey: apiKey,
  );

  print('Token Count: $tokenCount');

  // 生成文本。
  const textRequest = GenerateTextRequest(
    prompt: TextPrompt(text: 'Write a story about a magic backpack.'),
    temperature: 1.0,
    candidateCount: 2,
  );

  final response = await GenerativeLanguageAPI.generateText(
    modelName: textModel,
    request: textRequest,
    apiKey: apiKey,
  );

  print(const JsonEncoder.withIndent('  ').convert(response));

  // 嵌入文本。
  const embedRequest = EmbedTextRequest(text: 'say something nice!');

  final embedResponse = await GenerativeLanguageAPI.embedText(
    modelName: embedModel,
    request: embedRequest,
    apiKey: apiKey,
  );

  print(const JsonEncoder.withIndent('  ').convert(embedResponse));
}

希望这些信息对你有所帮助！如果有任何问题或建议，请随时联系我。