objectiveai-sdk 2.1.3

ObjectiveAI SDK, definitions, and utilities
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
86

//! ObjectiveAI SDK for Rust.
//!
//! This crate provides data structures, validation, and client-side compilation
//! for the ObjectiveAI API - a platform for scoring, ranking, and simulating
//! preferences using swarms of agents.
//!
//! # Core Concepts
//!
//! - **Agent**: A configured instance of a single upstream language model
//! - **Swarm**: A collection of Agents used together for voting
//! - **Vector Completion**: Runs multiple agents to vote on responses, producing weighted scores
//! - **Function**: A composable scoring pipeline built from Vector Completions
//! - **Profile**: Learned weights for a Function, trained on example data
//!
//! # Features
//!
//! - `http` (default): Enables the HTTP client for making API requests
//!
//! # Modules
//!
//! - [`auth`] - API authentication types
//! - [`agent`] - Agent definitions, configuration, and completion APIs
//! - [`swarm`] - Swarm definitions and validation
//! - [`error`] - Error types
//! - [`functions`] - Function definitions, execution, and client-side compilation
//! - [`prefixed_uuid`] - UUID utilities
//! - [`vector`] - Vector completion APIs
//!
//! When the `http` feature is enabled:
//! - [`HttpClient`] - HTTP client for API requests
//! - [`HttpError`] - HTTP error types

pub mod agent;
pub mod arbitrary_util;
pub mod auth;
pub mod data_url;
pub mod error;
pub mod functions;
mod json_schema;
pub mod swarm;
pub use json_schema::*;
pub mod prefixed_uuid;
mod remote;
pub(crate) mod serde_util;
mod util;
pub mod vector;
mod weights;

pub use remote::*;
pub use weights::*;

#[cfg(test)]
mod serde_util_tests;
#[cfg(test)]
mod tests;

#[cfg(test)]
mod test_util;

#[cfg(feature = "http")]
pub mod http;

#[cfg(feature = "http")]
pub use http::*;

#[cfg(feature = "mcp")]
pub mod mcp;

#[cfg(feature = "lockfile")]
pub mod lockfile;

// `client_objectiveai_mcp` is the reverse-attach protocol's wire
// envelope. The typed `server_request::Payload` and
// `server_response::Payload` variants reference `mcp::tool::*` /
// `mcp::resource::*` shapes, so the module is gated behind the same
// feature. Pure-`http` consumers (no MCP) wouldn't have anything to
// do with it anyway — the McpHandler trait + WS streaming path also
// require this module.
#[cfg(feature = "mcp")]
pub mod client_objectiveai_mcp;

#[cfg(feature = "cli")]
pub mod cli;

#[cfg(feature = "viewer")]
pub mod viewer;