Expand description
§nvisy-rt-sdk
Rust client for the Nvisy Runtime API.
The Nvisy Runtime is the core redaction engine that detects and removes sensitive information across documents, images, and audio. It combines deterministic patterns, NER, computer vision, and LLM-driven classification into auditable, policy-driven pipelines. Use this crate to connect directly to a runtime instance without going through the Nvisy Server.
§Installation
[dependencies]
nvisy-rt-sdk = { version = "0.1", features = ["base64"] }
tokio = { version = "1", features = ["macros", "rt-multi-thread"] }§Quick Start
use nvisy_rt_sdk::NvisyRt;
use nvisy_rt_sdk::model::Pagination;
use nvisy_rt_sdk::service::{FileService, InfraService};
#[tokio::main]
async fn main() -> nvisy_rt_sdk::Result<()> {
let client = NvisyRt::new();
// Check runtime health
let health = client.health().await?;
println!("Status: {:?}", health.status);
// List uploaded files
let files = client.list_files(&Pagination::default()).await?;
println!("Files: {} total", files.total);
Ok(())
}See the examples/ folder for more.
§Features
rustls-tls(default): use rustls for HTTPSnative-tls: use platform-native TLS (mutually exclusive withrustls-tls)base64: enable base64 encoding/decoding helpers for file contentstream: enable auto-paginatingPageStreamiterators for list endpoints via futurestracing: emit tracing spans and events for HTTP requests and client lifecycle
§Deployment
The fastest way to get started is with Nvisy Cloud.
To run locally, see the nvisycom/runtime and nvisycom/server repositories.
§License
MIT License, see LICENSE.txt
§Support
- Documentation: docs.nvisy.com
- API reference: docs.rs/nvisy-rt-sdk
- Issues: github.com/nvisycom/sdk-rs/issues
- Email: support@nvisy.com
Modules§
- model
- Data models for the Nvisy Runtime API.
- service
- Service modules for interacting with Nvisy Runtime API endpoints.
Structs§
- NvisyRt
- Main Nvisy Runtime API client.
- Nvisy
RtBuilder - Builder for configuring and creating a
NvisyRtclient.
Enums§
- Error
- Error type for Nvisy Runtime API operations.
Constants§
- DEFAULT_
BASE_ URL - Default base URL for the Nvisy Runtime API.
- DEFAULT_
MAX_ RETRIES - Default maximum number of retries for transient failures.
- DEFAULT_
TIMEOUT - Default request timeout.
- DEFAULT_
USER_ AGENT - Default User-Agent header value.
Type Aliases§
- Result
- Result type for Nvisy Runtime API operations.