Module: Zvec::CollectionConvenience

Defined in:
lib/zvec/collection.rb

Instance Method Summary collapse

Instance Method Details

#query_vector(field_name, vector, top_k:, filter: nil, include_vector: false, query_params: nil, output_fields: nil) ⇒ Object

Convenience: build a VectorQuery and execute it

Raises:

  • (ArgumentError)


6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
# File 'lib/zvec/collection.rb', line 6

def query_vector(field_name, vector, top_k:, filter: nil, include_vector: false, query_params: nil, output_fields: nil)
  vq = Zvec::VectorQuery.new
  vq.topk = top_k
  vq.field_name = field_name
  vq.filter = filter if filter
  vq.include_vector = include_vector
  vq.query_params = query_params if query_params
  vq.output_fields = output_fields if output_fields

  schema_obj = schema
  fs = schema_obj.get_field(field_name)
  raise ArgumentError, "Unknown field: #{field_name}" unless fs

  vq.set_vector(fs, vector)
  query(vq)
end