Struct AgentDefinition

pub struct AgentDefinition {
    pub name: String,
    pub description: String,
    pub version: String,
    pub instructions: String,
    pub variables: Vec<AgentVariable>,
    pub documents: Vec<String>,
    pub conversation_starters: Vec<String>,
    pub metadata: HashMap<String, Value>,
}

The definition of an agent, loaded from its index.yaml file.

Fields

name: String

The unique name of the agent.

description: String

A description of the agent’s purpose and capabilities.

version: String

The version of the agent.

instructions: String

The system prompt or instructions that guide the agent’s behavior.

variables: Vec<AgentVariable>

Variables that can be configured for the agent.

documents: Vec<String>

A list of documents to be used for Retrieval-Augmented Generation (RAG).

conversation_starters: Vec<String>

A list of example prompts to start a conversation with the agent.

metadata: HashMap<String, Value>

Additional, unstructured metadata for the agent.

Trait Implementations

impl Clone for AgentDefinition

fn clone(&self) -> AgentDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AgentDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AgentDefinition

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for AgentDefinition

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Serialize for AgentDefinition

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

where __S: Serializer,

Serialize this value into the given Serde serializer.