Skip to content

feat(protocol): Add an error type #134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
grahamking merged 5 commits into from
Jul 24, 2026
Merged

feat(protocol): Add an error type #134

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b1a6f42
feat(libsy-llm-client): Add an error type
grahamking Jul 24, 2026
ba5dfda
Add a variant for encoding the request after translation
grahamking Jul 24, 2026
111fec2
Distinguish between JSON errors and other kinds
grahamking Jul 24, 2026
344e938
Merge LlmClientError and RoutedLlmClientError
grahamking Jul 24, 2026
05cfdc1
Merge two overlapping reqwest::Error conversion functions
grahamking Jul 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion crates/libsy-llm-client/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ reqwest = { version = "0.12", default-features = false, features = ["json", "rus
async-trait = "0.1"
futures-util = "0.3"
serde_json = "1"
thiserror = "2"

[dev-dependencies]
futures = "0.3"
Expand Down
31 changes: 18 additions & 13 deletions crates/libsy-llm-client/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,9 +88,9 @@ async fn ask(client: &TranslatingLlmClient) -> switchyard_llm_client::Result<Str

match response.llm_response {
LlmResponse::Agg(agg) => Ok(completion_text(&agg)),
LlmResponse::Stream(_) => Err(LlmClientError::Stream(
"expected a buffered response".to_string(),
)),
LlmResponse::Stream(_) => Err(LlmClientError::InvalidResponse {
source: "expected a buffered response".into(),
}),
}
}
```
Expand All @@ -101,10 +101,12 @@ Set `stream` on the IR request and drive the returned chunk stream:

```rust
use futures_util::StreamExt;
use switchyard_llm_client::{LlmClientError, TranslatingLlmClient};
use switchyard_llm_client::TranslatingLlmClient;
use switchyard_protocol::{text_request, Context, LlmResponse, LlmResponseChunk, Request};

async fn stream(client: &TranslatingLlmClient) -> switchyard_llm_client::Result<()> {
async fn stream(
client: &TranslatingLlmClient,
) -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
let mut llm_request = text_request(None, "Count to five.");
llm_request.stream = true;
let request = Request { llm_request, raw_request: None, metadata: None };
Expand All @@ -118,7 +120,7 @@ async fn stream(client: &TranslatingLlmClient) -> switchyard_llm_client::Result<
match item {
Ok(LlmResponseChunk::TextDelta { text, .. }) => print!("{text}"),
Ok(_) => {} // usage, tool-call deltas, message start/stop
Err(error) => return Err(LlmClientError::Stream(error.to_string())),
Err(error) => return Err(error),
}
}
}
Expand Down Expand Up @@ -174,14 +176,17 @@ fn build_multi_format_client(

| Variant | When |
|---------|------|
| `MissingModel` | no `model_name` arg and no `request.llm_request.model` |
| `UnknownModel(model)` | model has no backends configured |
| `UnknownModelFormat { model, format }` | model has no backend for that format |
| `Translation(msg)` | encode/decode failed in the translation engine |
| `Transport(msg)` | connect/timeout/transport failure |
| `InvalidRequest { message }` | the request does not identify a model |
| `Configuration { message }` | the model or requested wire format has no configured backend |
| `RequestTranslation(msg)` | decoding the inbound request failed in the translation engine |
| `RequestEncoding(msg)` | re-encoding an already-decoded request to the wire format failed (internal fault) |
| `ResponseTranslation(msg)` | response decoding or encoding failed in the translation engine |
| `Timeout { source }` | request or response body read exceeded its timeout |
| `Transport { source }` | non-timeout connection or transport failure |
| `ContextWindowExceeded { model, message }` | upstream 400 detected as a context overflow (checked before `UpstreamHttp`, so callers can evict-and-retry) |
| `UpstreamHttp { status, body }` | any other non-2xx upstream response |
| `Stream(msg)` | mid-stream read / malformed frame |
| `InvalidResponse { source }` | the upstream response could not be decoded |
| `Other(source)` | a client-specific failure outside the shared categories |

[`switchyard_protocol::Request`]: ../libsy-protocol
[`switchyard_protocol::Response`]: ../libsy-protocol
Expand All @@ -190,4 +195,4 @@ fn build_multi_format_client(
[`HttpBackendConfig`]: src/backend.rs
[`ModelConfig`]: src/client.rs
[`TranslatingLlmClient::call_rewrite_model`]: src/client.rs
[`LlmClientError`]: src/error.rs
[`LlmClientError`]: ../protocol/src/client.rs
Loading
Loading