Skip to content

docs(ai): add active-development caution callout to AI pages #66

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tmgbedu wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(ai): add active-development caution callout to AI pages #66

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/ai/agent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ keywords: AI agents, Anthropic, OpenAI, Google Gemini, LLM, tool calling, stream

# AI Agents

::: warning Active development
The AI package is under active development. APIs may change without notice as we experiment with the best integration patterns. Use with caution in production.
:::

FastAPI Startkit includes a declarative, **LangChain-powered AI agent module** that lets you build provider-agnostic LLM agents as plain Python classes. Swap between Anthropic, OpenAI, and Google with a single environment variable; attach tools, documents, structured-output schemas, and middleware; and test everything offline with built-in faking and record/replay utilities.

## Introduction
Expand Down
4 changes: 4 additions & 0 deletions docs/ai/audio.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ keywords: audio generation, text-to-speech, TTS, OpenAI, Google Gemini, ElevenLa

# Audio Generation

::: warning Active development
The AI package is under active development. APIs may change without notice as we experiment with the best integration patterns. Use with caution in production.
:::

FastAPI Startkit ships a fluent, provider-agnostic **text-to-speech** API. Turn any string into spoken audio, pick a voice, and persist the result to any configured storage disk — all in a single chained expression.

## Introduction
Expand Down
4 changes: 4 additions & 0 deletions docs/ai/image.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ keywords: image generation, text-to-image, DALL-E, Imagen, OpenAI, Google Gemini

# Image Generation

::: warning Active development
The AI package is under active development. APIs may change without notice as we experiment with the best integration patterns. Use with caution in production.
:::

FastAPI Startkit ships a fluent, provider-agnostic **image generation** API. Describe an image in plain text, optionally attach a source photo for editing, and persist the result to any configured storage disk — all with a single chained expression.

## Introduction
Expand Down
4 changes: 4 additions & 0 deletions docs/ai/mcp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ keywords: MCP, Model Context Protocol, JSON-RPC, AI tools, FastAPI, fastapi-star

# MCP (Model Context Protocol)

::: warning Active development
The AI package is under active development. APIs may change without notice as we experiment with the best integration patterns. Use with caution in production.
:::

The [Model Context Protocol](https://modelcontextprotocol.io/) (MCP) is a JSON-RPC 2.0 standard that lets AI assistants — such as Claude, Cursor, and other MCP-compatible clients — discover and call capabilities exposed by your application. `fastapi-startkit` includes built-in support for MCP: define servers, tools, prompts, and resources as plain Python classes and mount them on your app with a single line.

## Getting Started
Expand Down
4 changes: 4 additions & 0 deletions docs/ai/skills.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ keywords: AI skills, Claude Code, Gemini CLI, artisan, fastapi-startkit

# Skills

::: warning Active development
The AI package is under active development. APIs may change without notice as we experiment with the best integration patterns. Use with caution in production.
:::

The Skills module syncs provider-declared `SKILL.md` documents to your local AI coding tools — [Claude Code](https://claude.ai/code) and [Gemini CLI](https://github.com/google-gemini/gemini-cli).

## Registration
Expand Down