Class: Google::Cloud::AIPlatform::V1::IndexDatapoint

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/aiplatform/v1/index.rb

Overview

A datapoint of Index.

Defined Under Namespace

Classes: CrowdingTag, Restriction

Instance Attribute Summary collapse

Instance Attribute Details

#crowding_tag ⇒ ::Google::Cloud::AIPlatform::V1::IndexDatapoint::CrowdingTag

Returns Optional. CrowdingTag of the datapoint, the number of neighbors to return in each crowding can be configured during query.

Returns:



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'proto_docs/google/cloud/aiplatform/v1/index.rb', line 136

class IndexDatapoint
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Restriction of a datapoint which describe its attributes(tokens) from each
  # of several attribute categories(namespaces).
  # @!attribute [rw] namespace
  #   @return [::String]
  #     The namespace of this restriction. eg: color.
  # @!attribute [rw] allow_list
  #   @return [::Array<::String>]
  #     The attributes to allow in this namespace. eg: 'red'
  # @!attribute [rw] deny_list
  #   @return [::Array<::String>]
  #     The attributes to deny in this namespace. eg: 'blue'
  class Restriction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Crowding tag is a constraint on a neighbor list produced by nearest
  # neighbor search requiring that no more than some value k' of the k
  # neighbors returned have the same value of crowding_attribute.
  # @!attribute [rw] crowding_attribute
  #   @return [::String]
  #     The attribute value used for crowding.  The maximum number of neighbors
  #     to return per crowding attribute value
  #     (per_crowding_attribute_num_neighbors) is configured per-query. This
  #     field is ignored if per_crowding_attribute_num_neighbors is larger than
  #     the total number of neighbors to return for a given query.
  class CrowdingTag
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#datapoint_id ⇒ ::String

Returns Required. Unique identifier of the datapoint.

Returns:

  • (::String) —

    Required. Unique identifier of the datapoint.



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'proto_docs/google/cloud/aiplatform/v1/index.rb', line 136

class IndexDatapoint
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Restriction of a datapoint which describe its attributes(tokens) from each
  # of several attribute categories(namespaces).
  # @!attribute [rw] namespace
  #   @return [::String]
  #     The namespace of this restriction. eg: color.
  # @!attribute [rw] allow_list
  #   @return [::Array<::String>]
  #     The attributes to allow in this namespace. eg: 'red'
  # @!attribute [rw] deny_list
  #   @return [::Array<::String>]
  #     The attributes to deny in this namespace. eg: 'blue'
  class Restriction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Crowding tag is a constraint on a neighbor list produced by nearest
  # neighbor search requiring that no more than some value k' of the k
  # neighbors returned have the same value of crowding_attribute.
  # @!attribute [rw] crowding_attribute
  #   @return [::String]
  #     The attribute value used for crowding.  The maximum number of neighbors
  #     to return per crowding attribute value
  #     (per_crowding_attribute_num_neighbors) is configured per-query. This
  #     field is ignored if per_crowding_attribute_num_neighbors is larger than
  #     the total number of neighbors to return for a given query.
  class CrowdingTag
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#feature_vector ⇒ ::Array<::Float>

Returns Required. Feature embedding vector. An array of numbers with the length of [NearestNeighborSearchConfig.dimensions].

Returns:

  • (::Array<::Float>) —

    Required. Feature embedding vector. An array of numbers with the length of [NearestNeighborSearchConfig.dimensions].



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'proto_docs/google/cloud/aiplatform/v1/index.rb', line 136

class IndexDatapoint
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Restriction of a datapoint which describe its attributes(tokens) from each
  # of several attribute categories(namespaces).
  # @!attribute [rw] namespace
  #   @return [::String]
  #     The namespace of this restriction. eg: color.
  # @!attribute [rw] allow_list
  #   @return [::Array<::String>]
  #     The attributes to allow in this namespace. eg: 'red'
  # @!attribute [rw] deny_list
  #   @return [::Array<::String>]
  #     The attributes to deny in this namespace. eg: 'blue'
  class Restriction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Crowding tag is a constraint on a neighbor list produced by nearest
  # neighbor search requiring that no more than some value k' of the k
  # neighbors returned have the same value of crowding_attribute.
  # @!attribute [rw] crowding_attribute
  #   @return [::String]
  #     The attribute value used for crowding.  The maximum number of neighbors
  #     to return per crowding attribute value
  #     (per_crowding_attribute_num_neighbors) is configured per-query. This
  #     field is ignored if per_crowding_attribute_num_neighbors is larger than
  #     the total number of neighbors to return for a given query.
  class CrowdingTag
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#restricts ⇒ ::Array<::Google::Cloud::AIPlatform::V1::IndexDatapoint::Restriction>

Returns Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering.

Returns:



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'proto_docs/google/cloud/aiplatform/v1/index.rb', line 136

class IndexDatapoint
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Restriction of a datapoint which describe its attributes(tokens) from each
  # of several attribute categories(namespaces).
  # @!attribute [rw] namespace
  #   @return [::String]
  #     The namespace of this restriction. eg: color.
  # @!attribute [rw] allow_list
  #   @return [::Array<::String>]
  #     The attributes to allow in this namespace. eg: 'red'
  # @!attribute [rw] deny_list
  #   @return [::Array<::String>]
  #     The attributes to deny in this namespace. eg: 'blue'
  class Restriction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Crowding tag is a constraint on a neighbor list produced by nearest
  # neighbor search requiring that no more than some value k' of the k
  # neighbors returned have the same value of crowding_attribute.
  # @!attribute [rw] crowding_attribute
  #   @return [::String]
  #     The attribute value used for crowding.  The maximum number of neighbors
  #     to return per crowding attribute value
  #     (per_crowding_attribute_num_neighbors) is configured per-query. This
  #     field is ignored if per_crowding_attribute_num_neighbors is larger than
  #     the total number of neighbors to return for a given query.
  class CrowdingTag
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end