Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add Vector Index API #25436

Merged
merged 2 commits into from
Mar 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -77,10 +77,36 @@ class Index
# @!attribute [rw] array_config
# @return [::Google::Cloud::Firestore::Admin::V1::Index::IndexField::ArrayConfig]
# Indicates that this field supports operations on `array_value`s.
# @!attribute [rw] vector_config
# @return [::Google::Cloud::Firestore::Admin::V1::Index::IndexField::VectorConfig]
# Indicates that this field supports nearest neighbors and distance
# operations on vector.
class IndexField
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods

# The index configuration to support vector search operations
# @!attribute [rw] dimension
# @return [::Integer]
# Required. The vector dimension this configuration applies to.
#
# The resulting index will only include vectors of this dimension, and
# can be used for vector search with the same dimension.
# @!attribute [rw] flat
# @return [::Google::Cloud::Firestore::Admin::V1::Index::IndexField::VectorConfig::FlatIndex]
# Indicates the vector index is a flat index.
class VectorConfig
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods

# An index that stores vectors in a flat data structure, and supports
# exhaustive search.
class FlatIndex
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
end

# The supported orderings.
module Order
# The ordering is unspecified. Not a valid option.
Expand Down