Skip to content

Tryll Engine

C++ Client API Reference

C++ Client API Reference¶

Full API reference for the Tryll:: C++ client library, auto-generated from Doxygen documentation blocks in server/client-cpp/include/tryll/. Browse individual classes and structs in the sidebar.

Entry points¶

Type	Role
`Tryll::TryllClient`	TCP session — connect, configure, manage models, create agents
`Tryll::ConnectedSession`	RAII pair: owns a `ManagedServer` + `TryllClient`; returned by `RunAndConnect`
`Tryll::AgentProxy`	Per-agent handle — send messages, receive streaming tokens, destroy
`Tryll::Client::GraphDescription`	Fluent graph builder — add nodes, wire routes, set start node
`Tryll::Client::ManagedServer`	RAII handle that spawns `tryll_server` and waits for TCP readiness
`Tryll::Client::ManagedServerOptions`	Configuration for `ManagedServer::Start`
`Tryll::MessageResult`	Streaming result handle returned by synchronous `SendMessage`
`Tryll::TryllError`	Error type carrying a numeric code and human-readable message

Supporting types¶

Type	Role
`Tryll::Client::GraphDescription::NodeDesc`	Single node description inside a graph
`Tryll::Client::GraphDescription::RouteDesc`	Single exit-route wire inside a graph
`Tryll::Client::ModelInfo`	Model catalog entry returned by `ListModels`
`Tryll::Client::ToolDef`	Tool declaration passed on `CreateAgentRequest`
`Tryll::Client::ToolParamDef`	Single parameter within a `ToolDef`
`Tryll::TryllClient::EmbeddedStorageInfo`	Embedded-storage descriptor returned by `ListEmbeddedStorages`

Selected method signatures¶

`TryllClient::ConfigureSession`¶

void ConfigureSession(
    Client::InferenceEngine engine,
    bool                    allowAutoModelDownloading = false,
    std::chrono::milliseconds timeout = std::chrono::seconds(30));

When allowAutoModelDownloading is true, subsequent CreateAgent calls will automatically download any missing models referenced by the graph. The default CreateAgent timeout is automatically extended to 30 minutes when this flag is active. See Enable Auto Model Downloading.

Headers¶

Header	Declares
`tryll/TryllClient.h`	`TryllClient`, `ConnectedSession`, session-level types
`tryll/AgentProxy.h`	`AgentProxy`
`tryll/GraphDescription.h`	`GraphDescription` and its nested types
`tryll/ManagedServer.h`	`ManagedServer`, `ManagedServerOptions`
`tryll/MessageResult.h`	`MessageResult`
`tryll/TryllError.h`	`TryllError`