Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1IndexDatapoint

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1beta1/classes.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb

Overview

A datapoint of Index.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1beta1IndexDatapoint

Returns a new instance of GoogleCloudAiplatformV1beta1IndexDatapoint.



21943
21944
21945
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 21943

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#crowding_tag ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1IndexDatapointCrowdingTag

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. Corresponds to the JSON property crowdingTag

Returns:



21904
21905
21906
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 21904

def crowding_tag
  @crowding_tag
end

#datapoint_id ⇒ String

Required. Unique identifier of the datapoint. Corresponds to the JSON property datapointId

Returns:

  • (String) 


21909
21910
21911
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 21909

def datapoint_id
  @datapoint_id
end

#embedding_metadata ⇒ Hash<String,Object>

Optional. The key-value map of additional metadata for the datapoint. Corresponds to the JSON property embeddingMetadata

Returns:

  • (Hash<String,Object>) 


21914
21915
21916
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 21914

def embedding_metadata
  @embedding_metadata
end

#feature_vector ⇒ Array<Float>

Required. Feature embedding vector for dense index. An array of numbers with the length of [NearestNeighborSearchConfig.dimensions]. Corresponds to the JSON property featureVector

Returns:

  • (Array<Float>) 


21920
21921
21922
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 21920

def feature_vector
  @feature_vector
end

#numeric_restricts ⇒ Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1IndexDatapointNumericRestriction>

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. This uses numeric comparisons. Corresponds to the JSON property numericRestricts

Returns:



21927
21928
21929
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 21927

def numeric_restricts
  @numeric_restricts
end

#restricts ⇒ Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1IndexDatapointRestriction>

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. This uses categorical tokens. See: https://cloud.google. com/vertex-ai/docs/matching-engine/filtering Corresponds to the JSON property restricts

Returns:



21935
21936
21937
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 21935

def restricts
  @restricts
end

#sparse_embedding ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1IndexDatapointSparseEmbedding

Feature embedding vector for sparse index. An array of numbers whose values are located in the specified dimensions. Corresponds to the JSON property sparseEmbedding

Returns:



21941
21942
21943
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 21941

def sparse_embedding
  @sparse_embedding
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



21948
21949
21950
21951
21952
21953
21954
21955
21956
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 21948

def update!(**args)
  @crowding_tag = args[:crowding_tag] if args.key?(:crowding_tag)
  @datapoint_id = args[:datapoint_id] if args.key?(:datapoint_id)
  @embedding_metadata = args[:embedding_metadata] if args.key?(:embedding_metadata)
  @feature_vector = args[:feature_vector] if args.key?(:feature_vector)
  @numeric_restricts = args[:numeric_restricts] if args.key?(:numeric_restricts)
  @restricts = args[:restricts] if args.key?(:restricts)
  @sparse_embedding = args[:sparse_embedding] if args.key?(:sparse_embedding)
end