Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
- name: Set up Ruby
uses: ruby/setup-ruby@v1
with:
ruby-version: 3.2.2
ruby-version: '3.2'
bundler-cache: true
- name: Build pages
run: |
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ jobs:
- name: Set up Ruby
uses: ruby/setup-ruby@v1
with:
ruby-version: 3.2.2
ruby-version: '3.2'
bundler-cache: true
- name: Build pages
run: |
Expand Down
3 changes: 3 additions & 0 deletions html5/_main_toc.html.slim
Original file line number Diff line number Diff line change
Expand Up @@ -330,6 +330,9 @@ nav.sidebar-nav
li
a.nav-link href="/latest/aviate-catalog-guide.html"
| Aviate Catalog Guide
li
a.nav-link href="/latest/aviate-ai-assistant.html"
| Catalog AI Assistant
li
a.nav-link href="/latest/how-to-install-the-aviate-plugin.html"
| Aviate Plugin Installation
Expand Down
68 changes: 68 additions & 0 deletions userguide/aviate/aviate-ai-assistant.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
= Aviate Catalog AI Assistant
:description: Describe a product and plan in plain English and let the Aviate AI Assistant draft it in your catalog. Nothing goes live until you publish.

:card-badge: Premium
:card-title: Aviate
:card-link: https://aviate.killbill.io/
:card-description:
include::{sourcedir}/includes/premium-card.adoc[]

== Overview

The AI Assistant in the Aviate catalog drafts products and plans from a plain-English description. Instead of filling in each field, you describe what you want to create. The assistant then prepares the product and the plan for you, including the trial phase and the recurring price.

You can ask for:

* a new product,
* a plan for an existing product, or
* both.

The assistant only prepares a draft. The changes are marked *Unsaved*, and nothing goes live until you click *Publish*.

== Before you start

* You have access to Aviate, and a Kill Bill deployment has been added. See the https://docs.killbill.io/latest/aviate-deployment-management.html[Aviate Deployment Management] guide.
* You know how products and plans work in the Aviate catalog. See the https://docs.killbill.io/latest/aviate-catalog-guide.html[Aviate Catalog Guide].

== Use the AI Assistant

. In Aviate, go to the *Catalog* page.
. Click the sparkle button next to *Add product*. Its tooltip reads *Add product and plans with AI assistant*.
+
The *AI Assistant* opens.
. Describe in plain English what you want to create. For example:
+
----
A monthly plan with a 14-day free trial
----
+
TIP: Mention the pricing, the billing period and the trial length in your description.
+
The assistant drafts the product and the plan, including the trial phase and the recurring price.

== Review and publish

The drafted changes appear in the catalog marked *Unsaved*. A banner asks you to review the changes, then publish them.

* To make the changes live, click *Publish*.
* To discard the changes, click *Cancel*, then confirm with *Discard*. Nothing is published.

Nothing goes live until you click *Publish*.

TIP: Check the product name, the plan, the trial length, the billing period and the price before you click *Publish*.

== Advanced: paste intent JSON

The AI Assistant also offers an advanced option, *Paste intent JSON*. It accepts a structured definition of what to create, instead of a plain-English description.

== Limits of this page

This page describes the assistant as it appears in the Aviate catalog.

To create or change products and plans without the assistant, see the https://docs.killbill.io/latest/aviate-catalog-guide.html[Aviate Catalog Guide].

== Related pages

* https://docs.killbill.io/latest/aviate-catalog-guide.html[Aviate Catalog Guide]
* https://docs.killbill.io/latest/aviate-catalog-plugin.html[Aviate Catalog Plugin]
* https://docs.killbill.io/latest/what_is_aviate.html[What Is Aviate?]
2 changes: 2 additions & 0 deletions userguide/aviate/aviate-catalog-guide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ To create a product, plan, and pricelist:
. Set the price (e.g., `$10` per month).
. Save your entries.

[TIP]
You can also describe a product and plan in plain English and let the AI Assistant draft them. See the https://docs.killbill.io/latest/aviate-ai-assistant.html[Aviate Catalog AI Assistant] guide.

Demo:

Expand Down
2 changes: 2 additions & 0 deletions userguide/aviate/what_is_aviate.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ Aviate is composed of two main components that work together to deliver a compre

* *Aviate Plugin*: A plugin installed on each Kill Bill instance that extends it with additional API endpoints. It acts as the bridge between the control plane and the Kill Bill core, enabling centralized management and real-time monitoring across all your deployments.

The Aviate catalog includes an AI Assistant that drafts products and plans from a plain-English description. Nothing goes live until you publish. See the https://docs.killbill.io/latest/aviate-ai-assistant.html[Aviate Catalog AI Assistant] guide.

The following diagram illustrates the relationship between these components:

image::../assets/aviate/AviateOverview.png[Aviate Overview,width=50%,align=center]
Expand Down
Loading