Add New Optional Parameters to AssistantRequest Struct

[Vanessamae23]

Add New Optional Parameters to AssistantRequest Struct

This update introduces three new optional parameters to the AssistantRequest struct: ResponseFormat, Temperature, and TopP. These parameters provide additional control over the output format and sampling behavior of the OpenAI assistant, enhancing its flexibility and usability.

OpenAI Documentation Link

For detailed information about these parameters, please refer to the OpenAI API documentation: OpenAI API Reference

Solution Description

The solution involves extending the AssistantRequest struct to include the following fields:

• ResponseFormat any: Specifies the format that the model must output. Example: setting this to { "type": "json_object" } ensures the model generates valid JSON. but it can also be a string format for 'auto'
• Temperature *float32: Determines the sampling temperature.
• TopP *float32: Defines the nucleus sampling parameter.

These additions enable users to specify advanced settings for response generation, aligning the API with the latest OpenAI features.

Struct Definition

Here is the updated AssistantRequest struct with the new fields included:

type AssistantRequest struct {
    Model         string                 `json:"model"`
    Name          *string                `json:"name,omitempty"`
    Description   *string                `json:"description,omitempty"`
    Instructions  *string                `json:"instructions,omitempty"`
    Tools         []AssistantTool        `json:"-"`
    FileIDs       []string               `json:"file_ids,omitempty"`
    Metadata      map[string]any         `json:"metadata,omitempty"`
    ToolResources *AssistantToolResource `json:"tool_resources,omitempty"`
    ResponseFormat any                   `json:"response_format,omitempty"`
    Temperature   *float32               `json:"temperature,omitempty"`
    TopP          *float32               `json:"top_p,omitempty"`
}

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.88%. Comparing base (774fc9d) to head (8a05028).
Report is 27 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #795      +/-   ##
==========================================
+ Coverage   98.46%   98.88%   +0.42%     
==========================================
  Files          24       26       +2     
  Lines        1364     1343      -21     
==========================================
- Hits         1343     1328      -15     
+ Misses         15        9       -6     
  Partials        6        6              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[sashabaranov]

Duh, temperature and top_p are getting different types across the codebase 🤯 #9

[sashabaranov]

Thank you for the PR!