tryAGI.OpenAI.Models.ResponsePropertiesText.g.cs

#nullable enable

namespace tryAGI.OpenAI
{
    /// <summary>
    /// Configuration options for a text response from the model. Can be plain<br/>
    /// text or structured JSON data. Learn more:<br/>
    /// - [Text inputs and outputs](https://platform.openai.com/docs/guides/text)<br/>
    /// - [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs)
    /// </summary>
    public sealed partial class ResponsePropertiesText
    {
        /// <summary>
        /// An object specifying the format that the model must output.<br/>
        /// Configuring `{ "type": "json_schema" }` enables Structured Outputs, <br/>
        /// which ensures the model will match your supplied JSON schema. Learn more in the <br/>
        /// [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).<br/>
        /// The default format is `{ "type": "text" }` with no additional options.<br/>
        /// **Not recommended for gpt-4o and newer models:**<br/>
        /// Setting to `{ "type": "json_object" }` enables the older JSON mode, which<br/>
        /// ensures the message the model generates is valid JSON. Using `json_schema`<br/>
        /// is preferred for models that support it.
        /// </summary>
        [global::System.Text.Json.Serialization.JsonPropertyName("format")]
        [global::System.Text.Json.Serialization.JsonConverter(typeof(global::tryAGI.OpenAI.JsonConverters.TextResponseFormatConfigurationJsonConverter))]
        public global::tryAGI.OpenAI.TextResponseFormatConfiguration? Format { get; set; }

        /// <summary>
        /// Constrains the verbosity of the model's response. Lower values will result in<br/>
        /// more concise responses, while higher values will result in more verbose responses.<br/>
        /// Currently supported values are `low`, `medium`, and `high`.<br/>
        /// Default Value: medium
        /// </summary>
        [global::System.Text.Json.Serialization.JsonPropertyName("verbosity")]
        [global::System.Text.Json.Serialization.JsonConverter(typeof(global::tryAGI.OpenAI.JsonConverters.VerbosityJsonConverter))]
        public global::tryAGI.OpenAI.Verbosity? Verbosity { get; set; }

        /// <summary>
        /// Additional properties that are not explicitly defined in the schema
        /// </summary>
        [global::System.Text.Json.Serialization.JsonExtensionData]
        public global::System.Collections.Generic.IDictionary<string, object> AdditionalProperties { get; set; } = new global::System.Collections.Generic.Dictionary<string, object>();

        /// <summary>
        /// Initializes a new instance of the <see cref="ResponsePropertiesText" /> class.
        /// </summary>
        /// <param name="format">
        /// An object specifying the format that the model must output.<br/>
        /// Configuring `{ "type": "json_schema" }` enables Structured Outputs, <br/>
        /// which ensures the model will match your supplied JSON schema. Learn more in the <br/>
        /// [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).<br/>
        /// The default format is `{ "type": "text" }` with no additional options.<br/>
        /// **Not recommended for gpt-4o and newer models:**<br/>
        /// Setting to `{ "type": "json_object" }` enables the older JSON mode, which<br/>
        /// ensures the message the model generates is valid JSON. Using `json_schema`<br/>
        /// is preferred for models that support it.
        /// </param>
        /// <param name="verbosity">
        /// Constrains the verbosity of the model's response. Lower values will result in<br/>
        /// more concise responses, while higher values will result in more verbose responses.<br/>
        /// Currently supported values are `low`, `medium`, and `high`.<br/>
        /// Default Value: medium
        /// </param>
#if NET7_0_OR_GREATER
        [global::System.Diagnostics.CodeAnalysis.SetsRequiredMembers]
#endif
        public ResponsePropertiesText(
            global::tryAGI.OpenAI.TextResponseFormatConfiguration? format,
            global::tryAGI.OpenAI.Verbosity? verbosity)
        {
            this.Format = format;
            this.Verbosity = verbosity;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="ResponsePropertiesText" /> class.
        /// </summary>
        public ResponsePropertiesText()
        {
        }
    }
}