cortexdb-sdk 0.2.0-beta.2

Rust HTTP client SDK for CortexDB
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

//! Blocking Rust HTTP client for CortexDB.
//!
//! `cortexdb-sdk` provides a synchronous, ergonomic client for the CortexDB
//! beta HTTP API. All methods return strongly-typed responses or
//! `serde_json::Value` for raw access.
//!
//! # Quickstart
//!
//! ```no_run
//! use cortex_sdk::CortexDbClient;
//!
//! let client = CortexDbClient::new("http://127.0.0.1:8181");
//! let health = client.health_response().unwrap();
//! println!("Server version: {}", health.server_version);
//! ```

mod aql;
mod aql_support;
#[cfg(feature = "async")]
mod async_client;
mod client;
mod context_pack;
mod generated;
mod grounded_answer;
mod http;
mod types;
mod verification;

pub use aql::{
    Aql, AqlBuildError, AqlRetrievalMode, RememberBuilder, RetrieveContextBuilder,
    VerifyFactBuilder,
};
#[cfg(feature = "async")]
pub use async_client::AsyncCortexDbClient;
pub use client::{CortexDbClient, SdkError, SdkResult};
pub use context_pack::{
    AnswerGroundingOptionsV1, AnswerGroundingReportV1, AnswerGroundingSpanV1,
    ContextPackAccessDecisionV1, ContextPackAnomalyV1, ContextPackCellV1, ContextPackExplainV1,
    ContextPackProvenanceV1, ContextPackSourceRefV1, ContextPackV1,
    CONTEXT_PACK_V1_REQUIRED_FIELDS, CONTEXT_PACK_V1_SCHEMA_VERSION,
};
pub use grounded_answer::{GroundedAnswerRequest, GroundedAnswerResponse};
pub use types::{
    AnnEvaluationResponse, AnnNoFallbackDecision, AnnSearchReport, AnswerGroundingOptionsResponse,
    AnswerGroundingReportResponse, AnswerGroundingSpanResponse, AqlCandidateCounts,
    AqlCellResponse, AqlExecutionOperator, AqlExecutionTrace, AqlExplainFilter, AqlExplainResponse,
    AqlLogicalPlan, AqlLogicalPlanNode, AqlResponse, CellLookupResponse, CellResponse,
    ContextPackAnomalyResponse, ContextPackCellResponse, ContextPackResponse,
    ContextSpanProvenanceResponse, DeleteJobResponse, ErrorCode, ErrorResponse, EvidenceResponse,
    ExplainResponse, GuardResponse, HealthResponse, HnswNoFallbackProfileResponse, IngestResponse,
    IngestionJobResponse, IngestionJobStatus, IngestionSkippedItem, IngestionSourceRefReport,
    IngestionValidationIssue, IngestionValidationReport, NumericConflictResponse, PutCellResponse,
    RememberResponse, ScoreComponentResponse, SearchAnswerGroundingReportResponse,
    SearchAnswerGroundingSpanResponse, SearchExplainItem, SearchExplainResponse,
    SearchExplainTermContribution, SearchResponse, SearchResult, SearchRoutingDecision,
    SourceRefResponse, StatsResponse, ValidationResponse, VectorAlgorithm,
    VerificationReportResponse, WriteBatchOperationRequest, WriteBatchRequest, WriteBatchResponse,
};
pub use verification::{
    VerificationReportExt, VerifyConflict, VerifyEvidenceConflict, VerifyNumericConflict,
    VerifyOutputFormat, VerifyRequest, VerifyResult,
};

#[cfg(test)]
mod context_pack_tests;
#[cfg(test)]
mod grounded_answer_tests;
#[cfg(test)]
mod tests;
#[cfg(test)]
mod verification_tests;