Struct Context 

pub struct Context {
    pub system_prompt: Option<String>,
    pub messages: Vec<Message>,
    pub tools: Vec<Tool>,
}

Shared conversation context. Conversation context for LLM interactions.

Fields

system_prompt: Option<String>

System prompt sent with each request

messages: Vec<Message>

Conversation history

tools: Vec<Tool>

Available tools for this context

Implementations

impl Context

pub fn new() -> Self

Create a new empty context

Examples

use oxi_ai::Context;
let mut ctx = Context::new();
ctx.set_system_prompt("You are a helpful assistant.");

pub fn with_system_prompt(self, prompt: impl Into<String>) -> Self

Create a context with a system prompt

pub fn add_message(&mut self, message: Message)

Add a message to the context

Examples

use oxi_ai::{Context, Message, UserMessage};
let mut ctx = Context::new();
ctx.add_message(Message::User(UserMessage::new("Hello!")));
assert_eq!(ctx.len(), 1);

pub fn message(&self, index: usize) -> Option<&Message>

Get a message by index

pub fn last_message(&self) -> Option<&Message>

Get the last message

Examples

use oxi_ai::{Context, Message, UserMessage};
let mut ctx = Context::new();
ctx.add_message(Message::User(UserMessage::new("First")));
ctx.add_message(Message::User(UserMessage::new("Second")));
assert!(ctx.last_message().is_some());

pub fn is_empty(&self) -> bool

Check if context has any messages

pub fn len(&self) -> usize

Get number of messages

pub fn set_system_prompt(&mut self, prompt: impl Into<String>)

Set the system prompt

pub fn clear_system_prompt(&mut self)

Clear the system prompt

pub fn set_tools(&mut self, tools: Vec<Tool>)

Set available tools

Examples

use oxi_ai::{Context, Tool};
let mut ctx = Context::new();
let tool = Tool::new(
    "search",
    "Search the web",
    serde_json::json!({"type": "object", "properties": {}}),
);
ctx.set_tools(vec![tool]);
assert_eq!(ctx.tools.len(), 1);

pub fn add_tool(&mut self, tool: Tool)

Add a tool

pub fn system_prompt(&self) -> Option<&str>

Get the system prompt for this context.

pub fn to_json(&self) -> Result<String, Error>

Serialize context to a JSON string.

pub fn from_json(json: &str) -> Result<Self, Error>

Deserialize a context from a JSON string.

pub fn duplicate(&self) -> Self

Duplicate this context

Trait Implementations

impl Clone for Context

fn clone(&self) -> Context

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Context

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Context

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Context

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Message> for Context

fn from(message: Message) -> Self

Converts to this type from the input type.

impl From<Vec<Message>> for Context

fn from(messages: Vec<Message>) -> Self

Converts to this type from the input type.

impl Serialize for Context

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.