mirror of
https://github.com/katanemo/plano.git
synced 2026-04-25 00:36:34 +02:00
|
Some checks failed
CI / pre-commit (push) Has been cancelled
CI / plano-tools-tests (push) Has been cancelled
CI / native-smoke-test (push) Has been cancelled
CI / docker-build (push) Has been cancelled
CI / validate-config (push) Has been cancelled
CI / security-scan (push) Has been cancelled
CI / test-prompt-gateway (push) Has been cancelled
CI / test-model-alias-routing (push) Has been cancelled
CI / test-responses-api-with-state (push) Has been cancelled
CI / e2e-plano-tests (3.10) (push) Has been cancelled
CI / e2e-plano-tests (3.11) (push) Has been cancelled
CI / e2e-plano-tests (3.12) (push) Has been cancelled
CI / e2e-plano-tests (3.13) (push) Has been cancelled
CI / e2e-plano-tests (3.14) (push) Has been cancelled
CI / e2e-demo-preference (push) Has been cancelled
CI / e2e-demo-currency (push) Has been cancelled
Publish docker image (latest) / build-arm64 (push) Has been cancelled
Publish docker image (latest) / build-amd64 (push) Has been cancelled
Publish docker image (latest) / create-manifest (push) Has been cancelled
Build and Deploy Documentation / build (push) Has been cancelled
* feat(provider): add xiaomi as first-class provider * feat(demos): add xiaomi mimo integration demo * refactor(demos): remove Xiaomi MiMo integration demo and update documentation * updating model list and adding the xiamoi models --------- Co-authored-by: Salman Paracha <salmanparacha@MacBook-Pro-389.local> |
||
|---|---|---|
| .. | ||
| src | ||
| Cargo.toml | ||
| README.md | ||
hermesllm
A Rust library for handling LLM (Large Language Model) API requests and responses with unified abstractions across multiple providers.
Features
- Unified request/response types with provider-specific parsing
- Support for both streaming and non-streaming responses
- Type-safe provider identification
- OpenAI-compatible API structure with extensible provider support
Supported Providers
- OpenAI
- Mistral
- Groq
- Deepseek
- Gemini
- Claude
- GitHub
Installation
Add to your Cargo.toml:
[dependencies]
hermesllm = { path = "../hermesllm" } # or appropriate path in workspace
Usage
Basic Request Parsing
use hermesllm::providers::{ProviderRequestType, ProviderRequest, ProviderId};
// Parse request from JSON bytes
let request_bytes = r#"{"model": "gpt-4", "messages": [{"role": "user", "content": "Hello!"}]}"#;
// Parse with provider context
let request = ProviderRequestType::try_from((request_bytes.as_bytes(), &ProviderId::OpenAI))?;
// Access request properties
println!("Model: {}", request.model());
println!("User message: {:?}", request.get_recent_user_message());
println!("Is streaming: {}", request.is_streaming());
Working with Responses
use hermesllm::providers::{ProviderResponseType, ProviderResponse};
// Parse response from provider
let response_bytes = /* JSON response from LLM */;
let response = ProviderResponseType::try_from((response_bytes, ProviderId::OpenAI))?;
// Extract token usage
if let Some((prompt, completion, total)) = response.extract_usage_counts() {
println!("Tokens used: {}/{}/{}", prompt, completion, total);
}
Handling Streaming Responses
use hermesllm::providers::{ProviderStreamResponseIter, ProviderStreamResponse};
// Create streaming iterator from SSE data
let sse_data = /* Server-Sent Events data */;
let mut stream = ProviderStreamResponseIter::try_from((sse_data, &ProviderId::OpenAI))?;
// Process streaming chunks
for chunk_result in stream {
match chunk_result {
Ok(chunk) => {
if let Some(content) = chunk.content_delta() {
print!("{}", content);
}
if chunk.is_final() {
break;
}
}
Err(e) => eprintln!("Stream error: {}", e),
}
}
Provider Compatibility
use hermesllm::providers::{ProviderId, has_compatible_api, supported_apis};
// Check API compatibility
let provider = ProviderId::Groq;
if has_compatible_api(&provider, "/v1/chat/completions") {
println!("Provider supports chat completions");
}
// List supported APIs
let apis = supported_apis(&provider);
println!("Supported APIs: {:?}", apis);
Core Types
Provider Types
ProviderId- Enum identifying supported providers (OpenAI, Mistral, Groq, etc.)ProviderRequestType- Enum wrapping provider-specific request typesProviderResponseType- Enum wrapping provider-specific response typesProviderStreamResponseIter- Iterator for streaming response chunks
Traits
ProviderRequest- Common interface for all request typesProviderResponse- Common interface for all response typesProviderStreamResponse- Interface for streaming response chunksTokenUsage- Interface for token usage information
OpenAI API Types
ChatCompletionsRequest- Chat completion request structureChatCompletionsResponse- Chat completion response structureMessage,Role,MessageContent- Message building blocks
Architecture
The library uses a type-safe enum-based approach that:
- Provides Type Safety: All provider operations are checked at compile time
- Enables Runtime Provider Selection: Provider can be determined from request headers or config
- Maintains Clean Abstractions: Common traits hide provider-specific details
- Supports Extensibility: New providers can be added by extending the enums
All requests are parsed into a common ProviderRequestType enum which implements the ProviderRequest trait, allowing uniform access to request properties regardless of the underlying provider format.
Examples
See the src/lib.rs tests for complete working examples of:
- Parsing requests with provider context
- Handling streaming responses
- Working with token usage information
License
This project is licensed under the MIT License.