Skip to main content

Item

Struct Item 

Source
pub struct Item {
    pub id: Option<MessageId>,
    pub kind: ItemKind,
    pub parts: Vec<Part>,
    pub metadata: BTreeMap<String, Value>,
}
Expand description

A single entry in the agent transcript.

An Item represents one message or event in the conversation between the system, user, assistant, and tools. Each item has a kind that determines its role and a vector of Parts that carry its content.

Items are the primary unit of data flowing through the agentkit loop: callers submit user and system items, the loop appends assistant and tool items, and compaction strategies operate on the full Vec<Item> transcript.

§Example

use agentkit_core::{Item, ItemKind};

let user_msg = Item::text(ItemKind::User, "List the workspace crates.");

assert_eq!(user_msg.kind, ItemKind::User);
assert_eq!(user_msg.parts.len(), 1);

Fields§

§id: Option<MessageId>

Optional provider-assigned or user-supplied message identifier.

§kind: ItemKind

The role of this item in the transcript.

§parts: Vec<Part>

The content parts that make up this item.

§metadata: BTreeMap<String, Value>

Arbitrary key-value metadata for this item.

Implementations§

Source§

impl Item

Source

pub fn new(kind: ItemKind, parts: Vec<Part>) -> Item

Builds an item with the given role and parts.

Source

pub fn text(kind: ItemKind, text: impl Into<String>) -> Item

Builds a single-text-part item.

Source

pub fn with_id(self, id: impl Into<MessageId>) -> Item

Sets the item identifier.

Source

pub fn with_metadata(self, metadata: BTreeMap<String, Value>) -> Item

Replaces the item metadata.

Source

pub fn push_part(self, part: Part) -> Item

Appends one part to the item.

Trait Implementations§

Source§

impl Clone for Item

Source§

fn clone(&self) -> Item

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Item

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Item

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<Item, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl ItemView for Item

Source§

fn kind(&self) -> ItemKind

Returns the role of this item.
Source§

fn parts(&self) -> &[Part]

Returns the content parts.
Source§

fn metadata(&self) -> &BTreeMap<String, Value>

Returns the metadata map.
Source§

impl PartialEq for Item

Source§

fn eq(&self, other: &Item) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for Item

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Item

Auto Trait Implementations§

§

impl Freeze for Item

§

impl RefUnwindSafe for Item

§

impl Send for Item

§

impl Sync for Item

§

impl Unpin for Item

§

impl UnsafeUnpin for Item

§

impl UnwindSafe for Item

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,