Developing Genkit Dart
GoogleOfficialPublished by Google
- Skill
- Tool integration
- Software development
- Apache-2.0
- Low risk
AutoGineer summary
Written by AutoGineer from the skill’s own files, not by the author
The Genkit Dart skill provides comprehensive guidance for utilizing the Genkit SDK to develop AI-powered applications. It covers the core framework, including defining flows and agents, managing sessions, handling persistence, and implementing generative UI (A2UI). The skill emphasizes the use of the Genkit CLI for local development, tracing, and debugging, while providing patterns for integrating various LLM plugins and managing type-safe schemas via the schemantic library.
What it does
- Generates code and documentation for building AI agents and flows in Dart.
- Provides patterns for integrating LLMs into Dart and Flutter applications.
- Explains the use of the Genkit CLI for tracing, debugging, and running flows.
- Details the implementation of persistent sessions, human-in-the-loop interrupts, and multi-agent orchestration.
- Supports A2UI for streaming interactive UI surfaces to Flutter clients.
- Guides the use of type-safe schemas with the schemantic library for tool and flow inputs.
When to use it
- When building AI agents, chatbots, or assistants in Dart or Flutter.
- When you need to integrate LLMs into a Dart backend or Flutter frontend.
- When you need to debug model inputs, outputs, and tool calls using traces.
- When implementing conversational workflows that require persistent state or human-in-the-loop approval.
- When you want to stream interactive UI components from an agent to a Flutter app.
Advantages
- Provides a unified interface for code generation, structured outputs, and agentic workflows.
- Enables deep visibility into AI execution via the Genkit CLI and trace inspection.
- Supports complex agentic behaviors like branching, background execution, and multi-agent delegation.
- Facilitates type-safe development through integration with the schemantic library.
- Offers a consistent developer experience across different LLM providers via a plugin ecosystem.
Usage examples
- “How do I define a simple agent in Genkit Dart?”
- The agent will provide a code snippet using ai.defineAgent, including system instructions, tools, and session storage configuration.
- “How can I debug my Genkit flow locally?”
- The agent will explain how to use 'genkit start -- dart run main.dart' to capture traces and inspect them via the Developer UI at localhost:4000.
- “How do I use A2UI to stream a card to my Flutter app?”
- The agent will guide you to register the A2uiPlugin, add the a2ui() middleware to your agent, and use the genui package on the Flutter client.
- “How do I define a tool with a typed input schema?”
- The agent will show how to use the @Schema() annotation and schemantic library to define a type-safe input class for your tool.
Install
Download the skill as a ZIP:
https://autogineer.com/agent-skills/google/developing-genkit-dart/downloadUnzip it into the cross-client skills folder of your project:
mkdir -p .agents/skills && unzip developing-genkit-dart.zip -d .agents/skills
Documentation by Google
Genkit Dart
Genkit Dart is an AI SDK for Dart that provides a unified interface for code generation, structured outputs, tools, flows, and AI agents.
Core Features and Usage
If you need help with initializing Genkit (Genkit()), Generation (ai.generate), Tooling (ai.defineTool), Flows (ai.defineFlow), Embeddings (ai.embed), streaming, or calling remote flow endpoints, please load the core framework reference:
references/genkit.md
1.0 vs pre-1.0 APIs
This skill targets Genkit Dart 1.0 (genkit: ^1.0.0). Older code and
training data use pre-1.0 names that no longer compile; the common ones:
HTTP:
startFlowServer/ per-routeshelfHandler/shelf_cors_headersare nowGenkitRouter+serve()orasShelfHandler(), withCorsOptions; context providers takeRequestData(genkit_shelf.md).StatusCodes.UNAUTHENTICATEDisStatusCode.unauthenticated(lowerCamelCase, same forEvalStatus.pass,ToolChoice.required).No
RetryPlugin;retry()is built in and takesDurations (initialDelay,maxDelay, alsocacheTtlelsewhere).Renames:
GenerateResponseHelper->GenerateResult(modelResponse,chunk.modelChunk),ExecutablePrompt->Prompt<Input, Output>,embedMany->embed,ToolFnArgs->ToolFnArg,toolOutputSchema->outputSchema,underlyingException->cause,modelInfo:->info:,RemoteAction.dispose()->close(),prompt(input, PromptGenerateOptions(config: ...))->prompt(input, config: ...)(named options, likegenerate),defineMiddleware->ai.defineGenerateMiddleware(app) /generateMiddleware(plugins).Provider config types are prefixed:
GeminiThinkingConfig,GeminiSafetySettings,GeminiGoogleSearch,GeminiSpeechConfig,GoogleGenAiEmbedderOptions,AnthropicThinkingConfig.Removed:
ToolInterruptException/ctx.interrupt()(return.interrupt(...)),GoogleAiModels/OpenAIModelsconstants (usegoogleAI.gemini('...'),openAI.model('...')). Simulated constrained output is opt-in viasimulateConstrainedGeneration()..promptPicoschema is spec-compliant:name: type, description, nevername(description): type(dotprompt.md).
Prompts (Dotprompt)
.prompt files keep prompt content out of Dart code with YAML frontmatter plus a
Handlebars template. See references/dotprompt.md:
promptDir, ai.prompt() (call/stream/render), variants, partials, named
schemas via defineSchema, and the tools/maxTurns/returnToolRequests/use
(middleware) frontmatter fields. A .prompt file can also back an agent directly
via definePromptAgent.
Agents
Genkit Dart has an agent API for persistent, multi-turn conversations
(sessions, snapshots, interrupts, branching, background execution, custom state,
artifacts, and multi-agent delegation). The agent/session/snapshot APIs are
experimental and live behind opt-in imports: server APIs come from
package:genkit/experimental.dart (alongside package:genkit/genkit.dart), the
browser/HTTP client from package:genkit/experimental_client.dart (alongside
package:genkit/client.dart), and dart:io extras like FileSessionStore from
package:genkit/experimental_io.dart. These entry points are @experimental, so
importing them raises an experimental_member_use analyzer warning you can
silence in analysis_options.yaml. The remoteAgent client works from any Dart
app, including Flutter, and the backend is fully interchangeable — it can talk
to a Genkit agent implemented in Dart, JS/TypeScript, or Go over the same HTTP
protocol. A few Dart specifics: interrupts are ai.defineInterrupt(...) or
tools that return .interrupt(...) (there is no ctx.interrupt()), sub-agent delegation uses
the agents() middleware from package:genkit_middleware, and there is no
artifacts() middleware yet (define artifact tools directly).
For more details see:
Agents: defining/serving an agent and client-managed state (start here).
Sessions & persistence: session stores (
InMemorySessionStore/FileSessionStore/FirestoreSessionStore).Human-in-the-loop / interrupts: pausing for approval/input via
.interrupt(...)and resuming.Branching: forking a conversation from a snapshot.
Background agents: detaching long-running turns and polling.
Working with state: typed custom session state, auto-synced to the client.
Artifacts: producing and reading named deliverables.
Multi-agent orchestration: delegating to sub-agents with the
agents()middleware.Advanced custom agents:
defineCustomAgentfor full turn control.Deploying agents: serving agents over HTTP with
GenkitRouter.addAgent(multiple agents, shelf, CORS).
Generative UI (A2UI)
Genkit Dart has an A2UI (Agent-to-UI) plugin (genkit_a2ui)
that lets an agent stream interactive UI surfaces (cards, lists, forms,
buttons), not just prose. The whole server-side integration is the a2ui() model
middleware in an agent's (or ai.generate's) use list; the Flutter client
renders surfaces with the genui package plus
the helpers in package:genkit_a2ui/client.dart. Dart specific: you must
register A2uiPlugin() in Genkit(plugins: [...]) (unlike JS, middleware is
resolved by name from the registry).
A2UI: server middleware, options, Flutter/genui client rendering, user actions/forms, custom catalogs, and the security/trust boundary.
Genkit CLI (recommended)
genkit start unintrusively wraps any Dart program that uses the Genkit library, running it unchanged while capturing traces from every Genkit action so you can prove tools were actually called and inspect model I/O from the terminal, even for headless checks. It forwards stdio, so interactive CLI tools that rely on stdin/stdout work without issues. Running the app directly (dart run) skips trace capture, so you're debugging blind. Check install with genkit --version.
Installation:
curl -sL cli.genkit.dev | bash # Native CLI
# OR
npm install -g genkit-cli # Via npm
# OR run commands directly with npx without a global install (prefix every genkit command):
# npx genkit-cli start -- dart run main.dartPrimary pattern (default): prefix genkit start -- to your normal run command. This collects telemetry from any Genkit code your program runs, whether triggered from the dev UI, your own web server/web UI, or a plain script. Starts the Developer UI (usually http://localhost:4000) for running flows, model and agent playground, and browsing traces:
genkit start -- dart run main.dart
genkit start --noui -- dart run main.dart # same, without the Dev UI (still a persistent server)genkit start runs until you stop it with Ctrl+C. That is expected and correct for the common cases: a server your web/mobile app calls, or an interactive CLI you exit yourself. --noui only drops the Dev UI; it is not a one-shot command and will not exit on its own. Do not use genkit start as a blocking step in automated/non-interactive contexts; use flow:run (below) for that.
Non-interactive use (agents/CI): add the global --non-interactive flag before -- so the CLI uses defaults and never blocks on a prompt (e.g. the first-run analytics notice): genkit start --non-interactive -- dart run main.dart (works with flow:run too).
Run a flow (flow:run): invoke a specific flow by name from the CLI. Append your run command after -- to spin up the runtime just for this run (the command runs as-is to register your flows):
genkit flow:run myFlow '{"data": "input"}' -- dart run main.dartThis is self-terminating: it runs the flow once, prints a Trace ID, then exits, so it's the right choice for a quick, non-interactive check (unlike genkit start). Note: flow:run runs flows (ai.defineFlow), not agents; you can't flow:run an agent (ai.defineAgent) directly. To exercise an agent from the CLI, wrap one turn in a throwaway flow and run that (see Agents). Traces for this run can be inspected using the trace commands below.
Gotcha: top-level final declarations are lazy. Flows and agents defined as top-level final register with Genkit only when the symbol is first evaluated. An empty main() registers nothing, so flow:run fails with Process exited before runtime was ready. Reference the flow/agent symbols from main() (or import a module that does) so their define* calls actually run.
Debugging with traces: the fastest way to see prompts, model inputs/outputs, tool calls, latencies, and errors. Inspect from the terminal after any run under genkit start:
genkit trace:list # find recent trace IDs
genkit trace:get <traceId> # full trace details (inputs, outputs, tool calls, errors)
genkit trace:get <traceId> --format json # machine-readable JSON, safe to pipe into jq or other parsersFor machine-readable output, pass --format json to get clean JSON you can pipe into jq or other parsers. The default output is human-oriented (banner/log lines, possible truncation on large traces), so don't pipe that form directly; use --format json, grep, or the Dev UI trace viewer.
Documentation:
genkit docs:search "streaming" dart
genkit docs:list dart
genkit docs:read dart/flows.mdPlugin Ecosystem
Genkit relies on a large suite of plugins to perform generative AI actions, interface with external LLMs, or host web servers.
When asked to use any given plugin, always verify usage by referring to its corresponding reference below. You should load the reference when you need to know the specific initialization arguments, tools, models, and usage patterns for the plugin:
| Plugin Name | Reference Link | Description |
|---|---|---|
genkit_google_genai | references/genkit_google_genai.md | Load for Google Gemini plugin interface usage. |
genkit_vertexai | references/genkit_vertexai.md | Load for Gemini via Vertex AI (Google Cloud auth, versioned model IDs, embeddings incl. multimodal). |
genkit_anthropic | references/genkit_anthropic.md | Load for Anthropic plugin interface for Claude models. |
genkit_openai | references/genkit_openai.md | Load for OpenAI plugin interface for GPT models, Groq, and custom compatible endpoints. |
genkit_middleware | references/genkit_middleware.md | Load for Tooling for specific agentic behavior: filesystem, skills, and toolApproval interrupts. |
genkit_mcp | references/genkit_mcp.md | Load for Model Context Protocol integration (Server, Host, and Client capabilities). |
genkit_chrome | references/genkit_chrome.md | Load for Running Gemini Nano locally inside the Chrome browser using the Prompt API. |
genkit_shelf | references/genkit_shelf.md | Load for serving flows/models/agents over HTTP: GenkitRouter (core package:genkit/io.dart, standalone dart:io) and mounting it into Shelf apps. |
genkit_firebase_ai | references/genkit_firebase_ai.md | Load for Firebase AI plugin interface (Gemini API via Vertex AI). |
genkit_a2ui | references/a2ui.md | Load for A2UI (Agent-to-UI): streaming generative UI surfaces via the a2ui() middleware, rendered on the client with genui. |
External Dependencies
Whenever you define schemas mapping inside of Tools, Flows, and Prompts, you must use the schemantic library.
To learn how to use schemantic, ensure you read references/schemantic.md for how to implement type safe generated Dart code. This is particularly relevant when you encounter symbols like @Schema(), SchemanticType, or classes with the $ prefix. Genkit Dart uses schemantic for all of its data models so it's a CRITICAL skill to understand for using Genkit Dart.
Best Practices
Agent or flow? If the task is conversational, multi-turn, or described as "an agent", "assistant", or "chatbot", build it with
ai.defineAgent(see Agents) rather than hand-rolling agenerate+ tools loop inside a flow. Reach for a plain flow only for single-shot, stateless generation.Always check that code cleanly compiles using
dart analyzebefore generating the final response.Always use the Genkit CLI for local development and debugging.
Verify with traces, not a blind run. Running the app directly (
dart run) does not capture dev traces. See the Genkit CLI section for how to run your app and capture traces.
Files
- ATTRIBUTION.mdAdded by AutoGineer862 B
- LICENSELicence file added by AutoGineer11.1 KiB
- SKILL.md13.4 KiB
- references/a2ui.md14.7 KiB
- references/agents-artifacts.md5.7 KiB
- references/agents-background.md3.8 KiB
- references/agents-branching.md3.5 KiB
- references/agents-custom.md6.7 KiB
- references/agents-deployment.md4.1 KiB
- references/agents-human-in-the-loop.md8.0 KiB
- references/agents-multi-agent.md5.6 KiB
- references/agents-sessions.md6.7 KiB
- references/agents-state.md7.1 KiB
- references/agents.md14.6 KiB
- references/dotprompt.md7.9 KiB
- references/genkit.md16.2 KiB
- references/genkit_anthropic.md1.7 KiB
- references/genkit_chrome.md543 B
- references/genkit_firebase_ai.md588 B
- references/genkit_google_genai.md3.8 KiB
- references/genkit_mcp.md4.3 KiB
- references/genkit_middleware.md4.7 KiB
- references/genkit_openai.md2.8 KiB
- references/genkit_shelf.md4.4 KiB
- references/genkit_vertexai.md2.6 KiB
- references/schemantic.md4.8 KiB
references/genkit.md
Genkit Core Framework
Genkit Dart is an AI SDK for Dart that provides a unified interface for text generation, structured output, tool calling, and agentic workflows.
Initialization
import 'package:genkit/genkit.dart';
import 'package:genkit_google_genai/genkit_google_genai.dart'; // Or any other plugin
void main() async {
// Pass plugins to use into the Genkit constructor. Built-in middleware such
// as `retry` needs no plugin.
final ai = Genkit(plugins: [googleAI()]);
}Reliability: retry transient errors
Model backends routinely return transient errors (Gemini "high demand" surfaces
as StatusCode.internal, plus unavailable / resourceExhausted under load).
In practice retry() is close to mandatory for reliable runs. It is a core
middleware, always registered (no plugin, no extra package): just add
use: [retry()] to a call. By default it retries unavailable,
deadlineExceeded, resourceExhausted, aborted, and internal, and it works
the same on generate, generateStream, prompts, and flows. The examples below
add it where it matters.
retry(
maxRetries: 5,
initialDelay: const Duration(milliseconds: 500), // Durations, not ms ints
maxDelay: const Duration(seconds: 30),
statuses: [StatusCode.unavailable, StatusCode.resourceExhausted],
// noRetryModel: true, // skip model retries (on by default)
// retryTools: true, // also retry failed tools (off by default)
)Generate Text
final response = await ai.generate(
model: googleAI.gemini('gemini-flash-latest'), // Needs a model reference from a plugin
prompt: 'Explain quantum computing in simple terms.',
use: [retry()], // recommended; stream/embed/prompts/flows take the same `use:`
);
print(response.text);Stream Responses
final stream = ai.generateStream(
model: googleAI.gemini('gemini-flash-latest'),
prompt: 'Write a short story about a robot learning to paint.',
);
await for (final chunk in stream) {
print(chunk.text);
}Embed Text
ai.embed takes either document: (one) or documents: (many) and always
returns List<Embedding>. There is no embedMany.
final embeddings = await ai.embed(
documents: [
DocumentData(content: [TextPart(text: 'Hello world')]),
],
embedder: googleAI.textEmbedding('gemini-embedding-001'),
);
print(embeddings.first.embedding);Define Tools
Models can use define actions and access external data via custom defined tools.
Requires the schemantic library for schema definitions.
import 'package:schemantic/schemantic.dart';
@Schema()
abstract class $WeatherInput {
String get location;
}
final weatherTool = ai.defineTool(
name: 'getWeather',
description: 'Gets the current weather for a location',
inputSchema: WeatherInput.$schema,
fn: (input, _) async {
// Call your weather API here
return .response('Weather in ${input.location}: 72°F and sunny');
},
);
final response = await ai.generate(
model: googleAI.gemini('gemini-flash-latest'),
prompt: 'What\'s the weather like in San Francisco?',
toolNames: ['getWeather'], // Use the tools
);Tool functions return a
ToolResult. A tool'sfnreturns aToolResult<Output>, built with dot-shorthand:
return .response(output)for a normal result.
return .response(output, parts: [...])to attach media parts alongside the structured output (multipart), e.g. an image the tool produced.
return .interrupt(data)to pause the generation loop (see human-in-the-loop).fn: (input, _) async => .response( {'result': 'captured'}, parts: [MediaPart(media: Media(contentType: 'image/png', url: dataUri))], );Reading a tool's direct result (e.g. via
tool.call) also yields aToolResult; read(result as ToolResponseResult).output.
Structured Output
You can ensure the generative model returns a typed JSON object by providing an outputSchema.
@Schema()
abstract class $Person {
String get name;
int get age;
}
// ... inside main ...
final response = await ai.generate(
model: googleAI.gemini('gemini-flash-latest'),
prompt: 'Generate a person named John Doe, age 30',
outputSchema: Person.$schema, // Force the model to return this schema
);
final person = response.output; // Typed Person object
print('Name: ${person.name}, Age: ${person.age}');Errors and finish reasons
generate and generateStream do not throw for model errors, throwing
tools, cancellation, or hitting maxTurns. They resolve to a response whose
finishReason tells you what happened; branch on it instead of wrapping the
call in try/catch:
final res = await ai.generate(
model: googleAI.gemini('gemini-flash-latest'),
prompt: 'hi',
toolNames: ['myTool'],
);
switch (res.finishReason) {
case FinishReason.failed:
// A model error or a throwing tool. `res.error` is a structured
// RuntimeError; `res.cause` is the thrown object (in-process only, it
// does not cross the HTTP/reflection boundary).
// - Model error: `cause` is what the model call threw. A GenkitException
// keeps its status; anything else maps to INTERNAL.
// - Throwing tool: `cause` is a GenkitException (INTERNAL,
// 'tool "x" failed: ...') wrapping the tool's error, so the original
// is one level down, on its own `.cause`.
print(res.error?.status);
final cause = res.cause;
final original = cause is GenkitException ? cause.cause ?? cause : cause;
if (original is SocketException) {/* retry later */}
case FinishReason.aborted:
// Cancelled, or hit maxTurns.
print('aborted: ${res.finishMessage}');
default:
print(res.text);
}Only a tool returning .interrupt(...) is treated as a turn outcome
(FinishReason.interrupted) rather than a failure. See
human-in-the-loop.
Resume from the last-good state
On a failed or aborted response, res.messages holds the last-good
conversation state: the request messages plus every tool turn that completed
before the failure/abort (the failing turn's own partial output is dropped).
You do not have to start over. Feed res.messages straight back into a fresh
generate (with a new, uncancelled token if you were cancelling) to continue
from where it stopped:
if (res.finishReason == FinishReason.failed ||
res.finishReason == FinishReason.aborted) {
final resumed = await ai.generate(
model: googleAI.gemini('gemini-flash-latest'),
messages: res.messages, // last-good history: pick up where it stopped
);
}Cancellation
generate, generateStream, and action calls accept a CancellationToken. The
caller owns a CancellationController and hands its token to the call. These are
stable core types from package:genkit/genkit.dart (and client.dart).
final controller = CancellationController();
final stream = ai.generateStream(
model: googleAI.gemini('gemini-flash-latest'),
prompt: 'Write a long, detailed essay about the history of the internet.',
cancel: controller.token,
);
controller.cancel('user pressed stop');
// Chunks emitted before the cancel still arrive; the stream then closes.
await for (final chunk in stream) {
stdout.write(chunk.text);
}
final res = await stream.onResult;
if (res.finishReason == FinishReason.aborted) {
// res.messages holds the last-good history, so you can resume later.
print('\nCancelled: ${res.finishMessage}');
}Telemetry (instrumentation)
Telemetry is a pluggable abstraction, not a hardcoded OpenTelemetry dependency.
By default Genkit is not instrumented. In the dev environment (under
genkit start) a built-in provider is auto-injected so the Developer UI receives
traces with no setup, so most users never touch this API. For production, stack
one or more Instrumentation providers before creating Genkit:
import 'package:genkit/telemetry.dart';
void main() {
configureInstrumentation(myInstrumentation());
final ai = Genkit(plugins: [googleAI()]);
// ...
}Providers compose as a middleware chain, so multiple can be active at once. A
third-party platform can implement Instrumentation without taking an OTel
dependency.
Define Flows
Wrap your AI logic in flows for better observability, testing, and deployment:
final jokeFlow = ai.defineFlow(
name: 'tellJoke',
inputSchema: .string(),
outputSchema: .string(),
fn: (topic, _) async {
final response = await ai.generate(
model: googleAI.gemini('gemini-flash-latest'),
prompt: 'Tell me a joke about $topic',
);
return response.text; // Value return
},
);
final joke = await jokeFlow('programming');
print(joke);Top-level
finalflows are lazy. A flow declared as a top-levelfinalregisters only when the symbol is first evaluated, so an emptymain()registers nothing andgenkit flow:runfails withProcess exited before runtime was ready. Reference the flow frommain()(or import a module that does) so itsdefineFlowcall runs.
Streaming Flows
Stream data from your flows using context.sendChunk(...) and returning the final value:
final streamStory = ai.defineFlow(
name: 'streamStory',
inputSchema: .string(),
outputSchema: .string(),
streamSchema: .string(),
fn: (topic, context) async {
final stream = ai.generateStream(
model: googleAI.gemini('gemini-flash-latest'),
prompt: 'Write a story about $topic',
);
await for (final chunk in stream) {
context.sendChunk(chunk.text); // Stream the chunks
}
return 'Story complete'; // Value return
},
);Calling remote Flows from a dart client
The genkit package provides package:genkit/client.dart representing remote Genkit actions that can be invoked or streamed using type-safe definitions.
Defines a remote action
import 'package:genkit/client.dart';
final stringAction = defineRemoteAction(
url: 'http://localhost:3400/my-flow',
inputSchema: .string(),
outputSchema: .string(),
);Call the Remote Action (Non-streaming)
final response = await stringAction(input: 'Hello from Dart!');
print('Flow Response: $response');Call the Remote Action (Streaming) Use the
.stream()method on the action flow, and accessstream.onResultto wait on the async return value.
final streamAction = defineRemoteAction(
url: 'http://localhost:3400/stream-story',
inputSchema: .string(),
outputSchema: .string(),
streamSchema: .string(),
);
final stream = streamAction.stream(
input: 'Tell me a short story about a Dart developer.',
);
await for (final chunk in stream) {
print('Chunk: $chunk');
}
final finalResult = await stream.onResult;
print('\nFinal Response: $finalResult');Calling remote Flows from a Javascript client
Install genkit npm package:
npm install genkitCall a remote flow (non-streaming)
import { runFlow } from 'genkit/beta/client';
async function callHelloFlow() {
try {
const result = await runFlow({
url: 'http://127.0.0.1:3400/helloFlow', // Replace with your deployed flow's URL
input: { name: 'Genkit User' },
});
console.log('Non-streaming result:', result.greeting);
} catch (error) {
console.error('Error calling helloFlow:', error);
}
}
callHelloFlow();Call a remote flow (streaming)
import { streamFlow } from 'genkit/beta/client';
async function streamHelloFlow() {
try {
const result = streamFlow({
url: 'http://127.0.0.1:3400/helloFlow', // Replace with your deployed flow's URL
input: { name: 'Streaming User' },
});
// Process the stream chunks as they arrive
for await (const chunk of result.stream) {
console.log('Stream chunk:', chunk);
}
// Get the final complete response
const finalOutput = await result.output;
console.log('Final streaming output:', finalOutput.greeting);
} catch (error) {
console.error('Error streaming helloFlow:', error);
}
}
streamHelloFlow();Data Models
Genkit uses standard data models for representing prompts (messages & parts) and responses. These classes are implemented using schemantic library.
import 'package:genkit/genkit.dart';
import 'package:schemantic/schemantic.dart';
@Schema()
abstract class $MyDataModel {
// uses Genkit's Message schema (not schemantic's Message)
List<$Message> get messages;
List<$Part> get parts;
}
void example() {
// --- Parts ---
// A Text part
final textPart = TextPart(text: 'some text', metadata: {'foo': 'bar'});
// A Media/Image part
final mediaPart = MediaPart(
media: Media(url: 'https://...', contentType: 'image/png'),
metadata: {'foo': 'bar'},
);
// A Tool Request initiated by the model
final toolRequestPart = ToolRequestPart(
toolRequest: ToolRequest(
name: 'get_weather',
ref: 'abc',
input: {'location': 'Paris, France'},
),
metadata: {'foo': 'bar'},
);
// The resulting data from a Tool execution
final toolResponsePart = ToolResponsePart(
toolResponse: ToolResponse(
name: 'get_weather',
ref: 'abc',
output: {'temperature': '20C'},
),
metadata: {'foo': 'bar'},
);
// Model reasoning (e.g. for Claude's "thinking" models)
final reasoningPart = ReasoningPart(
reasoning: 'thinking...',
metadata: {'foo': 'bar'},
);
// A custom fallback part
final customPart = CustomPart(
custom: {'provider': {'specific': 'data'}},
metadata: {'foo': 'bar'},
);
// --- Messages ---
final systemMessage = Message(
role: Role.system,
content: [textPart, mediaPart],
metadata: {'foo': 'bar'},
);
final userMessage = Message(
role: Role.user,
content: [textPart, mediaPart], // Can contain media (multimodal)
);
final modelMessage = Message(
role: Role.model,
// Models can emit text, tool requests, reasoning, or custom parts
content: [textPart, toolRequestPart, reasoningPart, customPart],
);
// --- Ergonomic Data Access (schema_extensions.dart) ---
// The Genkit SDK provides extensions on `Message` and `Part` to easily access fields
// without needing to cast them manually.
// Get concatenated text from all TextParts in a Message
print(modelMessage.text);
// Get the first Media object from a Message
print(modelMessage.media?.url);
// Iterate over tool requests in a Message
for (final toolReq in modelMessage.toolRequests) {
print(toolReq.name);
}
// Inspect individual parts
for (final part in modelMessage.content) {
if (part.isText) print(part.text);
if (part.isMedia) print(part.media?.url);
if (part.isToolRequest) print(part.toolRequest?.name);
if (part.isToolResponse) print(part.toolResponse?.name);
if (part.isReasoning) print(part.reasoning);
if (part.isCustom) print(part.custom);
}
// --- Streaming Chunks ---
// Data emitted by ai.generateStream() calls
final generateResponseChunk = ModelResponseChunk(
content: [textPart],
index: 0, // Index of the message this chunk belongs to
aggregated: false,
);
// Chunks also have text and media accessors
print(generateResponseChunk.text);
// --- Advanced: Schemas ---
// Use Genkit type schemas directly in Schemantic validations
final messageSchema = Message.$schema;
final partSchema = Part.$schema;
final mySchema = SchemanticType.map(
.string(),
.list(Message.$schema), // Requires a list of Messages
);
// --- Generate Response ---
// ai.generate() returns a read-only GenerateResult<Output> view over the
// underlying ModelResponse:
final response = await ai.generate(...);
print(response.text); // Concatenated text
print(response.media?.url); // First media part
print(response.toolRequests); // All tool requests
print(response.interrupts); // Tool requests that triggered an interrupt
print(response.messages); // Full history of the conversation, including the request and response
print(response.output); // Structured typed output (if outputSchema was used)
print(response.usage?.inputTokens); // int? token counts
print(response.modelResponse); // the raw ModelResponse (modelRequest too)
// Stream chunks are GenerateResponseChunk<Output>; `chunk.modelChunk` is the
// raw ModelResponseChunk (e.g. to forward with ctx.sendChunk in a model).
}Requirements and compatibility
Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta
“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.
Needs: Needs Node.js
Security
What our scanner noticed· Low risk
- Instructions that use the network
A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.
Attribution and licence
- Published by
- Publisher
- Google (Official)
- Source
- google/skills · skills/cloud/developing-genkit-dart · commit 2194d3b
- Licence
- Apache License 2.0 (redistribution allowed)
- LICENSE (added by AutoGineer from LICENSE)
- ATTRIBUTION.md (written by AutoGineer)
- Synced
AutoGineer is not affiliated with or endorsed by Google or Google.
Download ZIP
The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download developing-genkit-dart.zip