Class VectorQuery

couchbase/logic/vector_search.py:30–185

Represents a vector query. Args: field_name (str): The name of the field in the search index that stores the vector. vector (Union[List[float], str]): The vector to use in the query. num_candidates (int, optional): Specifies the number of results returned. If provided,

class VectorQuery:
    """ Represents a vector query.

    Args:
        field_name (str): The name of the field in the search index that stores the vector.
        vector (Union[List[float], str]): The vector to use in the query.
        num_candidates (int, optional): Specifies the number of results returned. If provided, must be greater or equal to 1.
        boost (float, optional): Add boost to query.
        prefilter (`~couchbase.search.SearchQuery`, optional): Specifies a pre-filter to use for the vector query.

    Raises:
        :class:`~couchbase.exceptions.InvalidArgumentException`: If the vector is not provided.
        :class:`~couchbase.exceptions.InvalidArgumentException`: If the vector is not a list or str.
        :class:`~couchbase.exceptions.InvalidArgumentException`: If vector is a list and all values of the provided vector are not instances of float.

    Returns:
        :class:`~couchbase.vector_search.VectorQuery`: The created vector query.
    """  # noqa: E501

    def __init__(self,
                 field_name,  # type: str
                 vector,  # type: Union[List[float], str]
                 num_candidates=None,  # type: Optional[int]
                 boost=None,  # type: Optional[float]
                 prefilter=None,  # type: Optional[SearchQuery]
                 ):
        if is_null_or_empty(field_name):
            raise InvalidArgumentException('Must provide a field name.')
        self._field_name = field_name
        self._vector = None
        self._vector_base64 = None
        self._validate_and_set_vector(vector)
        self._num_candidates = self._boost = self._prefilter = None
        if num_candidates is not None:
            self.num_candidates = num_candidates
        if boost is not None:
            self.boost = boost
        if prefilter is not None:
            self.prefilter = prefilter

    @property
    def boost(self) -> Optional[float]:
        """
        Optional[float]: Returns vector query's boost value, if it exists.
        """
        return self._boost

    @boost.setter
    def boost(self,
              value  # type: float
              ):
        if not isinstance(value, float):
            raise InvalidArgumentException('boost must be a float.')
        self._boost = value

    @property
    def field_name(self) -> str:
        """