Skip to content

Commit

Permalink
Merge pull request #60 from hackgoofer/main
Browse files Browse the repository at this point in the history
correct docstrings for adapters change
  • Loading branch information
olirice authored Nov 16, 2023
2 parents 7680c01 + 2163145 commit 866ce8b
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions src/vecs/collection.py
Original file line number Diff line number Diff line change
Expand Up @@ -321,9 +321,12 @@ def upsert(
Inserts or updates *vectors* records in the collection.
Args:
vectors (Iterable[Tuple[str, Any, Metadata]]): An iterable of vectors to upsert.
Each vector is represented as a tuple where the first element is a unique string identifier,
the second element is an iterable of numeric values, and the third element is metadata associated with the vector.
records (Iterable[Tuple[str, Any, Metadata]]): An iterable of content to upsert.
Each record is a tuple where:
- the first element is a unique string identifier
- the second element is an iterable of numeric values or relevant input type for the
adapter assigned to the collection
- the third element is metadata associated with the vector
skip_adapter (bool): Should the adapter be skipped while upserting. i.e. if vectors are being
provided, rather than a media type that needs to be transformed
Expand Down Expand Up @@ -460,7 +463,7 @@ def query(
The return type is dependent on arguments *include_value* and *include_metadata*
Args:
query_vector (Any): The vector to use as the query.
data (Any): The vector to use as the query.
limit (int, optional): The maximum number of results to return. Defaults to 10.
filters (Optional[Dict], optional): Filters to apply to the search. Defaults to None.
measure (Union[IndexMeasure, str], optional): The distance measure to use for the search. Defaults to 'cosine_distance'.
Expand Down

0 comments on commit 866ce8b

Please sign in to comment.