10.3.4 ML

10.3.4 ML_RAG

The ML_RAG routine performs retrieval-augmented generation (RAG) by:

Taking a natural-language query.
Retrieving context from relevant documents using semantic search.
Generating a response that integrates information from the retrieved documents.

This routine aims to provide detailed, accurate, and contextually relevant answers by augmenting a generative model with information retrieved from a comprehensive knowledge base.

This topic contains the following sections:

ML_RAG Syntax

mysql> CALL sys.ML_RAG('QueryInNaturalLanguage', 'Output'[, options]);

options: JSON_OBJECT(keyvalue[, keyvalue]...)
keyvalue:
{
  'vector_store', JSON_ARRAY('VectorStoreTableName'[, 'VectorStoreTableName']...)
  |'schema', JSON_ARRAY('SchemaName'[, 'SchemaName']...)
  |'n_citations', NumberOfCitations
  |'distance_metric', {'COSINE'|'DOT'|'EUCLIDEAN'}
  |'document_name', JSON_ARRAY('DocumentName'[, 'DocumentName']...)
  |'skip_generate', {true|false}
  |'model_options', modeloptions
  |'exclude_vector_store', JSON_ARRAY('ExcludeVectorStoreTableName'[, 'ExcludeVectorStoreTableName']...)
  |'exclude_document_name', JSON_ARRAY('ExcludeDocumentName'[, 'ExcludeDocumentName']...)
  |'retrieval_options', retrievaloptions
  |'vector_store_columns', vscoptions
  |'embed_model_id', 'EmbeddingModelID'
  |'query_embedding', 'QueryEmbedding'
}

Following are ML_RAG parameters:

QueryInNaturalLangugae: specifies the natural-language query.
Output: stores the generated output. The output contains the following segments:
- text: the generated text-based response.
- citations: contains the following details:
  - segment: the textual content that is retrieved from the vector store through semantic search, and used as context generating the response.
  - distance: the distance between the query embedding the segment embedding.
  - document_name: the name of the document from which the segment is retrieved.
- vector_store: the list of vector store tables used for context retrieval.
options: specifies optional parameters as key-value pairs in JSON format. It can include the following parameters:
- vector_store: specifies a list of loaded vector store tables to use for context retrieval. The routine ignores invalid table names. By default, the routine performs a global search across all the available vector store tables in the DB system.
- schema: specifies a list of schemas to check for loaded vector store tables. By default, the routine performs a global search across all the available vector store tables in all the schemas that are available in the DB system.
- n_citations: specifies the number of segments to consider for context retrieval. Default value is 3. Possible values are integer values between 0 and 100.
- distance_metric: specifies the distance metrics to use for context retrieval. Default value is COSINE. Possible values are COSINE, DOT, and EUCLIDEAN.
- document_name: limits the documents to use for context retrieval. Only the specified documents are used. By default, the routine performs a global search across all the available documents stored in all the available vector stores in the DB system.
- skip_generate: specifies whether to skip generation of the text-based response, and only perform context retrieval from the available or specified vector stores, schemas, or documents. Default value is false.
- model_options: additional options that you can set for generating the text-based response. These are the same options that are available in the ML_GENERATE routine, which alter the text-based response per the specified settings. However, the context option is not supported as an ML_RAG model option. As of MySQL 9.3.1, default value is '{"model_id": "llama3.2-3b-instruct-v1"}', in previous versions, default value is '{"model_id": "mistral-7b-instruct-v1"}'.
- exclude_vector_store: specifies a list of loaded vector store tables to exclude from context retrieval. The routine ignores invalid table names. Default value is NULL. This option is available as of MySQL 9.0.1-u1.
- exclude_document_name: specifies a list of documents to exclude from context retrieval. Default value is NULL. This parameter is available as of MySQL 9.0.1-u1.
- retrieval_options: specifies optional context retrieval parameters as key-value pairs in JSON format. If a parameter value in retrieval_options is set to auto, the default value for that parameter is used.
  The retrieval_options parameters are available as of MySQL 9.1.2.
  It can include the following parameters:
```
retrievaloptions: JSON_OBJECT(retrievaloptkeyvalue[, retrievaloptkeyvalue]...)
retrievaloptkeyvalue:
{
  'max_distance', MaxDistance
  |'percentage_distance', PercentageDistance
  |'segment_overlap', SegmentOverlap
} 
```
  - max_distance: specifies a maximum distance threshold for filtering out segments from context retrieval. Segments for which the distance from the input query exceeds the specified maximum distance threshold are excluded from content retrieval. This ensures that only the segments that are closer to the input query are included during context retrieval. However, if no segments are found within the specified distance, the routine fails to run.
    Note
    If this parameter is set, the default value of the n_citations parameter is automatically updated to 10.
    Default value is 0.6 for all distance metrics.
    Possible values are decimal values between 0 and 999999.9999.
  - percentage_distance: specifies what percentage of distance to the nearest segment is to be used to determine the maximum distance threshold for filtering out segments from context retrieval.
    Following is the formula used for calculating the maximum distance threshold:
    MaximumDistanceThreshold = DistanceOfInputQueryToNearestSegment + [(percentage_distance / 100) * DistanceOfInputQueryToNearestSegment]
    Which means that the segments for which the distance to the input query exceeds the distance of the input query to the nearest segment by the specified percentage are filtered out from context retrieval.
    Note
    If this parameter is set, the default value of the n_citations parameter is automatically updated to 10.
    Default value is 20 for all distance metrics.
    Possible values are decimal values between 0 and 999999.9999.
    Note
    If both max_distance and percentage_distance are set, the smaller threshold value is considered for filtering out the segments.
  - segment_overlap: specifies the number of additional segments adjacent to the nearest segments to the input query to be included in context retrieval. These additional segments provide more continuous context for the input query. Default value is 1. Possible values are integer values between 0 and 5.
- vector_store_columns: specifies column names for finding relevant vector and embedding tables for context retrieval as key-value pairs in JSON format. If multiple tables contain columns with the same name and data type, then all such tables are used for context retrieval.
  It can include the following parameters:
```
vscoptions: JSON_OBJECT('segment', 'SegmentColName', 'segment_embedding', 'EmbeddingColName'[, vsckeyvalue]...)
vsckeyvalue:
{
  'document_name', 'DocumentName'
  |'document_id', DocumentID
  |'metadata', 'Metadata'
  |'segment_number', SegmentNumber
} 
```
  - segment: specifies the name of the mandatory string column that contains the text segments. Default value is segment.
  - segment_embedding: specifies the name of the mandatory vector column that contains vector embeddings of the text segments. Default value is segment_embedding.
  - document_name: specifies the name of the optional column that contains the document names. This column can be of any data type supported by MySQL HeatWave. Default value is document_name.
  - document_id: specifies the name of the optional integer column that contains the document IDs. Default value is document_id.
  - metadata: specifies the name of the optional JSON column that contains additional table metadata. Default value is metadata.
  - segment_number: specifies the name of the optional integer column that contains the segment numbers. Default value is segment_number.
  Default value is {"segment": "segment", "segment_embedding": "segment_embedding", "document_id: "document_id", "segment_number": "segment_number", "metadata": "metadata"}, which means that by default, the routine uses the default values of all column names to find relevant tables for context retrieval.
  This parameter is available as of MySQL 9.2.1.
- embed_model_id: specifies the embedding model to use for embedding the input query. If you are providing the query embedding, then set this parameter to specify the embedding model to use to embed the query. The routine uses vector store tables and embedding tables created using the same embedding model for context retrieval.
  As of 9.3.0, default value is multilingual-e5-small. In earlier versions of MySQL, default value is minilm for English text and multilingual-e5-small for text in languages other than English.
  To view the list of available embedding models, see MySQL HeatWave In-Database Embedding Models and OCI Generative AI Service Embedding Models.
  As of MySQL 9.4.0, to use an OCI Generative AI service Dedicated AI Cluster model, specify the model endpoint OCID. For more information, see Creating an Endpoint in Generative AI.
  This parameter is available as of MySQL 9.2.1.
- query_embedding: specifies the vector embedding of the input query. If this parameter is set, then the routine skips generating the vector embeddings of the input query. Instead, it uses this embedding for context retrieval from valid vector store and embedding tables that contain vector embeddings created using the same embedding model.
  This parameter is available as of MySQL 9.2.1.

Syntax Examples

Retrieving context and generating output:

mysql> CALL sys.ML_RAG("What is AutoML",@output,@options);

Where, @options is set to specify the vector store table to use using vector_store key, as shown below:

mysql> SET @options = JSON_OBJECT("vector_store", JSON_ARRAY("demo_db.demo_embeddings"));

10.3.4 ML_RAG

ML_RAG Syntax

Syntax Examples

See Also