Initial Draft

[ivanleomk]

I've created a procedural macro that implements a get_info() method. This get_info() method will in turn generate a json obj that will take the individual types + names + comments.

Eg.

#[derive(InstructMacro, Deserialize, Serialize, Debug)]
/// This is a model which represents a single individual user
struct UserInfo {
    /// This is the name of the user
    name: String,
    /// This is the age of the user
    age: u8,
    /// This is the city of the user
    city: String,
}

This gets transformed into

StructInfo {
  name: "UserInfo",
  description: "This is a model which represents a single individual user",
  parameters: [
    ParameterInfo {
      name: "name",
      type: "String",
      comment: "This is the name of the user"
    },
    ParameterInfo {
      name: "age",
      type: "u8",
      comment: "This is the age of the user"
    },
    ParameterInfo {
      name: "city",
      type: "String",
      comment: "This is the city of the user"
    }
  ]
}

We then take this and use it to generate a function definition which can be called. Since it's a simple struct, we can just deserialize it once we get the response back from OpenAI

[ivanleomk]

I put an example of what an API might look like in main.rs which will show how to do structured extraction to get a UserInfo object

[jxnl]

use max_retries

[ivanleomk]

One of the things I'm struggling with in rust is that I couldn't find a way to extend the object (eg.

impl InstructorClientReq extends ChatCompletionReq{
maxRetries: u8,
...req
}

This doesn't quite seem to exist and the articles I've seen recommend simply doing something like

impl InstructorClientReq{
maxRetries: u8,
req: ChatCompletionReq
}

[jxnl]

impl InstructorClientReq{
maxRetries: u8,
req: ChatCompletionReq
}

looks right.
make sure to also specify mode as tools since in'll be different for llama-cpp server

[jxnl]

typos in the read me
how do imports work in rust?

[jxnl]

and we make a todo list of common types

int
str
float
bool

List[Object]
Literal[a,b,c]

[ivanleomk]

and we make a todo list of common types

int str float bool

List[Object] Literal[a,b,c]

Yup I think we should just define a simple mapping of eg. u8,u16.u32, i8 -> Number and we can update this

[ivanleomk]

typos in the read me how do imports work in rust?

Depends on how we're using it. If you're using a mod from another file, you need to use the mod <filename> syntax but if it';s another crate than you use crate_name::<import_path> i believe