Method bind_index_params

src/binding/python/model/param/python_param.cc:131–1179

}

void ZVecPyParams::bind_index_params(pybind11::module_ &m) {
  // binding base index params
  py::class_<IndexParams, std::shared_ptr<IndexParams>> index_params(
      m, "IndexParam", R"pbdoc(
Base class for all index parameter configurations.

This abstract base class defines the common interface for index types.
It should not be instantiated directly; use derived classes instead.

Attributes:
    type (IndexType): The type of the index (e.g., HNSW, FLAT, INVERT).
)pbdoc");
  index_params
      .def_property_readonly(
          "type",
          [](const IndexParams &self) -> IndexType { return self.type(); },
          "IndexType: The type of the index.")
      .def("clone", &IndexParams::clone, py::return_value_policy::copy)
      .def(
          "__eq__",
          [](const IndexParams &self, const py::object &other) {
            if (!py::isinstance<IndexParams>(other)) return false;
            return self == other.cast<const IndexParams &>();
          },
          py::is_operator())
      .def(
          "to_dict",
          [](const IndexParams &self) -> py::dict {
            py::dict dict;
            dict["type"] = index_type_to_string(self.type());
            return dict;
          },
          "Convert to dictionary with all fields")
      .def(py::pickle(
          [](const IndexParams &self) {  // __getstate__
            return py::make_tuple(self.type());
          },
          [](py::tuple t) {  // __setstate__
            if (t.size() != 1)
              throw std::runtime_error("Invalid state for IndexParams");
            return std::shared_ptr<IndexParams>();
          }));

  // binding invert index params
  py::class_<InvertIndexParams, IndexParams, std::shared_ptr<InvertIndexParams>>
      invert_params(m, "InvertIndexParam", R"pbdoc(
Parameters for configuring an invert index.

This class controls whether range query
optimization is enabled for invert index structures.

Attributes:
    type (IndexType): Always `IndexType.INVERTED`.
    enable_range_optimization (bool): Whether range optimization is enabled.
    enable_extended_wildcard (bool): Whether extended wildcard (suffix and infix) search is enabled.

Examples:
    >>> params = InvertIndexParam(enable_range_optimization=True, enable_extended_wildcard=False)