docs: updated example usage in docstring for rag_retrieval preview and GA

docs: updated example usage in docstring for rag_store preview and GA

PiperOrigin-RevId: 700577610

Author: vertex-sdk-bot

vertexai/preview/rag/rag_retrieval.py

@@ -43,6 +43,7 @@ def retrieval_query(
 
     vertexai.init(project="my-project")
 
+    # Using deprecated parameters
     results = vertexai.preview.rag.retrieval_query(
         text="Why is the sky blue?",
         rag_resources=[vertexai.preview.rag.RagResource(
@@ -53,6 +54,26 @@ def retrieval_query(
         vector_distance_threshold=0.5,
         vector_search_alpha=0.5,
     )
+
+    # Using RagRetrievalConfig. Equivalent to the above example.
+    config = vertexai.preview.rag.rag_retrieval_config(
+        top_k=2,
+        filter=vertexai.preview.rag.rag_retrieval_config.filter(
+            vector_distance_threshold=0.5
+        ),
+        hybrid_search=vertexai.preview.rag.rag_retrieval_config.hybrid_search(
+            alpha=0.5
+        ),
+    )
+
+    results = vertexai.preview.rag.retrieval_query(
+        text="Why is the sky blue?",
+        rag_resources=[vertexai.preview.rag.RagResource(
+            rag_corpus="projects/my-project/locations/us-central1/ragCorpora/rag-corpus-1",
+            rag_file_ids=["rag-file-1", "rag-file-2", ...],
+        )],
+        rag_retrieval_config=config,
+    )
     ```
 
     Args:
@@ -61,17 +82,20 @@ def retrieval_query(
             only or ragfiles. Currently only support one corpus or multiple files
             from one corpus. In the future we may open up multiple corpora support.
         rag_corpora: If rag_resources is not specified, use rag_corpora as a list
-            of rag corpora names.
-        similarity_top_k: The number of contexts to retrieve.
+            of rag corpora names. Deprecated. Use rag_resources instead.
+        similarity_top_k: The number of contexts to retrieve. Deprecated. Use
+            rag_retrieval_config.top_k instead.
         vector_distance_threshold: Optional. Only return contexts with vector
-            distance smaller than the threshold.
+            distance smaller than the threshold. Deprecated. Use
+            rag_retrieval_config.filter.vector_distance_threshold instead.
         vector_search_alpha: Optional. Controls the weight between dense and
             sparse vector search results. The range is [0, 1], where 0 means
             sparse vector search only and 1 means dense vector search only.
-            The default value is 0.5.
+            The default value is 0.5. Deprecated. Use
+            rag_retrieval_config.hybrid_search.alpha instead.
         rag_retrieval_config: Optional. The config containing the retrieval
-            parameters, including similarity_top_k, vector_distance_threshold,
-            vector_search_alpha, and hybrid_search.
+            parameters, including top_k, vector_distance_threshold,
+            and alpha.
 
     Returns:
         RetrieveContextsResonse.

vertexai/preview/rag/rag_store.py

@@ -61,14 +61,32 @@ def __init__(
 
         vertexai.init(project="my-project")
 
-        results = vertexai.preview.rag.retrieval_query(
-            text="Why is the sky blue?",
-            rag_resources=[vertexai.preview.rag.RagResource(
-                rag_corpus="projects/my-project/locations/us-central1/ragCorpora/rag-corpus-1",
-                rag_file_ids=["rag-file-1", "rag-file-2", ...],
-            )],
-            similarity_top_k=2,
-            vector_distance_threshold=0.5,
+        # Using deprecated parameters
+        tool = Tool.from_retrieval(
+            retrieval=vertexai.preview.rag.Retrieval(
+                source=vertexai.preview.rag.VertexRagStore(
+                    rag_corpora=["projects/my-project/locations/us-central1/ragCorpora/rag-corpus-1"],
+                    similarity_top_k=3,
+                    vector_distance_threshold=0.4,
+                ),
+            )
+        )
+
+        # Using RagRetrievalConfig. Equivalent to the above example.
+        config = vertexai.preview.rag.RagRetrievalConfig(
+            top_k=2,
+            filter=vertexai.preview.rag.RagRetrievalConfig.Filter(
+                vector_distance_threshold=0.5
+            ),
+        )
+
+        tool = Tool.from_retrieval(
+            retrieval=vertexai.preview.rag.Retrieval(
+                source=vertexai.preview.rag.VertexRagStore(
+                    rag_corpora=["projects/my-project/locations/us-central1/ragCorpora/rag-corpus-1"],
+                    rag_retrieval_config=config,
+                ),
+            )
         )
         ```
 
@@ -78,16 +96,15 @@ def __init__(
                 corpus or multiple files from one corpus. In the future we
                 may open up multiple corpora support.
             rag_corpora: If rag_resources is not specified, use rag_corpora as a
-                list of rag corpora names.
+                list of rag corpora names. Deprecated. Use rag_resources instead.
             similarity_top_k: Number of top k results to return from the selected
-                corpora.
+                corpora. Deprecated. Use rag_retrieval_config.top_k instead.
             vector_distance_threshold (float):
                 Optional. Only return results with vector distance smaller
-                than the threshold.
+                than the threshold. Deprecated. Use
+                rag_retrieval_config.filter.vector_distance_threshold instead.
             rag_retrieval_config: Optional. The config containing the retrieval
-                parameters, including similarity_top_k, hybrid search alpha,
-                and vector_distance_threshold.
-
+                parameters, including top_k and vector_distance_threshold.
         """
 
         if rag_resources:

vertexai/rag/rag_retrieval.py

@@ -38,14 +38,20 @@ def retrieval_query(
 
     vertexai.init(project="my-project")
 
-    results = vertexai.preview.rag.retrieval_query(
+    config = vertexai.rag.rag_retrieval_config(
+        top_k=2,
+        filter=vertexai.rag.rag_retrieval_config.filter(
+            vector_distance_threshold=0.5
+        ),
+    )
+
+    results = vertexai.rag.retrieval_query(
         text="Why is the sky blue?",
-        rag_resources=[vertexai.preview.rag.RagResource(
+        rag_resources=[vertexai.rag.RagResource(
             rag_corpus="projects/my-project/locations/us-central1/ragCorpora/rag-corpus-1",
             rag_file_ids=["rag-file-1", "rag-file-2", ...],
         )],
-        similarity_top_k=2,
-        vector_distance_threshold=0.5,
+        rag_retrieval_config=config,
     )
     ```
 
@@ -55,8 +61,7 @@ def retrieval_query(
             only or ragfiles. Currently only support one corpus or multiple files
             from one corpus. In the future we may open up multiple corpora support.
         rag_retrieval_config: Optional. The config containing the retrieval
-            parameters, including similarity_top_k, vector_distance_threshold,
-            and hybrid_search.
+            parameters, including similarity_top_k and vector_distance_threshold
 
     Returns:
         RetrieveContextsResonse.

vertexai/rag/rag_store.py

@@ -57,20 +57,20 @@ def __init__(
 
         vertexai.init(project="my-project")
 
-        config = vertexai.preview.rag.RagRetrievalConfig(
+        config = vertexai.rag.RagRetrievalConfig(
             top_k=2,
-            filter=vertexai.preview.rag.RagRetrievalConfig.Filter(
+            filter=vertexai.rag.RagRetrievalConfig.Filter(
                 vector_distance_threshold=0.5
             ),
         )
 
-        results = vertexai.preview.rag.retrieval_query(
-            text="Why is the sky blue?",
-            rag_resources=[vertexai.preview.rag.RagResource(
-                rag_corpus="projects/my-project/locations/us-central1/ragCorpora/rag-corpus-1",
-                rag_file_ids=["rag-file-1", "rag-file-2", ...],
-            )],
-            rag_retrieval_config=config,
+        tool = Tool.from_retrieval(
+            retrieval=vertexai.rag.Retrieval(
+                source=vertexai.rag.VertexRagStore(
+                    rag_corpora=["projects/my-project/locations/us-central1/ragCorpora/rag-corpus-1"],
+                    rag_retrieval_config=config,
+                ),
+            )
         )
         ```