Method query

vicinity/vicinity.py:114–138

Find the nearest neighbors to some arbitrary vector. Use this to look up the nearest neighbors to a vector that is not in the vocabulary. :param vectors: The vectors to find the nearest neighbors to. :param k: The number of most similar items to retrieve. :

(
        self,
        vectors: npt.NDArray,
        k: int = 10,
    )

        return self.backend.arguments.metric

    def query(
        self,
        vectors: npt.NDArray,
        k: int = 10,
    ) -> SimilarityResult[T]:
        """
        Find the nearest neighbors to some arbitrary vector.

        Use this to look up the nearest neighbors to a vector that is not in the vocabulary.

        :param vectors: The vectors to find the nearest neighbors to.
        :param k: The number of most similar items to retrieve.
        :return: For each item in the input, the num most similar items are returned in the form of
            (NAME, DISTANCE) tuples.
        """
        vectors = np.asarray(vectors)
        if np.ndim(vectors) == 1:
            vectors = vectors[None, :]

        out = []
        for index, distances in self.backend.query(vectors, k):
            distances.clip(min=0, out=distances)
            out.append([(self.items[idx], dist) for idx, dist in zip(index, distances)])

        return out

    def query_threshold(
        self,