Skip to content

Commit

Permalink
🦉 Updates from OwlBot post-processor
Browse files Browse the repository at this point in the history
  • Loading branch information
gcf-owl-bot[bot] committed Jul 23, 2024
1 parent e23ef44 commit 53c7761
Show file tree
Hide file tree
Showing 218 changed files with 85 additions and 74,828 deletions.
2 changes: 1 addition & 1 deletion google/cloud/firestore_v1/types/document.py
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ class Value(proto.Message):
An array value.
Cannot directly contain another array value,
though can contain an map which contains another
though can contain a map which contains another
array.
This field is a member of `oneof`_ ``value_type``.
Expand Down
33 changes: 20 additions & 13 deletions google/cloud/firestore_v1/types/query.py
Original file line number Diff line number Diff line change
Expand Up @@ -153,8 +153,8 @@ class StructuredQuery(proto.Message):
- The value must be greater than or equal to zero if
specified.
find_nearest (google.cloud.firestore_v1.types.StructuredQuery.FindNearest):
Optional. A potential Nearest Neighbors
Search.
Optional. A potential nearest neighbors
search.
Applies after all other filters and ordering.
Finds the closest vector embeddings to the given
Expand Down Expand Up @@ -520,7 +520,10 @@ class Projection(proto.Message):
)

class FindNearest(proto.Message):
r"""Nearest Neighbors search config.
r"""Nearest Neighbors search config. The ordering provided by
FindNearest supersedes the order_by stage. If multiple documents
have the same vector distance, the returned document order is not
guaranteed to be stable between queries.
Attributes:
vector_field (google.cloud.firestore_v1.types.StructuredQuery.FieldReference):
Expand All @@ -532,7 +535,7 @@ class FindNearest(proto.Message):
searching on. Must be a vector of no more than
2048 dimensions.
distance_measure (google.cloud.firestore_v1.types.StructuredQuery.FindNearest.DistanceMeasure):
Required. The Distance Measure to use,
Required. The distance measure to use,
required.
limit (google.protobuf.wrappers_pb2.Int32Value):
Required. The number of nearest neighbors to
Expand All @@ -549,21 +552,25 @@ class DistanceMeasure(proto.Enum):
EUCLIDEAN (1):
Measures the EUCLIDEAN distance between the vectors. See
`Euclidean <https://en.wikipedia.org/wiki/Euclidean_distance>`__
to learn more
to learn more. The resulting distance decreases the more
similar two vectors are.
COSINE (2):
Compares vectors based on the angle between them, which
allows you to measure similarity that isn't based on the
vectors magnitude. We recommend using DOT_PRODUCT with unit
normalized vectors instead of COSINE distance, which is
mathematically equivalent with better performance. See
`Cosine
COSINE distance compares vectors based on the angle between
them, which allows you to measure similarity that isn't
based on the vectors magnitude. We recommend using
DOT_PRODUCT with unit normalized vectors instead of COSINE
distance, which is mathematically equivalent with better
performance. See `Cosine
Similarity <https://en.wikipedia.org/wiki/Cosine_similarity>`__
to learn more.
to learn more about COSINE similarity and COSINE distance.
The resulting COSINE distance decreases the more similar two
vectors are.
DOT_PRODUCT (3):
Similar to cosine but is affected by the magnitude of the
vectors. See `Dot
Product <https://en.wikipedia.org/wiki/Dot_product>`__ to
learn more.
learn more. The resulting distance increases the more
similar two vectors are.
"""
DISTANCE_MEASURE_UNSPECIFIED = 0
EUCLIDEAN = 1
Expand Down
13 changes: 0 additions & 13 deletions owl-bot-staging/firestore/v1/.coveragerc

This file was deleted.

33 changes: 0 additions & 33 deletions owl-bot-staging/firestore/v1/.flake8

This file was deleted.

2 changes: 0 additions & 2 deletions owl-bot-staging/firestore/v1/MANIFEST.in

This file was deleted.

49 changes: 0 additions & 49 deletions owl-bot-staging/firestore/v1/README.rst

This file was deleted.

3 changes: 0 additions & 3 deletions owl-bot-staging/firestore/v1/docs/_static/custom.css

This file was deleted.

Loading

0 comments on commit 53c7761

Please sign in to comment.