Struct FunctionResult 

pub struct FunctionResult { /* private fields */ }

Validated caller-supplied result for a client function call.

Examples

use providers_kit::generation::{FunctionResult, ContentPart};
let result = FunctionResult::new(Some("call-1".into()), "lookup", vec![ContentPart::Json { value: serde_json::json!({"value":2}) }], false)?;
assert_eq!(result.call_id(), Some("call-1"));
assert_eq!(result.name(), "lookup");
assert_eq!(result.content().len(), 1);
assert!(!result.is_error());

Implementations

impl FunctionResult

pub fn new( call_id: Option<String>, name: impl Into<String>, content: Vec<ContentPart>, is_error: bool, ) -> Result<Self, KitError>

Creates a validated function result.

Errors

Returns an input error for an invalid name/id, empty or invalid content, or provider thinking content. Accepted function failures use is_error = true with nonempty model-visible content.

Examples

use providers_kit::generation::{FunctionResult, ContentPart};
let result = FunctionResult::new(Some("call-1".into()), "lookup", vec![ContentPart::Json { value: serde_json::json!({"value":2}) }], false)?;
assert_eq!(result.call_id(), Some("call-1"));
assert_eq!(result.name(), "lookup");
assert_eq!(result.content().len(), 1);
assert!(!result.is_error());

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

Returns the originating call id, when available.

Examples

use providers_kit::generation::{FunctionResult, ContentPart};
let result = FunctionResult::new(Some("call-1".into()), "lookup", vec![ContentPart::Json { value: serde_json::json!({"value":2}) }], false)?;
assert_eq!(result.call_id(), Some("call-1"));
assert_eq!(result.name(), "lookup");
assert_eq!(result.content().len(), 1);
assert!(!result.is_error());

pub fn name(&self) -> &str

Returns the function name.

Examples

use providers_kit::generation::{FunctionResult, ContentPart};
let result = FunctionResult::new(Some("call-1".into()), "lookup", vec![ContentPart::Json { value: serde_json::json!({"value":2}) }], false)?;
assert_eq!(result.call_id(), Some("call-1"));
assert_eq!(result.name(), "lookup");
assert_eq!(result.content().len(), 1);
assert!(!result.is_error());

pub fn content(&self) -> &[ContentPart]

Returns ordered model-visible result content.

Examples

use providers_kit::generation::{FunctionResult, ContentPart};
let result = FunctionResult::new(Some("call-1".into()), "lookup", vec![ContentPart::Json { value: serde_json::json!({"value":2}) }], false)?;
assert_eq!(result.call_id(), Some("call-1"));
assert_eq!(result.name(), "lookup");
assert_eq!(result.content().len(), 1);
assert!(!result.is_error());

pub const fn is_error(&self) -> bool

Reports whether the completed function execution failed.

Examples

use providers_kit::generation::{FunctionResult, ContentPart};
let result = FunctionResult::new(Some("call-1".into()), "lookup", vec![ContentPart::Json { value: serde_json::json!({"value":2}) }], false)?;
assert_eq!(result.call_id(), Some("call-1"));
assert_eq!(result.name(), "lookup");
assert_eq!(result.content().len(), 1);
assert!(!result.is_error());

Trait Implementations

impl Clone for FunctionResult

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionResult

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FunctionResult

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FunctionResult

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for FunctionResult

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FunctionResult