Skip to main content

Crate nvisy_rt_sdk

Crate nvisy_rt_sdk 

Source
Expand description

§nvisy-rt-sdk

Crates.io Documentation Build

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 HTTPS
  • native-tls: use platform-native TLS (mutually exclusive with rustls-tls)
  • base64: enable base64 encoding/decoding helpers for file content
  • stream: enable auto-paginating PageStream iterators for list endpoints via futures
  • tracing: 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

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.
NvisyRtBuilder
Builder for configuring and creating a NvisyRt client.

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.