CLIENTS: Discuss Using Fluent API for Building Completion Requests

[hassanhabib]

#73

[jodendaal]

I like using fluent assertions they are useful for building complex objects.

My only observation , which is not to do with fluent syntax directly, is how the consumer knows which properties are required when initializing a TextCompletion, it's not obvious.

Is it a rule in the Standard to only use anemic models? (I need to read it all, got to find some time with all he bits I'm working on at the moment). I much prefer something like below, as it's obvious to me that prompt and model are required, other properties are optional. I would eventually figure it out by trial and error on anemic model, but it's not a great developer experience.

The same applies for the Fluent Assertions, they are great but should start with required parameters being mandatory(if thats possible), then allow you to chain the additional properties you want.

This forces the correct consumption/usage

public class TextCompletionRequest
{
    public TextCompletionRequest(string[] prompt, string model)
    { 
        this.Prompt = prompt;
        this.Model = model;
    }

    public string Model { get; set; }
    public string[] Prompt { get; set; }

}

Or an alternative so you still have anemic model, but method to create it with required defaults.

public class TextCompletionRequest
{
    private TextCompletionRequest()
    { 
    }

    public string Model { get; set; }
    public string[] Prompt { get; set; }

   public static TextCompletionRequest Create(string[] prompt, string model)
   {
      var textCompletionRequest = new TextCompletion();
            textCompletionRequest.Prompt = prompt;
            textCompletionRequest.Model= model;
      return textCompletionRequest;
   }

}

Then you can do

var textCompletionRequest = TextCompletionRequest.Create(prompt,model);
      textCompletionRequest.Echo = true;
      textCompletionRequest.Temperature = 0.1;
      ...