mp.tasks.retrieval.SemanticRetrieverOptions

Options for the semantic retriever task.

mp.tasks.retrieval.SemanticRetrieverOptions(
    embedder: mp.tasks.retrieval.UniversalEmbedder,
    embedding_dimension: int = _DEFAULT_EMBEDDING_DIMENSION,
    database_path: Optional[str] = None,
    chunk_size: int = 512,
    chunk_overlap: int = 100,
    chunking_mode: int = ChunkingMode.CHARACTER
)

Attributes
embedder	Dataclass field
embedding_dimension	Dataclass field
database_path	Dataclass field
chunk_size	Dataclass field
chunk_overlap	Dataclass field
chunking_mode	Dataclass field

Methods

to_ctypes

View source

to_ctypes() -> _MpSemanticRetrieverOptionsC

Generates a ctypes MpSemanticRetrieverOptionsC object.

__eq__

__eq__(
    other
)

Return self==value.

Class Variables
chunk_overlap	100
chunk_size	512
chunking_mode	0
database_path	None
embedding_dimension	768