Merge pull request #189 from nvillahermosa-mdb/DOCSP-43580-byo-llm

DOCSP-43580 BYO LLM

Author: nvillahermosa-mdb

source/code-generation.txt

@@ -29,8 +29,8 @@ application code:
      - Supports 
 
    * - Query Converter
-     - Converts SQL based relational database code to function with 
-       MongoDB. The converted code takes into consideration the mapping 
+     - Uses Generative AI to convert SQL-based relational database code to work
+       with MongoDB. The converted code takes into consideration the mapping 
        rules and schema transformations defined in your project.
      - 
       - SQL queries 

source/code-generation/query-converter.txt

@@ -10,16 +10,22 @@ Query Converter
    :depth: 1
    :class: singlecol
 
-Use Query Converter to convert SQL statements, views, and stored 
+Query Converter uses Generative AI to convert SQL statements, views, and stored
 procedures to MongoDB syntax. Relational Migrator considers the mapping 
 rules and schema transformations defined in your project when converting
 your SQL code.
 
+.. important::
+
+   Query Converter is disabled by default. You must :ref:`opt-in and enable the
+   feature <rm-enable-query-converter>` to use it.
+
 .. toctree::
    :hidden:
    :titlesonly:
 
    AI & Data Usage </code-generation/query-converter/ai-and-data-usage-information>
+   Set AI Provider and LLM </code-generation/query-converter/set-query-converter-llm>
    Enable Query Converter </code-generation/query-converter/enable-query-converter>
    Convert Queries </code-generation/query-converter/convert-queries>
    Convert Stored Procedures </code-generation/query-converter/convert-stored-procedures>

source/code-generation/query-converter/ai-and-data-usage-information.txt

@@ -10,17 +10,54 @@ AI and Data Usage Information
    :depth: 1
    :class: singlecol
 
-The Query Converter feature is powered by Generative AI
-(Gen AI), and may give inaccurate responses. Please see our `Generative AI FAQ 
+Query Converter is powered by Generative AI
+(Gen AI), and may give inaccurate responses. Please see the `Generative AI FAQ 
 <https://dochub.mongodb.org/core/faq-ai-features>`__ 
 for more information about Gen AI in MongoDB products.
 
 Third Party Providers
 ---------------------
 
-Query Converter currently uses the `Azure OpenAI Service
+By default, Query Converter uses the GPT-4o model with the `Azure OpenAI
+Service
 <https://azure.microsoft.com/en-us/products/ai-services/openai-service>`__ 
-hosted by Microsoft. This is subject to change in the future.
+hosted by Microsoft. You can :ref:`configure Relational Migrator to use a
+different AI provider or Large Language Model (LLM)<rm-query-converter-set-llm>`.
+
+.. _rm-supported-llms:
+
+Supported Providers and LLMs
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+MongoDB tests Query Converter with the following AI providers and models:
+
+.. list-table::
+   header-rows: 1
+
+   * - Provider
+     - Models
+
+   * - `Microsoft Azure OpenAI <https://azure.microsoft.com/en-us/products/ai-services/openai-service>`__
+     - `GPT-4o <https://platform.openai.com/docs/models#gpt-4o>`__, `GPT-4 <https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4>`__
+
+   * - `OpenAI <https://platform.openai.com/docs/overview>`__
+     - `GPT-4o <https://platform.openai.com/docs/models#gpt-4o>`__, `GPT-4 <https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4>`__
+
+   * - `Amazon Bedrock <https://aws.amazon.com/bedrock/>`__
+     - `Claude 3.5 (Sonnet) <https://docs.anthropic.com/en/api/claude-on-amazon-bedrock>`__, `Mistral Large <https://docs.mistral.ai/deployment/cloud/aws/>`__
+
+   * - `GCP Vertex AI <https://cloud.google.com/vertex-ai>`__
+     - `Gemini 1.5 Pro <https://cloud.google.com/vertex-ai/generative-ai/docs/learn/models>`__
+
+   * - Self-managed local/Cloud
+     - `Llama 3.1 405B <https://www.llama.com/docs/getting_the_models>`__
+
+.. note::
+
+   You can configure Query Converter to run models on different providers,
+   like running Llama 3.1 on Blackrock AWS, but MongoDB provides no
+   performance or stability guarantees for these configurations.
+
 
 How Your Data is Used
 ---------------------
@@ -52,8 +89,7 @@ your data to be stored, you have the option to opt out:
 Disable Query Converter
 -----------------------
 
-Query Converter is available in the Relational Migrator UI once you have
-:ref:`enabled the query converter feature <rm-enable-query-converter>`. 
+Query Converter is only available if you :ref:`enable it <rm-enable-query-converter>`. 
 If you no longer want to use the feature, you can ignore it and no data 
-will be sent to generative AI models. If needed, you can hide the 
+is sent to generative AI models. If needed, you can hide the 
 feature by clearing all browser data for the Relational Migrator host.

source/code-generation/query-converter/enable-query-converter.txt

@@ -10,15 +10,15 @@ Enable Query Converter
    :depth: 1
    :class: singlecol
 
-You can use the query converter to convert SQL statements, views, and 
-stored procedures to MongoDB syntax. The query converter considers the 
+You can use Query Converter to convert SQL statements, views, and 
+stored procedures to MongoDB syntax. Query Converter considers the 
 mapping rules and schema transformations defined in your project when 
 converting your SQL code.
 
 Before You Begin
 ----------------
 
-Before you can use the query converter, you must sign in to your Atlas
+Before you can use Query Converter, you must sign in to your Atlas
 account in Relational Migrator. For details, see :ref:`rm-atlas-log-in`.
 
 Steps
@@ -27,7 +27,7 @@ Steps
 .. procedure::
    :style: normal
 
-   .. step:: Navigate to the query converter pane
+   .. step:: Navigate to the Query Converter pane
 
       From the :guilabel:`Code Generation` tab, click the 
       :guilabel:`Query Converter` pane.
@@ -36,14 +36,12 @@ Steps
 
    .. step:: (Optional) Review telemetry preferences
 
-      Telemetry data about the source and converted queries are 
-      temporarily stored by MongoDB to improve the query converter 
-      feature. If you do not want your data to be stored, you have 
-      the option to opt out:
+      Telemetry data about source and converted queries is 
+      temporarily stored by MongoDB to improve Query Converter. If you don't want your data stored, you can opt out:
 
       .. include:: /includes/fact-disable-query-converter.rst
 
-   .. step:: Enable the query converter feature
+   .. step:: Enable Query Converter
 
       Click :guilabel:`Start Using Query Converter`. 
       The :guilabel:`Query Converter` pane is displayed.