Linq.AI.OpenAI 1.1.0

Linq.AI.OpenAI

This library adds Linq extension methods using OpenAI structured outputs.

This library was heaviy inspired by stevenic's agentm-js library, Kudos!

Installation

dotnet add package Linq.AI.OpenAI

Architecture

For each element in a collection an model API call is made to evaluate and return the result. These are done in parallel on background threads.

OpenAI model

To use these methods you will need to instantiate a ChatClient model like this:

var model = new ChatClient(model: "gpt-4o-2024-08-06", "<modelKey>");

NOTE: The model must support structured output.

String Extensions

These extensions use an OpenAI model to work with text.

Examples

.Classify() text

enum Genres { Rock, Pop, Electronica, Country, Classical };
var classification = await text.Classify<Genres>(model);

.Summarize() text

var summary = await text.Summarize(model, "with 3 words");

.Matches() text

if (await text.Matches(model, "there is date"))
  ...

.Answer() text

var summary = await text.Answer(model, "what is the birthday?");

.Select() text

Example using model to select

var words = await text.Select<string>(model, "The second word of every paragraph");

Example using model to select structed data.

public class HREF 
{ 
	public string Url {get;set;}
	public string Title {get;set;}
}
var summary = await text.Select<HREF>(model);

Collection Extensions

These collection extensions use an OpenAI model to work with collections using Linq style methods.

Examples

.Classify() items

This allows you to classify each item using a model;

enum Genres { Rock, Pop, Electronica, Country, Classical };
var classifiedItems = items.Classify<Genres>(model);

.Where()/.Remove() items

Filter a collection using natural language

var breadboxItems = items.Where(model, "item would fit in a bread box");
var bigItems = items.Remove(model, "item would fit in a bread box");

.Select() items

.Select() let's you transform the source into target using an OpenAI model.

Object transformation

You can use it to transform an object from one format to another by simply giving the types. It will use model. to do the transformation.

var targetItems = items.Select<SourceItem,TargetItem>(model")

String transformation

var markdownItems = items.Select(model, "transform each item into markdown like this:\n# {{TITLE}}\n{{AUTHOR}}\n{{Description}}")

.Summarize() items

Generate text summary for each item using an OpenAI model.

var summaries = items.Summarize(model);

You can control the summarization with a hint

var summaries = items.Summarize(model, "generate a 3 word summary");

.Answer() items

This operator let's you ask a question for each item in a collection.

var answers = items.Answer(model, "What is total cost of the item as a float?").Select(answer => Convert.ToFloat(answer));