v3.8.0

What's Changed

• chore(deps): Bump the all group with 6 updates by @dependabot in #80
• feat:@coderabbitai by @HavenDV in #81
• feat:@coderabbitai by @HavenDV in #82
• feat:@coderabbitai by @HavenDV in #83
• feat:Title: Update documentation for API endpoints and usage examples by @HavenDV in #84
• feat:Update XML documentation comments for enumeration types in OpenAI models by @HavenDV in #85
• chore(deps): Bump the all group with 2 updates by @dependabot in #86
• feat:Title: Update documentation for API endpoints and usage examples by @HavenDV in #87

Full Changelog: v3.7.0...v3.8.0

v3.7.0

What's Changed

• feat: Added o1-preview/o1-mini metadata.
• feat: Added SambaNova custom provider.
• feat: Added Perplexity custom provider.
• test: Added StructuredOutputs example like official.
• fix: Fixed RunStepObject deserialization issue.
• feat:Update XML documentation comments in OpenAI.Models namespace by @HavenDV in #76
• feat:Update documentation, parameters, and properties in OpenAI library by @HavenDV in #79

Full Changelog: v3.6.3...v3.7.0

v3.6.3

Full Changelog: v3.6.2...v3.6.3

fix: Fixed RunStepObject deserialization issue.

v3.6.2

Full Changelog: v3.6.1...v3.6.2

fix: Fixed some issues with Source Generator.

v3.6.1

What's Changed

• feat:Minor formatting adjustments in JsonSerializerContext.g.cs for readability by @HavenDV in #68

• feat:Add file search classes, enums, and OpenAPI enhancements in OpenAI namespace by @HavenDV in #70

• feat:Update OpenAPI specification to rename query parameter include to include[] by @HavenDV in #71

• feat:Add Initialized method for HttpClient customization in client classes by @HavenDV in #72

• feat:Introduce UnixTimestampJsonConverter for DateTimeOffset handling by @HavenDV in #73

• feat:Add default parameter values and update JSON serialization in client methods by @HavenDV in #74

• fix: Added Assistants.CreateRunAsStream. Fixed AssistantsWithVision.

• docs: Added new examples.

• fix: Changed Files.DownloadFile return type to byte[].

• fix: Fixed MessageObject required properties exception.

• feat: Added OpenAI-Beta: assistants=v2 header.

• feat: Added AsUserMessage(this byte[] bytes, string mimeType) extension to easy use vision.

• feat: Added Image.Bytes auto-property to get Base64 json as byte array.

• feat: Make SourceGenerationContext public.

Full Changelog: v3.5.1...v3.6.1

v3.5.1

Full Changelog: v3.5.0...v3.5.1

v3.5.0

Added Structured Outputs support.

using OpenAI;

using var api = new OpenAiApi("API_KEY");

var response = await api.Chat.CreateChatCompletionAsAsync<Weather>(
    messages: ["Generate random weather."],
    model: CreateChatCompletionRequestModel.Gpt4oMini,
    jsonSerializerOptions: new JsonSerializerOptions
    {
        Converters = {new JsonStringEnumConverter()},
    });
// or (if you need trimmable/NativeAOT version)
var response = await api.Chat.CreateChatCompletionAsAsync(
    jsonTypeInfo: SourceGeneratedContext.Default.Weather,
    messages: ["Generate random weather."],
    model: CreateChatCompletionRequestModel.Gpt4oMini);

// response.Value1 contains the structured output
// response.Value2 contains the CreateChatCompletionResponse object

Weather:
Location: San Francisco, CA
Temperature: 65
Unit: Fahrenheit
Description: Partly cloudy with a light breeze and occasional sunshine.
Raw Response:
{"Location":"San Francisco, CA","Temperature":65,"Unit":"Fahrenheit","Description":"Partly cloudy with a light breeze and occasional sunshine."}

Additional code for trimmable/NativeAOT version:

[JsonSourceGenerationOptions(Converters = [typeof(JsonStringEnumConverter<Unit>)])]
[JsonSerializable(typeof(Weather))]
public partial class SourceGeneratedContext : JsonSerializerContext;

Full Changelog: v3.4.1...v3.5.0

v3.4.1

Full Changelog: v3.4.0...v3.4.1