io.github.honhimw.ms.Experimental Maven / Gradle / Ivy

Go to download
/*
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.github.honhimw.ms;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Marked experimental features
 *
 * @author hon_him
 * @since 2024-01-17
 */

@Target({ElementType.METHOD, ElementType.FIELD, ElementType.TYPE})
@Retention(RetentionPolicy.SOURCE)
public @interface Experimental {

    /**
     * Experimental features
     *
     * @return Experimental features
     */
    Features[] features() default {};

    /**
     * Experimental features
     */
    enum Features {
        /**
         * Vector search
         */
        VECTOR_SEARCH,

        /**
         * edit_documents_by_function
         */
        EDIT_DOCUMENTS_BY_FUNCTION
    }

}