Class: Google::Cloud::AIPlatform::V1::FindNeighborsRequest

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

Overview

The request message for MatchService.FindNeighbors.

Defined Under Namespace

Classes: Query

Instance Attribute Summary collapse

Instance Attribute Details

#deployed_index_id ⇒ ::String

Returns The ID of the DeployedIndex that will serve the request. This request is sent to a specific IndexEndpoint, as per the IndexEndpoint.network. That IndexEndpoint also has IndexEndpoint.deployed_indexes, and each such index has a DeployedIndex.id field. The value of the field below must equal one of the DeployedIndex.id fields of the IndexEndpoint that is being called for this request.

Returns:

  • (::String) —

    The ID of the DeployedIndex that will serve the request. This request is sent to a specific IndexEndpoint, as per the IndexEndpoint.network. That IndexEndpoint also has IndexEndpoint.deployed_indexes, and each such index has a DeployedIndex.id field. The value of the field below must equal one of the DeployedIndex.id fields of the IndexEndpoint that is being called for this request.



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'proto_docs/google/cloud/aiplatform/v1/match_service.rb', line 48

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

  # A query to find a number of the nearest neighbors (most similar vectors)
  # of a vector.
  # @!attribute [rw] rrf
  #   @return [::Google::Cloud::AIPlatform::V1::FindNeighborsRequest::Query::RRF]
  #     Optional. Represents RRF algorithm that combines search results.
  # @!attribute [rw] datapoint
  #   @return [::Google::Cloud::AIPlatform::V1::IndexDatapoint]
  #     Required. The datapoint/vector whose nearest neighbors should be searched
  #     for.
  # @!attribute [rw] neighbor_count
  #   @return [::Integer]
  #     The number of nearest neighbors to be retrieved from database for each
  #     query. If not set, will use the default from the service configuration
  #     (https://cloud.google.com/vertex-ai/docs/matching-engine/configuring-indexes#nearest-neighbor-search-config).
  # @!attribute [rw] per_crowding_attribute_neighbor_count
  #   @return [::Integer]
  #     Crowding 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.
  #     It's used for improving result diversity.
  #     This field is the maximum number of matches with the same crowding tag.
  # @!attribute [rw] approximate_neighbor_count
  #   @return [::Integer]
  #     The number of neighbors to find via approximate search before
  #     exact reordering is performed. If not set, the default value from scam
  #     config is used; if set, this value must be > 0.
  # @!attribute [rw] fraction_leaf_nodes_to_search_override
  #   @return [::Float]
  #     The fraction of the number of leaves to search, set at query time allows
  #     user to tune search performance. This value increase result in both
  #     search accuracy and latency increase. The value should be between 0.0
  #     and 1.0. If not set or set to 0.0, query uses the default value specified
  #     in
  #     NearestNeighborSearchConfig.TreeAHConfig.fraction_leaf_nodes_to_search.
  class Query
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Parameters for RRF algorithm that combines search results.
    # @!attribute [rw] alpha
    #   @return [::Float]
    #     Required. Users can provide an alpha value to give more weight to dense
    #     vs sparse results. For example, if the alpha is 0, we only return
    #     sparse and if the alpha is 1, we only return dense.
    class RRF
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#index_endpoint ⇒ ::String

Returns Required. The name of the index endpoint. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}.

Returns:

  • (::String) —

    Required. The name of the index endpoint. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'proto_docs/google/cloud/aiplatform/v1/match_service.rb', line 48

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

  # A query to find a number of the nearest neighbors (most similar vectors)
  # of a vector.
  # @!attribute [rw] rrf
  #   @return [::Google::Cloud::AIPlatform::V1::FindNeighborsRequest::Query::RRF]
  #     Optional. Represents RRF algorithm that combines search results.
  # @!attribute [rw] datapoint
  #   @return [::Google::Cloud::AIPlatform::V1::IndexDatapoint]
  #     Required. The datapoint/vector whose nearest neighbors should be searched
  #     for.
  # @!attribute [rw] neighbor_count
  #   @return [::Integer]
  #     The number of nearest neighbors to be retrieved from database for each
  #     query. If not set, will use the default from the service configuration
  #     (https://cloud.google.com/vertex-ai/docs/matching-engine/configuring-indexes#nearest-neighbor-search-config).
  # @!attribute [rw] per_crowding_attribute_neighbor_count
  #   @return [::Integer]
  #     Crowding 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.
  #     It's used for improving result diversity.
  #     This field is the maximum number of matches with the same crowding tag.
  # @!attribute [rw] approximate_neighbor_count
  #   @return [::Integer]
  #     The number of neighbors to find via approximate search before
  #     exact reordering is performed. If not set, the default value from scam
  #     config is used; if set, this value must be > 0.
  # @!attribute [rw] fraction_leaf_nodes_to_search_override
  #   @return [::Float]
  #     The fraction of the number of leaves to search, set at query time allows
  #     user to tune search performance. This value increase result in both
  #     search accuracy and latency increase. The value should be between 0.0
  #     and 1.0. If not set or set to 0.0, query uses the default value specified
  #     in
  #     NearestNeighborSearchConfig.TreeAHConfig.fraction_leaf_nodes_to_search.
  class Query
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Parameters for RRF algorithm that combines search results.
    # @!attribute [rw] alpha
    #   @return [::Float]
    #     Required. Users can provide an alpha value to give more weight to dense
    #     vs sparse results. For example, if the alpha is 0, we only return
    #     sparse and if the alpha is 1, we only return dense.
    class RRF
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#queries ⇒ ::Array<::Google::Cloud::AIPlatform::V1::FindNeighborsRequest::Query>

Returns The list of queries.

Returns:



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'proto_docs/google/cloud/aiplatform/v1/match_service.rb', line 48

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

  # A query to find a number of the nearest neighbors (most similar vectors)
  # of a vector.
  # @!attribute [rw] rrf
  #   @return [::Google::Cloud::AIPlatform::V1::FindNeighborsRequest::Query::RRF]
  #     Optional. Represents RRF algorithm that combines search results.
  # @!attribute [rw] datapoint
  #   @return [::Google::Cloud::AIPlatform::V1::IndexDatapoint]
  #     Required. The datapoint/vector whose nearest neighbors should be searched
  #     for.
  # @!attribute [rw] neighbor_count
  #   @return [::Integer]
  #     The number of nearest neighbors to be retrieved from database for each
  #     query. If not set, will use the default from the service configuration
  #     (https://cloud.google.com/vertex-ai/docs/matching-engine/configuring-indexes#nearest-neighbor-search-config).
  # @!attribute [rw] per_crowding_attribute_neighbor_count
  #   @return [::Integer]
  #     Crowding 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.
  #     It's used for improving result diversity.
  #     This field is the maximum number of matches with the same crowding tag.
  # @!attribute [rw] approximate_neighbor_count
  #   @return [::Integer]
  #     The number of neighbors to find via approximate search before
  #     exact reordering is performed. If not set, the default value from scam
  #     config is used; if set, this value must be > 0.
  # @!attribute [rw] fraction_leaf_nodes_to_search_override
  #   @return [::Float]
  #     The fraction of the number of leaves to search, set at query time allows
  #     user to tune search performance. This value increase result in both
  #     search accuracy and latency increase. The value should be between 0.0
  #     and 1.0. If not set or set to 0.0, query uses the default value specified
  #     in
  #     NearestNeighborSearchConfig.TreeAHConfig.fraction_leaf_nodes_to_search.
  class Query
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Parameters for RRF algorithm that combines search results.
    # @!attribute [rw] alpha
    #   @return [::Float]
    #     Required. Users can provide an alpha value to give more weight to dense
    #     vs sparse results. For example, if the alpha is 0, we only return
    #     sparse and if the alpha is 1, we only return dense.
    class RRF
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#return_full_datapoint ⇒ ::Boolean

Returns If set to true, the full datapoints (including all vector values and restricts) of the nearest neighbors are returned. Note that returning full datapoint will significantly increase the latency and cost of the query.

Returns:

  • (::Boolean) —

    If set to true, the full datapoints (including all vector values and restricts) of the nearest neighbors are returned. Note that returning full datapoint will significantly increase the latency and cost of the query.



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'proto_docs/google/cloud/aiplatform/v1/match_service.rb', line 48

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

  # A query to find a number of the nearest neighbors (most similar vectors)
  # of a vector.
  # @!attribute [rw] rrf
  #   @return [::Google::Cloud::AIPlatform::V1::FindNeighborsRequest::Query::RRF]
  #     Optional. Represents RRF algorithm that combines search results.
  # @!attribute [rw] datapoint
  #   @return [::Google::Cloud::AIPlatform::V1::IndexDatapoint]
  #     Required. The datapoint/vector whose nearest neighbors should be searched
  #     for.
  # @!attribute [rw] neighbor_count
  #   @return [::Integer]
  #     The number of nearest neighbors to be retrieved from database for each
  #     query. If not set, will use the default from the service configuration
  #     (https://cloud.google.com/vertex-ai/docs/matching-engine/configuring-indexes#nearest-neighbor-search-config).
  # @!attribute [rw] per_crowding_attribute_neighbor_count
  #   @return [::Integer]
  #     Crowding 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.
  #     It's used for improving result diversity.
  #     This field is the maximum number of matches with the same crowding tag.
  # @!attribute [rw] approximate_neighbor_count
  #   @return [::Integer]
  #     The number of neighbors to find via approximate search before
  #     exact reordering is performed. If not set, the default value from scam
  #     config is used; if set, this value must be > 0.
  # @!attribute [rw] fraction_leaf_nodes_to_search_override
  #   @return [::Float]
  #     The fraction of the number of leaves to search, set at query time allows
  #     user to tune search performance. This value increase result in both
  #     search accuracy and latency increase. The value should be between 0.0
  #     and 1.0. If not set or set to 0.0, query uses the default value specified
  #     in
  #     NearestNeighborSearchConfig.TreeAHConfig.fraction_leaf_nodes_to_search.
  class Query
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Parameters for RRF algorithm that combines search results.
    # @!attribute [rw] alpha
    #   @return [::Float]
    #     Required. Users can provide an alpha value to give more weight to dense
    #     vs sparse results. For example, if the alpha is 0, we only return
    #     sparse and if the alpha is 1, we only return dense.
    class RRF
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end