API-Referenz

Vollständige Gemini CLI API-Dokumentation mit detaillierten Methodenbeschreibungen, Parametern und praktischen Beispielen.

API-Bereiche

Navigieren Sie durch verschiedene API-Kategorien

Kern-API

Haupt-API für die Interaktion mit Gemini-Modellen und die Verwaltung von Gesprächen

Plugin-API

API für die Entwicklung benutzerdefinierter Plugins und Erweiterungen

Konfigurations-API

API zur Verwaltung von CLI-Konfiguration und -Einstellungen

Tools-API

API zur Verwaltung und Ausführung integrierter Tools

Kern-API

Haupt-API für die Interaktion mit Gemini-Modellen und die Verwaltung von Gesprächen

chat()

Interaktive Chat-Sitzung mit Gemini starten

Signatur:

chat(options?: ChatOptions): Promise<ChatSession>

Beispiel:

import { GeminiCLI } from '@google/generative-ai-cli';

const cli = new GeminiCLI();
const session = await cli.chat({
  model: 'gemini-pro',
  temperature: 0.7
});

ask()

Eine Eingabeaufforderung senden und eine Antwort erhalten

Signatur:

ask(prompt: string, options?: AskOptions): Promise<string>

Beispiel:

const response = await cli.ask("Was ist maschinelles Lernen?", {
  maxTokens: 1000,
  temperature: 0.5
});

analyze()

Dateien oder Code mit KI-Unterstützung analysieren

Signatur:

analyze(files: string[], options?: AnalyzeOptions): Promise<AnalysisResult>

Beispiel:

const analysis = await cli.analyze(['src/main.js'], {
  type: 'code-review',
  includeMetrics: true
});

Plugin-API

API für die Entwicklung benutzerdefinierter Plugins und Erweiterungen

registerPlugin()

Neues Plugin mit der CLI registrieren

Signatur:

registerPlugin(plugin: Plugin): void

Beispiel:

const myPlugin = {
  name: 'my-custom-plugin',
  version: '1.0.0',
  commands: {
    'custom-command': async (args) => {
      // Plugin-Logik hier
      return 'Plugin erfolgreich ausgeführt';
    }
  }
};

cli.registerPlugin(myPlugin);

createTool()

Benutzerdefiniertes Tool für KI erstellen

Signatur:

createTool(definition: ToolDefinition): Tool

Beispiel:

const weatherTool = cli.createTool({
  name: 'get_weather',
  description: 'Aktuelles Wetter für einen Ort abrufen',
  parameters: {
    location: { type: 'string', required: true }
  },
  execute: async ({ location }) => {
    // Wetterdaten abrufen
    return `Wetter in ${location}: Sonnig, 25°C`;
  }
});

Konfigurations-API

API zur Verwaltung von CLI-Konfiguration und -Einstellungen

getConfig()

Aktuelle Konfigurationswerte abrufen

Signatur:

getConfig(key?: string): any

Beispiel:

// Alle Konfiguration abrufen
const config = cli.getConfig();

// Spezifischen Konfigurationswert abrufen
const model = cli.getConfig('model');

setConfig()

Konfigurationswerte setzen

Signatur:

setConfig(key: string, value: any): void

Beispiel:

// Modell setzen
cli.setConfig('model', 'gemini-pro');

// Mehrere Werte setzen
cli.setConfig('temperature', 0.8);
cli.setConfig('maxTokens', 2000);

resetConfig()

Konfiguration auf Standardwerte zurücksetzen

Signatur:

resetConfig(key?: string): void

Beispiel:

// Alle Konfiguration zurücksetzen
cli.resetConfig();

// Spezifischen Schlüssel zurücksetzen
cli.resetConfig('temperature');

Tools-API

API zur Verwaltung und Ausführung integrierter Tools

listTools()

Liste verfügbarer Tools abrufen

Signatur:

listTools(): Tool[]

Beispiel:

const tools = cli.listTools();
console.log(tools.map(t => t.name));
// ['read_file', 'write_file', 'run_shell_command', ...]

executeTool()

Spezifisches Tool ausführen

Signatur:

executeTool(name: string, args: any): Promise<any>

Beispiel:

// Datei lesen
const content = await cli.executeTool('read_file', {
  path: './package.json'
});

// Shell-Befehl ausführen
const result = await cli.executeTool('run_shell_command', {
  command: 'ls -la'
});

Häufige Typen

TypeScript-Schnittstellen und -Typen, die in der API verwendet werden

ChatOptions

Optionen zum Starten einer Chat-Sitzung

model

string

Zu verwendendes Modell (z.B. "gemini-pro")

temperature

number

Kreativitätslevel (0-1)

maxTokens

number

Maximale Antwortlänge

systemPrompt

string

Systemanweisungen

ToolDefinition

Definition zum Erstellen benutzerdefinierter Tools

name

string

Eindeutiger Tool-Name

description

string

Tool-Beschreibung für KI

parameters

object

Parameter-Schema

execute

function

Tool-Ausführungsfunktion

Zusätzliche Ressourcen

Weitere Dokumentation und Beispiele erkunden

Beispiele AnzeigenZurück zu Docs