bigrag 0.1.1

Rust client for bigRAG — a self-hostable RAG platform
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

use crate::client::BigRag;
use crate::core::urlencode;
use crate::error::BigRagError;
use crate::sse::SseStream;
use crate::types::collections::{
    Collection, CollectionListOptions, CollectionListResponse, CollectionStatsResponse,
    CreateCollectionBody, UpdateCollectionBody,
};
use crate::types::common::StatusResponse;

/// Collections resource — manage bigRAG collections.
pub struct Collections<'a> {
    pub(crate) client: &'a BigRag,
}

impl Collections<'_> {
    /// List collections with optional filters.
    pub async fn list(
        &self,
        options: Option<CollectionListOptions>,
    ) -> Result<CollectionListResponse, BigRagError> {
        let mut query = Vec::new();
        if let Some(opts) = options {
            if let Some(name) = opts.name {
                query.push(("name".into(), name));
            }
            if let Some(limit) = opts.limit {
                query.push(("limit".into(), limit.to_string()));
            }
            if let Some(offset) = opts.offset {
                query.push(("offset".into(), offset.to_string()));
            }
        }
        self.client.transport.get("/v1/collections", query).await
    }

    /// Get a collection by name.
    pub async fn get(&self, name: &str) -> Result<Collection, BigRagError> {
        let path = format!("/v1/collections/{}", urlencode(name));
        self.client.transport.get(&path, vec![]).await
    }

    /// Create a new collection.
    pub async fn create(&self, body: CreateCollectionBody) -> Result<Collection, BigRagError> {
        self.client.transport.post("/v1/collections", &body).await
    }

    /// Update a collection.
    pub async fn update(
        &self,
        name: &str,
        body: UpdateCollectionBody,
    ) -> Result<Collection, BigRagError> {
        let path = format!("/v1/collections/{}", urlencode(name));
        self.client.transport.put(&path, &body).await
    }

    /// Delete a collection and all its data.
    pub async fn delete(&self, name: &str) -> Result<StatusResponse, BigRagError> {
        let path = format!("/v1/collections/{}", urlencode(name));
        self.client.transport.delete(&path).await
    }

    /// Get collection statistics.
    pub async fn stats(&self, name: &str) -> Result<CollectionStatsResponse, BigRagError> {
        let path = format!("/v1/collections/{}/stats", urlencode(name));
        self.client.transport.get(&path, vec![]).await
    }

    /// Truncate a collection (delete all documents but keep the collection).
    pub async fn truncate(&self, name: &str) -> Result<StatusResponse, BigRagError> {
        let path = format!("/v1/collections/{}/truncate", urlencode(name));
        self.client
            .transport
            .post(&path, &serde_json::Value::Null)
            .await
    }

    /// Stream real-time events for a collection via SSE.
    pub async fn stream_events(&self, name: &str) -> Result<SseStream, BigRagError> {
        let path = format!("/v1/collections/{}/events", urlencode(name));
        let response = self.client.transport.get_stream(&path).await?;
        Ok(SseStream::new(response))
    }
}