Skip to content

Commit f2859f3

Browse files
committed
add docstring clarification
1 parent 2bbbaf4 commit f2859f3

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

bigframes/bigquery/__init__.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,8 @@ def vector_search(
175175
>>> import bigframes.bigquery as bbq
176176
>>> bpd.options.display.progress_bar = None
177177
178-
DataFrame embeddings for which to find nearest neighbors:
178+
DataFrame embeddings for which to find nearest neighbors, and ARRAY<FLOAT> column
179+
is used as the search query:
179180
180181
>>> search_query = bpd.DataFrame({"query_id": ["dog", "cat"],
181182
... "embedding": [[1.0, 2.0], [3.0, 5.2]]})
@@ -210,7 +211,9 @@ def vector_search(
210211
<BLANKLINE>
211212
[4 rows x 4 columns]
212213
213-
You can specify the name of the column in the query DataFrame embeddings and distance type:
214+
You can specify the name of the column in the query DataFrame embeddings and distance type.
215+
If you specify query_column_to_search_value, it will use the provided column which contains
216+
the embeddings for which to find nearest neighbors. Otherwiese, it uses the column_to_search value.
214217
215218
>>> search_query = bpd.DataFrame({"query_id": ["dog", "cat"],
216219
... "embedding": [[1.0, 2.0], [3.0, 5.2]],

0 commit comments

Comments
 (0)