Class Tryll::Client::MutableKb

ClassList > Tryll > Client > MutableKb

Experimental session-scoped mutable knowledge-base handle.

• #include <MutableKb.h>

Public Functions

Type	Name
std::uint32_t	Clear (std::chrono::milliseconds timeout=std::chrono::seconds{10})
std::future< std::uint32_t >	ClearAsync ()
std::uint32_t	Delete (std::span< const std::string > ids, std::chrono::milliseconds timeout=std::chrono::seconds{10})
std::future< std::uint32_t >	DeleteAsync (std::span< const std::string > ids)
MutableKbSnapshot	Export (std::chrono::milliseconds timeout=std::chrono::seconds{30})
std::future< MutableKbSnapshot >	ExportAsync ()
std::optional< MutableKbRecord >	Get (std::string_view id, std::chrono::milliseconds timeout=std::chrono::seconds{10})
std::future< std::optional< MutableKbRecord > >	GetAsync (std::string_view id)
MutableKbImportResult	Import (const MutableKbSnapshot & snapshot, MutableKbCompatibility compatibility=MutableKbCompatibility::Strict, std::chrono::milliseconds timeout=std::chrono::seconds{60})
std::future< MutableKbImportResult >	ImportAsync (const MutableKbSnapshot & snapshot, MutableKbCompatibility compatibility=MutableKbCompatibility::Strict)
bool	IsValid () noexcept const
MutableKbListPage	List (std::uint32_t offset=0, std::uint32_t limit=50, std::chrono::milliseconds timeout=std::chrono::seconds{10})
std::future< MutableKbListPage >	ListAsync (std::uint32_t offset=0, std::uint32_t limit=50)
	MutableKb () = default
const std::string &	Name () noexcept const
std::vector< MutableKbHit >	Query (std::string_view queryText, std::uint32_t topK=4, ::Tryll::RetrievalMode mode=::Tryll::RetrievalMode_Dense, std::chrono::milliseconds timeout=std::chrono::seconds{30})
std::future< std::vector< MutableKbHit > >	QueryAsync (std::string_view queryText, std::uint32_t topK=4, ::Tryll::RetrievalMode mode=::Tryll::RetrievalMode_Dense)
const std::string &	Schema () noexcept const
MutableKbStats	Stats (std::chrono::milliseconds timeout=std::chrono::seconds{10})
std::future< MutableKbStats >	StatsAsync ()
std::vector< MutableKbWriteResult >	Write (std::span< const MutableKbUpsert > records, std::chrono::milliseconds timeout=std::chrono::seconds{30})
std::future< std::vector< MutableKbWriteResult > >	WriteAsync (std::span< const MutableKbUpsert > records)

Public Functions Documentation

function Clear

std::uint32_t Tryll::Client::MutableKb::Clear (
    std::chrono::milliseconds timeout=std::chrono::seconds{10}
) 

---

function ClearAsync

std::future< std::uint32_t > Tryll::Client::MutableKb::ClearAsync () 

---

function Delete

std::uint32_t Tryll::Client::MutableKb::Delete (
    std::span< const std::string > ids,
    std::chrono::milliseconds timeout=std::chrono::seconds{10}
) 

---

function DeleteAsync

std::future< std::uint32_t > Tryll::Client::MutableKb::DeleteAsync (
    std::span< const std::string > ids
) 

---

function Export

MutableKbSnapshot Tryll::Client::MutableKb::Export (
    std::chrono::milliseconds timeout=std::chrono::seconds{30}
) 

---

function ExportAsync

std::future< MutableKbSnapshot > Tryll::Client::MutableKb::ExportAsync () 

---

function Get

std::optional< MutableKbRecord > Tryll::Client::MutableKb::Get (
    std::string_view id,
    std::chrono::milliseconds timeout=std::chrono::seconds{10}
) 

---

function GetAsync

std::future< std::optional< MutableKbRecord > > Tryll::Client::MutableKb::GetAsync (
    std::string_view id
) 

---

function Import

MutableKbImportResult Tryll::Client::MutableKb::Import (
    const MutableKbSnapshot & snapshot,
    MutableKbCompatibility compatibility=MutableKbCompatibility::Strict,
    std::chrono::milliseconds timeout=std::chrono::seconds{60}
) 

---

function ImportAsync

std::future< MutableKbImportResult > Tryll::Client::MutableKb::ImportAsync (
    const MutableKbSnapshot & snapshot,
    MutableKbCompatibility compatibility=MutableKbCompatibility::Strict
) 

---

function IsValid

inline bool Tryll::Client::MutableKb::IsValid () noexcept const

---

function List

MutableKbListPage Tryll::Client::MutableKb::List (
    std::uint32_t offset=0,
    std::uint32_t limit=50,
    std::chrono::milliseconds timeout=std::chrono::seconds{10}
) 

---

function ListAsync

std::future< MutableKbListPage > Tryll::Client::MutableKb::ListAsync (
    std::uint32_t offset=0,
    std::uint32_t limit=50
) 

---

function MutableKb [1/2]

Tryll::Client::MutableKb::MutableKb () = default

---

function Name

inline const std::string & Tryll::Client::MutableKb::Name () noexcept const

---

function Query

std::vector< MutableKbHit > Tryll::Client::MutableKb::Query (
    std::string_view queryText,
    std::uint32_t topK=4,
    ::Tryll::RetrievalMode mode=::Tryll::RetrievalMode_Dense,
    std::chrono::milliseconds timeout=std::chrono::seconds{30}
) 

---

function QueryAsync

std::future< std::vector< MutableKbHit > > Tryll::Client::MutableKb::QueryAsync (
    std::string_view queryText,
    std::uint32_t topK=4,
    ::Tryll::RetrievalMode mode=::Tryll::RetrievalMode_Dense
) 

---

function Schema

inline const std::string & Tryll::Client::MutableKb::Schema () noexcept const

---

function Stats

MutableKbStats Tryll::Client::MutableKb::Stats (
    std::chrono::milliseconds timeout=std::chrono::seconds{10}
) 

---

function StatsAsync

std::future< MutableKbStats > Tryll::Client::MutableKb::StatsAsync () 

---

function Write

std::vector< MutableKbWriteResult > Tryll::Client::MutableKb::Write (
    std::span< const MutableKbUpsert > records,
    std::chrono::milliseconds timeout=std::chrono::seconds{30}
) 

---

function WriteAsync

std::future< std::vector< MutableKbWriteResult > > Tryll::Client::MutableKb::WriteAsync (
    std::span< const MutableKbUpsert > records
) 

---

---

The documentation for this class was generated from the following file C:/_tryll/_monorepo3/tryll/clients/cpp/include/tryll/MutableKb.h