Method create_index

python/zvec/model/collection.py:107–136

Create an index on a field. Vector index types (HNSW, IVF, FLAT) can only be applied to vector fields. Inverted index (`InvertIndexParam`) is for scalar fields. FTS index (`FtsIndexParam`) is for full-text search on STRING fields. Args: field_name (str):

(
        self,
        field_name: str,
        index_param: Union[
            HnswIndexParam,
            HnswRabitqIndexParam,
            IVFIndexParam,
            FlatIndexParam,
            InvertIndexParam,
            FtsIndexParam,
        ],
        option: IndexOption = IndexOption(),
    )

    # ========== Index DDL Methods ==========
    def create_index(
        self,
        field_name: str,
        index_param: Union[
            HnswIndexParam,
            HnswRabitqIndexParam,
            IVFIndexParam,
            FlatIndexParam,
            InvertIndexParam,
            FtsIndexParam,
        ],
        option: IndexOption = IndexOption(),
    ) -> None:
        """Create an index on a field.

        Vector index types (HNSW, IVF, FLAT) can only be applied to vector fields.
        Inverted index (`InvertIndexParam`) is for scalar fields.
        FTS index (`FtsIndexParam`) is for full-text search on STRING fields.

        Args:
            field_name (str): Name of the field to index.
            index_param (Union[HnswIndexParam, HnswRabitqIndexParam, IVFIndexParam, FlatIndexParam, InvertIndexParam, FtsIndexParam]):
                Index configuration.
            option (Optional[IndexOption], optional): Index creation options.
                Defaults to ``IndexOption()``.

        """
        self._obj.CreateIndex(field_name, index_param, option)
        self._schema = CollectionSchema._from_core(self._obj.Schema())
        self._querier._schema = self._schema

    def drop_index(self, field_name: str) -> None:
        """Remove the index from a field.