BM25BuiltInFunction#

class langchain_milvus.function.BM25BuiltInFunction(*, input_field_names: str = 'text', output_field_names: str = 'sparse', analyzer_params: Dict[Any, Any] | None = None, enable_match: bool = False, function_name: str | None = None)[source]#

Milvus BM25 built-in function.

See: https://milvus.io/docs/full-text-search.md

Parameters:
  • input_field_names (str) – The name of the input field, default is β€˜text’.

  • output_field_names (str) – The name of the output field, default is β€˜sparse’.

  • analyzer_params (Optional[Dict[Any, Any]]) – The parameters for the analyzer. Default is None. See: https://milvus.io/docs/analyzer-overview.md#Analyzer-Overview

  • enable_match (bool) – Whether to enable match.

  • function_name (Optional[str]) – The name of the function. Default is None, which means a random name will be generated.

Attributes

function

input_field_names

output_field_names

type

Methods

__init__(*[,Β input_field_names,Β ...])

get_input_field_schema_kwargs()

__init__(*, input_field_names: str = 'text', output_field_names: str = 'sparse', analyzer_params: Dict[Any, Any] | None = None, enable_match: bool = False, function_name: str | None = None)[source]#
Parameters:
  • input_field_names (str) – The name of the input field, default is β€˜text’.

  • output_field_names (str) – The name of the output field, default is β€˜sparse’.

  • analyzer_params (Optional[Dict[Any, Any]]) – The parameters for the analyzer. Default is None. See: https://milvus.io/docs/analyzer-overview.md#Analyzer-Overview

  • enable_match (bool) – Whether to enable match.

  • function_name (Optional[str]) – The name of the function. Default is None, which means a random name will be generated.

get_input_field_schema_kwargs() β†’ dict[source]#
Return type:

dict