Skip to main content

Function

Addedv2.6.x

Defines a built-in function (e.g., BM25, text embedding) that can be attached to a collection schema.

type Function struct {
    Name string
    Description string
    Type FunctionType
    InputFieldNames []string
    OutputFieldNames []string
    Params map[string]string
}

Constructor​

entity.NewFunction().
    WithName(name).
    WithInputFields(inputFields).
    WithOutputFields(outputFields).
    WithType(funcType).
    // ...

BUILDER METHODS:

  • WithName(name string)

    Sets the name of the function.

  • WithInputFields(inputFields ...string)

    Sets the input field names for the function.

  • WithOutputFields(outputFields ...string)

    Sets the output field names for the function.

  • WithType(funcType FunctionType)

    Sets the function type (BM25, TextEmbedding, Rerank).

  • WithParam(key string, value any)

    Sets a function parameter key-value pair.

Example​

import (
    "github.com/milvus-io/milvus/client/v2/entity"
)

// Define a BM25 text embedding function on a VarChar field
fn := entity.NewFunction().
    WithName("bm25_fn").
    WithFunctionType(entity.FunctionTypeBM25).
    WithInputFields("text").
    WithOutputFields("sparse_vector")

schema := entity.NewSchema().
    WithName("my_collection").
    WithField(entity.NewField().WithName("id").WithDataType(entity.FieldTypeInt64).WithIsPrimaryKey(true)).
    WithField(entity.NewField().WithName("text").WithDataType(entity.FieldTypeVarChar).WithMaxLength(1000).WithEnableAnalyzer(true)).
    WithField(entity.NewField().WithName("sparse_vector").WithDataType(entity.FieldTypeSparseVector)).
    WithFunction(fn)