You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/api/retrieval_model_clients/SnowflakeRM.md
+6-4Lines changed: 6 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
---
2
-
sidebar_position:
2
+
sidebar_position:
3
3
---
4
4
5
5
# retrieve.SnowflakeRM
@@ -20,6 +20,7 @@ SnowflakeRM(
20
20
```
21
21
22
22
**Parameters:**
23
+
23
24
-`snowflake_table_name (str)`: The name of the Snowflake table containing embeddings.
24
25
-`snowflake_credentials (dict)`: The connection parameters needed to initialize a Snowflake Snowpark Session.
25
26
-`k (int, optional)`: The number of top passages to retrieve. Defaults to 3.
@@ -34,10 +35,12 @@ SnowflakeRM(
34
35
Search the Snowflake table for the top `k` passages matching the given query or queries, using embeddings generated via the default `e5-base-v2` model or the specified `embedding_model`.
35
36
36
37
**Parameters:**
38
+
37
39
-`query_or_queries` (_Union[str, List[str]]_): The query or list of queries to search for.
38
40
-`k` (_Optional[int]_, _optional_): The number of results to retrieve. If not specified, defaults to the value set during initialization.
39
41
40
42
**Returns:**
43
+
41
44
-`dspy.Prediction`: Contains the retrieved passages, each represented as a `dotdict` with schema `[{"id": str, "score": float, "long_text": str, "metadatas": dict }]`
42
45
43
46
### Quickstart
@@ -53,14 +56,14 @@ from dspy.retrieve.snowflake_rm import SnowflakeRM
0 commit comments