Skip to content

Commit

Permalink
Some minor tweaks to the AI docs
Browse files Browse the repository at this point in the history
- Make the nav item "AI" instead of "Gel AI"
- Some minor rephrasing
- Move "Index" heading into the "Built-in Resources" section
  • Loading branch information
scotttrinh committed Feb 21, 2025
1 parent 981181a commit 684d45d
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 20 deletions.
20 changes: 10 additions & 10 deletions docs/ai/extai.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
.. _ref_ai_extai_reference:

============
AI Extension
============
=======
ext::ai
=======

This reference documents the |Gel| AI extension's components, configuration
options, and APIs.
This reference documents the |Gel| ``ext::ai`` extension components, configuration options, and database APIs.


Enabling the Extension
Expand Down Expand Up @@ -43,7 +42,8 @@ Reset configuration:

.. code-block:: edgeql
configure current branch reset ext::ai::Config::indexer_naptime;
configure current branch
reset ext::ai::Config::indexer_naptime;
.. _ref_ai_extai_reference_ui:
Expand Down Expand Up @@ -93,10 +93,13 @@ Enables management of API configurations for AI API providers.
:width: 100%


Built-in resources
==================

.. _ref_ai_extai_reference_index:

Index
=====
-----

The ``ext::ai::index`` creates a deferred semantic similarity index of an
expression on a type.
Expand Down Expand Up @@ -134,9 +137,6 @@ Parameters:
* ``truncate_to_max``: bool (Default: False)


Built-in resources
==================

.. _ref_ai_extai_reference_embedding_models:

Embedding models
Expand Down
18 changes: 8 additions & 10 deletions docs/ai/index.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
.. _ref_ai_overview:

======
Gel AI
======
==
AI
==

:edb-alt-title: Using Gel AI

.. toctree::
:hidden:
Expand All @@ -15,10 +17,8 @@ Gel AI
extvectorstore
vectorstore_python

:edb-alt-title: Using Gel AI

|Gel| AI is a set of tools designed to enable you to ship AI-enabled apps with
practically no effort. This is what comes in the box:
practically no effort.

1. ``ext::ai``: this Gel extension automatically generates embeddings for your
data. Works with OpenAI, Mistral AI, Anthropic, and any other provider with a
Expand All @@ -32,7 +32,5 @@ practically no effort. This is what comes in the box:
3. Python library: ``gel.ai``. Access all Gel AI features straight from your
Python application.

4. JavaScript library: ``@gel/ai``.



4. JavaScript library: ``@gel/ai``. Access all Gel AI features right from your
JavaScript backend application.

0 comments on commit 684d45d

Please sign in to comment.