Enum RemoteFunction 

pub enum RemoteFunction {
    Scalar {
        description: String,
        input_schema: InputSchema,
        tasks: Vec<TaskExpression>,
    },
    Vector {
        description: String,
        input_schema: InputSchema,
        tasks: Vec<TaskExpression>,
        output_length: Expression,
        input_split: Expression,
        input_merge: Expression,
    },
}

A remote function with full metadata.

Remote functions are stored as function.json in repositories and referenced by remote/owner/repository. They include documentation fields that inline functions lack.

Variants

Scalar

Produces a single score in [0, 1].

Fields

description: String

Human-readable description of what the function does.

input_schema: InputSchema

JSON Schema defining the expected input structure.

tasks: Vec<TaskExpression>

The list of tasks to execute. Tasks with a map expression are expanded into multiple instances. Each instance is compiled with map set to the current integer index. Receives: input, map (if mapped).

Vector

Produces a vector of scores that sums to 1.

Fields

description: String

Human-readable description of what the function does.

input_schema: InputSchema

JSON Schema defining the expected input structure.

tasks: Vec<TaskExpression>

The list of tasks to execute. Tasks with a map expression are expanded into multiple instances. Each instance is compiled with map set to the current integer index. Receives: input, map (if mapped).

output_length: Expression

Expression computing the expected output vector length for task outputs. Receives: input.

input_split: Expression

Expression transforming input into an input array of the output_length When the Function is executed with any input from the array, The output_length should be 1. Receives: input.

input_merge: Expression

Expression transforming an array of inputs computed by input_split into a single Input object for the Function. Receives: input (as an array).

Implementations

impl RemoteFunction

pub fn description(&self) -> &str

Returns the function’s description.

pub fn input_schema(&self) -> &InputSchema

Returns the function’s input schema.

pub fn tasks(&self) -> &[TaskExpression]

Returns the function’s tasks.

pub fn output_length(&self) -> Option<&Expression>

Returns the function’s expected output length, if defined (vector functions only).

pub fn input_split(&self) -> Option<&Expression>

Returns the function’s input_split expression, if defined (vector functions only).

pub fn input_merge(&self) -> Option<&Expression>

Returns the function’s input_merge expression, if defined (vector functions only).

pub fn remotes(&self) -> impl Iterator<Item = &RemotePath>

Trait Implementations

impl<'arbitrary> Arbitrary<'arbitrary> for RemoteFunction

fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Clone for RemoteFunction

fn clone(&self) -> RemoteFunction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RemoteFunction

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RemoteFunction

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for RemoteFunction

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

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 inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for RemoteFunction

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for RemoteFunction

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 RemoteFunction