using System;

namespace OpenAI.Chat;

/// <summary>
/// Represents the definition of a function that the model may call, as supplied in a chat completion request.
/// </summary>
[Obsolete($"This class is obsolete. Please use {nameof(ChatTool)} instead.")]
[CodeGenType("ChatCompletionFunctions")]
[CodeGenSuppress("ChatFunction", typeof(string))]
public partial class ChatFunction
{
    // CUSTOM: Added custom constructor.
    /// <summary>
    /// Creates a new instance of <see cref="ChatFunction"/>.
    /// </summary>
    /// <param name="functionName"> The <c>name</c> of the function. </param>
    public ChatFunction(string functionName)
    {
        Argument.AssertNotNull(functionName, nameof(functionName));

        FunctionName = functionName;
    }

    // CUSTOM: Renamed.
    /// <summary> The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. </summary>
    [CodeGenMember("Name")]
    public string FunctionName { get; }

    // CUSTOM: Renamed
    /// <summary> A description of what the function does, used by the model to choose when and how to call the function. </summary>
    [CodeGenMember("Description")]
    public string FunctionDescription { get; set; }

    // CUSTOM: Changed type to BinarayData.
    /// <summary> Gets or sets the parameters. </summary>
    [CodeGenMember("Parameters")]
    public BinaryData FunctionParameters { get; set; }
}