“依托 Google 搜索进行接地”功能现已推出！了解详情

此页面由 Cloud Translation API 翻译。

教程：Gemini API 使用入门

本教程演示了如何访问适用于 Dart 或使用 Google AI Dart SDK 的 Flutter 应用。如果您不想直接使用 REST API 访问 Gemini 模型，应用。

在本教程中，您将了解如何执行以下操作：

设置您的项目，包括您的 API 密钥
根据纯文本输入生成文本
根据文本和图片输入生成文本（多模态）
建立多轮对话（聊天）
使用流式传输加快互动速度

此外，本教程还包含一些有关高级用例（如 embeddings 和计算词元）以及控制内容生成。

前提条件

本教程假定您熟悉使用 Dart 构建应用。

要完成本教程，请确保您的开发环境符合以下要求：

Dart 3.2.0 及更高版本

设置项目

在调用 Gemini API 之前，您需要设置项目，包括设置 API 密钥，将 SDK 添加到发布商依赖项初始化模型。

设置您的 API 密钥

如需使用 Gemini API，您需要 API 密钥。如果您还没有账号，在 Google AI Studio 中创建密钥。

获取 API 密钥

保护您的 API 密钥

确保 API 密钥的安全。我们强烈建议您不要添加直接在代码中放置 API 密钥，或检查包含该密钥的文件的版本控制系统相反，您应该为 API 密钥使用 Secret 存储区。

本教程中的所有代码段均假定您以进程环境变量。如果你正在开发一款 Flutter 应用 String.fromEnvironment，并将 --dart-define=API_KEY=$API_KEY 传递给 flutter build 或 flutter run，以使用 API 密钥进行编译，因为不同的环境。

安装 SDK 软件包

如需在您自己的应用中使用 Gemini API，您需要add google_generative_ai 软件包添加到您的 Dart 或 Flutter 应用：

Dart

dart pub add google_generative_ai

Flutter

flutter pub add google_generative_ai

初始化生成模型

在进行任何 API 调用之前，您需要先导入并初始化生成模型。

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

void main() async {

  // Access your API key as an environment variable (see "Set up your API key" above)
  final apiKey = Platform.environment['API_KEY'];
  if (apiKey == null) {
    print('No \$API_KEY environment variable');
    exit(1);
  }

  // The Gemini 1.5 models are versatile and work with most use cases
  final model = GenerativeModel(model: 'gemini-1.5-flash', apiKey: apiKey);
}

指定模型时，请注意以下事项：

请使用您的用例专用的模型（例如 gemini-1.5-flash 适用于多模态输入）。在本指南中，实现列出了每个用例的推荐模型。

注意：如需详细了解可用模型，包括功能和速率限制，请参阅 Gemini 模型。我们提供请求提高速率限制的选项默认还不够。

实现常见使用场景

现在您的项目已设置完毕，您可以探索如何使用 Gemini API 来实现不同的应用场景：

根据纯文本输入生成文本
根据文本和图片输入生成文本（多模态）
建立多轮对话（聊天）
使用流式传输加快互动速度

在“高级用例”部分，您可以找到有关 Gemini API 的信息和嵌入。

根据纯文本输入生成文本

如果输入的提示仅包含文本，请使用 Gemini 1.5 模型或使用 generateContent 生成文本输出的 Gemini 1.0 Pro 模型：

import 'dart:io';

import 'package:google_generative_ai/google_generative_ai.dart';

void main() async {
  // Access your API key as an environment variable (see "Set up your API key" above)
  final apiKey = Platform.environment['API_KEY'];
  if (apiKey == null) {
    print('No \$API_KEY environment variable');
    exit(1);
  }
  // The Gemini 1.5 models are versatile and work with both text-only and multimodal prompts
  final model = GenerativeModel(model: 'gemini-1.5-flash', apiKey: apiKey);
  final content = [Content.text('Write a story about a magic backpack.')];
  final response = await model.generateContent(content);
  print(response.text);
}

根据文本和图片输入生成文本（多模态）

Gemini 提供各种可处理多模态输入的模型（Gemini 1.5 模型），这样你就可以同时输入和图片。请务必查看提示的图片要求。

如果输入的提示同时包含文本和图片，请使用 Gemini 1.5 模型使用 generateContent 方法生成文本输出：

import 'dart:io';

import 'package:google_generative_ai/google_generative_ai.dart';

void main() async {
  // Access your API key as an environment variable (see "Set up your API key" above)
  final apiKey = Platform.environment['API_KEY'];
  if (apiKey == null) {
    print('No \$API_KEY environment variable');
    exit(1);
  }
  // The Gemini 1.5 models are versatile and work with both text-only and multimodal prompts
  final model = GenerativeModel(model: 'gemini-1.5-flash', apiKey: apiKey);
  final (firstImage, secondImage) = await (
    File('image0.jpg').readAsBytes(),
    File('image1.jpg').readAsBytes()
  ).wait;
  final prompt = TextPart("What's different between these pictures?");
  final imageParts = [
    DataPart('image/jpeg', firstImage),
    DataPart('image/jpeg', secondImage),
  ];
  final response = await model.generateContent([
    Content.multi([prompt, ...imageParts])
  ]);
  print(response.text);
}

建立多轮对话（聊天）

借助 Gemini，您可以跨多个回合构建自由形式的对话。通过 SDK 通过管理对话状态来简化流程，使用 generateContent，则无需存储对话记录。

如需构建多轮对话（如聊天），请使用 Gemini 1.5 模型或 Gemini 1.0 Pro 模型，并通过调用 startChat() 来初始化对话。然后，使用 sendMessage() 发送一条新的用户消息，此消息还将附加消息和对聊天记录的响应。

与内容关联的 role 有两种可能的选项对话：

user：提供提示的角色。该值是 sendMessage 调用，如果没有不同的值，该函数将抛出异常角色。
model：提供响应的角色。此角色可以在以下情况下使用：使用现有的 history 调用 startChat()。

。

import 'dart:io';

import 'package:google_generative_ai/google_generative_ai.dart';

Future<void> main() async {
  // Access your API key as an environment variable (see "Set up your API key" above)
  final apiKey = Platform.environment['API_KEY'];
  if (apiKey == null) {
    print('No \$API_KEY environment variable');
    exit(1);
  }
  // The Gemini 1.5 models are versatile and work with multi-turn conversations (like chat)
  final model = GenerativeModel(
      model: 'gemini-1.5-flash',
      apiKey: apiKey,
      generationConfig: GenerationConfig(maxOutputTokens: 100));
  // Initialize the chat
  final chat = model.startChat(history: [
    Content.text('Hello, I have 2 dogs in my house.'),
    Content.model([TextPart('Great to meet you. What would you like to know?')])
  ]);
  var content = Content.text('How many paws are in my house?');
  var response = await chat.sendMessage(content);
  print(response.text);
}

使用流式传输加快互动速度

默认情况下，模型会在完成整个生成过程后返回响应过程。您无需等待整个会话，即可实现更快速的互动结果，而改用流式传输来处理部分结果。

以下示例展示了如何使用 generateContentStream 方法，用于根据文本和图片输入生成文本提示。

// ...

final response = model.generateContentStream([
  Content.multi([prompt, ...imageParts])
]);
await for (final chunk in response) {
  print(chunk.text);
}

// ...

对于纯文本输入和聊天用例，您可以使用类似的方法。

// Use streaming with text-only input
final response = model.generateContentStream(content);

// Use streaming with multi-turn conversations (like chat)
final response = chat.sendMessageStream(content);

实现高级用例

本教程上一部分中介绍的常见用例有助于能够熟练使用 Gemini API。本部分介绍了一些可能被视为更高级的用例。

调用函数

函数调用可让您更轻松地从 Google Cloud 控制台获取结构化数据输出生成模型。然后，您可以使用这些输出来调用其他 API 并返回将相关的响应数据提供给模型。换句话说，函数调用有助于将生成模型连接到外部系统，可提供最新、最准确的信息。如需了解详情，请参阅函数调用教程。

使用嵌入

嵌入是一种用于表示信息的技术数组中的浮点数列表。借助 Gemini，你可以以矢量化形式处理文本（字词、句子和文本块），更容易比较和对比嵌入。例如，相似的主题或情感都应具有相似的嵌入，通过余弦相似度等数学比较技术确定的类别。

结合使用 embedding-001 模型和 embedContent 方法（或 batchEmbedContent 方法）以生成嵌入。以下示例为单个字符串生成嵌入：

final model = GenerativeModel(model: 'embedding-001', apiKey: apiKey);
final content = Content.text('The quick brown fox jumps over the lazy dog.');
final result = await model.embedContent(content);
print(result.embedding.values);

计算词元数量

在使用长提示时，在发送任何词元之前计算词元数量可能会有帮助传递给模型。以下示例展示了如何使用 countTokens() 例如：

// For text-only input
final tokenCount = await model.countTokens(Content.text(prompt));
print('Token count: ${tokenCount.totalTokens}');

// For text-and-image input (multimodal)
final tokenCount = await model.countTokens([
  Content.multi([prompt, ...imageParts])
]);
print('Token count: ${tokenCount.totalTokens}');

// For multi-turn conversations (like chat)
final prompt = Content.text(message);
final allContent = [...chat.history, prompt];
final tokenCount = await model.countTokens(allContent);
print('Token count: ${tokenCount.totalTokens}');

用于控制内容生成的选项

您可以通过配置模型参数和使用安全设置。

请注意，将 generationConfig 或 safetySettings 传递给模型请求方法（例如 generateContent）将完全替换配置对象在 getGenerativeModel 中传递的相同名称。

配置模型参数

您发送到模型的每个提示都包含参数值，用于控制模型生成回答。对于不同的参数值，模型会生成不同的结果。详细了解模型参数。此配置在模型实例的生命周期内保持不变。

final generationConfig = GenerationConfig(
  stopSequences: ["red"],
  maxOutputTokens: 200,
  temperature: 0.9,
  topP: 0.1,
  topK: 16,
);
final model = GenerativeModel(
  // The Gemini 1.5 models are versatile and work with most use cases
  model: 'gemini-1.5-flash',
  apiKey: apiKey,
  generationConfig: generationConfig,
);

使用安全设置

你可以使用安全设置来调整收到符合以下要求的回答的可能性可能会被视为有害的内容。默认情况下，安全设置会屏蔽带有“中等”标记的内容和/或在所有维度上都属于不安全的内容的高概率。了解详细了解安全设置。

设置一项安全设置的方法如下：

final safetySettings = [
  SafetySetting(HarmCategory.harassment, HarmBlockThreshold.high)
];
final model = GenerativeModel(
  // The Gemini 1.5 models are versatile and work with most use cases
  model: 'gemini-1.5-flash',
  apiKey: apiKey,
  safetySettings: safetySettings,
);

您还可以设定多项安全设置：

final safetySettings = [
  SafetySetting(HarmCategory.harassment, HarmBlockThreshold.high),
  SafetySetting(HarmCategory.hateSpeech, HarmBlockThreshold.high),
];

后续步骤

提示设计是创建提示以从语言模型引出所需回复的过程。撰写结构合理的提示是是确保语言模型做出准确、高质量响应的一部分。了解提示撰写的最佳做法。
Gemini 提供多种模型变体，以满足不同使用情形的需求例如输入类型和复杂性、聊天或其他对话框语言任务和大小限制。不妨了解可用的 Gemini 模型。

。