st_provider

T module-attribute

T: TypeAlias = Tensor | NDArray

STProvider

STProvider(
    model: str,
    instruction: str | None = None,
    device: str | None = None,
    half: bool = False,
    chunk_size: int | None = None,
    chunk_overlap: int | None = None,
)

Bases: LLMProvider[T]

PARAMETER	DESCRIPTION
model	TYPE: str
instruction	TYPE: str | None DEFAULT: None
device	TYPE: str | None DEFAULT: None
half	TYPE: bool DEFAULT: False
chunk_size	TYPE: int | None DEFAULT: None
chunk_overlap	TYPE: int | None DEFAULT: None

embed_corpus

embed_corpus(texts: list[str] | str) -> T

PARAMETER	DESCRIPTION
texts	TYPE: list[str] | str

embed_queries

embed_queries(texts: list[str] | str) -> T

PARAMETER	DESCRIPTION
texts	TYPE: list[str] | str

chunk

chunk(
    header: str,
    text: str,
    size: int | None = None,
    overlap: int | None = None,
) -> list[str]

PARAMETER	DESCRIPTION
header	TYPE: str
text	TYPE: str
size	TYPE: int | None DEFAULT: None
overlap	TYPE: int | None DEFAULT: None

search

search(
    query_embeddings: T, corpus_embeddings: T, top_k: int
) -> list[list[int]]

PARAMETER	DESCRIPTION
query_embeddings	TYPE: T
corpus_embeddings	TYPE: T
top_k	TYPE: int