Struct BigRag 

pub struct BigRag { /* private fields */ }

The bigRAG client.

Examples

use bigrag::BigRag;

let client = BigRag::new("http://localhost:6100", "sk-...");
let collections = client.collections().list(None).await?;

Implementations

impl BigRag

pub fn new(base_url: &str, api_key: &str) -> Self

Create a new client with a base URL and API key.

pub fn from_env() -> Result<Self, BigRagError>

Create a new client from environment variables.

Reads BIGRAG_BASE_URL (default: http://localhost:6100) and BIGRAG_API_KEY (optional).

pub fn builder() -> BigRagBuilder

Create a builder for fine-grained configuration.

pub fn collections(&self) -> Collections<'_>

Access the collections resource.

pub fn documents(&self) -> Documents<'_>

Access the documents resource.

pub fn queries(&self) -> Queries<'_>

Access the queries resource.

pub fn vectors(&self) -> Vectors<'_>

Access the vectors resource.

pub fn webhooks(&self) -> Webhooks<'_>

Access the webhooks resource.

pub fn collection(&self, name: &str) -> CollectionClient<'_>

Create a collection-scoped client for convenience.

pub async fn health(&self) -> Result<HealthResponse, BigRagError>

Check API health.

pub async fn readiness(&self) -> Result<ReadinessResponse, BigRagError>

Check API readiness (includes dependency health).

pub async fn stats(&self) -> Result<PlatformStatsResponse, BigRagError>

Get platform-wide statistics.

pub async fn embedding_models( &self, ) -> Result<EmbeddingModelListResponse, BigRagError>

List available embedding models.

pub async fn analytics( &self, collection: &str, ) -> Result<AnalyticsResponse, BigRagError>

Get analytics for a collection.