Vector Search V1 API - Class Google::Cloud::VectorSearch::V1::Index (v0.1.0)

Reference documentation and code samples for the Vector Search V1 API class Google::Cloud::VectorSearch::V1::Index.

Message describing Index object

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#dedicated_infrastructure

def dedicated_infrastructure() -> ::Google::Cloud::VectorSearch::V1::DedicatedInfrastructure
Returns

#dedicated_infrastructure=

def dedicated_infrastructure=(value) -> ::Google::Cloud::VectorSearch::V1::DedicatedInfrastructure
Parameter
Returns

#dense_scann

def dense_scann() -> ::Google::Cloud::VectorSearch::V1::DenseScannIndex
Returns

#dense_scann=

def dense_scann=(value) -> ::Google::Cloud::VectorSearch::V1::DenseScannIndex
Parameter
Returns

#description

def description() -> ::String
Returns
  • (::String) — Optional. User-specified description of the index

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Optional. User-specified description of the index
Returns
  • (::String) — Optional. User-specified description of the index

#display_name

def display_name() -> ::String
Returns
  • (::String) — Optional. User-specified display name of the index

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — Optional. User-specified display name of the index
Returns
  • (::String) — Optional. User-specified display name of the index

#distance_metric

def distance_metric() -> ::Google::Cloud::VectorSearch::V1::DistanceMetric
Returns

#distance_metric=

def distance_metric=(value) -> ::Google::Cloud::VectorSearch::V1::DistanceMetric
Parameter
Returns

#filter_fields

def filter_fields() -> ::Array<::String>
Returns
  • (::Array<::String>) — Optional. The fields to push into the index to enable fast ANN inline filtering.

#filter_fields=

def filter_fields=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Optional. The fields to push into the index to enable fast ANN inline filtering.
Returns
  • (::Array<::String>) — Optional. The fields to push into the index to enable fast ANN inline filtering.

#index_field

def index_field() -> ::String
Returns
  • (::String) — Required. The collection schema field to index.

#index_field=

def index_field=(value) -> ::String
Parameter
  • value (::String) — Required. The collection schema field to index.
Returns
  • (::String) — Required. The collection schema field to index.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. Labels as key value pairs.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Optional. Labels as key value pairs.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. Labels as key value pairs.

#name

def name() -> ::String
Returns
  • (::String) — Identifier. name of resource

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Identifier. name of resource
Returns
  • (::String) — Identifier. name of resource

#store_fields

def store_fields() -> ::Array<::String>
Returns
  • (::Array<::String>) — Optional. The fields to push into the index to enable inline data retrieval.

#store_fields=

def store_fields=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Optional. The fields to push into the index to enable inline data retrieval.
Returns
  • (::Array<::String>) — Optional. The fields to push into the index to enable inline data retrieval.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns